{ "swagger": "2.0", "info": { "version": "V1", "title": "Orion Connect API", "x-swagger-net-version": "8.4.12.001" }, "host": "api.orionadvisor.com", "basePath": "/api", "schemes": [ "https" ], "paths": { "/Actions/Remove": { "post": { "tags": [ "Remove" ], "summary": "Removes the Schwab integration for the current user.", "description": "The user must have the necessary privileges to remove the integration.", "operationId": "Supernova_RemoveServiceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/Actions/Setup": { "post": { "tags": [ "Setup" ], "operationId": "Supernova_SetupService", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "setupRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.IntegrationSetupRequestDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.BasicIntegrationConfigDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/{uri}": { "get": { "tags": [ "{uri}" ], "operationId": "Catchall_GetRedirect", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "uri", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "{uri}" ], "operationId": "Catchall_MethodNotAllowed", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "uri", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "{uri}" ], "operationId": "Catchall_PostV1ByUri", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "uri", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "{uri}" ], "operationId": "Catchall_DeleteV1ByUri", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "uri", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "options": { "tags": [ "{uri}" ], "operationId": "Catchall_OptionsV1ByUri", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "uri", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "head": { "tags": [ "{uri}" ], "operationId": "Catchall_HeadV1ByUri", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "uri", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "patch": { "tags": [ "{uri}" ], "operationId": "Catchall_PatchV1ByUri", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "uri", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/AdvisorTrading/BuySell/Data": { "get": { "tags": [ "AdvisorTrading/BuySell" ], "operationId": "AdvisorTradingBuySell_GetBuySellDataAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "query", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/AdvisorTrading/Core/EclipseFirm": { "get": { "tags": [ "AdvisorTrading/Core" ], "operationId": "AdvisorTradingCore_GetEclipseFirmIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "query", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/AdvisorTrading/Instances/Rep/{repId}": { "get": { "tags": [ "AdvisorTrading/Instances" ], "operationId": "AdvisorTradingInstances_GetTradeInstancesByRepIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "repId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "take", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/AdvisorTrading/Instances/Rep/{repId}/{tradeInstanceId}/Orders": { "get": { "tags": [ "AdvisorTrading/Instances" ], "operationId": "AdvisorTradingInstances_GetTradeOrdersByInstanceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "repId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "tradeInstanceId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/AdvisorTrading/SleeveAssignment/Data": { "get": { "tags": [ "AdvisorTrading/SleeveAssignment" ], "operationId": "AdvisorTradingSleeveAssignment_GetSleeveAssignmentDataAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "query", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Aggregator": { "get": { "tags": [ "Aggregator" ], "summary": "Gets a list of all aggregators", "description": "Sample Request\r\n\tGET /Aggregator", "operationId": "ConfirmAggregator_GetAggregators", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.AggregatorDto" }, "xml": { "name": "AggregatorDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Aggregator/AccessToken": { "get": { "tags": [ "Aggregator/AccessToken" ], "summary": "Gets a new access token from an id token request", "description": "Sample Request\r\n\tGET /Aggregator/AccessToken\r\n\t{\r\n\t\t\"idToken\": \"ThisIsAnIdTokenExampleValue\"\r\n\t}", "operationId": "ConfirmAggregator_GetTokenAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "idToken", "in": "query", "description": "The Id Token of a credential", "required": true, "type": "string" }, { "name": "token", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.AggregatorTokenResponseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Aggregator/Accounts": { "get": { "tags": [ "Aggregator/Accounts" ], "summary": "Gets All Akoya Accounts with balances", "description": "Sample Request\r\n\tGET /Aggregator/Accounts\r\n\t{\r\n\t\t\"credentialId\": 1234,\r\n\t\t\"aggregatorId\":1060\r\n\t}", "operationId": "ConfirmAggregator_GetAllAccountsWithBalances", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "credentialId", "in": "query", "description": "The credential ID (aka: appLinkDtlId)", "required": true, "type": "string" }, { "name": "aggregatorId", "in": "query", "description": "The Aggregator ID (aka: appLinkId", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.PlanningName" }, "xml": { "name": "PlanningName", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Aggregator/Holdings": { "get": { "tags": [ "Aggregator/Holdings" ], "summary": "Get All Holdings", "description": " Sample Request\r\n\t\tGET /Aggregator/Accounts\r\n\t\t{\r\n\t\t\t\"credentialId\": 1234,\r\n\t\t\t\"aggregatorId\":1060,\r\n\t\t\t\"accountId\":1234\r\n\t\t}", "operationId": "ConfirmAggregator_GetAllHoldings", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "credentialId", "in": "query", "description": "The credential ID(aka: appLinkDtlId)", "required": true, "type": "string" }, { "name": "aggregatorId", "in": "query", "description": "The Aggregator ID (aka: appLinkId", "required": true, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "query", "description": "The akoya account id", "required": true, "type": "string" }, { "name": "includeHistory", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.PlanningPosition" }, "xml": { "name": "PlanningPosition", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Aggregator/Token": { "get": { "tags": [ "Aggregator/Token" ], "summary": "Gets All Idtokens for a single credentialId (aka: applinkdtlId)", "description": "Sample Request\r\n\tGET /Aggregator/Token\r\n\t{\r\n\t\t\"credentialId\": 1234,\r\n\t\t\"aggregatorId\": 1060\r\n\t}", "operationId": "ConfirmAggregator_GetIdToken", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "credentialId", "in": "query", "description": "The ApplinkDtl Id", "required": true, "type": "string" }, { "name": "aggregatorId", "in": "query", "description": "The aggregator Id (aka: applinkId)", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.AggregatorIdTokenDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Aggregator/Token" ], "summary": "Update refresh token of an akoya user", "description": "Sample Request\r\n\tPUT /Aggregator/Token\r\n\t{\r\n\t\t\"credentialId\": 1234,\r\n\t\t\"idToken\": \"eyJhbGciOiJSUzI1NiIsImtpZCI6IjFjNmXXXTZhZGVmODU2YzXXXzM2ZjVlZTgzM2ViODg2MzRhNzY4XXXX.XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\r\n\t\t\"aggregatorId\":1060\r\n\t}", "operationId": "ConfirmAggregator_UpdateTokenAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "credentialId", "in": "query", "description": "The credential ID (aka: appLinkDtlId)", "required": true, "type": "string" }, { "name": "idToken", "in": "query", "description": "The idToken of an akoya user", "required": true, "type": "string" }, { "name": "aggregatorId", "in": "query", "description": "The Aggregator ID (aka: appLinkId", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Aggregator/Transactions": { "get": { "tags": [ "Aggregator/Transactions" ], "summary": "Get All Transactions", "description": " Sample Request\r\n\t\tGET /Aggregator/Accounts\r\n\t\t{\r\n\t\t\t\"credentialId\": 1234,\r\n\t\t\t\"aggregatorId\":1060,\r\n\t\t\t\"accountId\":1234\r\n\t\t}", "operationId": "ConfirmAggregator_GetAllTransactions", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "credentialId", "in": "query", "description": "The credential ID(aka: appLinkDtlId)", "required": true, "type": "string" }, { "name": "aggregatorId", "in": "query", "description": "The Aggregator ID (aka: appLinkId", "required": true, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "query", "description": "The akoya account id", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.PlanningTransaction" }, "xml": { "name": "PlanningTransaction", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Authorization/Databases": { "get": { "tags": [ "Authorization/Databases" ], "summary": "Gets a list of databases the logged in user has access to. The list includes a mark for which one the user is currently logged into.", "operationId": "Authorization_GetAvailableDatabases", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "resetCache", "in": "query", "description": "Optional. Default: false. The result is cached for fifteen minutes. To force the cache to refresh call with resetCache = true.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Authorization.ALClientDto" }, "xml": { "name": "ALClientDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Authorization/Profiles": { "get": { "tags": [ "Authorization/Profiles" ], "summary": "Gets a list of profiles for the currently logged in user.", "operationId": "Authorization_GetProfiles", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isActive", "in": "query", "description": "Optional. Default: True. If true only the profiles associated to active users are returned.", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.UserDetailDto" }, "xml": { "name": "UserDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Authorization/User": { "get": { "tags": [ "Authorization/User" ], "summary": "Gets commonly used information about the logged in user.", "operationId": "User_GetUserAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "forMobileApp", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.UserProfileDto" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Authorization/User" ], "summary": "Create a new Client level user. Special permissions are required to allow client users to be created through this method. The selected user name must be unique, or an error will be returned.", "operationId": "User_CreateUser", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "newUserDto", "in": "body", "description": "New User Login information", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Security.NewUserDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.UserProfileDto" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Authorization/User/AvailableToConnect/{searchText}": { "get": { "tags": [ "Authorization/User" ], "summary": "Gets a list of users that the current user is allowed to connect with.", "operationId": "User_AllowedToConnect", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "searchText", "in": "path", "required": true, "type": "string" }, { "name": "forMobileApp", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.UserProfileDto" }, "xml": { "name": "UserProfileDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Authorization/User/Databases": { "get": { "tags": [ "Authorization/User" ], "summary": "Gets a list of databases the logged in user has access to.", "operationId": "Databases_GetAvailableDatabasesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "token", "in": "header", "required": true }, { "name": "isActive", "in": "query", "description": "Optional. Default: null. If provided limits the return to only those database", "required": false, "type": "boolean" }, { "name": "filterForMasterGroup", "in": "query", "description": "Optional. Default null. If provided limits the return to only the databases in the logged in users mastergroup.", "required": false, "type": "boolean" }, { "name": "searchText", "in": "query", "required": false, "type": "string", "default": "" }, { "name": "filterForCotenant", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.DatabaseDto" }, "xml": { "name": "DatabaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Authorization/User/Databases/{key}": { "get": { "tags": [ "Authorization/User" ], "summary": "Gets the database that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Databases_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "token", "in": "header", "required": true }, { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.DatabaseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Authorization/User" ], "operationId": "Databases_UpdateDatabaseAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "token", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.DatabaseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.DatabaseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Authorization/User/Databases/Action/LockDown": { "put": { "tags": [ "Authorization/User" ], "operationId": "Databases_ReleaseLockDownAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Authorization/User/Databases/LockDown": { "get": { "tags": [ "Authorization/User" ], "operationId": "Databases_GetLockDownType", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Authorization/User/Gravatar": { "get": { "tags": [ "Authorization/User" ], "summary": "Gets commonly used information about the logged in user.", "operationId": "User_GetUsersGravatarAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "size", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 80 }, { "name": "defaultImage", "in": "query", "required": false, "type": "string", "default": 3, "enum": [ "_404", "Mp", "Identicon", "Monsterid", "Wavatar", "Retro", "Rodohbash", "Black" ] } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Authorization/User/Integrations/{app}": { "get": { "tags": [ "Authorization/User" ], "summary": "Retreives the Intgration information for the specified integration partner application for the user that is currently logged in, or the impersonated user.", "operationId": "UserIntegrations_GetUserIntegrationDtl", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "app", "in": "path", "description": "Integraton partners application code", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Security.UserDetailIntegration" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Authorization/User" ], "summary": "Updates the current users integration information for the Currently logged in, or the impersonated user.", "operationId": "UserIntegrations_UpdateUserIntegrationDtl", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "app", "in": "path", "required": true, "type": "string" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Security.UserDetailIntegration" } }, { "name": "forCurrentUser", "in": "query", "description": "Optional. Default is true. When true, the integration information is saved for the currently logged in user. If false, The integration info is saved for the specified user in the body - UserDetailId", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Security.UserDetailIntegration" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Authorization/User" ], "summary": "Deletes the integration information for the specified integration application, and for the current logged in user.", "operationId": "UserIntegrations_DeleteUserIntegrationDtl", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "app", "in": "path", "description": "Integraton partners application code", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Authorization/User/Integrations/SaleForce": { "post": { "tags": [ "Authorization/User" ], "operationId": "UserIntegrations_CreateIntegrationDetailForSaleForceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "sessionId", "in": "query", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Authorization/User/Logo": { "get": { "tags": [ "Authorization/User" ], "summary": "Gets the user's logo", "operationId": "User_GetLogoAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "imageType", "in": "query", "required": false, "type": "string", "default": 1, "enum": [ "Report", "Portal", "Firm" ] } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Authorization/User/Privileges": { "get": { "tags": [ "Authorization/User" ], "operationId": "AuthorizationPrivileges_GetCurrentUserPrivileges", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "object" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Authorization/User/Privileges/{code}": { "get": { "tags": [ "Authorization/User" ], "summary": "Gets the right that the logged in user has that matches the security code provided.", "operationId": "AuthorizationPrivileges_GetPrivilege", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "code", "in": "path", "required": true, "type": "string" }, { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.AuthorizationPrivilegeDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Authorization/User/Privileges/Codes": { "post": { "tags": [ "Authorization/User" ], "summary": "Gets the rights that the logged in user has that matches the security codes provided.", "operationId": "AuthorizationPrivileges_GetPrivileges", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "codes", "in": "body", "description": "The privilege codes being queried", "required": true, "schema": { "items": { "type": "string" }, "type": "array" } }, { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.AuthorizationPrivilegeDto" }, "xml": { "name": "AuthorizationPrivilegeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Authorization/User/Reset": { "put": { "tags": [ "Authorization/User" ], "summary": "Marks the currently logged in user as reset, requiring a password change on next login.", "description": "Cannot be used for API-only users, nor while impersonating.", "operationId": "User_ResetUserAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Authorization/User/Rights": { "get": { "tags": [ "Authorization/User" ], "summary": "Gets a list of rights that the logged in user has.", "operationId": "Rights_GetRights", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "resetCache", "in": "query", "description": "Optional. Default: false. The result is cached for fifteen minutes. To force the cache to refresh call with resetCache = true.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.RightDto" }, "xml": { "name": "RightDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Authorization/User/Rights/{securitycode}": { "get": { "tags": [ "Authorization/User" ], "summary": "Gets the right that the logged in user has that matches the security code provided.", "operationId": "Rights_GetRight", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "securitycode", "in": "path", "description": "The security code for", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.RightDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Authorization/User/Rights/Groups": { "get": { "tags": [ "Authorization/User" ], "summary": "Gets the groups that the logged in user has access to.", "operationId": "Rights_GetGroups", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Authorization/User/Rights/ObjectTypeCode/{code}": { "get": { "tags": [ "Authorization/User" ], "summary": "Gets the rights that the logged in user has that fall within the object type code provided.", "operationId": "Rights_GetRightsByObjectTypeCode", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "code", "in": "path", "description": "The object type code to return the rights of.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.RightDto" }, "xml": { "name": "RightDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Authorization/User/ServiceTeam": { "get": { "tags": [ "Authorization/User" ], "operationId": "User_GetServiceTeam", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Authorization.ServiceTeamDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Authorization/User/Verbose": { "get": { "tags": [ "Authorization/User" ], "operationId": "User_GetVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Personal", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Authorization.UserVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Authorization/User" ], "operationId": "User_UpdateVerboseUser", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Authorization.UserVerboseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Authorization.UserVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Accounts": { "get": { "tags": [ "Billing/Accounts" ], "operationId": "BillingAccounts_GetAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "top", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "status", "in": "query", "required": false, "type": "string", "enum": [ "MissingFeeSchedules", "MissingPayoutSchedules", "BillStatusNotReady", "PayingFeeIsZero", "PayingFeeIsIndirect", "PayingFeeIsInactive", "CreditRemaining", "CheckPayPaidByOther", "SubadvisorFeeSchedule", "AccountsPaidByAndFor", "StatusNotBilled", "MissingManagementStyles", "BillAccountStatusNotReady", "FeeScheduleIsZero", "AssetLevelBilling" ] }, { "name": "isActive", "in": "query", "required": false, "type": "boolean" }, { "name": "custodianId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "representativeId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "householdId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "registationId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "accountId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "fundFamilyId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "managementStyleId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "payoutScheduleId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "feeSecheduleId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "businessLineId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillAccountDto" }, "xml": { "name": "BillAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Accounts/{key}": { "get": { "tags": [ "Billing/Accounts" ], "summary": "Gets the bill account that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "BillingAccounts_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillAccountDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Accounts/{key}/CreditCardNumber": { "put": { "tags": [ "Billing/Accounts" ], "summary": "Return Credit Card Number", "operationId": "BillingAccounts_GetCreditCardNumberAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "reason", "in": "body", "required": true, "schema": { "type": "string" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Accounts/{key}/DefaultPercentsForGeneralAccount": { "get": { "tags": [ "Billing/Accounts" ], "summary": "Gets Percent for Account", "operationId": "BillingAccounts_GetDefaultPercentsForGeneralAccount", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "object" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Accounts/{key}/RecurringAdjustments": { "get": { "tags": [ "Billing/Accounts" ], "summary": "Returns accounts with recurring adjustments", "operationId": "BillingAccounts_GetRecurrentAdjustments", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Bill Account Id which can be different than account id", "required": true, "type": "integer", "format": "int32" }, { "name": "isActive", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "object" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Accounts/{key}/Tickers/Simple": { "get": { "tags": [ "Billing/Accounts" ], "summary": "Generate Tickers associated with account", "description": "Sample Request\r\n\tGET v1/Billing/Accounts/{key}/Tickers/Simple", "operationId": "BillingAccounts_GetAssetsValueAsOfDateAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Account Id", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Accounts/AccountSearch": { "get": { "tags": [ "Billing/Accounts" ], "summary": "Search Billing Accounts", "operationId": "BillingAccounts_AccountSearchAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "description": "Cancellation Token", "required": true }, { "name": "search", "in": "query", "description": "Optional.", "required": true, "type": "string" }, { "name": "isActive", "in": "query", "description": "Optional.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleAccount" }, "xml": { "name": "SimpleAccount", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Accounts/AccountSearch/{search}": { "get": { "tags": [ "Billing/Accounts" ], "summary": "Search Billing Accounts", "operationId": "BillingAccounts_GetV1BillingAccountsAccountSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "description": "Cancellation Token", "required": true }, { "name": "search", "in": "path", "description": "Optional.", "required": true, "type": "string" }, { "name": "isActive", "in": "query", "description": "Optional.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleAccount" }, "xml": { "name": "SimpleAccount", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Accounts/CheckPayforAccounts": { "post": { "tags": [ "Billing/Accounts" ], "summary": "check bill account paymethid indirect can't add payfor accounts", "operationId": "BillingAccounts_CheckPayforAccounts", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "obj", "in": "body", "required": true, "schema": { "type": "object" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Accounts/GetAllPaidbyBillAccounts": { "get": { "tags": [ "Billing/Accounts" ], "summary": "Return all acount ids paying for someone", "operationId": "BillingAccounts_GetAllPaidbyAccounts", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Accounts/GetCounts": { "get": { "tags": [ "Billing/Accounts" ], "operationId": "BillingAccounts_GetCounts", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillingAccountCountsDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Accounts/Grid": { "get": { "tags": [ "Billing/Accounts" ], "operationId": "BillingAccounts_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "manipulator", "in": "header", "required": true }, { "name": "status", "in": "query", "required": false, "type": "string", "enum": [ "MissingFeeSchedules", "MissingPayoutSchedules", "BillStatusNotReady", "PayingFeeIsZero", "PayingFeeIsIndirect", "PayingFeeIsInactive", "CreditRemaining", "CheckPayPaidByOther", "SubadvisorFeeSchedule", "AccountsPaidByAndFor", "StatusNotBilled", "MissingManagementStyles", "BillAccountStatusNotReady", "FeeScheduleIsZero", "AssetLevelBilling" ] }, { "name": "isActive", "in": "query", "required": false, "type": "boolean" }, { "name": "custodianId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "representativeId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "householdId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "registationId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "accountId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "fundFamilyId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "managementStyleId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "payoutScheduleId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "feeSecheduleId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "businessLineId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillAccountDto" }, "xml": { "name": "BillAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Accounts/Grid/New": { "get": { "tags": [ "Billing/Accounts" ], "operationId": "BillingAccounts_GetAllNewAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "manipulator", "in": "header", "required": true }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "assetManipulator", "in": "header", "required": false }, { "name": "status", "in": "query", "required": false, "type": "string", "enum": [ "MissingFeeSchedules", "MissingPayoutSchedules", "BillStatusNotReady", "PayingFeeIsZero", "PayingFeeIsIndirect", "PayingFeeIsInactive", "CreditRemaining", "CheckPayPaidByOther", "SubadvisorFeeSchedule", "AccountsPaidByAndFor", "StatusNotBilled", "MissingManagementStyles", "BillAccountStatusNotReady", "FeeScheduleIsZero", "AssetLevelBilling" ] }, { "name": "isActive", "in": "query", "required": false, "type": "boolean" }, { "name": "custodianId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "representativeId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "householdId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "registationId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "accountId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "fundFamilyId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "managementStyleId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "payoutScheduleId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "feeSecheduleId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "businessLineId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillAccountBaseDto" }, "xml": { "name": "BillAccountBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Accounts/HouseholdRecurringAdjustments": { "get": { "tags": [ "Billing/Accounts" ], "summary": "Returns recurring adjustments for household", "description": "Sample Request\r\n\tGET /HouseholdRecurringAdjustments\r\nSample Response\r\n[\r\n {\r\n \"id\": 95,\r\n \"adjustmentId\": 47,\r\n \"clientName\": \"Tiara Booker\",\r\n \"additionalAnnualAmount\": 1000.0000,\r\n \"type\": \"Dollar\",\r\n \"feeScheduleName\": null,\r\n \"adjustmentTypeDescription\": \"Account Debit\",\r\n \"entity\": \"Client\"\r\n }\r\n]", "operationId": "BillingAccounts_GetHouseholdRecurrentAdjustments", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "householdId", "in": "query", "description": "Optional household id filter", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.HouseholdRecurringAdjustmentDto" }, "xml": { "name": "HouseholdRecurringAdjustmentDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Accounts/ImportFileFilter": { "post": { "tags": [ "Billing/Accounts" ], "summary": "Takes an xlsx or csv file as multipart content. The file needs either an \"Account ID\" or \"Account Number\" or \"Household ID\" or \"Representative Name\" or \"Representative Number\" column\r\nThe file will be processed and returned billing accounts data filtered by column.", "description": "Sample Request\r\n\tPOST v1/Billing/Accounts/ImportFileFilter\r\n\t{\r\n\t \"file\": binary,\r\n \"columnName\": \"AccountId\"\r\n }", "operationId": "BillingAccounts_ImportFileFilterAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "fileData", "in": "body", "description": "File upload data with column information", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ImportFileFilterDto" } }, { "name": "token", "in": "header", "description": "Cancellation token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Accounts/List": { "post": { "tags": [ "Billing/Accounts" ], "summary": "Gets a list of bill accounts that match one of the keys in the provided list.", "operationId": "BillingAccounts_GetListById", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillAccountDto" }, "xml": { "name": "BillAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Accounts/List/AccountIds": { "post": { "tags": [ "Billing/Accounts" ], "summary": "Gets a list of Bill Account Grid objects by AccountIds", "description": "Sample Request\r\n POST v1/Billing/AccountsList/AccountIds\r\n {\r\n \"accountIds\": [1, 2, 3]\r\n }", "operationId": "BillingAccounts_GetListByAccountIds", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountIds", "in": "body", "description": "Account IDs to lookup", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "limitedDataSet", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillAccountGridDto" }, "xml": { "name": "BillAccountGridDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Accounts/List/Id": { "post": { "tags": [ "Billing/Accounts" ], "summary": "Gets a list of bill accounts that match one of the keys in the provided list.", "operationId": "BillingAccounts_PostV1BillingAccountsListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillAccountDto" }, "xml": { "name": "BillAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Accounts/RecurringAdjustments": { "get": { "tags": [ "Billing/Accounts" ], "summary": "Returns recurring adjustments", "description": "Sample Request\r\n\tGET /RecurringAdjustments\r\nSample Response\r\n[\r\n {\r\n \"id\": 246,\r\n \"clientId\": 83,\r\n \"fundName\": \"Schwab\",\r\n \"accountNumber\": \"GHED-3\",\r\n \"managementStyle\": \"Managed Account\",\r\n \"subAdvisorName\": null,\r\n \"feeSchedule\": \"2Q2017 TEST\",\r\n \"masterPayoutSchedule\": \"MC 80% / GY 20% (AFRD / AHFE. AR89)\",\r\n \"accountValue\": 1043329.78,\r\n \"clientName\": \"Tiara Comer\",\r\n \"clientFirstName\": \"Tiara\",\r\n \"accountId\": 280,\r\n \"additionalAnnualAmount\": 0.0000,\r\n \"adjustmentTypeDescription\": \"Goodwill/Giveaway credit\",\r\n \"entityDescription\": \"Broker Dealer\",\r\n \"billScheduleName\": \"DF Billing Test\",\r\n \"type\": \"Schedule\",cr\r\n \"billStartDate\": null,\r\n \"feeScheduleId\": 504,\r\n \"representativeName\": \"Kristina Salvador\",\r\n \"representativeNumber\": \"1122025\",\r\n \"businessLine\": null,\r\n \"accountStartDate\": \"2007-12-21\",\r\n \"endDate\": null,\r\n \"adjutmentStartDate\": \"2007-12-21\",\r\n \"adjustmentEndDate\": null,\r\n \"outsideId\": null\r\n }\r\n ]", "operationId": "BillingAccounts_GetV1BillingAccountsRecurringAdjustments", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "query", "description": "Optional account id filter", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillAccountRecurringAdjustmentDto" }, "xml": { "name": "BillAccountRecurringAdjustmentDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Accounts/SimpleBillAccounts": { "get": { "tags": [ "Billing/Accounts" ], "summary": "Get a list of simple bill accounts that the logged in user has access to see. Use $top and $skip in the query string to page through the data.", "operationId": "BillingAccounts_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "description": "Optional.", "required": true }, { "name": "skip", "in": "query", "description": "Optional.", "required": false, "type": "integer", "format": "int32" }, { "name": "top", "in": "query", "description": "Optional.", "required": false, "type": "integer", "format": "int32" }, { "name": "status", "in": "query", "description": "Optional.", "required": false, "type": "string", "enum": [ "MissingFeeSchedules", "MissingPayoutSchedules", "BillStatusNotReady", "PayingFeeIsZero", "PayingFeeIsIndirect", "PayingFeeIsInactive", "CreditRemaining", "CheckPayPaidByOther", "SubadvisorFeeSchedule", "AccountsPaidByAndFor", "StatusNotBilled", "MissingManagementStyles", "BillAccountStatusNotReady", "FeeScheduleIsZero", "AssetLevelBilling" ] }, { "name": "clientId", "in": "query", "description": "Optional.", "required": false, "type": "string", "default": "" }, { "name": "id", "in": "query", "description": "Optional.", "required": false, "type": "string", "default": "" }, { "name": "isActive", "in": "query", "description": "Optional. Default: null. When provided limits the return only to active (true) accounts, or inactive (false), or both (null).", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillAccountSimpleDto" }, "xml": { "name": "BillAccountSimpleDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Accounts/Summary": { "get": { "tags": [ "Billing/Accounts" ], "summary": "Gets the bill account summaries.", "operationId": "BillingAccounts_GetBillAccountByBillId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "billId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "clientId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillAccountSummaryDto" }, "xml": { "name": "BillAccountSummaryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/accountsPaidByFor/{key}": { "get": { "tags": [ "Billing/accountsPaidByFor" ], "operationId": "Billing_getAccountsPaidByFor", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/AccountStatusTypes": { "get": { "tags": [ "Billing/AccountStatusTypes" ], "summary": "Get list of Bill Account Status Types.", "operationId": "Billing_GetBillAccountStatusTypeList", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAccountStatus" }, "xml": { "name": "BillAccountStatus", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/AdjustmentTypes": { "get": { "tags": [ "Billing/AdjustmentTypes" ], "operationId": "BillingAdjustmentTypes_GetAdjustmentType", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isPayable", "in": "query", "required": false, "type": "boolean" }, { "name": "isPayableAffect", "in": "query", "required": false, "type": "boolean" }, { "name": "isDebit", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillAdjustmentTypeDto" }, "xml": { "name": "BillAdjustmentTypeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Billing/AdjustmentTypes" ], "operationId": "BillingAdjustmentTypes_CreateAdjustmentTypeAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillAdjustmentTypeDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillAdjustmentTypeDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/AdjustmentTypes/{key}": { "get": { "tags": [ "Billing/AdjustmentTypes" ], "operationId": "BillingAdjustmentTypes_GetAdjustmentTypesByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillAdjustmentTypeDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Billing/AdjustmentTypes" ], "operationId": "BillingAdjustmentTypes_UpdateAdjustmentTypeAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillAdjustmentTypeDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillAdjustmentTypeDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Billing/AdjustmentTypes" ], "operationId": "BillingAdjustmentTypes_DeleteAdjustmentTypeAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/AdjustmentTypes/DeleteMany": { "post": { "tags": [ "Billing/AdjustmentTypes" ], "operationId": "BillingAdjustmentTypes_DeleteAdjustmentTypesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/AdjustmentTypes/History/{key}": { "get": { "tags": [ "Billing/AdjustmentTypes" ], "operationId": "BillingAdjustmentTypes_GetAdjustmentTypeHistoryByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillAdjustmentTypeHistoryDto" }, "xml": { "name": "BillAdjustmentTypeHistoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Assets": { "get": { "tags": [ "Billing/Assets" ], "summary": "Get a list of bill assets that the logged in user has access to see.\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "BillingAsset_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "status", "in": "query", "description": "Optional. Default: null. When provided limits the return to only those bill assets included in the status provided.", "required": false, "type": "string", "enum": [ "Excluded", "PartiallyExcluded" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillAssetDto" }, "xml": { "name": "BillAssetDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Assets/{key}": { "get": { "tags": [ "Billing/Assets" ], "summary": "Gets the bill asset that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "BillingAsset_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillAssetDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Assets/ExcludeandPartially": { "get": { "tags": [ "Billing/Assets" ], "summary": "Get a list of excluded & partially excluded bill assets that the logged in user has access to see.\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "BillingAsset_GetExcludandPartiallyExcluded", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Assets/HouseholdExclusions": { "get": { "tags": [ "Billing/Assets" ], "summary": "Get all assets that have been excluded at the household level\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "BillingAsset_GetHouseholdExcludedAssetsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.HouseholdExclusionDto" }, "xml": { "name": "HouseholdExclusionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Assets/HouseholdExclusionsAll": { "get": { "tags": [ "Billing/Assets" ], "summary": "Get all assets that have been excluded enable and disabled at the household level\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "BillingAsset_GetHouseholdExcludedAssetsAllAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.HouseholdExclusionDto" }, "xml": { "name": "HouseholdExclusionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Assets/List": { "post": { "tags": [ "Billing/Assets" ], "summary": "Gets a list of bill assets that match one of the keys in the provided list.", "operationId": "BillingAsset_GetListById", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillAssetDto" }, "xml": { "name": "BillAssetDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Assets/List/Id": { "post": { "tags": [ "Billing/Assets" ], "summary": "Gets a list of bill assets that match one of the keys in the provided list.", "operationId": "BillingAsset_PostV1BillingAssetsListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillAssetDto" }, "xml": { "name": "BillAssetDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Assets/SecurityClassificationExclusions": { "get": { "tags": [ "Billing/Assets" ], "summary": "Get all security class exclusions for the Exclusions page. Requires split opex_Billing_UseNewSecurityClass_19909.\r\nReturns local security classes excluded from fees and payouts.", "operationId": "BillingAsset_GetSecurityClassificationExclusionsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.SecurityClassExclusionDto" }, "xml": { "name": "SecurityClassExclusionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Audit/{key}/File": { "get": { "tags": [ "Billing/Audit" ], "operationId": "BillingAudit_GetBlobAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Billing/Audit" ], "operationId": "BillingAudit_DeleteBlobAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Audit/AuditFiles": { "get": { "tags": [ "Billing/Audit" ], "operationId": "BillingAudit_GetBlobs", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "billInstanceId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.AuditFileBlobDto" }, "xml": { "name": "AuditFileBlobDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Audit/Consolidation/AuditFiles": { "get": { "tags": [ "Billing/Audit" ], "summary": "List of Audit Files for a date range", "operationId": "BillingAudit_GetConsolidatedBlobs", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.AuditFileBlobDto" }, "xml": { "name": "AuditFileBlobDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Audit/PayablesByRep": { "post": { "tags": [ "Billing/Audit" ], "operationId": "BillingPayables_GetBlobsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "param", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RepPayableSummaryParamsDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RepPayableSummaryDto" }, "xml": { "name": "RepPayableSummaryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Audit/PayablesByRep/{key}": { "get": { "tags": [ "Billing/Audit" ], "operationId": "BillingPayables_GetBlobAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Audit/PayablesByRep/Action/Delete/{key}": { "delete": { "tags": [ "Billing/Audit" ], "operationId": "BillingPayables_DeleteBlobAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Audit/PayablesByRep/Action/Download": { "post": { "tags": [ "Billing/Audit" ], "operationId": "BillingPayables_StageForDownloadAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Audit/PayablesByRep/Action/Download/{sessionId}": { "get": { "tags": [ "Billing/Audit" ], "operationId": "BillingPayables_GetFilesAsZipAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Audit/PayablesByRep/Action/SendFile": { "post": { "tags": [ "Billing/Audit" ], "summary": "Send files to users associated with Reps", "description": "Sample Request\r\n\tPOST /Billing/Audit/PayablesByRep/Action/SendFile\r\nPayload\r\n[23448]", "operationId": "BillingPayables_SendFileAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of blobIds.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "description": "Cancellation token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillAssetItem/{key}": { "get": { "tags": [ "Billing/BillAssetItem" ], "operationId": "BillAssetItem_GetBillAssetItemByBillAccountItemKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillAssetItemDto" }, "xml": { "name": "BillAssetItemDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillAssetItem/{key}/export": { "get": { "tags": [ "Billing/BillAssetItem" ], "operationId": "BillAssetItem_toExcelFile", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillCompareDashboard/BillTypes": { "get": { "tags": [ "Billing/BillCompareDashboard" ], "summary": "Get Bill Compare Instances for comparision", "operationId": "BillCompareDashboard_GetBillCompareInstances", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillCompareTypeDto" }, "xml": { "name": "BillCompareTypeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillCompareDashboard/Note": { "post": { "tags": [ "Billing/BillCompareDashboard" ], "summary": "Create new bill compare note.", "operationId": "BillCompareDashboard_CreateNoteAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "BillCompareNote form fields.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillCompareNoteDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillCompareNoteDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillCompareDashboard/Note/{key}": { "get": { "tags": [ "Billing/BillCompareDashboard" ], "summary": "Gets the note that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "BillCompareDashboard_GetNoteByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillCompareNoteDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Billing/BillCompareDashboard" ], "summary": "Update the note that has the provided key.", "operationId": "BillCompareDashboard_UpdateNoteAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Id of the note to delete.", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "description": "Key of the desired return object.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillCompareNoteDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillCompareNoteDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Billing/BillCompareDashboard" ], "summary": "Deletes note record provided the key.", "operationId": "BillCompareDashboard_DeleteNoteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Id of the note to delete.", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillCompareDashboard/Note/New": { "get": { "tags": [ "Billing/BillCompareDashboard" ], "summary": "Gets the notes that match with provided filters.", "operationId": "BillCompareDashboard_GetNewNote", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "query", "description": "Filter by AccountId.", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "compareFromOfDate", "in": "query", "description": "Filter by Bills As of Date", "required": false, "type": "string" }, { "name": "isMockCompareFrom", "in": "query", "description": "Bill Type to Compare", "required": false, "type": "boolean", "default": false }, { "name": "compareToOfDate", "in": "query", "description": "Filter by Bills As of Date to compare to", "required": false, "type": "string" }, { "name": "isMockCompareTo", "in": "query", "description": "Bill Type to Compare to", "required": false, "type": "boolean", "default": false }, { "name": "filterValue", "in": "query", "description": "Filter value", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "frequency", "in": "query", "description": "Bill frequency", "required": false, "type": "integer", "format": "int32", "default": 3 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillCompareNoteDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillCompareDashboard/Notes": { "get": { "tags": [ "Billing/BillCompareDashboard" ], "summary": "Gets the notes that match with provided filters.", "operationId": "BillCompareDashboard_GetNotesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "accountId", "in": "query", "description": "Filter by AccountId.", "required": false, "type": "integer", "format": "int32" }, { "name": "compareFromOfDate", "in": "query", "description": "Filter by Bills As of Date", "required": false, "type": "string", "format": "date-time" }, { "name": "isMockCompareFrom", "in": "query", "description": "Bill Type to Compare", "required": false, "type": "boolean" }, { "name": "compareToOfDate", "in": "query", "description": "Filter by Bills As of Date to compare to", "required": false, "type": "string", "format": "date-time" }, { "name": "isMockCompareTo", "in": "query", "description": "Bill Type to Compare to", "required": false, "type": "boolean" }, { "name": "filterValue", "in": "query", "description": "Filter value", "required": false, "type": "integer", "format": "int32" }, { "name": "frequency", "in": "query", "description": "Bill frequency", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillCompareNoteDto" }, "xml": { "name": "BillCompareNoteDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillCompareDashboard/Results": { "get": { "tags": [ "Billing/BillCompareDashboard" ], "summary": "Get Bill Compare results", "operationId": "BillCompareDashboard_GetBillCompareDashboard", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDateCompare", "in": "query", "description": "Filter by Bills As of Date", "required": false, "type": "string" }, { "name": "isMockBillCompare", "in": "query", "description": "Bill Type to Compare", "required": false, "type": "boolean", "default": false }, { "name": "asOfDateCompareTo", "in": "query", "description": "Filter by Bills As of Date to compare to", "required": false, "type": "string" }, { "name": "isMockBillCompareTo", "in": "query", "description": "Bill Type to Compare to", "required": false, "type": "boolean", "default": false }, { "name": "frequency", "in": "query", "description": "Bill frequency", "required": false, "type": "string", "default": 3, "enum": [ "Undefined", "Monthly", "Quarterly", "Triannual", "Semiannually", "Annually", "AtMaturity" ] }, { "name": "filterValue", "in": "query", "description": "Filter value", "required": false, "type": "string", "default": 0, "enum": [ "FeeScheduleChange", "InactivePreviouslyActive", "NewAccounts", "CashFlows", "AdjustmentsApplied", "RelatedHHAggregation", "AccountAggregation", "Cancellations", "Others" ] }, { "name": "includeApprovedNotes", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillCompareDashboard" }, "xml": { "name": "BillCompareDashboard", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillCompareDashboard/SummaryCount": { "get": { "tags": [ "Billing/BillCompareDashboard" ], "summary": "Get summary for Bill Compare Dashboard", "operationId": "BillCompareDashboard_GetBillCompareSummaryCounts", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDateCompare", "in": "query", "description": "Filter by Bills As of Date", "required": false, "type": "string" }, { "name": "isMockBillCompare", "in": "query", "description": "Bill Type to Compare", "required": false, "type": "boolean", "default": false }, { "name": "asOfDateCompareTo", "in": "query", "description": "Filter by Bills As of Date to compare to", "required": false, "type": "string" }, { "name": "isMockBillCompareTo", "in": "query", "description": "Bill Type to Compare to", "required": false, "type": "boolean", "default": false }, { "name": "frequency", "in": "query", "required": false, "type": "string", "default": 3, "enum": [ "Undefined", "Monthly", "Quarterly", "Triannual", "Semiannually", "Annually", "AtMaturity" ] }, { "name": "includeApprovedNotes", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillCompareDashboardCounts" }, "xml": { "name": "BillCompareDashboardCounts", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillDataExport": { "get": { "tags": [ "Billing/BillDataExport" ], "summary": "Get list of unpaid bills.", "operationId": "Billing_GetBillDataExport", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "billInstanceId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillDataDto" }, "xml": { "name": "BillDataDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillGenerator/Action/Instance": { "post": { "tags": [ "Billing/BillGenerator" ], "summary": "Create bill instance and client instances", "operationId": "BillGenerator_CreateBillInstancesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "Required. Passed as body.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillGeneratorInfoDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillInstanceDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillGenerator/Action/Recalc": { "post": { "tags": [ "Billing/BillGenerator" ], "summary": "Create bill instance and client instances", "description": "Sample Request\r\nPOST v1/Billing/BillGenerator/Action/Recalc\r\n{\r\n \"clientId\": 1,\r\n \"billIds\": [1, 2, 3],\r\n \"runForAccounts\": 1\r\n}", "operationId": "BillGenerator_RecalculateBillsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "Required. Passed as body.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillRecalcInfoDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillGenerator/Action/RecalcPayables": { "post": { "tags": [ "Billing/BillGenerator" ], "operationId": "BillGenerator_RecalculatePayablesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillPayableRecalcInfoDto" } }, { "name": "token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillGenerator/Action/RecalcPayees": { "post": { "tags": [ "Billing/BillGenerator" ], "operationId": "BillGenerator_RecalcPayeesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillPayableRecalcInfoDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillGenerator/Action/RecalcRepSplit": { "post": { "tags": [ "Billing/BillGenerator" ], "summary": "recalculate payables by spliting rep bill by percentage setup thru history", "operationId": "BillGenerator_RecalculateRepSplitBillsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "Required. Passed as body.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillRecalcInfoDto" } }, { "name": "token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillGenerator/BillAccountItem": { "put": { "tags": [ "Billing/BillGenerator" ], "operationId": "BillGenerator_UpdateBillAccountDtoItemAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountItemDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BillAccountItemDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BillAccountItemDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillGenerator/BillAccountItems": { "get": { "tags": [ "Billing/BillGenerator" ], "operationId": "BillGenerator_GetBillAccountItemAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "token", "in": "header", "required": true }, { "name": "key", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAccountItem" }, "xml": { "name": "BillAccountItem", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillGenerator/BillAccountItems/BillAccountAdj/{key}": { "get": { "tags": [ "Billing/BillGenerator" ], "summary": "Retrieves bill account item adjustments by BillAccountItem key", "operationId": "BillGenerator_GetBillAccountItemAdjByBillAccountItemKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillAccountItemAdjustmentDto" }, "xml": { "name": "BillAccountItemAdjustmentDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillGenerator/BillAccountItems/BillAccountAdj/edit/{billAccountItemId}": { "put": { "tags": [ "Billing/BillGenerator" ], "summary": "This operation will add/update/delete Bill Account Adjustments.\r\nIt takes three parameters billAccountItemId (required), adjustments(required), cancellationToken(required) & optional createPayableAdj", "description": "Sample Request\r\n\tPUT /BillGenerator/BillAccountItems/BillAccountAdj/edit\r\n\t{\r\n\t\t\"billAccountItemId\":835591,\r\n\t\t\"adjustments\":\r\n\t\t[\r\n\t\t {\r\n\t\t \"id\": -1,\r\n\t\t \"adjustmentType\": \"WriteOff\",\r\n\t\t \"adjustmentTypeId\": 10,\r\n\t\t \"fromBillEntity\": \"Client\",\r\n\t\t \"fromBillEntityId\": 3,\r\n\t\t \"dateOccured\": \"2024-01-16T21:15:28.853Z\",\r\n\t\t \"changeAmount\": -20,\r\n\t\t \"status\": \"Add\",\r\n\t\t \"isLocked\": true\r\n\t\t },\r\n\t\t {\r\n\t\t \"id\": 1278345,\r\n\t\t \"adjustmentType\": \"Payment\",\r\n\t\t \"adjustmentTypeId\": 1,\r\n\t\t \"fromBillEntity\": \"Client\",\r\n\t\t \"fromBillEntityId\": 3,\r\n\t\t \"dateOccured\": \"2024-01-16T21:15:36.880Z\",\r\n\t\t \"changeAmount\": -30,\r\n\t\t \"status\": \"Update\",\r\n\t\t \"isLocked\": true\r\n\t\t },\r\n\t\t {\r\n\t\t \"id\": 1278377,\r\n\t\t \"adjustmentType\": \"Cancellation\",\r\n\t\t \"adjustmentTypeId\": 7,\r\n\t\t \"fromBillEntity\": \"Rep\",\r\n\t\t \"fromBillEntityId\": 2,\r\n\t\t \"dateOccured\": \"2024-01-16T21:15:51.194Z\",\r\n\t\t \"changeAmount\": 50,\r\n\t\t \"status\": \"Delete\",\r\n\t\t \"isLocked\": true\r\n\t\t }\r\n\t\t]\r\n\t}", "operationId": "BillGenerator_UpdateBillAccountItemAdjsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "billAccountItemId", "in": "path", "description": "billAccountItem Id.", "required": true, "type": "integer", "format": "int32" }, { "name": "adjustments", "in": "body", "description": "billAccountItem Adjustment information", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillAccountItemAdjustmentDto" }, "xml": { "name": "BillAccountItemAdjustmentDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "createPayableAdj", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillAccountItemAdjustmentDto" }, "xml": { "name": "BillAccountItemAdjustmentDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillGenerator/BillAccountItems/PayableItems/{key}": { "get": { "tags": [ "Billing/BillGenerator" ], "summary": "Retrieves PayableItems by BillAccountItem key", "description": "Sample Request\r\n\tGET /Billing/BillGenerator/BillAccountItems/PayableItems/228789\r\n[\r\n {\r\n \"id\": 123456,\r\n \"payeeName\": \"First Last\",\r\n \"billStatus\": \"WaitingForPayment\",\r\n \"payableType\": \"Rep\",\r\n \"initialAmt\": 71.78,\r\n \"balanceDue\": 71.78,\r\n \"aggValue\": 1234567.1,\r\n \"calcDate\": \"2022-12-19\",\r\n \"percent\": 0.1,\r\n \"isPoints\": false,\r\n \"editedBy\": \"test.user\",\r\n \"createdBy\": \"test.user\"\r\n },\r\n {\r\n \"id\": 234567,\r\n \"payeeName\": \"First Last\",\r\n \"billStatus\": \"WaitingForPayment\",\r\n \"payableType\": \"RIA\",\r\n \"initialAmt\": 21.71,\r\n \"balanceDue\": 21.71,\r\n \"aggValue\": 2345678.47,\r\n \"calcDate\": \"2022-12-19\",\r\n \"percent\": 0,\r\n \"isPoints\": false,\r\n \"editedBy\": \"test.user\",\r\n \"createdBy\": \"test.user\"\r\n }\r\n]", "operationId": "BillGenerator_GetPayableItemByBillAccountItemKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PayableItemDto" }, "xml": { "name": "PayableItemDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillGenerator/BillAccountItems/PayableItems/PayableItemAdjustment/{key}": { "get": { "tags": [ "Billing/BillGenerator" ], "summary": "Retrieves Payable Item adjustments by Payable Item key", "operationId": "BillGenerator_GetPayableItemAdjustmentByPayableItemKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PayableItemAdjustmentDto" }, "xml": { "name": "PayableItemAdjustmentDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillGenerator/BillAccountItems/PayableItems/PayableItemAdjustment/edit/{payableId}": { "put": { "tags": [ "Billing/BillGenerator" ], "summary": "This operation will add/update/delete payable adjustments.\r\nIt takes three parameters payableId (required), payableAdjs(required) and cancellationToken(required)", "description": "Sample Request\r\n\tPUT /BillGenerator/BillAccountItems/PayableItems/PayableItemAdjustment/edit\r\n\t{\r\n\t\t\"payableId\":835591,\r\n\t\t\"payableAdjs\":\r\n\t\t[\r\n\t\t {\r\n\t\t \"id\": -1,\r\n\t\t \"adjustmentType\": \"Debit\",\r\n\t\t \"adjustmentTypeId\": 43,\r\n\t\t \"fromBillEntity\": \"Rep\",\r\n\t\t \"fromBillEntityId\": 2,\r\n\t\t \"dateOccured\": \"2024-01-16T19:58:52.000Z\",\r\n\t\t \"changeAmount\": -20,\r\n\t\t \"status\": \"Add\",\r\n\t\t \"isLocked\": true\r\n\t\t },\r\n\t\t {\r\n\t\t \"id\": 1278340,\r\n\t\t \"adjustmentType\": \"Payment\",\r\n\t\t \"adjustmentTypeId\": 39,\r\n\t\t \"fromBillEntity\": \"BD\",\r\n\t\t \"fromBillEntityId\": 4,\r\n\t\t \"dateOccured\": \"2024-01-16T19:59:14.669Z\",\r\n\t\t \"changeAmount\": -30,\r\n\t\t \"status\": \"Delete\",\r\n\t\t \"isLocked\": true\r\n\t\t },\r\n\t\t {\r\n\t\t \"id\": 1278345,\r\n\t\t \"adjustmentType\": \"Expense\",\r\n\t\t \"adjustmentTypeId\": 44,\r\n\t\t \"fromBillEntity\": \"Client\",\r\n\t\t \"fromBillEntityId\": 3,\r\n\t\t \"dateOccured\": \"1/16/2024\",\r\n\t\t \"changeAmount\": -35,\r\n\t\t \"status\": \"Update\",\r\n\t\t \"isLocked\": true\r\n\t\t }\r\n\t\t]\r\n\t}", "operationId": "BillGenerator_UpdatePayableItemAdjAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "payableId", "in": "path", "description": "payable Item Id.", "required": true, "type": "integer", "format": "int32" }, { "name": "payableAdjs", "in": "body", "description": "Payable Item Adjustment information", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PayableItemAdjustmentDto" }, "xml": { "name": "PayableItemAdjustmentDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PayableItemDto" }, "xml": { "name": "PayableItemDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillGenerator/BillItems": { "get": { "tags": [ "Billing/BillGenerator" ], "operationId": "BillGenerator_GetBillsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "billInstanceIds", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "billIds", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BillAccountItemDto" }, "xml": { "name": "BillAccountItemDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillGenerator/BillItemsOptimize": { "get": { "tags": [ "Billing/BillGenerator" ], "summary": "Call the v1/Billing/BillGenerator/BillItems endpoint instead.", "operationId": "BillGenerator_GetBillsNewAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "billInstanceIds", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "billIds", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BillAccountItemDto" }, "xml": { "name": "BillAccountItemDto", "wrapped": true }, "type": "array" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillGenerator/BillPeriodDetail": { "get": { "tags": [ "Billing/BillGenerator" ], "summary": "Get bill period detail.", "operationId": "BillGenerator_BillPeriodDetailAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "periodEndDate", "in": "query", "description": "Optional.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillGeneratorBillPeriodDetailDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillGenerator/BillTimeFrames": { "get": { "tags": [ "Billing/BillGenerator" ], "summary": "Bill generator billing timeframes", "operationId": "BillGenerator_GetBillTimeFramesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillGeneratorBillTimeFramesDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillGenerator/getCashflows": { "post": { "tags": [ "Billing/BillGenerator" ], "summary": "Get cash-flow detail", "description": "Sample Request\r\nPOST /Billing/BillGenerator/getCashFlows?runFor=7&asOfDate=12/31/2023\r\n[1, 17, 25]", "operationId": "BillGenerator_getCashflowsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "runFor", "in": "query", "description": "The type objects to get cashflows for", "required": true, "type": "integer", "format": "int32" }, { "name": "asOfDate", "in": "query", "description": "An As Of date. The end date for the period.", "required": true, "type": "string", "format": "date-time" }, { "name": "runForKeyList", "in": "body", "description": "A list of object IDs for the runFor type", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillGeneratorCashFlowDto" }, "xml": { "name": "BillGeneratorCashFlowDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillGenerator/Instance/{key}/ClientList": { "get": { "tags": [ "Billing/BillGenerator" ], "summary": "Return list of client instances", "operationId": "BillGenerator_GetInstanceClientAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Required.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "clientId", "in": "query", "description": "Optional.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillInstanceClientDto" }, "xml": { "name": "BillInstanceClientDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillGenerator/Instance/{key}/ClientList/Grid": { "get": { "tags": [ "Billing/BillGenerator" ], "summary": "Return list of client instances", "operationId": "BillGenerator_GetV1BillingBillGeneratorInstanceByKeyClientListGrid", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Required.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "clientId", "in": "query", "description": "Optional.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillInstanceClientDto" }, "xml": { "name": "BillInstanceClientDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Billing/BillGenerator" ], "summary": "Get Bill Instance Clients by client Ids", "description": "Sample Request\r\n\tpost /BillGenerator/Instance/123/ClientList/Grid\r\n\t[251]\r\nSample Response\r\n[\r\n{\r\n \"id\": 133161,\r\n \"billInstanceId\": 5436,\r\n \"billType\": \"Renewal\",\r\n \"clientId\": 251,\r\n \"clientName\": \"Bode\",\r\n \"status\": \"Not Generated\",\r\n \"startDate\": \"2024-01-01\",\r\n \"endDate\": \"2024-03-31\",\r\n \"initialAmt\": 0.00,\r\n \"adjAmt\": 0.00,\r\n \"balanceDue\": 0.00,\r\n \"feeFileGenerated\": false,\r\n \"createdBy\": \"collin.buus@orion.com\",\r\n \"createdDate\": \"2024-05-08T12:11:46.36-05:00\",\r\n \"repName\": \"Liana Cooks\",\r\n \"repID\": 18,\r\n \"repNumber\": \"123456\",\r\n \"relatedHouseholds\": \"\",\r\n \"isValid\": false\r\n}\r\n]", "operationId": "BillGenerator_GetInstanceClientGridByClientIdAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Instance Id", "required": true, "type": "integer", "format": "int32" }, { "name": "clientIds", "in": "body", "description": "List of Client Ids", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillInstanceClientDto" }, "xml": { "name": "BillInstanceClientDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillGenerator/Overview": { "get": { "tags": [ "Billing/BillGenerator" ], "summary": "Bill generator overview", "operationId": "BillGenerator_GetBillOverview", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillGeneratorOverview" }, "xml": { "name": "BillGeneratorOverview", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillGenerator/Simple/Bill/Ids": { "post": { "tags": [ "Billing/BillGenerator" ], "operationId": "BillGenerator_GetBillIdsList", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillGenerator/Summary": { "get": { "tags": [ "Billing/BillGenerator" ], "summary": "Get summary for bill generator", "operationId": "BillGenerator_GetSummaryValue", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "description": "Required.", "required": true, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Required.", "required": true, "type": "string", "format": "date-time" }, { "name": "billInstanceId", "in": "query", "description": "Optional.", "required": false, "type": "integer", "format": "int32" }, { "name": "resetCache", "in": "query", "description": "Optional.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Charts.ChartDataDto" }, "xml": { "name": "ChartDataDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillingCompare": { "get": { "tags": [ "Billing/BillingCompare" ], "summary": "Get list of Billing Compares in DB", "operationId": "BillCompareDashboard_GetBillingCompare", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ofDate", "in": "query", "description": "Filter by Bills As of Date", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillingCompareDto" }, "xml": { "name": "BillingCompareDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillingCompare/HouseholdBills/{clientId}": { "get": { "tags": [ "Billing/BillingCompare" ], "summary": "Get Household Bills", "operationId": "BillCompareDashboard_GetHouseholdBills", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "description": "ClientId", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillComboForHousehold" }, "xml": { "name": "BillComboForHousehold", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillingCompare/instance": { "get": { "tags": [ "Billing/BillingCompare" ], "summary": "This operation will compare account items between two bill instances", "description": "Sample Request\r\n\tGET /Billing/BillingCompare/instance?billInstanceA=3729&billInstanceB=3726&take=10000&skip=10000\r\n [\r\n {\r\n \"clientId\": 383,\r\n \"repName\": \"Kadeem Shelton\",\r\n \"repNo\": null,\r\n \"clientName\": null,\r\n \"lName\": null,\r\n \"accountId\": 2400,\r\n \"regName\": \"Alanna Sowell\",\r\n \"acctCode\": \"010000180\",\r\n \"fundName\": \"401(k) Account\",\r\n \"isActive\": true,\r\n \"feeSchedule\": \"TieredFee\",\r\n \"feePercent\": null,\r\n \"payMethod\": null,\r\n \"valueMethod\": null,\r\n \"billStyle\": null,\r\n \"billFrequency\": null,\r\n \"billId\": 0,\r\n \"ofDate\": \"2024-03-31T00:00:00-05:00\",\r\n \"flowValue\": 0.0000,\r\n \"flowBalance\": 0.0000,\r\n \"renewalValue\": 175000.0000,\r\n \"renewalAggregate\": 175000.0000,\r\n \"renewalInitialAmount\": 652.6600,\r\n \"renewalAdjustments\": 0.0000,\r\n \"renewalBalanceDue\": 652.6600,\r\n \"previousDate\": \"2024-03-31T00:00:00-05:00\",\r\n \"previousFlowValue\": 0.0000,\r\n \"previousFlowBalance\": 0.0000,\r\n \"previousValue\": 175000.0000,\r\n \"previousAggregate\": 175000.0000,\r\n \"previousInitialAmount\": 652.6600,\r\n \"previousAdjustments\": 0.0000,\r\n \"previousBalanceDue\": 652.6600,\r\n \"differenceValue\": 0.0000,\r\n \"differentInitial\": 0.0000,\r\n \"differentBalanceDue\": 0.0000,\r\n \"percentofValue\": null,\r\n \"percentofFee\": 0.0000\r\n }\r\n ]", "operationId": "BillCompareDashboard_GetBillingCompareByInstance", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "billInstanceA", "in": "query", "description": "Requires. Bill Instance A", "required": true, "type": "integer", "format": "int32" }, { "name": "billInstanceB", "in": "query", "description": "Requires. Bill Instance B", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "take", "in": "query", "description": "Number of Records to return", "required": false, "type": "integer", "format": "int32", "default": 100000 }, { "name": "skip", "in": "query", "description": "Number of records to skip.", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillingCompareDto" }, "xml": { "name": "BillingCompareDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillingCompare/instance/new": { "get": { "tags": [ "Billing/BillingCompare" ], "summary": "Enhanced billing compare that returns both Receivables and Payables data with warnings and filtering", "operationId": "BillCompareDashboard_GetBillingCompareEnhancedByInstanceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "billInstanceA", "in": "query", "description": "Requires. Bill Instance A", "required": true, "type": "integer", "format": "int32" }, { "name": "billInstanceB", "in": "query", "description": "Requires. Bill Instance B", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "description": "Cancellation token", "required": true }, { "name": "take", "in": "query", "description": "Number of Records to return", "required": false, "type": "integer", "format": "int32", "default": 100000 }, { "name": "skip", "in": "query", "description": "Number of records to skip", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillingCompareEnhancedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillingEntities": { "get": { "tags": [ "Billing/BillingEntities" ], "operationId": "Billing_GetBillingEntities", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "status", "in": "query", "required": false, "type": "string", "enum": [ "ShowOnlyWithAssignedSchedules" ] }, { "name": "schedule", "in": "query", "required": false, "items": { "type": "string", "enum": [ "Undefined", "Fee", "Payout", "BDOverride", "Remainder", "PerformanceFee", "PerformancePayout" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "isActive", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.SimpleBillingEntityDto" }, "xml": { "name": "SimpleBillingEntityDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillingSummary": { "get": { "tags": [ "Billing/BillingSummary" ], "summary": "Get a billing summary list.", "operationId": "Billing_GetBillingSummary", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "AsOfDate", "in": "query", "description": "Optional. Default is Today. The date to run the billing summary as of.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillingSummaryDto" }, "xml": { "name": "BillingSummaryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillPayMethods": { "get": { "tags": [ "Billing/BillPayMethods" ], "summary": "Get list of pay methods in database", "operationId": "BillPayMethods_GetList", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillPayMethodDto" }, "xml": { "name": "BillPayMethodDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillPayMethods/{key}": { "get": { "tags": [ "Billing/BillPayMethods" ], "summary": "Get a bill pay method by Id", "operationId": "BillPayMethods_GetByIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillPayMethodDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillPayMethods/Update": { "put": { "tags": [ "Billing/BillPayMethods" ], "summary": "Update bill pay method", "operationId": "BillPayMethods_UpdateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "billPayMethodDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillPayMethodDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillPayMethodDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillProductGroup": { "get": { "tags": [ "Billing/BillProductGroup" ], "summary": "Returns a list of Bill Product Groups", "description": "Sample Request\r\n GET /Billing/BillProductGroup", "operationId": "BillProductGroup_ListAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "required": false, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillProductGroupDto" }, "xml": { "name": "BillProductGroupDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Billing/BillProductGroup" ], "summary": "Create a new Bill Product Group", "description": "Sample Request\r\n POST /Billing/BillProductGroup", "operationId": "BillProductGroup_CreateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillProductGroupDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillProductGroupDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillProductGroup/{key}": { "get": { "tags": [ "Billing/BillProductGroup" ], "summary": "Fetch a Bill Product Group by key", "description": "Sample Request\r\n GET /Billing/BillProductGroup/1", "operationId": "BillProductGroup_DetailAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillProductGroupDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Billing/BillProductGroup" ], "summary": "Updates a new Bill Product Group", "description": "Sample Request\r\n PUT /Billing/BillProductGroup/1", "operationId": "BillProductGroup_UpdateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillProductGroupDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillProductGroupDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Billing/BillProductGroup" ], "summary": "Delete a Bill Product Group by key", "description": "Sample Request\r\n DELETE /Billing/BillProductGroup/1", "operationId": "BillProductGroup_DeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillProductGroup/{key}/Grid": { "get": { "tags": [ "Billing/BillProductGroup" ], "summary": "Returns Bill Product Groups Details by Bill Product Group ID for a grid", "description": "Sample Request\r\n GET /Billing/BillProductGroup/:id/Grid", "operationId": "BillProductGroup_GridDetailAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillProductGroupDetailDto" }, "xml": { "name": "BillProductGroupDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillProductGroup/Grid": { "get": { "tags": [ "Billing/BillProductGroup" ], "summary": "Returns a list of Bill Product Groups Details for a grid", "description": "Sample Request\r\n GET /Billing/BillProductGroup", "operationId": "BillProductGroup_GridListAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillProductGroupDetailDto" }, "xml": { "name": "BillProductGroupDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Bills": { "get": { "tags": [ "Billing/Bills" ], "summary": "Get a list of bills that the logged in user has access to see.\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "BillingBill_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "instanceId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "isValid", "in": "query", "required": false, "type": "boolean" }, { "name": "billType", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillDto" }, "xml": { "name": "BillDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Bills/{key}": { "get": { "tags": [ "Billing/Bills" ], "summary": "Gets the bills that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "BillingBill_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Bills/{key}/Action/DeleteClientRelatedBills": { "delete": { "tags": [ "Billing/Bills" ], "operationId": "BillingBill_DeleteClientRelatedBills", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Bills/{key}/Action/Hold": { "put": { "tags": [ "Billing/Bills" ], "operationId": "BillingBill_ActionHoldAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Bills/{key}/Action/RemoveHold": { "put": { "tags": [ "Billing/Bills" ], "operationId": "BillingBill_ActionRemoveHoldAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Bills/{key}/Log": { "get": { "tags": [ "Billing/Bills" ], "summary": "Get bill log that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "BillingBill_GetBillLogByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillLogDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Bills/{key}/Simple": { "get": { "tags": [ "Billing/Bills" ], "summary": "Gets the simple bill that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "BillingBill_GetSimpleByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Bills/Action/Delete": { "put": { "tags": [ "Billing/Bills" ], "summary": "Delete bill records provided in the list of ids.", "description": "Sample Request\r\n\tPUT /Billing/Bills/Action/Delete\r\n [67567,56637]", "operationId": "BillingBill_ActionDeleteAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true }, { "name": "deleteRelatedHouseholds", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Bills/List": { "post": { "tags": [ "Billing/Bills" ], "summary": "Gets a list of bill assets that match one of the keys in the provided list.", "operationId": "BillingBill_GetListById", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillDto" }, "xml": { "name": "BillDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Bills/List/Id": { "post": { "tags": [ "Billing/Bills" ], "summary": "Gets a list of bill assets that match one of the keys in the provided list.", "operationId": "BillingBill_PostV1BillingBillsListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillDto" }, "xml": { "name": "BillDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Bills/Simple": { "get": { "tags": [ "Billing/Bills" ], "summary": "Gets a simple list of bills that the logged in user has access to.\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "BillingBill_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isValid", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Bills/Simple/List": { "post": { "tags": [ "Billing/Bills" ], "summary": "Gets a simple list of bill that match one of the keys in the provided list.", "operationId": "BillingBill_GetSimpleListById", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Bills/Simple/List/Id": { "post": { "tags": [ "Billing/Bills" ], "summary": "Gets a simple list of bill that match one of the keys in the provided list.", "operationId": "BillingBill_PostV1BillingBillsSimpleListId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Bills/ValidateAccPayments": { "post": { "tags": [ "Billing/Bills" ], "summary": "Returns a list of BillIds for instances where a Household account was making payments to other Household accounts.", "operationId": "BillingBill_ValidatePaysForAccountPaymentAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "token", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillPaysForAccountValidateDto" }, "xml": { "name": "BillPaysForAccountValidateDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillScheduleElementRestrictions": { "get": { "tags": [ "Billing/BillScheduleElementRestrictions" ], "summary": "Returns a list of broker dealer fees.", "operationId": "BillScheduleElementBrokerDealerRestrictions_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "brokerDealerId", "in": "query", "description": "Optional broker dealer ID to find.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillScheduleElementBrokerDealerRestrictionDto" }, "xml": { "name": "BillScheduleElementBrokerDealerRestrictionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Billing/BillScheduleElementRestrictions" ], "summary": "Accepts a Broker Dealers Fee Restriction and writes it into the table.", "operationId": "BillScheduleElementBrokerDealerRestrictions_AddEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "The BillScheduleElementBrokerDealerRestrictionDto to add.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillScheduleElementBrokerDealerRestrictionDto" } }, { "name": "ct", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillScheduleElementBrokerDealerRestrictionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillScheduleElementRestrictions/Action/Delete": { "put": { "tags": [ "Billing/BillScheduleElementRestrictions" ], "summary": "Deletes a list of Broker Dealers Fee Restrictions .", "operationId": "BillScheduleElementBrokerDealerRestrictions_DeleteEntities", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "itemsToDelete", "in": "body", "description": "The list of BillScheduleElementBrokerDealerRestrictionDto to delete.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillScheduleElementBrokerDealerRestrictionDto" }, "xml": { "name": "BillScheduleElementBrokerDealerRestrictionDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillScheduleElementRestrictions/list": { "put": { "tags": [ "Billing/BillScheduleElementRestrictions" ], "summary": "Accepts a list of Broker Dealers Fee Restrictions and writes them into the table.", "operationId": "BillScheduleElementBrokerDealerRestrictions_AddEntityList", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dtoList", "in": "body", "description": "The list of BillScheduleElementBrokerDealerRestrictionDto to add.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillScheduleElementBrokerDealerRestrictionDto" }, "xml": { "name": "BillScheduleElementBrokerDealerRestrictionDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillScheduleElementBrokerDealerRestrictionDto" }, "xml": { "name": "BillScheduleElementBrokerDealerRestrictionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillTransmitMethods": { "get": { "tags": [ "Billing/BillTransmitMethods" ], "summary": "Get a list of BillTransmitMethods that the logged in user has access to see.", "operationId": "BillTransmitMethods_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "statementDelivery", "in": "query", "description": "Optional. If provided the result will be limit to include only statement methods, or only not statement methods.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillTransmitMethodDto" }, "xml": { "name": "BillTransmitMethodDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillTransmitMethods/{key}": { "get": { "tags": [ "Billing/BillTransmitMethods" ], "summary": "Gets the BillTransmitMethod that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "BillTransmitMethods_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillTransmitMethodDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/BillTransmitMethods/Simple": { "get": { "tags": [ "Billing/BillTransmitMethods" ], "summary": "Get a simple list of BillTransmitMethods that the logged in user has access to see.", "operationId": "BillTransmitMethods_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "statementDelivery", "in": "query", "description": "Optional. If provided the result will be limit to include only statement methods, or only not statement methods.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/CancellationFeeAdjDefault": { "get": { "tags": [ "Billing/CancellationFeeAdjDefault" ], "operationId": "CancellationFeeAdjDefault_GetCancellationFeeAdjDefaults", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.CancellationFeeAdjustmentDefaultDto" }, "xml": { "name": "CancellationFeeAdjustmentDefaultDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Billing/CancellationFeeAdjDefault" ], "operationId": "CancellationFeeAdjDefault_CreateCancellationFeeAdjDefaultAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.CancellationFeeAdjustmentDefaultDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.CancellationFeeAdjustmentDefaultDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/CancellationFeeAdjDefault/{key}": { "get": { "tags": [ "Billing/CancellationFeeAdjDefault" ], "operationId": "CancellationFeeAdjDefault_GetCancellationFeeAdjDefaultsByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.CancellationFeeAdjustmentDefaultDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Billing/CancellationFeeAdjDefault" ], "operationId": "CancellationFeeAdjDefault_UpdateCancellationFeeAdjDefaultAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.CancellationFeeAdjustmentDefaultDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.CancellationFeeAdjustmentDefaultDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Billing/CancellationFeeAdjDefault" ], "operationId": "CancellationFeeAdjDefault_DeleteCancellationFeeAdjDefaultAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/CancellationFeeAdjDefault/DeleteMany": { "put": { "tags": [ "Billing/CancellationFeeAdjDefault" ], "operationId": "CancellationFeeAdjDefault_DeleteManyCancellationFeeAdjDefaultAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/CancellationFeeAdjDefault/History/{key}": { "get": { "tags": [ "Billing/CancellationFeeAdjDefault" ], "operationId": "CancellationFeeAdjDefault_GetAdjustmentTypeHistoryByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.CancellationFeeAdjustmentDefaultHistoryDto" }, "xml": { "name": "CancellationFeeAdjustmentDefaultHistoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/CashFunding": { "get": { "tags": [ "Billing/CashFunding" ], "summary": "Returns a list of Cash Funding Accounts with Balance Due", "description": " Sample Request:\r\n GET: /Billing/CashFunding?forecast=false&startDate=03/01/2024&endDate=03/31/2024&take=50000\r\n\r\n Response:\r\n [\r\n \t{\r\n\t \"id\": 123,\r\n\t \"registrationName\": \"First Last\",\r\n\t \"registrationId\": 456,\r\n\t \"fundFamily\": \"Fund Family\",\r\n\t \"productName\": \"Cash and Equivalents\",\r\n\t \"moneyMarketBalance\": 123.45,\r\n\t \"balanceDue\": -123.45,\r\n\t \"difference\": 123.45,\r\n\t \"payMethod\": \"Method\",\r\n\t \"instanceType\": \"Forecast\",\r\n\t \"clientId\": 789,\r\n\t \"clientLastName\": \"Last\",\r\n\t \"clientName\": \"First Last\",\r\n\t \"accountType\": \"Acct Type\",\r\n\t \"accountNumber\": \"acct-num\",\r\n\t \"managementStyle\": \"Managed Style\",\r\n\t \"accountIsActive\": true,\r\n\t \"representativeName\": \"First Last\",\r\n\t \"feeReqSrc\": \"Cash account\"\r\n\t },\r\n ]", "operationId": "Billing_GetCashFundingAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "startDate", "in": "query", "description": "Required. Begining date of the range.", "required": true, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Required. End date of range", "required": true, "type": "string", "format": "date-time" }, { "name": "forecast", "in": "query", "description": "Required. 1 = Forecast Bill, 0 = Live Bill", "required": true, "type": "boolean" }, { "name": "take", "in": "query", "description": "Required", "required": true, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Optional", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.CashFundingGridDto" }, "xml": { "name": "CashFundingGridDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Clients": { "get": { "tags": [ "Billing/Clients" ], "summary": "Get a list of billing clients that the logged in user has access to see.\r\nThe return is limited to pages of 60000. Use $top and $skip in the query string to page through the data.", "operationId": "BillingClients_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "status", "in": "query", "description": "Optional. Default: null. When provided limits the return to only those bill clients included in the status provided.", "required": false, "type": "string", "enum": [ "NotReady" ] }, { "name": "isActive", "in": "query", "description": "Optional. Default: null. When provided limits the return only to active (true) accounts, or inactive (false), or both (null).", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillClientDto" }, "xml": { "name": "BillClientDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Clients/{key}": { "get": { "tags": [ "Billing/Clients" ], "summary": "Gets the client that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "BillingClients_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillClientDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Clients/{key}/RelatedAccounts": { "get": { "tags": [ "Billing/Clients" ], "summary": "Gets a list of related accounts. Related accounts are accounts that fall below the client with the specified key or fall below another client which is related to the client with the specified key. The list does not include additional accounts.", "operationId": "BillingClients_GetRelatedAccountsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "isActive", "in": "query", "description": "Optional. Default null. When true - only active accounts are returned, when False, only inactive accounts, when null all accounts.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountDto" }, "xml": { "name": "AccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Clients/All": { "get": { "tags": [ "Billing/Clients" ], "summary": "Get a list of all clients that the logged in user has access to see.", "operationId": "BillingClients_GetAllAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "manipulator", "in": "header", "required": true }, { "name": "status", "in": "query", "description": "Optional. Default: null. When provided limits the return to only those bill clients included in the status provided.", "required": false, "type": "string", "enum": [ "NotReady" ] }, { "name": "isActive", "in": "query", "description": "Optional. Default: null. When provided limits the return only to active (true) accounts, or inactive (false), or both (null).", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillClientGridDto" }, "xml": { "name": "BillClientGridDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Clients/Grid": { "get": { "tags": [ "Billing/Clients" ], "summary": "Get a list of all clients that the logged in user has access to see.", "operationId": "BillingClients_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "manipulator", "in": "header", "required": true }, { "name": "status", "in": "query", "description": "Optional. Default: null. When provided limits the return to only those bill clients included in the status provided.", "required": false, "type": "string", "enum": [ "NotReady" ] }, { "name": "isActive", "in": "query", "description": "Optional. Default: null. When provided limits the return only to active (true) accounts, or inactive (false), or both (null).", "required": false, "type": "boolean" }, { "name": "top", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillClientDto" }, "xml": { "name": "BillClientDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Clients/List": { "post": { "tags": [ "Billing/Clients" ], "summary": "Gets a list of bill clients that match one of the keys in the provided list.", "operationId": "BillingClients_GetListById", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillClientDto" }, "xml": { "name": "BillClientDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Clients/List/Id": { "post": { "tags": [ "Billing/Clients" ], "summary": "Gets a list of bill clients that match one of the keys in the provided list.", "operationId": "BillingClients_PostV1BillingClientsListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillClientDto" }, "xml": { "name": "BillClientDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/ClientStatuses/Simple": { "get": { "tags": [ "Billing/ClientStatuses" ], "summary": "Get all billing client statuses", "operationId": "BillClientStatuses_GetAllSimpleEntities", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.SimpleBillClientStatus" }, "xml": { "name": "SimpleBillClientStatus", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Consolidation/PostAuditFiles": { "post": { "tags": [ "Billing/Consolidation" ], "summary": "Generate Audit files", "description": " Sample Request\r\n\t\tPOST v1/Billing/Consolidation/PostAuditFiles\r\n {\r\n \"startDate\": null,\r\n \"endDate\": null,\r\n \"billInstanceIds\": \"123,2333\",\r\n \"entityList\": [\r\n {\r\n \"entity\": 18,\r\n \"ids\": [\r\n 31,\r\n 1\r\n ],\r\n \"selected\": true\r\n },\r\n {\r\n \"entity\": 12,\r\n \"ids\": [],\r\n \"selected\": false\r\n },\r\n {\r\n \"entity\": 79,\r\n \"selected\": false\r\n }\r\n ]\r\n}", "operationId": "Billing_GenerateConsolidationBillingAuditFilesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "postData", "in": "body", "description": "File data", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PostAuditDataDto" } }, { "name": "ct", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.AuditFileBlobDto" }, "xml": { "name": "AuditFileBlobDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Consolidation/ReceiveableSummary": { "get": { "tags": [ "Billing/Consolidation" ], "summary": "Obsolete. This endpoint is no longer valid and will be removed 7/11/2024. New endpont is /Billing/CashFunding.", "operationId": "Billing_GetV1BillingConsolidationReceiveableSummary", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.CashFundingGridDto" }, "xml": { "name": "CashFundingGridDto", "wrapped": true }, "type": "array" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Counts": { "get": { "tags": [ "Billing/Counts" ], "operationId": "Billing_GetCounts", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/CreateNewBillAccountItemAdj": { "put": { "tags": [ "Billing/CreateNewBillAccountItemAdj" ], "operationId": "BillGenerator_CreateBillAccountItemAdjAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "amount", "in": "query", "required": true, "type": "number", "format": "double" }, { "name": "dateOccurred", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "option", "in": "query", "required": true, "type": "boolean" }, { "name": "data", "in": "body", "required": true, "schema": { "type": "object" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/CreateNewPayableItemAdj": { "put": { "tags": [ "Billing/CreateNewPayableItemAdj" ], "operationId": "BillGenerator_CreatePayableItemAdjAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ratedAmount", "in": "query", "required": true, "type": "number", "format": "double" }, { "name": "dateOccurred", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "data", "in": "body", "required": true, "schema": { "type": "object" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/DeleteNotes": { "post": { "tags": [ "Billing/DeleteNotes" ], "summary": "Create new confirm overview notes", "operationId": "BillPayment_DeleteNotes", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PostPaymentsDto" }, "xml": { "name": "PostPaymentsDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PostPaymentsDto" }, "xml": { "name": "PostPaymentsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Entities/{key}": { "get": { "tags": [ "Billing/Entities" ], "summary": "Get a bill entity by Id", "operationId": "Entities_GetEntityByIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillEntityDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Entities/BillEntitiyHistory": { "get": { "tags": [ "Billing/Entities" ], "summary": "Gets a list of bill entity audit histories", "operationId": "Entities_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "billEntitiyId", "in": "query", "description": "Required. Default: null, returns nothing.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillEntityAuditDto" }, "xml": { "name": "BillEntityAuditDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Entities/Delete": { "put": { "tags": [ "Billing/Entities" ], "operationId": "Entities_DeleteEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "billEntityIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Entities/EntityList": { "get": { "tags": [ "Billing/Entities" ], "summary": "Get list of bill entities in database", "operationId": "Entities_GetPayeeEntityList", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isActive", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillEntityDto" }, "xml": { "name": "BillEntityDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Entities/New": { "post": { "tags": [ "Billing/Entities" ], "summary": "Add new bill entity", "operationId": "Entities_CreateNewEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "billEntityDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillEntityDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillEntityDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Entities/Update": { "put": { "tags": [ "Billing/Entities" ], "summary": "Update bill entity", "operationId": "Entities_UpdateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "billEntityDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillEntityDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillEntityDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Enums": { "get": { "tags": [ "Billing/Enums" ], "operationId": "Billing_GetEnums", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/FeatureFlags": { "get": { "tags": [ "Billing/FeatureFlags" ], "summary": "Get feature flags for bill generation processing", "operationId": "Billing_GetFeatureFlags", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.FeatureFlagInputParameter" }, "xml": { "name": "FeatureFlagInputParameter", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/FeeCollection/{id}": { "delete": { "tags": [ "Billing/FeeCollection" ], "operationId": "FeeCollection_DeleteFeeCollectionInstanceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/FeeCollection/{id}/Action/BluePay": { "post": { "tags": [ "Billing/FeeCollection" ], "summary": "Sent payment information to bluepay", "description": " Sample Request\r\n\t\tPOST 123/Action/BluePay\r\n[\r\n 1123,\r\n 1145\r\n]", "operationId": "FeeCollection_SendPaymentsToBluePayAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "description": "The fee collection instance id", "required": true, "type": "integer", "format": "int32" }, { "name": "paymentList", "in": "body", "description": "List of payment ids", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "processType", "in": "query", "description": "How the information will be processed", "required": false, "type": "string", "default": 0, "enum": [ "None", "FeeFile", "Check", "CreditCard", "ACH", "Special" ] } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/FeeCollection/{id}/Action/FeeFiles": { "post": { "tags": [ "Billing/FeeCollection" ], "operationId": "FeeCollection_GenerateFeeFilesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/FeeCollection/{id}/Action/Payments": { "post": { "tags": [ "Billing/FeeCollection" ], "summary": "", "operationId": "FeeCollection_PostPaymentsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "detailIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/FeeCollection/{id}/Action/Refresh": { "post": { "tags": [ "Billing/FeeCollection" ], "operationId": "FeeCollection_UpdateInstanceDetailsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/FeeCollection/{id}/Details": { "get": { "tags": [ "Billing/FeeCollection" ], "operationId": "FeeCollection_GetDetails", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "payType", "in": "query", "required": false, "type": "string", "enum": [ "None", "FeeFile", "Check", "CreditCard", "ACH", "Special" ] }, { "name": "status", "in": "query", "required": false, "type": "string", "enum": [ "NotSent", "Sent", "Paid", "Error", "ValidationRequired", "Rollback" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillFeeCollectDetailDto" }, "xml": { "name": "BillFeeCollectDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/FeeCollection/{id}/Details/Counts": { "get": { "tags": [ "Billing/FeeCollection" ], "operationId": "FeeCollection_GetCounts", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillFeeCollectDetailCountDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/FeeCollection/{id}/Details/PayMethod/Counts": { "get": { "tags": [ "Billing/FeeCollection" ], "operationId": "FeeCollection_GetPaymethodCounts", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "status", "in": "query", "required": false, "type": "string", "enum": [ "NotSent", "Sent", "Paid", "Error", "ValidationRequired", "Rollback" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillFeeCollectDetailPaymentCountDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/FeeCollection/Instance": { "post": { "tags": [ "Billing/FeeCollection" ], "operationId": "FeeCollection_CreateInstanceAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillFeeCollectGeneratorDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillFeeCollectInstanceDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/FeeCollection/Instances": { "get": { "tags": [ "Billing/FeeCollection" ], "summary": "Returns fee collection instance list", "description": "Sample Request\r\n\tGET /Billing/FeeCollection/Instances\r\nSample Response\r\n[\r\n {\r\n \"id\": 2,\r\n \"description\": \"test\",\r\n \"createdDate\": \"2023-05-23\",\r\n \"createdBy\": \"angelika.lagera\",\r\n \"startDate\": \"2023-05-01\",\r\n \"endDate\": \"2023-05-23\"\r\n }\r\n]", "operationId": "FeeCollection_GetInstances", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillFeeCollectInstanceDto" }, "xml": { "name": "BillFeeCollectInstanceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/FeeFile/Action/Schwab": { "post": { "tags": [ "Billing/FeeFile" ], "operationId": "BillingFeeFile_PostSchwabFeeFileAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "blobId", "in": "query", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.SchwabSIIUploadFileDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/FeeFile/instance/{id}": { "get": { "tags": [ "Billing/FeeFile" ], "operationId": "BillingFeeFile_GetFeeFiles", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TradeFileDto" }, "xml": { "name": "TradeFileDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/FeeType": { "post": { "tags": [ "Billing/FeeType" ], "summary": "post form to add a new fee type", "operationId": "FeeType_AddFeeTypeAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "postData", "in": "body", "description": "int", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FeeTypeDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FeeTypeDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/FeeType/{id}": { "get": { "tags": [ "Billing/FeeType" ], "summary": "find a fee type by id", "operationId": "FeeType_GetFeeTypeByIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "description": "int", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FeeTypeDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Billing/FeeType" ], "summary": "post fee for update", "operationId": "FeeType_UpdateFeeTypeAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "description": "int representing the fee type id", "required": true, "type": "integer", "format": "int32" }, { "name": "updateDto", "in": "body", "description": "the new data from the user", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FeeTypeDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FeeTypeDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Billing/FeeType" ], "summary": "remove a fee type by id", "operationId": "FeeType_DeleteFeeTypeInstanceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "description": "int representing the fee type id", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/FeeType/List": { "get": { "tags": [ "Billing/FeeType" ], "summary": "Return all the fee types", "operationId": "FeeType_GetInstances", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FeeTypeDto" }, "xml": { "name": "FeeTypeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/FinalBills/account/{key}": { "get": { "tags": [ "Billing/FinalBills" ], "summary": "Get Account for a given Account Id", "operationId": "FinalBills_FinalBillInstanceItemGetResponsibleEntitiesByAccountKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/FinalBills/accounts/household/{key}": { "get": { "tags": [ "Billing/FinalBills" ], "summary": "Get list of accounts by Household Id", "operationId": "FinalBills_FinalBillInstanceItemGetResponsibleEntitiesByHouseholdKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/FinalBills/accounts/registration/{key}": { "get": { "tags": [ "Billing/FinalBills" ], "summary": "Get list of accounts by Registration Id", "operationId": "FinalBills_FinalBillInstanceItemGetResponsibleEntitiesByRegistrationKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/FinalBills/CreateBillInstance/{key}": { "get": { "tags": [ "Billing/FinalBills" ], "summary": "Actually create the bill instance from the final bill instance session.", "operationId": "FinalBills_CreateBillInstanceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillInstanceDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/FinalBills/CreateFinalBillInstance": { "post": { "tags": [ "Billing/FinalBills" ], "summary": "Create final bill instance", "operationId": "FinalBills_CreateFinalBillInstanceAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FinalBillInstanceDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FinalBillInstanceDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/FinalBills/CreateFinalBillInstanceItem": { "put": { "tags": [ "Billing/FinalBills" ], "summary": "Create final bill instance item", "operationId": "FinalBills_CreateFinalBillInstanceItemAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "item", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Billing.FinalBillInstanceItem" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/FinalBills/DeleteFinalBillInstance/{key}": { "delete": { "tags": [ "Billing/FinalBills" ], "summary": "Delete Final Bill Instance", "operationId": "FinalBills_DeleteFinalBillInstanceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/FinalBills/DeleteFinalBillInstanceItem/{key}": { "delete": { "tags": [ "Billing/FinalBills" ], "summary": "Delete Final Bill Instance Item", "operationId": "FinalBills_DeleteFinalBillInstanceItemAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/FinalBills/GetFinalBillInstance/{key}": { "get": { "tags": [ "Billing/FinalBills" ], "summary": "Gets a final bill instance for a given key", "operationId": "FinalBills_GetAllFinalBillInstanceByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FinalBillInstanceDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/FinalBills/GetFinalBillInstanceItem/{key}": { "get": { "tags": [ "Billing/FinalBills" ], "summary": "Gets a final bill instance item by key", "operationId": "FinalBills_FinalBillInstanceItemGetAllFinalBillInstanceItemByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of parent finalBillInstance.", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Billing.FinalBillInstanceItem" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/FinalBills/GetFinalBillInstanceItemAccounts/{key}": { "get": { "tags": [ "Billing/FinalBills" ], "summary": "Gets a list of final bill instance items accounts by the final bill instance id", "operationId": "FinalBills_GetAllFinalBillInstanceItemsByFinalBillInstanceKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of parent finalBillInstance.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FinalBillInstanceItemAccountDto" }, "xml": { "name": "FinalBillInstanceItemAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/FinalBills/GetFinalBillInstances": { "get": { "tags": [ "Billing/FinalBills" ], "summary": "Gets a list of incomplete final bill instances", "operationId": "FinalBills_GetAllFinalBillInstances", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FinalBillInstanceDto" }, "xml": { "name": "FinalBillInstanceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/FinalBills/GetFinalBillInstances/Grid": { "get": { "tags": [ "Billing/FinalBills" ], "operationId": "FinalBills_GetAllFinalBillInstancesGrid", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FinalBillInstanceDto" }, "xml": { "name": "FinalBillInstanceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/FinalBills/UpdateFinalBillInstance": { "put": { "tags": [ "Billing/FinalBills" ], "summary": "Update Final Bill Instance", "operationId": "FinalBills_UpdateFinalBillInstanceAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "instance", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Billing.FinalBillInstance" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/FinalBills/UpdateFinalBillInstanceItem": { "put": { "tags": [ "Billing/FinalBills" ], "summary": "Update Final Bill Instance Item", "operationId": "FinalBills_UpdateFinalBillInstanceItemAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "item", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Billing.FinalBillInstanceItem" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/FinancialPlanningFee/Action/Instance/{clientId}/{feeTypeId}": { "post": { "tags": [ "Billing/FinancialPlanningFee" ], "summary": "Get a list of financial planning fees using a household id", "operationId": "FinancialPlanningFee_GenerateNewFinancialPlanningBillAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "clientId", "in": "path", "description": "ClientId required", "required": true, "type": "integer", "format": "int32" }, { "name": "feeTypeId", "in": "path", "description": "fee type id, optional", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/FinancialPlanningFee/CreateBluePayPayment": { "post": { "tags": [ "Billing/FinancialPlanningFee" ], "summary": "Generate BluePay payments by taking a list of bill ids and submitting to BluePayPaymentsAccess", "description": "Sample Request\r\n\tPOST CreateBluePayPayment", "operationId": "FinancialPlanningFee_CreateBluePayPaymentAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "billIdList", "in": "body", "description": "Ienumerable int", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/FinancialPlanningFee/List/{householdId}": { "get": { "tags": [ "Billing/FinancialPlanningFee" ], "summary": "Get a list of financial planning fees using a household id", "operationId": "FinancialPlanningFee_GetBills", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "householdId", "in": "path", "description": "Household ID of clients requested", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FinancialPlanningFeeDto" }, "xml": { "name": "FinancialPlanningFeeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/GenerateMockBills": { "post": { "tags": [ "Billing/GenerateMockBills" ], "summary": "Generate Mock Bills for a date, renewals for pre-billing review", "operationId": "BillGenerator_GenerateMockBillsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "MockBillInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.MockBillInfoDto" } }, { "name": "token", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Hierarchy": { "put": { "tags": [ "Billing/Hierarchy" ], "summary": "Update a fee hierarchy record.", "operationId": "FeeHierarchy_UpdateHierarchyAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "updated", "in": "body", "description": "Updated detailed fee hierarchy record.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FeeHierarchyVerboseDto" } }, { "name": "ct", "in": "header", "description": "CancellationToken object", "required": true } ], "responses": { "200": { "description": "A detailed fee hierarchy record.", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FeeHierarchyVerboseDto" } }, "400": { "description": "Validation error:\r\n Fee Hierarchy Method Type is required." } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Billing/Hierarchy" ], "summary": "Create a new fee hierarchy record.", "operationId": "FeeHierarchy_CreateHierarchyAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "created", "in": "body", "description": "A detailed fee hierarchy record to create.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FeeHierarchyVerboseDto" } }, { "name": "ct", "in": "header", "description": "CancellationToken object", "required": true } ], "responses": { "200": { "description": "A detailed fee hierarchy record.", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FeeHierarchyVerboseDto" } }, "400": { "description": "Validation error:\r\n Fee Schedule type detected. Please use payout rate.\r\n -- OR --\r\n Entity is null or zero. Please select a valid entity.\r\n -- OR --\r\n Cannot Assign Custodian to Account or Registration levels.\r\n -- OR --\r\n Fee Hierarchy Method Type is required." } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Hierarchy/BillEntity/Search": { "get": { "tags": [ "Billing/Hierarchy" ], "summary": "Searches fee hierarchy records by bill entity.", "operationId": "FeeHierarchy_GetBillEntitySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "The bill entity to search for.", "required": true, "type": "string" } ], "responses": { "200": { "description": "A list of simple entities, consisting of the ID and name.", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Hierarchy/BillEntity/Search/{search}": { "get": { "tags": [ "Billing/Hierarchy" ], "summary": "Searches fee hierarchy records by bill entity.", "operationId": "FeeHierarchy_GetV1BillingHierarchyBillEntitySearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "The bill entity to search for.", "required": true, "type": "string" } ], "responses": { "200": { "description": "A list of simple entities, consisting of the ID and name.", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Hierarchy/Consolidation": { "get": { "tags": [ "Billing/Hierarchy" ], "summary": "Get all fee hierarchy records.", "operationId": "FeeHierarchy_GetFeeHierarchyConsolidation", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "A list of fee hierarchy records.", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FeeHierarchyConsolidationDto" }, "xml": { "name": "FeeHierarchyConsolidationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Hierarchy/Consolidation/{entity}/Search": { "get": { "tags": [ "Billing/Hierarchy" ], "summary": "Get fee hierarchy records for search criteria.", "operationId": "FeeHierarchy_GetV1BillingHierarchyConsolidationByEntitySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "Field to search (Level, Name, Bill Entity, Payout Rate, or Type)", "required": true, "type": "string" }, { "name": "search", "in": "query", "description": "Search text.", "required": true, "type": "string" } ], "responses": { "200": { "description": "A list of detailed fee hierarchy records.", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FeeHierarchyConsolidationDto" }, "xml": { "name": "FeeHierarchyConsolidationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Hierarchy/Consolidation/{entity}/Search/{search}": { "get": { "tags": [ "Billing/Hierarchy" ], "summary": "Get fee hierarchy records for search criteria.", "operationId": "FeeHierarchy_GetV1BillingHierarchyConsolidationByEntitySearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "Field to search (Level, Name, Bill Entity, Payout Rate, or Type)", "required": true, "type": "string" }, { "name": "search", "in": "path", "description": "Search text.", "required": true, "type": "string" } ], "responses": { "200": { "description": "A list of detailed fee hierarchy records.", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FeeHierarchyConsolidationDto" }, "xml": { "name": "FeeHierarchyConsolidationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Hierarchy/Consolidation/Accounts": { "get": { "tags": [ "Billing/Hierarchy" ], "summary": "Get fee hierarchy account records", "operationId": "FeeHierarchy_GetFeeHierarchyAccountsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "description": "CancellationToken object", "required": true } ], "responses": { "200": { "description": "List of fee hierarchy accounts", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FeeHierarchyConsolidationAuditDto" }, "xml": { "name": "FeeHierarchyConsolidationAuditDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Hierarchy/Consolidation/Accounts/Search": { "post": { "tags": [ "Billing/Hierarchy" ], "summary": "Get fee hierarchy account records by search criteria", "operationId": "FeeHierarchy_ConsolidationFHAccountSearchAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "description": "CancellationToken object", "required": true }, { "name": "filters", "in": "body", "description": "An object containing all required filters.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillingEntitySearchItemDto" }, "xml": { "name": "BillingEntitySearchItemDto", "wrapped": true }, "type": "array" } }, { "name": "take", "in": "query", "description": "Number of records to retrieve.", "required": true, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Optional. Number of records to skip.", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "List of fee hierarchy accounts", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FeeHierarchyConsolidationAuditDto" }, "xml": { "name": "FeeHierarchyConsolidationAuditDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Hierarchy/Consolidation/new/Search": { "post": { "tags": [ "Billing/Hierarchy" ], "summary": "Get fee hierarchy records by search criteria.", "operationId": "FeeHierarchy_ConsolidationForceSearchNew", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "filters", "in": "body", "description": "Object containing all required filters.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillingEntitySearchItemDto" }, "xml": { "name": "BillingEntitySearchItemDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "List of fee hierarchy records", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FeeHierarchyConsolidationDto" }, "xml": { "name": "FeeHierarchyConsolidationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Hierarchy/Consolidation/Search": { "get": { "tags": [ "Billing/Hierarchy" ], "summary": "Get fee hierarchy records for search criteria.", "operationId": "FeeHierarchy_ConsolidationForceSearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "Search text.", "required": true, "type": "string" }, { "name": "searchBy", "in": "query", "description": "Field to search (Level, Name, Bill Entity, Payout Rate, or Type)", "required": true, "type": "string" }, { "name": "top", "in": "query", "description": "Optional. Number of records to retrieve.", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Optional. Number of records to skip.", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "List of detailed fee hierarchy records", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FeeHierarchyConsolidationDto" }, "xml": { "name": "FeeHierarchyConsolidationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Hierarchy/Consolidation/Search/{search}": { "get": { "tags": [ "Billing/Hierarchy" ], "summary": "Get fee hierarchy records for search criteria.", "operationId": "FeeHierarchy_GetV1BillingHierarchyConsolidationSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "Search text.", "required": true, "type": "string" }, { "name": "searchBy", "in": "query", "description": "Field to search (Level, Name, Bill Entity, Payout Rate, or Type)", "required": true, "type": "string" }, { "name": "top", "in": "query", "description": "Optional. Number of records to retrieve.", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Optional. Number of records to skip.", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "List of detailed fee hierarchy records", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FeeHierarchyConsolidationDto" }, "xml": { "name": "FeeHierarchyConsolidationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Hierarchy/Consolidation/Update": { "put": { "tags": [ "Billing/Hierarchy" ], "summary": "Update a fee hierarchy record.", "operationId": "FeeHierarchy_UpdateHierarchyConsolidationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updated", "in": "body", "description": "Updated detailed fee hierarchy record.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FeeHierarchyVerboseDto" } }, { "name": "ct", "in": "header", "description": "CancellationToken object", "required": true } ], "responses": { "200": { "description": "Update successful.", "schema": { "type": "string", "enum": [ "Continue", "SwitchingProtocols", "OK", "Created", "Accepted", "NonAuthoritativeInformation", "NoContent", "ResetContent", "PartialContent", "MultipleChoices", "Ambiguous", "MovedPermanently", "Moved", "Found", "Redirect", "SeeOther", "RedirectMethod", "NotModified", "UseProxy", "Unused", "TemporaryRedirect", "RedirectKeepVerb", "BadRequest", "Unauthorized", "PaymentRequired", "Forbidden", "NotFound", "MethodNotAllowed", "NotAcceptable", "ProxyAuthenticationRequired", "RequestTimeout", "Conflict", "Gone", "LengthRequired", "PreconditionFailed", "RequestEntityTooLarge", "RequestUriTooLong", "UnsupportedMediaType", "RequestedRangeNotSatisfiable", "ExpectationFailed", "UpgradeRequired", "InternalServerError", "NotImplemented", "BadGateway", "ServiceUnavailable", "GatewayTimeout", "HttpVersionNotSupported" ] } }, "400": { "description": "Validation error:\r\n Fee Hierarchy Method Type is required.\r\n -- OR --\r\n Fee Schedule type detected. Please use payout rate.\r\n -- OR --\r\n Cannot Assign Custodian to Account or Registration levels." } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Hierarchy/CustodianCount": { "get": { "tags": [ "Billing/Hierarchy" ], "summary": "Get counts of custodians given a specific fee hierarchy level/id", "description": "Sample Response:\r\n[\r\n{\r\n \"entityEnum\": \"Global\",\r\n \"entityId\": 0,\r\n \"custodianId\": null,\r\n \"detailCount\": 3,\r\n \"type\": \"FeeHierarchy\"\r\n}\r\n]", "operationId": "FeeHierarchy_GetCustodianDetailCount", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "query", "description": "The entity type.", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "query", "description": "The ID of the entity.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "A list of records grouped by custodian and entity.", "schema": { "items": { "type": "object" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Hierarchy/Default": { "get": { "tags": [ "Billing/Hierarchy" ], "summary": "Get a fee hierarchy record with default values, for use in creating a new record. Does not add the new record.", "operationId": "FeeHierarchy_GetDefaultHierarchy", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "query", "description": "The entity of the new record.", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "query", "description": "The entity ID of the new record.", "required": true, "type": "integer", "format": "int32" }, { "name": "custodianId", "in": "query", "description": "Optional. The custodian ID of the new record.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "A detailed fee hierarchy record containing default values.", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FeeHierarchyVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Hierarchy/Delete": { "put": { "tags": [ "Billing/Hierarchy" ], "summary": "Delete a list of fee hierarchy records by ID.", "operationId": "FeeHierarchy_DeleteHierarchyByIdAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "itemsToDelete", "in": "body", "description": "List of fee hierarchy record IDs.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "description": "CancellationToken object", "required": true } ], "responses": { "200": { "description": "Update successful.", "schema": { "type": "string", "enum": [ "Continue", "SwitchingProtocols", "OK", "Created", "Accepted", "NonAuthoritativeInformation", "NoContent", "ResetContent", "PartialContent", "MultipleChoices", "Ambiguous", "MovedPermanently", "Moved", "Found", "Redirect", "SeeOther", "RedirectMethod", "NotModified", "UseProxy", "Unused", "TemporaryRedirect", "RedirectKeepVerb", "BadRequest", "Unauthorized", "PaymentRequired", "Forbidden", "NotFound", "MethodNotAllowed", "NotAcceptable", "ProxyAuthenticationRequired", "RequestTimeout", "Conflict", "Gone", "LengthRequired", "PreconditionFailed", "RequestEntityTooLarge", "RequestUriTooLong", "UnsupportedMediaType", "RequestedRangeNotSatisfiable", "ExpectationFailed", "UpgradeRequired", "InternalServerError", "NotImplemented", "BadGateway", "ServiceUnavailable", "GatewayTimeout", "HttpVersionNotSupported" ] } }, "400": { "description": "Validation error:\r\n There are no fee hierarchy items to delete." } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Hierarchy/Entity/Search": { "get": { "tags": [ "Billing/Hierarchy" ], "summary": "Searches fee hierarchy records by entity name.", "operationId": "FeeHierarchy_GetEntitySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "The entity name to search for.", "required": true, "type": "string" } ], "responses": { "200": { "description": "A list of simple entities, consisting of the ID and name.", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Hierarchy/Entity/Search/{search}": { "get": { "tags": [ "Billing/Hierarchy" ], "summary": "Searches fee hierarchy records by entity name.", "operationId": "FeeHierarchy_GetV1BillingHierarchyEntitySearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "The entity name to search for.", "required": true, "type": "string" } ], "responses": { "200": { "description": "A list of simple entities, consisting of the ID and name.", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Hierarchy/Estimate": { "get": { "tags": [ "Billing/Hierarchy" ], "summary": "Get estimate of what the fee hierarchy would be given the specified paramter values.", "operationId": "FeeHierarchy_GetFeHiEstimate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "query", "description": "Optional. Client ID to get estimate for. Takes top priority.", "required": false, "type": "integer", "format": "int32" }, { "name": "regId", "in": "query", "description": "Optional. Registration ID to get estimate for. Takes second priority.", "required": false, "type": "integer", "format": "int32" }, { "name": "repId", "in": "query", "description": "Optional. Representative ID to get estimate for. Takes third priority.", "required": false, "type": "integer", "format": "int32" }, { "name": "modelId", "in": "query", "description": "Optional. Model ID override to use, if exists.", "required": false, "type": "integer", "format": "int32" }, { "name": "modelAggId", "in": "query", "description": "Optional. Model aggregate ID override to use, if exists.", "required": false, "type": "integer", "format": "int32" }, { "name": "subId", "in": "query", "description": "Optional. Sub-advisor ID override to use, if exists.", "required": false, "type": "integer", "format": "int32" }, { "name": "custodianId", "in": "query", "description": "Optional. Custodian ID override to use, if exists.", "required": false, "type": "integer", "format": "int32" }, { "name": "planId", "in": "query", "description": "Optional. Plan ID override to use, if exists.", "required": false, "type": "integer", "format": "int32" }, { "name": "managementStyleId", "in": "query", "description": "Optional. Management style ID override to use, if exists.", "required": false, "type": "integer", "format": "int32" }, { "name": "astroEnabled", "in": "query", "description": "Optional. Whether Astro enabled records are included.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "List of fee hierarchy estimates.", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.FeeHierarchyEstimate" }, "xml": { "name": "FeeHierarchyEstimate", "wrapped": true }, "type": "array" } }, "400": { "description": "Exception thrown when none of ClientId, RegId or RepId parameters are specified." } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Hierarchy/MidLevel": { "get": { "tags": [ "Billing/Hierarchy" ], "summary": "Get more details for the fee hierarchy level of the entity", "operationId": "FeeHierarchy_GetMidView", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "query", "description": "Entity, the level (Global, Rep, Account, etc)", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] } ], "responses": { "200": { "description": "List of detailed fee hierarchy records", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FeeHierarchyVerboseDto" }, "xml": { "name": "FeeHierarchyVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Hierarchy/PayoutRate/Search": { "get": { "tags": [ "Billing/Hierarchy" ], "summary": "Searches fee hierarchy records by payout rate.", "operationId": "FeeHierarchy_GetPayoutRateSearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "The payout rate to search for.", "required": true, "type": "string" } ], "responses": { "200": { "description": "A list of simple entities, consisting of the ID and name.", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Hierarchy/PayoutRate/Search/{search}": { "get": { "tags": [ "Billing/Hierarchy" ], "summary": "Searches fee hierarchy records by payout rate.", "operationId": "FeeHierarchy_GetV1BillingHierarchyPayoutRateSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "The payout rate to search for.", "required": true, "type": "string" } ], "responses": { "200": { "description": "A list of simple entities, consisting of the ID and name.", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Hierarchy/Search": { "get": { "tags": [ "Billing/Hierarchy" ], "summary": "Search for fee hierarchy records by Entity", "operationId": "FeeHierarchy_GetFeHiByKeyword", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "Search pattern to look for.", "required": true, "type": "string" }, { "name": "entity", "in": "query", "description": "Optional. Entity type to search for. Looks for all if not provided.", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] } ], "responses": { "200": { "description": "List of detailed fee hierarchy records", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FeeHierarchyVerboseDto" }, "xml": { "name": "FeeHierarchyVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Hierarchy/TopLevel": { "get": { "tags": [ "Billing/Hierarchy" ], "summary": "Get a top level view of fee hierarchy records for all entities.", "operationId": "FeeHierarchy_GetUpperView", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "List of fee hierarchy summaries", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FeeHierarchyTopLevelDto" }, "xml": { "name": "FeeHierarchyTopLevelDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Hierarchy/Verbose": { "get": { "tags": [ "Billing/Hierarchy" ], "summary": "Gets the verbose fee hierarchy record for the specified entity and entity ID", "operationId": "FeeHierarchy_GetVerboseHierarchy", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "query", "description": "Entity, the level (Global, Rep, Account, etc)", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "query", "description": "The ID of the rep/account/etc.", "required": true, "type": "integer", "format": "int32" }, { "name": "custodianId", "in": "query", "description": "Optional. Custodian ID", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "A detailed fee hierarchy record", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FeeHierarchyVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/HouseholdSummary/{key}": { "get": { "tags": [ "Billing/HouseholdSummary" ], "summary": "Get household billing summary.", "operationId": "Billing_HouseholdSummary", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired returned object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillHouseholdSummaryDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/IndirectScript": { "post": { "tags": [ "Billing/IndirectScript" ], "summary": "Legacy Post Payments page removed (OC-33680). Use POST /Billing/Run/IndirectManagementFeeAdjScript from the Billing app instead.", "operationId": "Billing_RunIndirectScript", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": true, "type": "string" }, { "name": "endDate", "in": "query", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.IndirectScriptDto" }, "xml": { "name": "IndirectScriptDto", "wrapped": true }, "type": "array" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Instances": { "get": { "tags": [ "Billing/Instances" ], "summary": "Get a list of bill instances that the logged in user has access to see.\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "BillingInstance_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillInstanceDto" }, "xml": { "name": "BillInstanceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Instances/{id}/Action/BillDataFiles": { "post": { "tags": [ "Billing/Instances" ], "operationId": "BillingInstance_ActionCreateBillDataFilesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "token", "in": "header", "required": true }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Instances/{id}/Action/Complete": { "post": { "tags": [ "Billing/Instances" ], "operationId": "BillingInstance_ForceCompleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "token", "in": "header", "required": true }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Instances/{id}/Action/Invalidate": { "post": { "tags": [ "Billing/Instances" ], "operationId": "BillingInstance_InvalidateAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "validate", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Instances/{id}/Action/ResetFeeFile": { "post": { "tags": [ "Billing/Instances" ], "summary": "This operation will provide entity payout payments.\r\nIt takes one parameter id (bill instance id) (required)", "description": "Sample Request\r\n\tPOST /Billing/Instances/13/Action/ResetFeeFile", "operationId": "BillingInstance_ResetFeeFileAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "id", "in": "path", "description": "Requires. Bill Instance Id", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Instances/{key}": { "get": { "tags": [ "Billing/Instances" ], "summary": "Gets the bill instance that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "BillingInstance_GetEntityByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillInstanceDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Billing/Instances" ], "summary": "Update bill instance provided in the key.", "operationId": "BillingInstance_UpdateAync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "token", "in": "header", "required": true }, { "name": "key", "in": "path", "description": "Key of the desired return objects.", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "description": "Dto of the desired return objects.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillInstanceDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillInstanceDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Instances/{key}/Action/Generate": { "put": { "tags": [ "Billing/Instances" ], "operationId": "BillingInstance_ActionGenerateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "token", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "lockDown", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Instances/{key}/Action/Generate/Automate": { "put": { "tags": [ "Billing/Instances" ], "operationId": "BillingInstance_ActionGenerateAutomateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "lockDown", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "token", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Instances/{key}/Action/Generate/Cancel": { "put": { "tags": [ "Billing/Instances" ], "summary": "Cancel a running Bill Generation Job", "operationId": "BillingInstance_ActionCancelGenerateAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Instances/{key}/BillingEngine/Status": { "get": { "tags": [ "Billing/Instances" ], "summary": "Get Step Functions execution status for a bill instance started via the new billing engine.", "operationId": "BillingInstance_GetBillingEngineStatusAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "token", "in": "header", "description": "Cancellation token", "required": true }, { "name": "key", "in": "path", "description": "Bill instance Id", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillingEngineStatusDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Instances/{key}/RecalcPayees": { "put": { "tags": [ "Billing/Instances" ], "operationId": "BillingInstance_RecalcPayeesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "token", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "billInstanceClientIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Instances/{key}/Simple": { "get": { "tags": [ "Billing/Instances" ], "summary": "Gets the simple bill instances that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "BillingInstance_GetSimpleByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Instances/ABCompare/{instanceId}": { "get": { "tags": [ "Billing/Instances" ], "summary": "Returns a zip file containting the compare results from the AB Compare Regression Job", "operationId": "BillingInstance_DownloadABBillCompareAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "instanceId", "in": "path", "description": "Required. First Instance being compared (Instance A)", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Instances/Action/CompareBills": { "post": { "tags": [ "Billing/Instances" ], "summary": "", "operationId": "BillingInstance_CompareBillsAsync", "consumes": [], "produces": [], "parameters": [ { "name": "billIdOne", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "billIdTwo", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Instances/Action/Delete": { "put": { "tags": [ "Billing/Instances" ], "operationId": "BillingInstance_ActionDeleteAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "token", "in": "header", "required": true }, { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "bypassDeleteJobCheck", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Instances/Action/FeeFiles": { "post": { "tags": [ "Billing/Instances" ], "summary": "Creates fee files as db blobs based on bill instance ids and, optionally, a custodian ID.", "operationId": "BillingInstance_ActionCreateFeeFilesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "token", "in": "header", "required": true }, { "name": "ids", "in": "body", "description": "Bill Instance Id's for which to generate fee files", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "custodianId", "in": "query", "description": "Nullable/Optional Custodian ID", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Instances/Action/FeeFiles/Create": { "post": { "tags": [ "Billing/Instances" ], "summary": "Creates fee files for bill instances in Complete status or completed bill instances within a date range, with optional custodian and fund-family scope.", "operationId": "BillingInstance_ActionCreateBillFeeFilesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "token", "in": "header", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.CreateBillFeeFilesDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Instances/Action/FeeFiles/DateRange": { "post": { "tags": [ "Billing/Instances" ], "summary": "Creates fee files for completed bill instances within the provided date range.", "operationId": "BillingInstance_ActionCreateFeeFilesDateRangeAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "token", "in": "header", "required": true }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Instances/CanDelete": { "get": { "tags": [ "Billing/Instances" ], "summary": "Returns whether new bill instance deletes may be started: false when any accessible instance has\r\n{OAS.DataModel.Reporting.Batch.Enums.BatchHangfireJobType.DeleteBillInstance} and its Hangfire job is still active (queued, scheduled, processing, etc.).", "operationId": "BillingInstance_CanDeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Instances/CheckExportBillInstanceIds": { "get": { "tags": [ "Billing/Instances" ], "operationId": "BillingInstance_CheckExportBillInstanceIds", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "billInstanceIds", "in": "query", "required": true, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Instances/Client/{id}/Action/Invalidate": { "post": { "tags": [ "Billing/Instances" ], "operationId": "BillingInstanceClient_Invalidate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "validate", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Instances/Client/{id}/List": { "get": { "tags": [ "Billing/Instances" ], "summary": "Get a list of billInstanceClients by a single clientId", "operationId": "BillingInstanceClient_GetByClientIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "description": "Household ID of billInstance clients requested", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillInstanceClientDto" }, "xml": { "name": "BillInstanceClientDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Instances/Client/Action/InvalidateMultiple": { "post": { "tags": [ "Billing/Instances" ], "operationId": "BillingInstanceClient_InvalidateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "Ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "validate", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Instances/EclipseExport": { "get": { "tags": [ "Billing/Instances" ], "operationId": "BillingInstance_ExportOrionBillingToFileAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "billInstanceIds", "in": "query", "required": true, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "isForecast", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Instances/GenerateCashFunding": { "post": { "tags": [ "Billing/Instances" ], "operationId": "BillingInstance_GenerateCashFundingAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "billInstanceIds", "in": "query", "required": true, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "isForecast", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Instances/List": { "post": { "tags": [ "Billing/Instances" ], "summary": "Gets a list of bill assets that match one of the keys in the provided list.", "operationId": "BillingInstance_GetListById", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillInstanceDto" }, "xml": { "name": "BillInstanceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Instances/List/Id": { "post": { "tags": [ "Billing/Instances" ], "summary": "Gets a list of bill assets that match one of the keys in the provided list.", "operationId": "BillingInstance_PostV1BillingInstancesListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillInstanceDto" }, "xml": { "name": "BillInstanceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Instances/New": { "post": { "tags": [ "Billing/Instances" ], "summary": "Gets the bill instance that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "BillingInstance_CreateInstance", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "Key of the desired return object.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillInstanceDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillInstanceDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Instances/Search": { "get": { "tags": [ "Billing/Instances" ], "operationId": "BillingInstance_GetSearchAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "isMock", "in": "query", "required": false, "type": "boolean" }, { "name": "top", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Instances/Search/{search}": { "get": { "tags": [ "Billing/Instances" ], "operationId": "BillingInstance_GetV1BillingInstancesSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "search", "in": "path", "required": true, "type": "string" }, { "name": "isMock", "in": "query", "required": false, "type": "boolean" }, { "name": "top", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Instances/Simple": { "get": { "tags": [ "Billing/Instances" ], "summary": "Gets a simple list of bill instances that the logged in user has access to.\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "BillingInstance_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "hasValidBills", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Instances/Simple/List": { "post": { "tags": [ "Billing/Instances" ], "summary": "Gets a simple list of bill instances that match one of the keys in the provided list.", "operationId": "BillingInstance_GetSimpleListById", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Instances/Simple/List/Id": { "post": { "tags": [ "Billing/Instances" ], "summary": "Gets a simple list of bill instances that match one of the keys in the provided list.", "operationId": "BillingInstance_PostV1BillingInstancesSimpleListId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Invoices": { "get": { "tags": [ "Billing/Invoices" ], "summary": "Get a list of invoices that the logged in user has access to see.\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "Invoices_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "description": "Optional. If provided only invoices with a start date greater or equal to value provided will be returned.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. If provided only invoices with an end date less than or equal to value provided will be returned.", "required": false, "type": "string", "format": "date-time" }, { "name": "billInstanceId", "in": "query", "description": "Optional. Only invoices assiciated with the billInstanceId provided will be returned.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.InvoiceDto" }, "xml": { "name": "InvoiceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Invoices/{key}": { "get": { "tags": [ "Billing/Invoices" ], "summary": "Gets the invoices that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Invoices_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.InvoiceDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Invoices/Simple": { "get": { "tags": [ "Billing/Invoices" ], "summary": "Get a simple list of invoices that the logged in user has access to see.", "operationId": "Invoices_GetV1BillingInvoicesSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "query", "description": "Optional. If provided the result will be limit to include only invoices for the client specified.", "required": false, "type": "integer", "format": "int32" }, { "name": "excludeMockBills", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.SimpleInvoiceDto" }, "xml": { "name": "SimpleInvoiceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/ManagementFeesNotPosted": { "get": { "tags": [ "Billing/ManagementFeesNotPosted" ], "summary": "Get 'management fee' transactions.", "operationId": "Billing_GetManagementFeeNotPosted", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.ManagementFeesNotPostedDto" }, "xml": { "name": "ManagementFeesNotPostedDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/MasterPayoutSchedule": { "get": { "tags": [ "Billing/MasterPayoutSchedule" ], "summary": "Get all master payout schedules with filter option by Id or Name\r\nThe return is limited to pages of 1000. Use $top and $skip in the query string to page through the data.", "operationId": "MasterPayoutSchedules_GetAllAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "filter", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.MasterPayoutScheduleDto" }, "xml": { "name": "MasterPayoutScheduleDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Billing/MasterPayoutSchedule" ], "summary": "Modify multiple master payout schedules", "operationId": "MasterPayoutSchedules_UpdateEntitiesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updatedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.MasterPayoutScheduleFullDto" }, "xml": { "name": "MasterPayoutScheduleFullDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.MasterPayoutScheduleFullDto" }, "xml": { "name": "MasterPayoutScheduleFullDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Billing/MasterPayoutSchedule" ], "summary": "Create master payout schedule", "operationId": "MasterPayoutSchedules_CreateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.MasterPayoutScheduleFullDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.MasterPayoutScheduleFullDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/MasterPayoutSchedule/{key}": { "get": { "tags": [ "Billing/MasterPayoutSchedule" ], "summary": "Get master payout schedule by key", "operationId": "MasterPayoutSchedules_GetEntityByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.MasterPayoutScheduleFullDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Billing/MasterPayoutSchedule" ], "summary": "Modify master payout schedule", "operationId": "MasterPayoutSchedules_UpdateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.MasterPayoutScheduleFullDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.MasterPayoutScheduleFullDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/MasterPayoutSchedule/BillEntities/ByAccount/{key}": { "get": { "tags": [ "Billing/MasterPayoutSchedule" ], "summary": "Get master payout schedule by key", "operationId": "MasterPayoutSchedules_getEntityList", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/MasterPayoutSchedule/BillEntities/ByClient/{key}": { "get": { "tags": [ "Billing/MasterPayoutSchedule" ], "summary": "Get master payout schedule by key", "operationId": "MasterPayoutSchedules_getEntityListbyClient", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/MasterPayoutSchedule/Delete": { "post": { "tags": [ "Billing/MasterPayoutSchedule" ], "operationId": "MasterPayoutSchedules_DeleteItemAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/MasterPayoutSchedule/MasterPayoutScheduleDetailHistory": { "get": { "tags": [ "Billing/MasterPayoutSchedule" ], "summary": "Get a list of MasterBillScheduleDetail History", "operationId": "MasterPayoutSchedules_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "scheduleId", "in": "query", "description": "Required. Default: null, returns nothing.", "required": false, "type": "integer", "format": "int32" }, { "name": "scheduleDetailId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.MasterPayoutScheduleDetailHistoryDto" }, "xml": { "name": "MasterPayoutScheduleDetailHistoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/MasterPayoutSchedule/MasterPayoutScheduleHistory": { "get": { "tags": [ "Billing/MasterPayoutSchedule" ], "summary": "Get master payout schedule history by key", "operationId": "MasterPayoutSchedules_GetMasterPayoutScheduleHistoryByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "scheduleId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.MasterPayoutScheduleHistoryDto" }, "xml": { "name": "MasterPayoutScheduleHistoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/MasterPayoutSchedule/MasterPayoutSchedulesForAcctBD/{accountId}": { "get": { "tags": [ "Billing/MasterPayoutSchedule" ], "summary": "Returns Master Payout schedules limited to given accounts associated broker dealers payout schedules\r\nSample Request\r\n GET /Billing/MasterPayoutSchedule/MasterPayoutSchedulesForAcctBD/123\r\nSample Response\r\n[\r\n {\r\n \"id\": 123,\r\n \"name\": test\"\r\n }\r\n]", "operationId": "MasterPayoutSchedules_MasterPayoutSchedulesForAcctBDAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "description": "Account ID to filter schedules for", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "description": "CancellationToken", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.SimpleMasterPayoutScheduleDto" }, "xml": { "name": "SimpleMasterPayoutScheduleDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/MasterPayoutSchedule/Simple": { "get": { "tags": [ "Billing/MasterPayoutSchedule" ], "summary": "Get simple entities for master payout schedules\r\nThe return is limited to pages of 1000. Use $top and $skip in the query string to page through the data.", "operationId": "MasterPayoutSchedules_GetSimpleMasterPayoutSchedules", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.SimpleMasterPayoutScheduleDto" }, "xml": { "name": "SimpleMasterPayoutScheduleDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PayablesByRep": { "post": { "tags": [ "Billing/PayablesByRep" ], "summary": "Generate payable data by reps", "operationId": "Billing_GeneratePayablesByRepAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "postData", "in": "body", "description": "Filter data for the reports to generate", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PostAuditDataDto" } }, { "name": "token", "in": "header", "required": true } ], "responses": { "200": { "description": "A list of report blob IDs for the generated reports", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, "400": { "description": "Validation error:\r\n You cannot generate audit files on mock and regular instances at the same time." } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PayablesSummary": { "get": { "tags": [ "Billing/PayablesSummary" ], "summary": "Get a summary list of payables.\r\nThe return allows paging. Use $top and $skip in the query string to page through the data.", "operationId": "BillingPayables_GetPayablesSummary", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "periodStart", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "periodEnd", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PayableSummaryDto" }, "xml": { "name": "PayableSummaryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Payees": { "get": { "tags": [ "Billing/Payees" ], "summary": "Get list of payees in DB", "operationId": "Payees_GetPayeeList", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isActive", "in": "query", "required": false, "type": "boolean" }, { "name": "isCreate", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.SimplePayeeDto" }, "xml": { "name": "SimplePayeeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Billing/Payees" ], "operationId": "Payees_CreateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PayeeDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Payees/{key}": { "get": { "tags": [ "Billing/Payees" ], "operationId": "Payees_GetEntityByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PayeeDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Billing/Payees" ], "operationId": "Payees_UpdateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PayeeDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PayeeDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Billing/Payees" ], "operationId": "Payees_DeletePayeeAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Payees/{key}/Documents": { "get": { "tags": [ "Billing/Payees" ], "operationId": "Payees_GetBlobs", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "fileType", "in": "query", "required": false, "items": { "type": "string", "enum": [ "CrmDocuments", "Payable" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" }, "xml": { "name": "BlobBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Payees/{key}/Documents/{fileId}": { "get": { "tags": [ "Billing/Payees" ], "summary": "Gets a file for the payee with the specified key and the file with the specified key.", "operationId": "Payees_GetBlobDto", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "description": "Key of the file to be returned.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Payees/{key}/Documents/{fileId}/Download": { "get": { "tags": [ "Billing/Payees" ], "summary": "Gets the raw data of the specific file with the blobId provided which is associated to the payee with the specified key.", "operationId": "Payees_GetBlobFile", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "description": "Key of the file to be downloaded.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Payees/{key}/SSNTaxId": { "put": { "tags": [ "Billing/Payees" ], "operationId": "Payees_UpdateSSNTaxId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updateInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.UpdateSsnDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Payees/List": { "get": { "tags": [ "Billing/Payees" ], "summary": "Get list of payees in DB", "operationId": "Payees_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isActive", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PayeeDto" }, "xml": { "name": "PayeeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Payees/Search": { "get": { "tags": [ "Billing/Payees" ], "operationId": "Payees_GetSearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "top", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Payees/Search/{search}": { "get": { "tags": [ "Billing/Payees" ], "operationId": "Payees_GetV1BillingPayeesSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "required": true, "type": "string" }, { "name": "top", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Payees/Simple": { "get": { "tags": [ "Billing/Payees" ], "operationId": "Payees_GetSimpleAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isActive", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PayMethods": { "get": { "tags": [ "Billing/PayMethods" ], "operationId": "Billing_GetBillPayMethods", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.SimplePayMethodDto" }, "xml": { "name": "SimplePayMethodDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PayoutDashboard": { "get": { "tags": [ "Billing/PayoutDashboard" ], "summary": "Get the list of accounts for the appropriate values\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "PayoutDashboard_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "top", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "status", "in": "query", "required": false, "type": "string", "enum": [ "PendingApproval", "CurrentlyApproved", "CreditAndExpenses", "OutsideAccounts", "Paid" ] }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "payee", "in": "query", "required": false, "type": "string" }, { "name": "id", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PayoutDashboardDto" }, "xml": { "name": "PayoutDashboardDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PayoutDashboard/Action/Delete": { "put": { "tags": [ "Billing/PayoutDashboard" ], "operationId": "PayoutDashboard_ActionDeleteAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PayoutDashboard/CreateExpense": { "post": { "tags": [ "Billing/PayoutDashboard" ], "summary": "Creates a new expense", "operationId": "PayoutDashboard_CreateNewExpenseAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "payment", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PayoutDashboardDto" } }, { "name": "token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PayoutDashboardDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PayoutDashboard/Payment/{paymentId}/Action/Report": { "get": { "tags": [ "Billing/PayoutDashboard" ], "operationId": "PayoutDashboardPayment_GetExcelPayeeReport", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "paymentId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PayoutDashboard/Payment/DeletePayables": { "post": { "tags": [ "Billing/PayoutDashboard" ], "summary": "Unflushes Payables", "operationId": "PayoutDashboardPayment_DeletePayablesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "paymentId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillPayoutDashboardPaymentDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PayoutDashboard/Payment/Expenses": { "post": { "tags": [ "Billing/PayoutDashboard" ], "summary": "Creates a new payout adjustment, which updates payables", "operationId": "PayoutDashboardPayment_CreateNewExpensesAndCreditsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "payment", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillPayoutDashboardPaymentDto" } }, { "name": "token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillPayoutDashboardPaymentDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PayoutDashboard/Payment/GenerateReport": { "post": { "tags": [ "Billing/PayoutDashboard" ], "summary": "Takes list of Payout Dashboard Ids and generates a report for them.", "operationId": "PayoutDashboardPayment_GenerateRepReportAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "payoutDashboardIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PayoutDashboard/Payment/GetHangFireProgressById": { "get": { "tags": [ "Billing/PayoutDashboard" ], "operationId": "PayoutDashboardPayment_GetHangFireProgressById", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "jobId", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Hangfire.Console.Monitoring.LineDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PayoutDashboard/Payment/List": { "get": { "tags": [ "Billing/PayoutDashboard" ], "summary": "Returns a list of Payments for a given date range", "description": "Get /Billing/PayoutDashboard/Payment/List?endDate=04/09/2024&startDate=04/01/2024\r\nSample Results:\r\n[\r\n {\r\n \"id\": 123,\r\n \"payeeId\": 345,\r\n \"payee\": \"Name\",\r\n \"asOfDate\": \"2024-04-09\",\r\n \"paymentAmount\": 123.45\r\n \"adjustmentAmount\": 0.0000,\r\n \"uncollectedAmount\": null,\r\n \"totalPaymentAmount\": 123.45\r\n \"createdDate\": \"2024-04-09\",\r\n \"createdBy\": \"name@email.com\",\r\n \"editedDate\": \"2024-04-09\",\r\n \"editedBy\": \"name@email.com\",\r\n \"note\": null,\r\n \"toPay\": false,\r\n \"blobId\": null,\r\n \"hangFireId\": null\r\n }\r\n]", "operationId": "PayoutDashboardPayment_GetPaymentList", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "description": "Optional. Start Date to search payments.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. End Date to search payments.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillPayoutDashboardPaymentDto" }, "xml": { "name": "BillPayoutDashboardPaymentDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PayoutDashboard/Payment/MultiplePayments": { "post": { "tags": [ "Billing/PayoutDashboard" ], "summary": "Used to Create payments. If item is to be paid, set ToPay = true\r\nItems are queued to be processed, will return records that will be processed.", "description": "Post /Billing/PayoutDashboard/Payment/MultiplePayments?endDate=04/09/2024&startDate=04/01/2024\r\nSample Body \r\n[\r\n {\r\n \"adjustmentAmount\": 0,\r\n \"asOfDate\": \"2024-04-09T09:00:27.03218-05:00\",\r\n \"payee\": \"RIA\",\r\n \"payeeId\": 7,\r\n \"paymentAmount\": -123.45,\r\n \"toPay\": true,\r\n \"totalPaymentAmount\": -123.45,\r\n \"uncollectedAmount\": 14535.88\r\n }\r\n]\r\nSample Response\r\n[\r\n {\r\n \"adjustmentAmount\": 0.0,\r\n \"asOfDate\": \"2024-04-09\",\r\n \"blobId\": null,\r\n \"createdBy\": null,\r\n \"createdDate\": \"0001-01-01\",\r\n \"editedBy\": null,\r\n \"editedDate\": \"0001-01-01\",\r\n \"hangFireId\": null,\r\n \"id\": 0,\r\n \"note\": null,\r\n \"payee\": \"RIA\",\r\n \"payeeId\": 123,\r\n \"paymentAmount\": -123.45,\r\n \"toPay\": true,\r\n \"totalPaymentAmount\": -456.78,\r\n \"uncollectedAmount\": 456.45\r\n }\r\n]", "operationId": "PayoutDashboardPayment_CreateNewPaymentsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "payments", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillPayoutDashboardPaymentDto" }, "xml": { "name": "BillPayoutDashboardPaymentDto", "wrapped": true }, "type": "array" } }, { "name": "token", "in": "header", "required": true }, { "name": "startDate", "in": "query", "description": "Optional. Start date of Payment Range", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. End date of Payment Range", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillPayoutDashboardPaymentDto" }, "xml": { "name": "BillPayoutDashboardPaymentDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PayoutDashboard/Payment/New": { "get": { "tags": [ "Billing/PayoutDashboard" ], "summary": "This operation will provide entity payout payments.\r\nIt takes two parameters startDate (not required), endDate (not required)", "description": "Sample Request\r\n\tGET /Billing/PayoutDashboard/Payment/Consolidation/New?startDate=NULL&endDate=03/13/2024", "operationId": "PayoutDashboardPayment_GetNewPaymentsListAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "token", "in": "header", "required": true }, { "name": "startDate", "in": "query", "description": "Optional. Start Date to search payments.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. End Date to search payments.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillPayoutDashboardPaymentListDto" }, "xml": { "name": "BillPayoutDashboardPaymentListDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Billing/PayoutDashboard" ], "summary": "Used to Create payments. If item is to be paid, set ToPay = true\r\nItems are queued to be processed, will return records that will be processed.", "description": "Post /Billing/PayoutDashboard/Payment/New?endDate=04/09/2024&startDate=04/01/2024\r\nSample Body \r\n[\r\n {\r\n \"description\": \"payee name description\",\r\n \"id\": 1,\r\n \"isPayableEntity\": true,\r\n \"name\": \"payee\"\r\n }\r\n]\r\nSample Response\r\n[\r\n {\r\n \"adjustmentAmount\": 0.0,\r\n \"asOfDate\": \"2024-04-09\",\r\n \"blobId\": null,\r\n \"createdBy\": null,\r\n \"createdDate\": \"0001-01-01\",\r\n \"editedBy\": null,\r\n \"editedDate\": \"0001-01-01\",\r\n \"hangFireId\": null,\r\n \"id\": 0,\r\n \"note\": null,\r\n \"payee\": \"payee\",\r\n \"payeeId\": 1,\r\n \"paymentAmount\": 0.0,\r\n \"toPay\": true,\r\n \"totalPaymentAmount\": 0.0,\r\n \"uncollectedAmount\": -123.45\r\n }\r\n]", "operationId": "PayoutDashboardPayment_GetNewPaymentsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "payees", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } }, { "name": "startDate", "in": "query", "description": "Optional. Start date of Payment Range", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. End date of Payment Range", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillPayoutDashboardPaymentDto" }, "xml": { "name": "BillPayoutDashboardPaymentDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PayoutDashboard/Payment/PaymentProcessing": { "get": { "tags": [ "Billing/PayoutDashboard" ], "operationId": "PayoutDashboardPayment_PaymentProcessing", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PayoutDashboard/Reports/{key}": { "get": { "tags": [ "Billing/PayoutDashboard" ], "summary": "Returns Report Data. Requires Admin/Advisor with permissions.", "operationId": "PayoutDashboardReport_GetBlobAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Billing/PayoutDashboard" ], "summary": "This endpoint is no longer valid and will be removed 7/11/2024. Use endpoint is /Billing/PayoutDashboard/Payment/DeletePayables.", "operationId": "PayoutDashboardReport_DeleteBlobAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PayoutDashboard/Reports/Action/Delete": { "put": { "tags": [ "Billing/PayoutDashboard" ], "summary": "Used to delete Advisory Fee Reports", "operationId": "PayoutDashboardReport_DeleteBlobsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PayoutDashboard/Reports/Action/ManualReportUpload": { "post": { "tags": [ "Billing/PayoutDashboard" ], "summary": "Manually uploads an advisory fee report. Requires Admin.", "operationId": "PayoutDashboardReport_ManualReportUploadAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "ManualReportFileUploadDto", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.ManualReportFileUploadDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.FileImportDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PayoutDashboard/Reports/CreatePaymentReports": { "post": { "tags": [ "Billing/PayoutDashboard" ], "summary": "Generates a Payment Report. Requires Admin/Advisor with edit.", "operationId": "PayoutDashboardReport_CreatePendingPaymentReportsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "billEntityId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "entityId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "runForAll", "in": "query", "required": true, "type": "boolean" }, { "name": "startDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "isPaidStatus", "in": "query", "required": true, "type": "boolean" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PayoutDashboard/Reports/Download/{filename}": { "get": { "tags": [ "Billing/PayoutDashboard" ], "summary": "Used to download a previously generated report.", "operationId": "PayoutDashboardReport_RunReportAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "filename", "in": "path", "description": "The filename provided by the generate endpoint.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PayoutDashboard/Reports/List": { "get": { "tags": [ "Billing/PayoutDashboard" ], "operationId": "PayoutDashboardReport_GetPayoutDashboardReports", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "entity", "in": "query", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "showBDRepReport", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.AdvisoryFeeReportBlobDto" }, "xml": { "name": "AdvisoryFeeReportBlobDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PayoutDashboard/RepPayees": { "get": { "tags": [ "Billing/PayoutDashboard" ], "operationId": "PayoutDashboard_GetRepPayees", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PayoutDashboard/Summary/ActivityChart": { "get": { "tags": [ "Billing/PayoutDashboard" ], "operationId": "PayoutDashboard_GetSummaryChart", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "payee", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PayoutDashboardActivityChartDto" }, "xml": { "name": "PayoutDashboardActivityChartDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PayoutDashboard/Summary/Header": { "get": { "tags": [ "Billing/PayoutDashboard" ], "operationId": "PayoutDashboard_GetSummaryHeader", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "payee", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "additionalProperties": { "type": "number", "format": "double" }, "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Payouts/Summary/Header": { "get": { "tags": [ "Billing/Payouts" ], "summary": "Gets a sum of all payouts for the given timeframe for each billing status.", "description": "Sample Request\r\n GET /Billing/Payouts/Summary/Header?startDate=04/01/2024&endDate=04/30/2024&payeeId=1", "operationId": "Payouts_GetSummaryHeaderAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "description": "Optional. Start date for the search. Filters on the calculated (or paid for paid status) date.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. End date for the search. Filters on the calculated (or paid for paid status) date.", "required": false, "type": "string", "format": "date-time" }, { "name": "payeeId", "in": "query", "description": "Optional. The ID of the payee. Must be an exact match.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "additionalProperties": { "type": "number", "format": "double" }, "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PersonalizedPortfolio/UpdateRegistration": { "post": { "tags": [ "Billing/PersonalizedPortfolio" ], "summary": "Allows updating fee and payout schedule for all accounts in a registration", "operationId": "PersonalizedPortfolio_UpdateRegistrations", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "registrationId", "in": "query", "description": "the registration that will be updated, required", "required": true, "type": "integer", "format": "int32" }, { "name": "payoutId", "in": "query", "description": "new payout id for accounts", "required": true, "type": "integer", "format": "int32" }, { "name": "feeScheduleId", "in": "query", "description": "new fee schedule id for accounts", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "description": "when changes take effect", "required": true, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "when changes roll back to original: not required", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PostAuditFiles": { "post": { "tags": [ "Billing/PostAuditFiles" ], "summary": "Generate data queries for billing", "operationId": "Billing_GenerateBillingAuditFilesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "postData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PostAuditDataDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PostedPayments": { "get": { "tags": [ "Billing/PostedPayments" ], "summary": "Get a list of posted payments.\r\nNote: At least one filter is required.", "operationId": "PostedPayments_GetPostedPayments", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "paymentDate", "in": "query", "description": "Optional. Date the payment occurred.", "required": false, "type": "string", "format": "date-time" }, { "name": "accountId", "in": "query", "description": "Optional. Account ID", "required": false, "type": "integer", "format": "int32" }, { "name": "clientId", "in": "query", "description": "Optional. Client/Household ID", "required": false, "type": "integer", "format": "int32" }, { "name": "batchNumber", "in": "query", "description": "Optional. Batch number used when payments were created.", "required": false, "type": "string" } ], "responses": { "200": { "description": "A list of bill account item adjustments. Returns only items with bill payment IDs.", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PostedPaymentDto" }, "xml": { "name": "PostedPaymentDto", "wrapped": true }, "type": "array" } }, "400": { "description": "Validation error:\r\n Please provide a filter to view posted payments" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PostedPayments/{billPaymentId}/Action/Undo": { "put": { "tags": [ "Billing/PostedPayments" ], "summary": "Undo posted payments", "operationId": "PostedPayments_UndoPostedPaymentsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "billPaymentId", "in": "path", "description": "ID of bill payment associated with the payments", "required": true, "type": "integer", "format": "int32" }, { "name": "ids", "in": "body", "description": "IDs of bill account item adjstments (payments) to delete", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "description": "Optional. A cancellation token", "required": true } ], "responses": { "200": { "description": "IDs of payments that were undone", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PostedPayments/Action/Delete": { "put": { "tags": [ "Billing/PostedPayments" ], "operationId": "PostedPayments_PostedPaymentsBatchDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PostedPayments/Action/Reverse": { "put": { "tags": [ "Billing/PostedPayments" ], "summary": "Reverse selected postedpayment ids", "operationId": "PostedPayments_ReversePostedPayments", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "paymentsToReverse", "in": "body", "description": "payments to reverse with amounts", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PostedPaymentDto" }, "xml": { "name": "PostedPaymentDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PostedPaymentDto" }, "xml": { "name": "PostedPaymentDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PostedPayments/Action/UndoMultiple": { "put": { "tags": [ "Billing/PostedPayments" ], "summary": "Undo posted payments for multiple bill payments in a single request.", "operationId": "PostedPayments_UndoPostedPaymentsBatchAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "payload", "in": "body", "description": "List of billPaymentIds with their corresponding adjustment ids.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.UndoPostedPaymentRequestDto" }, "xml": { "name": "UndoPostedPaymentRequestDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "description": "Optional cancellation token", "required": true } ], "responses": { "200": { "description": "IDs of payments that were undone", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PostedPayments/reports": { "get": { "tags": [ "Billing/PostedPayments" ], "summary": "Get List of posted payments: returns only items with billPaymentIds", "description": " Sample Request \r\n\tGET v1/Billing/PostedPayments/reports?startDate=01/01/2024&endDate=02/01/2024", "operationId": "PostedPayments_ConsolidationPostedPayments", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "description": "Start Date to filter from", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "End Date to filter to", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PostedPaymentReportDTO" }, "xml": { "name": "PostedPaymentReportDTO", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PostedPayments/reportsByBatch/{batchId}": { "get": { "tags": [ "Billing/PostedPayments" ], "summary": "Get List of posted payments by batch number: returns only items with billPaymentIds", "description": " Sample Request \r\n\tGET v1/Billing/PostedPayments/reports/19", "operationId": "PostedPayments_ConsolidationPostedPaymentsByBatchAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "batchId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PostedPaymentReportDTO" }, "xml": { "name": "PostedPaymentReportDTO", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PostManagementFees": { "post": { "tags": [ "Billing/PostManagementFees" ], "summary": "", "operationId": "Billing_PostPayments", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "batchNumber", "in": "query", "required": true, "type": "string" }, { "name": "billId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "managementFeeData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.ManagementFeesNotPostedDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.ManagementFeesNotPostedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PostPayments": { "get": { "tags": [ "Billing/PostPayments" ], "summary": "Get list of payments so that they can be unposted.", "operationId": "PostPayments_GetPostedPayments", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "billPayMethod", "in": "query", "description": "Optional.", "required": false, "type": "integer", "format": "int32" }, { "name": "paymentNumber", "in": "query", "description": "Optional.", "required": false, "type": "string" }, { "name": "batchNumber", "in": "query", "description": "Optional.", "required": false, "type": "string" }, { "name": "createdDate", "in": "query", "description": "Optional.", "required": false, "type": "string", "format": "date-time" }, { "name": "postedDate", "in": "query", "description": "Optional.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillPaymentDto" }, "xml": { "name": "BillPaymentDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Billing/PostPayments" ], "summary": "Generate post payments for billing", "operationId": "PostPayments_PostPaymentsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "batchNumber", "in": "query", "required": true, "type": "string" }, { "name": "paymentData", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PostPaymentsDto" }, "xml": { "name": "PostPaymentsDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true }, { "name": "isImport", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PostPaymentsDto" }, "xml": { "name": "PostPaymentsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PostPayments/accounts": { "get": { "tags": [ "Billing/PostPayments" ], "summary": "Get all bill payments for accounts", "description": "Sample Request\r\n\tGet v1/Billing/PostPayments/account?endDate=6/1/2024&fundFamilyId=-1&startDate=6/1/2024", "operationId": "PostPayments_GetBillPaymentByAccountAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "startDate", "in": "query", "description": "Start Date", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "End Date", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PostPaymentsDto" }, "xml": { "name": "PostPaymentsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PostPayments/BillInstance/{key}": { "get": { "tags": [ "Billing/PostPayments" ], "summary": "Get all bill payments by bill instance id", "description": "Sample Request\r\n\tGet v1/Billing/PostPayments/billInstance/5518", "operationId": "PostPayments_GetBillPaymentForBillInstanceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "key", "in": "path", "description": "Bill Instance Id", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PostPaymentsDto" }, "xml": { "name": "PostPaymentsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PostPayments/BillPayments": { "get": { "tags": [ "Billing/PostPayments" ], "summary": "Get list of unpaid bills.", "operationId": "PostPayments_GetBillPayments", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "clientId", "in": "query", "description": "Optional. If provided only items related to the provided client will be returned.", "required": false, "type": "integer", "format": "int32" }, { "name": "fundFamilyId", "in": "query", "description": "Optional. If provided only items related to the provided fund family will be returned.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PostPaymentsDto" }, "xml": { "name": "PostPaymentsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PostPayments/CustodianAndDate": { "get": { "tags": [ "Billing/PostPayments" ], "summary": "Get Post Payments", "description": "Sample Request\r\n\tGET v1/Billing/PostPayments/CustodianAndDate?endDate=03/31/2024&custodianId=-1&startDate=01/01/2024", "operationId": "PostPayments_GetCustodianAndDateAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "startDate", "in": "query", "description": "Start date", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "End date", "required": false, "type": "string", "format": "date-time" }, { "name": "custodianId", "in": "query", "description": "Custodian Id", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PostPaymentsDto" }, "xml": { "name": "PostPaymentsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PostPayments/FFandDate": { "get": { "tags": [ "Billing/PostPayments" ], "summary": "Get list of unpaid bills by client.", "operationId": "PostPayments_GetV1BillingPostPaymentsFFandDate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "startDate", "in": "query", "description": "Start Date", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "End Date", "required": false, "type": "string", "format": "date-time" }, { "name": "fundFamilyId", "in": "query", "description": "Fund Family Id", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PostPaymentsDto" }, "xml": { "name": "PostPaymentsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PostPayments/FFandDate/Grid": { "get": { "tags": [ "Billing/PostPayments" ], "summary": "Get list of unpaid bills by client.", "operationId": "PostPayments_GetBillPaymentForFFandDateAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "startDate", "in": "query", "description": "Start Date", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "End Date", "required": false, "type": "string", "format": "date-time" }, { "name": "fundFamilyId", "in": "query", "description": "Fund Family Id", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PostPaymentsDto" }, "xml": { "name": "PostPaymentsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PostPayments/HHAndDate": { "get": { "tags": [ "Billing/PostPayments" ], "summary": "Get list of unpaid bills by client.", "operationId": "PostPayments_GetBillPaymentForHHandDateAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "clientId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PostPaymentsDto" }, "xml": { "name": "PostPaymentsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PostPayments/ImportAndDate": { "post": { "tags": [ "Billing/PostPayments" ], "summary": "Takes an xlsx, xls, or csv file as multipart content. The file needs either an \"Account ID\" or \"Account Number\" or \"Household ID\" column\r\nThe file will be processed and returned a Post Payments data filtered by column.", "description": "Sample Request\r\n\tPOST v1/Billing/PostPayments/ImportAndDate\r\n\t{\r\n\t \"file\": binary,\r\n \"startDate\": \"2024-03-01\",\r\n \"endDate\": \"2024-06-28\",\r\n \"columnName\": \"AccountId\"\r\n }", "operationId": "PostPayments_GetBillPaymentByFileandDateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillingFileUploadDto" } }, { "name": "token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PostPaymentsByFileDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PostPayments/IsPostingPayments": { "get": { "tags": [ "Billing/PostPayments" ], "summary": "Check if there is an existing Post Payments batch in progress", "operationId": "PostPayments_IsPostingPayments", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PostPayments/PostPaymentBatch/{key}/Action/Rerun": { "put": { "tags": [ "Billing/PostPayments" ], "operationId": "PostPayments_RerunPostPaymentsBatchAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PostPayments/Status": { "get": { "tags": [ "Billing/PostPayments" ], "operationId": "PostPayments_GetBatchStatusAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PostPaymentBatchDto" }, "xml": { "name": "PostPaymentBatchDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PostPayments/Status/{batchId}": { "post": { "tags": [ "Billing/PostPayments" ], "summary": "Retries processing of a post payment batch", "description": " Sample Request \r\n\tPOST v1/Billing/PostedPayments/Status/19", "operationId": "PostPayments_RetryBatchProcess", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "description": "Cancellation token for async operations", "required": true }, { "name": "batchId", "in": "path", "description": "ID of the batch to retry processing", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PostPayments/UpdateAmountToPost/{id}": { "put": { "tags": [ "Billing/PostPayments" ], "summary": "Echo without an update. Slickgrid insists, but can we do this another way?", "operationId": "PostPayments_UpdateBillPaymentForHHandDate", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "dto", "in": "body", "required": true, "schema": { "type": "object" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/PostPayments/WriteOffBills": { "post": { "tags": [ "Billing/PostPayments" ], "summary": "Write off Bills", "description": "POST v1/Billing/PostPayments/WriteOffBills?paymentFrom=2\r\n{\r\n [\r\n { \r\n \"id\":1234 ,\r\n \"reason\":null,\r\n \"clientName\":\"ClientFirst ClientLast\",\r\n \"accountId\":12345,\r\n \"registrationName\":\"Reg Name\",\r\n \"managementStyle\":\"Self-Directed\",\r\n \"fundFamilyName\":\"Schwab\",\r\n \"custodian\":\"Schwab (TDA)\",\r\n \"accountNumber\":\"9876543\",\r\n \"billDate\":\"2021-08-16\",\r\n \"billType\":\"Renewal\",\r\n \"balanceDue\":19.99,\r\n \"amountToPost\":19.99,\r\n \"registrationCode\":\"CUST\",\r\n \"paymentDate\":\"2021-08-20T05:00:00.000Z\",\r\n \"paidByAccountNumber\":null,\r\n \"payMethod\":\"Direct\",\r\n \"billId\":123456,\r\n \"billTypeId\":1,\r\n \"receivableId\":\"1234567\",\r\n \"feeScheduleName\":\"UnAssigned\",\r\n \"lastName\":\"Last Name\",\r\n \"firstName\":\"First Name\",\r\n \"repName\":\"RepFirst RepLast\",\r\n \"note\":null,\r\n \"householdId\":1234,\r\n \"billInstanceId\":123\r\n }\r\n ]\r\n}", "operationId": "PostPayments_WriteOffBillsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "paymentFrom", "in": "query", "description": "Optional.", "required": true, "type": "string", "enum": [ "Household", "Account" ] }, { "name": "paymentData", "in": "body", "description": "Bill data to write off", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PostPaymentsDto" }, "xml": { "name": "PostPaymentsDto", "wrapped": true }, "type": "array" } }, { "name": "batchNumber", "in": "query", "required": false, "type": "string" }, { "name": "cancellation", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Products": { "get": { "tags": [ "Billing/Products" ], "summary": "Get a list of bill Products that the logged in user has access to see.\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "BillingProduct_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "feeExcluded", "in": "query", "description": "Optional", "required": false, "type": "boolean" }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "FeeExcluded" ] }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Products/{key}": { "get": { "tags": [ "Billing/Products" ], "summary": "Gets the bill product that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "BillingProduct_GetEntityByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillProductDto" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Billing/Products" ], "operationId": "BillingProduct_CreateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillProductDto" } }, { "name": "ct", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/RecalcProcess/GetHangFireProgressById": { "get": { "tags": [ "Billing/RecalcProcess" ], "summary": "get hangfire job Id for recalc process", "operationId": "BillGenerator_GetHangFireProgressById", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "jobId", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Hangfire.Console.Monitoring.LineDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/ReceiveableSummary": { "get": { "tags": [ "Billing/ReceiveableSummary" ], "summary": "Get a summary list of recievables.", "operationId": "Billing_GetRecievablesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "startDate", "in": "query", "description": "Optional. Default is null which does not filter. If date is entered receivables are filtered for created on or after this date.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default is null which does not filter. If date is entered receivables are filtered for created on or before this date.", "required": false, "type": "string", "format": "date-time" }, { "name": "forecastBillOnly", "in": "query", "description": "Optional. Default is null which does not filter.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.ReceiveableSummaryDto" }, "xml": { "name": "ReceiveableSummaryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/ReferralPayments": { "get": { "tags": [ "Billing/ReferralPayments" ], "summary": "Get a list of referral payments that the logged in user has access to see.\r\nGet referral payments. Can filter by payee, batch or CreatedDate", "operationId": "ReferralPayments_GetAllReferralPayments", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "batchId", "in": "query", "description": "Optional. Default: null. If provided only payments for the batchId specified will be returned.", "required": false, "type": "integer", "format": "int32" }, { "name": "payeeId", "in": "query", "description": "Optional. Default: null. If provided only payments for the payeeId specified will be returned.", "required": false, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "description": "Optional. Default: null. If provided only payments created on or after the date specified will be returned.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default: null. If provided only payments created on or before the date specified will be returned.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.ReferralPaymentDto" }, "xml": { "name": "ReferralPaymentDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/ReferralPayments/Action/CalculateBatch": { "put": { "tags": [ "Billing/ReferralPayments" ], "summary": "Routine that calculates Referral payments and creates a new Referral Batch", "operationId": "ReferralPayments_ActionTransfer", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "batch", "in": "body", "description": "Batch Information", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.ReferralPaymentBatchDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/ReferralPayments/Batch": { "get": { "tags": [ "Billing/ReferralPayments" ], "summary": "Get all batches", "operationId": "ReferralPayments_GetAllBatches", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.ReferralPaymentBatchDto" }, "xml": { "name": "ReferralPaymentBatchDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/ReferralPayments/Batch/{key}": { "get": { "tags": [ "Billing/ReferralPayments" ], "summary": "Get batch by id", "operationId": "ReferralPayments_GetBatchById", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.ReferralPaymentBatchFullDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/ReferralPayments/Counts": { "get": { "tags": [ "Billing/ReferralPayments" ], "summary": "Get counts for the UI", "operationId": "ReferralPayments_GetCounts", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "batchId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "payeeId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/ReferralPayments/Delete": { "post": { "tags": [ "Billing/ReferralPayments" ], "operationId": "ReferralPayments_DeletePaymentsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "paymentIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/ReferralPayments/Payee": { "get": { "tags": [ "Billing/ReferralPayments" ], "summary": "Get list of payees with referral payments", "operationId": "ReferralPayments_GetAllPayees", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.SimplePayeeDto" }, "xml": { "name": "SimplePayeeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/ReferralPayouts": { "get": { "tags": [ "Billing/ReferralPayouts" ], "summary": "Get a list of Referral Payouts that the logged in user has access to see.\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "ReferralPayouts_GetAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.ReferralPayoutDto" }, "xml": { "name": "ReferralPayoutDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Billing/ReferralPayouts" ], "operationId": "ReferralPayouts_CreateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.ReferralPayoutDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.ReferralPayoutDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/ReferralPayouts/{key}": { "get": { "tags": [ "Billing/ReferralPayouts" ], "summary": "Gets the Referral Payouts that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ReferralPayouts_GetByPayoutIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.ReferralPayoutDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Billing/ReferralPayouts" ], "operationId": "ReferralPayouts_UpdateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.ReferralPayoutDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.ReferralPayoutDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Billing/ReferralPayouts" ], "operationId": "ReferralPayouts_DeleteItemAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/RelatedBillingClient": { "get": { "tags": [ "Billing/RelatedBillingClient" ], "operationId": "Billing_GetRelatedBillingClients", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.RelatedBillingClientDto" }, "xml": { "name": "RelatedBillingClientDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/RelatedBillingClient/{key}": { "get": { "tags": [ "Billing/RelatedBillingClient" ], "operationId": "Billing_GetRelatedBillingClientsById", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.RelatedBillingClientDto" }, "xml": { "name": "RelatedBillingClientDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/RevenuePayout": { "get": { "tags": [ "Billing/RevenuePayout" ], "operationId": "RevenuePayout_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.RevenuePayoutDto" }, "xml": { "name": "RevenuePayoutDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Billing/RevenuePayout" ], "summary": "This operation will create revenue payout report.\r\nIt takes three parameters asOfDate(required), description (not required), forecast (not required)", "description": "Sample Request\r\n\tPOST /Billing/RevenuePayout?asOfDate=03/13/2024&description=NULL&forecast=false", "operationId": "RevenuePayout_CreateAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "asOfDate", "in": "query", "description": "Optional. AsOfDate for selection of bills calculation date.", "required": true, "type": "string", "format": "date-time" }, { "name": "description", "in": "query", "description": "Optional. report description.", "required": false, "type": "string" }, { "name": "forecast", "in": "query", "description": "Optional. forecast report indication.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.RevenuePayoutDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/RevenuePayout/{id}": { "get": { "tags": [ "Billing/RevenuePayout" ], "operationId": "RevenuePayout_GetById", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.RevenuePayoutDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/RevenuePayout/{id}/Details": { "get": { "tags": [ "Billing/RevenuePayout" ], "operationId": "RevenuePayout_GetDetails", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.RevenuePayoutDetailDto" }, "xml": { "name": "RevenuePayoutDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/RevenuePayout/{id}/Payment/New": { "get": { "tags": [ "Billing/RevenuePayout" ], "operationId": "RevenuePayout_GetDefaultPaymentAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.RevenuePayoutPaymentDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/RevenuePayout/{id}/Payment/Reports": { "get": { "tags": [ "Billing/RevenuePayout" ], "summary": "Returns a list of all Reports for a given ReventuPayout Id", "description": "GET /Billing/RevenuePayout/1/Payment/Reports\r\nSample Response:\r\n[\r\n {\r\n \"id\": 123,\r\n \"name\": \"Feb 23 2024 3:15PM\",\r\n \"isChecked\": false\r\n }\r\n]", "operationId": "RevenuePayout_GetPaymentReportsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "description": "Required. Revenue Payout Id", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.SimpleEntityCheckedDto" }, "xml": { "name": "SimpleEntityCheckedDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/RevenuePayout/{id}/Payments": { "get": { "tags": [ "Billing/RevenuePayout" ], "summary": "Returns list of payments for revenue payout id", "description": " GET /Billing/RevenuePayout/68/Payments\r\n Returns:\r\n[\r\n {\r\n \"id\": 88,\r\n \"revenuePayoutId\": 68,\r\n \"asOfDate\": \"2023-01-01T00:00:00-06:00\",\r\n \"createdDate\": \"2023-01-01T12:46:15.413-06:00\",\r\n \"createdBy\": \"first.last\",\r\n \"editedDate\": \"2023-01-01T12:46:15.413-06:00\",\r\n \"editedBy\": \"first.last\",\r\n \"totalFeeRemaining\": 123.46,\r\n \"collectedRIAAmount\": 123.45,\r\n \"unCollectedRIAAmount\": 123.45,\r\n \"collectedAdvisorAmount\": 123.45,\r\n \"unCollectedAdvisorAmount\": 123.45,\r\n \"adjustmentAmount\": 123.45,\r\n \"note\": \"string note field\",\r\n \"reportId\": null\r\n }\r\n]", "operationId": "RevenuePayout_GetPayments", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "description": "Required. Revenue Payout Id", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.RevenuePayoutPaymentDto" }, "xml": { "name": "RevenuePayoutPaymentDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/RevenuePayout/Payment": { "post": { "tags": [ "Billing/RevenuePayout" ], "operationId": "RevenuePayout_CreatePaymentAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "paymentDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.RevenuePayoutPaymentDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.RevenuePayoutPaymentDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/RevenuePayout/Payment/{key}": { "delete": { "tags": [ "Billing/RevenuePayout" ], "operationId": "RevenuePayout_DeletePaymentAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/RevenuePayout/Payment/Report/{key}": { "get": { "tags": [ "Billing/RevenuePayout" ], "operationId": "RevenuePayout_GetPaymentReport", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/RevenuePayout/Payout/Delete/{key}": { "delete": { "tags": [ "Billing/RevenuePayout" ], "operationId": "RevenuePayout_DeletePayoutAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Run/IndirectManagementFeeAdjScript": { "post": { "tags": [ "Billing/Run" ], "summary": "Run the Indirect Management Fee Adjustment Script for a given date range", "description": "Sample Request\r\nGET /v1/Billing/Run/IndirectManagementFeeAdjScript?startDate=7/1/2024&endDate=9/16/2024\r\nSample Response\r\n[\r\n {\r\n \"clientId\": 1,\r\n \"clientName\": \"Test Client\",\r\n \"billId\": 123,\r\n \"payingFeeAccountId\": 444,\r\n \"paidAccountId\": 134,\r\n \"receivableId\": 155,\r\n \"processingMessage\": \"Error: No indirect fee receivable found.\"\r\n },\r\n {\r\n \"clientId\": 2,\r\n \"clientName\": \"Test Client 2\",\r\n \"billId\": 555,\r\n \"payingFeeAccountId\": 987,\r\n \"paidAccountId\": 4234,\r\n \"receivableId\": 71818,\r\n \"processingMessage\": \"Error: Sleeve account\"\r\n }\r\n]", "operationId": "Billing_RunIndirectManagementFeeAdjScript", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "description": "Start Date for the adjustment range", "required": true, "type": "string" }, { "name": "endDate", "in": "query", "description": "End Date for the adjustment range", "required": true, "type": "string" } ], "responses": { "200": { "description": "Returns the list of processed adjustments", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.IndirectManagementFeeAdjustmentDto" }, "xml": { "name": "IndirectManagementFeeAdjustmentDto", "wrapped": true }, "type": "array" } }, "400": { "description": "If start date or end date is missing or invalid" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Schedules": { "get": { "tags": [ "Billing/Schedules" ], "operationId": "BillSchedules_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "schedule", "in": "query", "required": false, "items": { "type": "string", "enum": [ "Undefined", "Fee", "Payout", "BDOverride", "Remainder", "PerformanceFee", "PerformancePayout" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "billEntityId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillScheduleDto" }, "xml": { "name": "BillScheduleDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Billing/Schedules" ], "summary": "Creates a new Bill Schedule based on the dto passed to the method", "operationId": "BillSchedules_CreateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillScheduleFullDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Schedules/{key}": { "get": { "tags": [ "Billing/Schedules" ], "summary": "Gets the schedule that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "BillSchedules_GetEntityByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillScheduleFullDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Billing/Schedules" ], "operationId": "BillSchedules_UpdateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillScheduleFullDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillScheduleFullDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Billing/Schedules" ], "operationId": "BillSchedules_DeleteAsync", "consumes": [], "produces": [], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Schedules/{key}/Calculate": { "get": { "tags": [ "Billing/Schedules" ], "summary": "Calculates the fee breakdown for the amount provided and the schedule that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "BillSchedules_UpdateEntity", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "amount", "in": "query", "description": "The amount to calculate the fee breakdown. Must be positive value.", "required": true, "type": "number", "format": "double" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillScheduleCalculateDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Schedules/AssignedSchedules": { "post": { "tags": [ "Billing/Schedules" ], "operationId": "BillSchedules_GetAssignedSchedules", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillAssignedSchedulesDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.AssignedSchedulesDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Schedules/BillScheduleDetailHistory": { "get": { "tags": [ "Billing/Schedules" ], "summary": "Get a list of BillScheduleDetail History", "operationId": "BillSchedules_GetV1BillingSchedulesBillScheduleDetailHistory", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "billscheduleId", "in": "query", "description": "Required. Default: null, returns nothing.", "required": false, "type": "integer", "format": "int32" }, { "name": "billscheduledetailId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillScheduleDetailHistoryDto" }, "xml": { "name": "BillScheduleDetailHistoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Schedules/BillScheduleHistory": { "get": { "tags": [ "Billing/Schedules" ], "summary": "Gets a list of bill schedule histories", "operationId": "BillSchedules_GetV1BillingSchedulesBillScheduleHistory", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "billscheduleId", "in": "query", "description": "Required. Default: null, returns nothing.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillScheduleHistoryDto" }, "xml": { "name": "BillScheduleHistoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Schedules/CLS/Platform/{key}/BillSchedule": { "get": { "tags": [ "Billing/Schedules" ], "operationId": "BillSchedules_GetBillScheduleTierByPlatform", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.ClsBillScheduleTierByPlatformDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Billing/Schedules" ], "operationId": "BillSchedules_UpdateTierSchedulePlatformAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "schedule", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.ClsBillScheduleTierByPlatformDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Schedules/CLS/Platform/BillSchedule": { "post": { "tags": [ "Billing/Schedules" ], "operationId": "BillSchedules_CreateBillScheduleFromClSWizardAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "detail", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.ClsBillScheduleTierByPlatformDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Schedules/CLSBillingWizard": { "post": { "tags": [ "Billing/Schedules" ], "operationId": "BillSchedules_PostV1BillingSchedulesCLSBillingWizard", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "wizardDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.ClsBillingWizardDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Schedules/Delete": { "put": { "tags": [ "Billing/Schedules" ], "operationId": "BillSchedules_DeleteEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "billScheduleIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Schedules/full": { "get": { "tags": [ "Billing/Schedules" ], "summary": "Gets the full schedule details.", "operationId": "BillSchedules_GetEntityFullAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillScheduleFullDto" }, "xml": { "name": "BillScheduleFullDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Schedules/Simple": { "get": { "tags": [ "Billing/Schedules" ], "operationId": "BillSchedules_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "schedule", "in": "query", "required": false, "items": { "type": "string", "enum": [ "Undefined", "Fee", "Payout", "BDOverride", "Remainder", "PerformanceFee", "PerformancePayout" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "billEntity", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "forShowInFeeCalculator", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.SimpleSchedule" }, "xml": { "name": "SimpleSchedule", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/SyncCashtoEclipse": { "post": { "tags": [ "Billing/SyncCashtoEclipse" ], "summary": "Draft method to sync cash between receivables and Eclipse. Right now we just send one account at a time.\r\nEventually, we want to be able to sync all accounts in a bill instance at once.", "operationId": "Billing_BillingSyncCashToEclipse", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "orionAccount", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.ReceiveableSummaryDto" } }, { "name": "ct", "in": "header", "description": "CancellationToken", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseCashFundingResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Transactions": { "get": { "tags": [ "Billing/Transactions" ], "operationId": "BillTransaction_GetAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "transTypeId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "custodianId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "representativeId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "fundFamilyId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillTransactionDto" }, "xml": { "name": "BillTransactionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Transactions/{key}": { "get": { "tags": [ "Billing/Transactions" ], "summary": "Gets the client that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "description": " GET: v1/Billing/Transactions/123\r\n Returns:\r\n {\r\n\t \"id\": 123,\r\n \"registrationName\": \"First Last\",\r\n\t \"accountId\": 1234,\r\n \"accountNumber\": \"ACCT_CODE\",\r\n\t \"brokerDealerName\": \"Broker Dealer\",\r\n \"representativeName\": \"Last, First\",\r\n\t \"representativeNumber\": \"123\",\r\n \"productName\": \"Product Name\",\r\n\t \"transactionDate\": \"2024-01-01\",\r\n \"transactionTime\": null,\r\n\t \"transactionAmount\": 123.45,\r\n \"isFeeExcluded\": false,\r\n\t \"isCashFlow\": false,\r\n \"isNMReady\": false,\r\n\t \"isBilled\": false,\r\n \"billedDate\": null,\r\n\t \"isAdvanceBilled\": false,\r\n \"transactionDescription\": \"Description of the Trans\",\r\n\t \"managementStyle\": \"Style\",\r\n \"fundFamily\": \"Fund Family\",\r\n\t \"cycleMonth\": 1,\r\n \"billStyle\": \"Arrear\",\r\n\t \"valuationMethod\": \"Period End Value\",\r\n \"clientId\": 1234,\r\n\t \"feeSchedule\": \"Schedule Name\",\r\n \"startDate\": \"2024-01-01\",\r\n\t \"billStartDate\": \"2024-01-01\",\r\n \"notes\": \"notes\",\r\n\t \"businessLine\": \"Business Line\",\r\n \"billFrequency\": \"Quarterly\",\r\n\t \"outsideId\": null,\r\n \"accountCreatedDate\": \"2024-01-01\",\r\n\t \"subAdvisor\": \" Sub Advisor\",\r\n \"productId\": 123,\r\n\t \"ticker\": \"TICKER\",\r\n \"performanceFeeBreak\": true,\r\n\t \"householdName\": \"First Last\"\r\n }", "operationId": "BillTransaction_GetEntityByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Required. Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "token", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillTransactionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Transactions/AutomateCashflows/Process": { "put": { "tags": [ "Billing/Transactions" ], "summary": "Process Cashflow Automation on demand.", "description": "Sample Request\r\n\tPUT v1/Billing/Transactions/AutomateCashflows/Process?startDate=01/01/2024&endDate=01/31/2024", "operationId": "BillTransaction_AutomateCashflowsProcess", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "description": "Transaction Start Date", "required": true, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Transaction End Date", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Transactions/AutomateCashflowSettings": { "get": { "tags": [ "Billing/Transactions" ], "summary": "Get Automated Casfhlow Settings", "description": " GET: v1/Billing/Transactions/AutomateCashflowSettings\r\n Returns:\r\n [\r\n {\r\n \t\"id\": 1,\r\n \t\"isEnabled\": false,\r\n\t \t\"minimumThreshold\": null,\r\n \t\"selectAll\": true,\r\n\t \t\"groupByDay\": true,\r\n \t\"transactionTypes\": []\r\n }\r\n ]", "operationId": "BillTransaction_GetAutomateCashflowSettingsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.AutomateCashflowSettingDto" }, "xml": { "name": "AutomateCashflowSettingDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Billing/Transactions" ], "summary": "Update Automated Cashflow Settings", "description": "PUT: v1/Billing/Transactions/AutomateCashflowSettings\r\nReturns: 200", "operationId": "BillTransaction_UpdateAutomateCashflowSettingsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "setting", "in": "body", "description": "Required", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.AutomateCashflowSettingDto" } }, { "name": "token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Transactions/Consolidated": { "get": { "tags": [ "Billing/Transactions" ], "summary": "Gets a list of transactions that the logged in user has access to.\r\nThe return is limited to pages of 100000. Use $top and $skip in the query string to page through the data.", "description": "Sample Request\r\n GET /Billing/Transactions/Consolidated?startDate=10/01/2023&endDate=10/15/2023&$top=100000\r\n Returns:\r\n [\r\n {\r\n \"id\": 1,\r\n \"registrationName\": \"Test\",\r\n \"accountId\": 12,\r\n \"accountNumber\": \"Test\",\r\n \"representativeName\": \"Test\",\r\n \"productName\": \"Test product\",\r\n \"transactionDate\": \"2023-10-01\",\r\n \"transactionAmount\": 123,\r\n \"isFeeExcluded\": false,\r\n \"isCashFlow\": false,\r\n \"isNMReady\": false,\r\n \"isBilled\": false,\r\n \"billedDate\": null,\r\n \"isAdvanceBilled\": false,\r\n \"transactionDescription\": \"Test desc\",\r\n \"managementStyle\": \"Test style\",\r\n \"clientId\": 123,\r\n \"outsideId\": null\r\n }\r\n ]", "operationId": "BillTransaction_GetV1BillingTransactionsConsolidated", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "description": "Optional. Default null. If provided only transactions with a transdate on or after the date provided will be returned.", "required": true, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default null. If provided only transactions with a transdate on or before the date provided will be returned.", "required": true, "type": "string", "format": "date-time" }, { "name": "manipulator", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillTransactionDto" }, "xml": { "name": "BillTransactionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Transactions/FeeExcludedAssets": { "get": { "tags": [ "Billing/Transactions" ], "summary": "Gets a list of transactions of buys or sells to/from fee excluded assets that match one of the keys in the provided list.", "description": " GET: v1/Billing/Transactions/FeeExcludedAssets\r\n Returns:\r\n [\r\n {\r\n\t \"id\": 1,\r\n \"registrationName\": \"First Last\",\r\n\t \"accountId\": 1234,\r\n \"accountNumber\": \"ACCT_CODE\",\r\n\t \"brokerDealerName\": \"Broker Dealer\",\r\n \"representativeName\": \"Last, First\",\r\n\t \"representativeNumber\": \"123\",\r\n \"productName\": \"Product Name\",\r\n\t \"transactionDate\": \"2024-01-01\",\r\n \"transactionTime\": null,\r\n\t \"transactionAmount\": 123.45,\r\n \"isFeeExcluded\": false,\r\n\t \"isCashFlow\": false,\r\n \"isNMReady\": false,\r\n\t \"isBilled\": false,\r\n \"billedDate\": null,\r\n\t \"isAdvanceBilled\": false,\r\n \"transactionDescription\": \"Description of the Trans\",\r\n\t \"managementStyle\": \"Style\",\r\n \"fundFamily\": \"Fund Family\",\r\n\t \"cycleMonth\": 1,\r\n \"billStyle\": \"Arrear\",\r\n\t \"valuationMethod\": \"Period End Value\",\r\n \"clientId\": 1234,\r\n\t \"feeSchedule\": \"Schedule Name\",\r\n \"startDate\": \"2024-01-01\",\r\n\t \"billStartDate\": \"2024-01-01\",\r\n \"notes\": \"notes\",\r\n\t \"businessLine\": \"Business Line\",\r\n \"billFrequency\": \"Quarterly\",\r\n\t \"outsideId\": null,\r\n \"accountCreatedDate\": \"2024-01-01\",\r\n\t \"subAdvisor\": \" Sub Advisor\",\r\n \"productId\": 123,\r\n\t \"ticker\": \"TICKER\",\r\n \"performanceFeeBreak\": true,\r\n\t \"householdName\": \"First Last\"\r\n }\r\n ]", "operationId": "BillTransaction_GetFeeExcludedTransactionsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "token", "in": "header", "required": true }, { "name": "startDate", "in": "query", "description": "Optional. Default startQTD. If provided only transactions that have matched start date will be returned.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default now. If provided only transactions that have matched end date will be returned.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillTransactionDto" }, "xml": { "name": "BillTransactionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Transactions/FeeExcludedAssets/Test": { "get": { "tags": [ "Billing/Transactions" ], "summary": "Testing endpoint for FeeExcludedAssets. Do not use outside of testing purposes.", "description": "Sample Request\r\n GET v1/Billing/Transactions/FeeExcludedAssets/Test", "operationId": "BillTransaction_GetFeeExcludedAssetsTestAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "description": "CancellationToken of the request", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.FeeExcludedAsset" }, "xml": { "name": "FeeExcludedAsset", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Transactions/Grid": { "get": { "tags": [ "Billing/Transactions" ], "operationId": "BillTransaction_GetAllGrid", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "manipulator", "in": "header", "required": false }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "top", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "transTypeId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "custodianId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "representativeId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "fundFamilyId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillTransactionDto" }, "xml": { "name": "BillTransactionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Transactions/List": { "post": { "tags": [ "Billing/Transactions" ], "summary": "Gets a list of bill transactions that match one of the keys in the provided list.", "description": " GET: v1/Billing/Transactions/List OR v1/Billing/Transactions/List/Id\r\n [ 1 ]\r\n Returns:\r\n [\r\n {\r\n\t \"id\": 1,\r\n \"registrationName\": \"First Last\",\r\n\t \"accountId\": 1234,\r\n \"accountNumber\": \"ACCT_CODE\",\r\n\t \"brokerDealerName\": \"Broker Dealer\",\r\n \"representativeName\": \"Last, First\",\r\n\t \"representativeNumber\": \"123\",\r\n \"productName\": \"Product Name\",\r\n\t \"transactionDate\": \"2024-01-01\",\r\n \"transactionTime\": null,\r\n\t \"transactionAmount\": 123.45,\r\n \"isFeeExcluded\": false,\r\n\t \"isCashFlow\": false,\r\n \"isNMReady\": false,\r\n\t \"isBilled\": false,\r\n \"billedDate\": null,\r\n\t \"isAdvanceBilled\": false,\r\n \"transactionDescription\": \"Description of the Trans\",\r\n\t \"managementStyle\": \"Style\",\r\n \"fundFamily\": \"Fund Family\",\r\n\t \"cycleMonth\": 1,\r\n \"billStyle\": \"Arrear\",\r\n\t \"valuationMethod\": \"Period End Value\",\r\n \"clientId\": 1234,\r\n\t \"feeSchedule\": \"Schedule Name\",\r\n \"startDate\": \"2024-01-01\",\r\n\t \"billStartDate\": \"2024-01-01\",\r\n \"notes\": \"notes\",\r\n\t \"businessLine\": \"Business Line\",\r\n \"billFrequency\": \"Quarterly\",\r\n\t \"outsideId\": null,\r\n \"accountCreatedDate\": \"2024-01-01\",\r\n\t \"subAdvisor\": \" Sub Advisor\",\r\n \"productId\": 123,\r\n\t \"ticker\": \"TICKER\",\r\n \"performanceFeeBreak\": true,\r\n\t \"householdName\": \"First Last\"\r\n }\r\n ]", "operationId": "BillTransaction_GetListByIdAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "token", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillTransactionDto" }, "xml": { "name": "BillTransactionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Transactions/List/Id": { "post": { "tags": [ "Billing/Transactions" ], "summary": "Gets a list of bill transactions that match one of the keys in the provided list.", "description": " GET: v1/Billing/Transactions/List OR v1/Billing/Transactions/List/Id\r\n [ 1 ]\r\n Returns:\r\n [\r\n {\r\n\t \"id\": 1,\r\n \"registrationName\": \"First Last\",\r\n\t \"accountId\": 1234,\r\n \"accountNumber\": \"ACCT_CODE\",\r\n\t \"brokerDealerName\": \"Broker Dealer\",\r\n \"representativeName\": \"Last, First\",\r\n\t \"representativeNumber\": \"123\",\r\n \"productName\": \"Product Name\",\r\n\t \"transactionDate\": \"2024-01-01\",\r\n \"transactionTime\": null,\r\n\t \"transactionAmount\": 123.45,\r\n \"isFeeExcluded\": false,\r\n\t \"isCashFlow\": false,\r\n \"isNMReady\": false,\r\n\t \"isBilled\": false,\r\n \"billedDate\": null,\r\n\t \"isAdvanceBilled\": false,\r\n \"transactionDescription\": \"Description of the Trans\",\r\n\t \"managementStyle\": \"Style\",\r\n \"fundFamily\": \"Fund Family\",\r\n\t \"cycleMonth\": 1,\r\n \"billStyle\": \"Arrear\",\r\n\t \"valuationMethod\": \"Period End Value\",\r\n \"clientId\": 1234,\r\n\t \"feeSchedule\": \"Schedule Name\",\r\n \"startDate\": \"2024-01-01\",\r\n\t \"billStartDate\": \"2024-01-01\",\r\n \"notes\": \"notes\",\r\n\t \"businessLine\": \"Business Line\",\r\n \"billFrequency\": \"Quarterly\",\r\n\t \"outsideId\": null,\r\n \"accountCreatedDate\": \"2024-01-01\",\r\n\t \"subAdvisor\": \" Sub Advisor\",\r\n \"productId\": 123,\r\n\t \"ticker\": \"TICKER\",\r\n \"performanceFeeBreak\": true,\r\n\t \"householdName\": \"First Last\"\r\n }\r\n ]", "operationId": "BillTransaction_PostV1BillingTransactionsListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "token", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillTransactionDto" }, "xml": { "name": "BillTransactionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Transactions/SleeveTransfers": { "get": { "tags": [ "Billing/Transactions" ], "summary": "Gets a list of bill transactions that match one of the keys in the provided list.", "description": " GET: v1/Billing/Transactions/SleeveTransfers?transferType=1\r\n Returns:\r\n [\r\n {\r\n\t \"id\": 1,\r\n \"registrationName\": \"First Last\",\r\n\t \"accountId\": 1234,\r\n \"accountNumber\": \"ACCT_CODE\",\r\n\t \"brokerDealerName\": \"Broker Dealer\",\r\n \"representativeName\": \"Last, First\",\r\n\t \"representativeNumber\": \"123\",\r\n \"productName\": \"Product Name\",\r\n\t \"transactionDate\": \"2024-01-01\",\r\n \"transactionTime\": null,\r\n\t \"transactionAmount\": 123.45,\r\n \"isFeeExcluded\": false,\r\n\t \"isCashFlow\": false,\r\n \"isNMReady\": false,\r\n\t \"isBilled\": false,\r\n \"billedDate\": null,\r\n\t \"isAdvanceBilled\": false,\r\n \"transactionDescription\": \"Description of the Trans\",\r\n\t \"managementStyle\": \"Style\",\r\n \"fundFamily\": \"Fund Family\",\r\n\t \"cycleMonth\": 1,\r\n \"billStyle\": \"Arrear\",\r\n\t \"valuationMethod\": \"Period End Value\",\r\n \"clientId\": 1234,\r\n\t \"feeSchedule\": \"Schedule Name\",\r\n \"startDate\": \"2024-01-01\",\r\n\t \"billStartDate\": \"2024-01-01\",\r\n \"notes\": \"notes\",\r\n\t \"businessLine\": \"Business Line\",\r\n \"billFrequency\": \"Quarterly\",\r\n\t \"outsideId\": null,\r\n \"accountCreatedDate\": \"2024-01-01\",\r\n\t \"subAdvisor\": \" Sub Advisor\",\r\n \"productId\": 123,\r\n\t \"ticker\": \"TICKER\",\r\n \"performanceFeeBreak\": true,\r\n\t \"householdName\": \"First Last\"\r\n }\r\n ]", "operationId": "BillTransaction_GetSleeveTransfersAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "token", "in": "header", "required": true }, { "name": "transferType", "in": "query", "description": "Optional. Both = 0, CashFlowOnly = 1, RebalanceOnly = 2", "required": false, "type": "string", "default": 0, "enum": [ "Both", "CashFlowOnly", "RebalanceOnly" ] }, { "name": "startDate", "in": "query", "description": "Optional. Default startQTD. If provided only transactions that have matched start date will be returned.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default now. If provided only transactions that have matched end date will be returned.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillTransactionDto" }, "xml": { "name": "BillTransactionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Transactions/TransactionSleeveCashflows/Test": { "get": { "tags": [ "Billing/Transactions" ], "summary": "Testing endpoint for TransactionSleeveCashflows. Do not use outside of testing purposes.", "description": "Sample Request\r\n GET v1/Billing/Transactions/TransactionSleeveCashflows/Test", "operationId": "BillTransaction_TransactionSleeveCashflowsTestAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "description": "CancellationToken of the request", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.TransactionSleeveCashflow" }, "xml": { "name": "TransactionSleeveCashflow", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/Transactions/TransType": { "get": { "tags": [ "Billing/Transactions" ], "summary": "Returns list of Transaction Types for Billing", "description": " GET: v1/Billing/Transactions/TransType\r\n Returns:\r\n\t[\r\n {\r\n \t\"financialType\": \"typeName\",\r\n \"description\": \"Type Description\",\r\n \t\"id\": 1,\r\n \"name\": \"Name\"\r\n },\r\n {\r\n \"financialType\": \"typeName\",\r\n \"description\": \"Type Description\",\r\n \"id\": 2,\r\n \"name\": \"Name\"\r\n }\r\n ]", "operationId": "BillTransaction_GetAllTransTypeAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TransactionTypeDto" }, "xml": { "name": "TransactionTypeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/UpdateBillaccountItem": { "put": { "tags": [ "Billing/UpdateBillaccountItem" ], "operationId": "BillGenerator_UpdateBillaccountItemAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAccountItem" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/UpdateNotes": { "post": { "tags": [ "Billing/UpdateNotes" ], "summary": "Create new confirm overview notes", "operationId": "BillPayment_CreateNewItemsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "newItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PostPaymentsDto" }, "xml": { "name": "PostPaymentsDto", "wrapped": true }, "type": "array" } }, { "name": "notes", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PostPaymentsDto" }, "xml": { "name": "PostPaymentsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/ValidateImport/Account/ReferralSchedules": { "post": { "tags": [ "Billing/ValidateImport" ], "operationId": "ValidateImportAccountReferralSchedules_ImportAccountReferralSchedulesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountVerboseValidationDto" }, "xml": { "name": "AccountVerboseValidationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/ValidateImport/FeeHierarchy": { "post": { "tags": [ "Billing/ValidateImport" ], "summary": "import the excel into a list of objects we can use", "operationId": "BillingValidateImportFeeHierarchy_ImportFeeHierarchyAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FeeHierarchyValidationDto" }, "xml": { "name": "FeeHierarchyValidationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/ValidateImport/FeeHierarchy/Import": { "put": { "tags": [ "Billing/ValidateImport" ], "summary": "import the processed data into tblFeeHierarchy. This only does an insert.", "operationId": "BillingValidateImportFeeHierarchy_ImportHierarchyAssignmentsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "importItems", "in": "body", "description": "list of FeeHierarchyValidationDto", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FeeHierarchyValidationDto" }, "xml": { "name": "FeeHierarchyValidationDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FeeHierarchyValidationDto" }, "xml": { "name": "FeeHierarchyValidationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/ValidateImport/FeeHierarchy/Templates/Csv": { "get": { "tags": [ "Billing/ValidateImport" ], "operationId": "BillingValidateImportFeeHierarchy_GetCsvTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/ValidateImport/FeeHierarchy/Templates/Xls": { "get": { "tags": [ "Billing/ValidateImport" ], "operationId": "BillingValidateImportFeeHierarchy_GetXlsTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/ValidateImport/FeeHierarchy/Templates/Xlsx": { "get": { "tags": [ "Billing/ValidateImport" ], "operationId": "BillingValidateImportFeeHierarchy_GetXlsxTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/ValidateImport/PartialExclusion": { "post": { "tags": [ "Billing/ValidateImport" ], "operationId": "BillingValidateImportPartialExclusion_ImportPayForAccountAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PartialExclusionValidationDto" }, "xml": { "name": "PartialExclusionValidationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/ValidateImport/PartialExclusion/Import": { "put": { "tags": [ "Billing/ValidateImport" ], "operationId": "BillingValidateImportPartialExclusion_ImportExclusionsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "importItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PartialExclusionValidationDto" }, "xml": { "name": "PartialExclusionValidationDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PartialExclusionValidationDto" }, "xml": { "name": "PartialExclusionValidationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/ValidateImport/PartialExclusion/Templates/Csv": { "get": { "tags": [ "Billing/ValidateImport" ], "operationId": "BillingValidateImportPartialExclusion_GetCsvTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/ValidateImport/PartialExclusion/Templates/Xls": { "get": { "tags": [ "Billing/ValidateImport" ], "operationId": "BillingValidateImportPartialExclusion_GetXlsTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/ValidateImport/PartialExclusion/Templates/Xlsx": { "get": { "tags": [ "Billing/ValidateImport" ], "operationId": "BillingValidateImportPartialExclusion_GetXlsxTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/ValidateImport/PayForAccounts": { "post": { "tags": [ "Billing/ValidateImport" ], "operationId": "BillingValidateImportPayForAccounts_ImportPayForAccountAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PayForAccountValidationDto" }, "xml": { "name": "PayForAccountValidationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/ValidateImport/PayForAccounts/Templates/Csv": { "get": { "tags": [ "Billing/ValidateImport" ], "operationId": "BillingValidateImportPayForAccounts_GetCsvTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/ValidateImport/PayForAccounts/Templates/Xls": { "get": { "tags": [ "Billing/ValidateImport" ], "operationId": "BillingValidateImportPayForAccounts_GetXlsTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/ValidateImport/PayForAccounts/Templates/Xlsx": { "get": { "tags": [ "Billing/ValidateImport" ], "operationId": "BillingValidateImportPayForAccounts_GetXlsxTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/ValidateImport/RelatedHouseholds": { "post": { "tags": [ "Billing/ValidateImport" ], "operationId": "BillingValidateImportRelatedHouseholds_ImportRelatedHouseholdsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RelatedHouseholdValidationDto" }, "xml": { "name": "RelatedHouseholdValidationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/ValidateImport/RelatedHouseholds/Templates/Csv": { "get": { "tags": [ "Billing/ValidateImport" ], "operationId": "BillingValidateImportRelatedHouseholds_GetCsvTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/ValidateImport/RelatedHouseholds/Templates/Xls": { "get": { "tags": [ "Billing/ValidateImport" ], "operationId": "BillingValidateImportRelatedHouseholds_GetXlsTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Billing/ValidateImport/RelatedHouseholds/Templates/Xlsx": { "get": { "tags": [ "Billing/ValidateImport" ], "operationId": "BillingValidateImportRelatedHouseholds_GetXlsxTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Blogging/Blogs": { "get": { "tags": [ "Blogging/Blogs" ], "summary": "Gets all blog objects for user", "operationId": "Blogs_GetAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.BlogDto" }, "xml": { "name": "BlogDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Blogging/Blogs" ], "summary": "Mass update blogs", "operationId": "Blogs_UpdateItems", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updatedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.BlogDto" }, "xml": { "name": "BlogDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.BlogDto" }, "xml": { "name": "BlogDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Blogging/Blogs" ], "summary": "Create a new blog", "operationId": "Blogs_CreateBlog", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.BlogDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.BlogDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Blogging/Blogs/{key}": { "get": { "tags": [ "Blogging/Blogs" ], "summary": "Gets blog by key", "operationId": "Blogs_GetItemByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.BlogDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Blogging/Blogs" ], "summary": "Update one blog", "operationId": "Blogs_UpdateBlog", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.BlogDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.BlogDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Blogging/Blogs" ], "summary": "Delete a blog", "operationId": "Blogs_DeleteItem", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Blogging/Blogs/Simple": { "get": { "tags": [ "Blogging/Blogs" ], "operationId": "Blogs_GetSimpleEntities", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.BlogDto" }, "xml": { "name": "BlogDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Blogging/Emails/{emailId}/Attachments/{key}/Download": { "get": { "tags": [ "Blogging/Emails" ], "summary": "Gets the raw data of the specific email attachment with the key provided which is associated to the email with the specified key.", "operationId": "Emails_GetAttachmentBlobFile", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "emailId", "in": "path", "description": "Key of the email.", "required": true, "type": "integer", "format": "int32" }, { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Blogging/Emails/{folder}": { "get": { "tags": [ "Blogging/Emails" ], "summary": "Gets all received email objects for user", "operationId": "Emails_GetAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "folder", "in": "path", "required": true, "type": "string", "enum": [ "Received", "Sent", "Archived", "Deleted" ] }, { "name": "userId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.EmailListDto" }, "xml": { "name": "EmailListDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Blogging/Emails/{key}": { "get": { "tags": [ "Blogging/Emails" ], "summary": "Gets email by key", "operationId": "Emails_GetItemByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.EmailDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Blogging/Emails" ], "summary": "Delete an email", "operationId": "Emails_DeleteItem", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Blogging/Emails/Mailboxes": { "get": { "tags": [ "Blogging/Emails" ], "summary": "Gets email mailboxes", "operationId": "Emails_GetMailBoxes", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Blogging/Emails/New": { "post": { "tags": [ "Blogging/Emails" ], "summary": "Create a new email", "operationId": "Emails_CreateEmailAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "newItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.NewEmailDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Blogging/Emails/Received/Action/Delete": { "put": { "tags": [ "Blogging/Emails" ], "operationId": "Emails_ActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Blogging/Emails/Received/Action/MarkRead": { "put": { "tags": [ "Blogging/Emails" ], "operationId": "Emails_ActionMarkRead", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.EmailListDto" }, "xml": { "name": "EmailListDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Blogging/Emails/Recipients/Search": { "get": { "tags": [ "Blogging/Emails" ], "summary": "Gets a list of recipients that the logged in user has access to where the UserName or UserId contains the search string.", "operationId": "Emails_GetRecipientsSearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "UserName, UserId, or EntityName to search for", "required": true, "type": "string" }, { "name": "entity", "in": "query", "description": "Optional. Default: null. If provided returns only the recipients for the entity level specified.", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.RecipientDto" }, "xml": { "name": "RecipientDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Blogging/Emails/Recipients/Search/{search}": { "get": { "tags": [ "Blogging/Emails" ], "summary": "Gets a list of recipients that the logged in user has access to where the UserName or UserId contains the search string.", "operationId": "Emails_GetV1BloggingEmailsRecipientsSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "UserName, UserId, or EntityName to search for", "required": true, "type": "string" }, { "name": "entity", "in": "query", "description": "Optional. Default: null. If provided returns only the recipients for the entity level specified.", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.RecipientDto" }, "xml": { "name": "RecipientDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Blogging/Emails/Sent/Action/Archive": { "put": { "tags": [ "Blogging/Emails" ], "operationId": "Emails_ActionArchive", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Blogging/Newsfeed": { "get": { "tags": [ "Blogging/Newsfeed" ], "summary": "Gets all Newsfeed objects for user", "operationId": "Newsfeed_GetAllAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true }, { "name": "startDate", "in": "query", "description": "Optional. Default:null", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default:null", "required": false, "type": "string", "format": "date-time" }, { "name": "clientId", "in": "query", "description": "Optional. Default:null", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.NewsFeedCompilationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Blogging/Newsfeed/Admin": { "get": { "tags": [ "Blogging/Newsfeed" ], "summary": "Gets all Newsfeed objects for user", "operationId": "NewsfeedAdmin_GetAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "feedType", "in": "query", "description": "News feed type, Optional. Default:null", "required": false, "type": "string", "enum": [ "Post", "Rss", "Notification", "Statement", "Webinar", "AdvisorMaterial" ] }, { "name": "allCurrent", "in": "query", "description": "Returns all feeds active and published, Optional. Default:false", "required": false, "type": "boolean", "default": false }, { "name": "feedStatus", "in": "query", "description": "Optional, ignored if allCurrent is true. Default:null", "required": false, "type": "string", "enum": [ "Inactive", "Active", "Draft", "Scheduled", "Published", "EBN", "Statement" ] }, { "name": "audienceType", "in": "query", "required": false, "type": "string", "default": 1, "enum": [ "Clients", "Reps" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.NewsfeedDto" }, "xml": { "name": "NewsfeedDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Blogging/Newsfeed" ], "summary": "Adds a new News feed item to the database.", "operationId": "NewsfeedAdmin_CreateNewsfeedAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.NewsfeedDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.NewsfeedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Blogging/Newsfeed/Admin/{key}": { "get": { "tags": [ "Blogging/Newsfeed" ], "summary": "Gets Newsfeed by key", "operationId": "NewsfeedAdmin_GetItemByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.NewsfeedDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Blogging/Newsfeed" ], "summary": "Update News feed", "operationId": "NewsfeedAdmin_UpdateNewsfeedAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.NewsfeedDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.NewsfeedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Blogging/Newsfeed/Admin/Action/Active": { "put": { "tags": [ "Blogging/Newsfeed" ], "operationId": "NewsfeedAdmin_ActionStatus", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "isActive", "in": "query", "required": true, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Blogging/Newsfeed/Admin/Action/Delete": { "put": { "tags": [ "Blogging/Newsfeed" ], "operationId": "NewsfeedAdmin_ActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Blogging/Newsfeed/Admin/AdvisorMaterial": { "post": { "tags": [ "Blogging/Newsfeed" ], "summary": "Creates News feed advisor material.Special endpoint to flatten the object for multipart form data.", "operationId": "NewsfeedAdmin_CreateAdvisorMaterialNewsfeedAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.NewsfeedAdvisorMaterialDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.NewsfeedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Blogging/Newsfeed/Admin/AdvisorMaterial/{key}": { "put": { "tags": [ "Blogging/Newsfeed" ], "summary": "Update News feed advisor material.Special endpoint to flatten the object for multipart form data.", "operationId": "NewsfeedAdmin_UpdateAdvisorMaterialNewsfeedAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.NewsfeedAdvisorMaterialDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.NewsfeedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Blogging/Newsfeed/Admin/AdvisorMaterial/File/{blobId}/download": { "get": { "tags": [ "Blogging/Newsfeed" ], "summary": "", "operationId": "NewsfeedAdmin_DownloadAdvisorMaterialFileAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "blobId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Blogging/Newsfeed/Admin/AdvisorMaterial/File/{newsfeedId}": { "get": { "tags": [ "Blogging/Newsfeed" ], "summary": "", "operationId": "NewsfeedAdmin_GetAdvisorMaterialFileAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newsfeedId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AdvisorBlob" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Blogging/Newsfeed/Admin/GetAllAdvisorPosts/{feedType}/{categoryId}/{subCategoryId}": { "get": { "tags": [ "Blogging/Newsfeed" ], "operationId": "NewsfeedAdmin_GetAllAdvisorPosts", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "feedType", "in": "path", "required": true, "type": "string", "default": 6, "enum": [ "Post", "Rss", "Notification", "Statement", "Webinar", "AdvisorMaterial" ] }, { "name": "categoryId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "subCategoryId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.NewsfeedDto" }, "xml": { "name": "NewsfeedDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Blogging/Newsfeed/Admin/Grid/Post": { "get": { "tags": [ "Blogging/Newsfeed" ], "summary": "Gets Newsfeed of type Post for grid display", "operationId": "NewsfeedAdmin_GetGridPost", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "includeEBN", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "includeStatements", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "audienceType", "in": "query", "required": false, "type": "string", "default": 1, "enum": [ "Clients", "Reps" ] }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.NewsfeedPostGridDto" }, "xml": { "name": "NewsfeedPostGridDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Blogging/Newsfeed/Admin/Grid/Rss": { "get": { "tags": [ "Blogging/Newsfeed" ], "summary": "Gets Newsfeed of type RSS for grid display", "operationId": "NewsfeedAdmin_GetGridRss", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "audienceType", "in": "query", "required": false, "type": "string", "default": 1, "enum": [ "Clients", "Reps" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.NewsfeedRssGridDto" }, "xml": { "name": "NewsfeedRssGridDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Blogging/Newsfeed/Admin/New": { "get": { "tags": [ "Blogging/Newsfeed" ], "summary": "Gets all blog objects for user", "operationId": "NewsfeedAdmin_GetNew", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "feedType", "in": "query", "description": "News feed type will default to Post if not entered.", "required": false, "type": "string", "default": 1, "enum": [ "Post", "Rss", "Notification", "Statement", "Webinar", "AdvisorMaterial" ] }, { "name": "audienceType", "in": "query", "description": "News feed audience type will default to Clients if not entered.", "required": false, "type": "string", "default": 1, "enum": [ "Clients", "Reps" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.NewsfeedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Blogging/Newsfeed/AdvisorMaterial": { "get": { "tags": [ "Blogging/Newsfeed" ], "summary": "Gets Newsfeed of type AdvisorMaterial for user display", "operationId": "Newsfeed_GetAdvisorMaterialAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true }, { "name": "startDate", "in": "query", "description": "Optional. Default:null", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default:null", "required": false, "type": "string", "format": "date-time" }, { "name": "repId", "in": "query", "description": "Optional. Default:null", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.NewsFeedCompilationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Blogging/Newsfeed/AdvisorMaterial/View": { "get": { "tags": [ "Blogging/Newsfeed" ], "summary": "Gets the viewable advisor material.", "operationId": "Newsfeed_GetViewableAdvisorMaterial", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true }, { "name": "fileId", "in": "query", "description": "The file identifier.", "required": true, "type": "integer", "format": "int32" }, { "name": "repId", "in": "query", "description": "The rep identifier.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Blogging/Newsfeed/Notification": { "get": { "tags": [ "Blogging/Newsfeed" ], "summary": "Gets Newsfeed of type Notification", "operationId": "Newsfeed_GetNotificationAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "token", "in": "header", "description": "The token.", "required": true }, { "name": "startDate", "in": "query", "description": "Optional. Default:null", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default:null", "required": false, "type": "string", "format": "date-time" }, { "name": "clientId", "in": "query", "description": "Optional. Default:null", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.NewsFeedCompilationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Blogging/Newsfeed/Notification/View": { "get": { "tags": [ "Blogging/Newsfeed" ], "summary": "Gets view of the Notification that was sent", "operationId": "Newsfeed_GetViewableNotificationAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true }, { "name": "instanceId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "clientId", "in": "query", "description": "Optional. Default:null", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Blogging/Newsfeed/Post": { "get": { "tags": [ "Blogging/Newsfeed" ], "summary": "Gets Newsfeed of type Post", "operationId": "Newsfeed_GetPostAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true }, { "name": "startDate", "in": "query", "description": "Optional. Default:null", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default:null", "required": false, "type": "string", "format": "date-time" }, { "name": "clientId", "in": "query", "description": "Optional. Default:null", "required": false, "type": "integer", "format": "int32" }, { "name": "repId", "in": "query", "description": "Optional. Default:null", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.NewsFeedCompilationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Blogging/Newsfeed/Rss": { "get": { "tags": [ "Blogging/Newsfeed" ], "summary": "Gets Newsfeed of type RSS for user display", "operationId": "Newsfeed_GetRssAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true }, { "name": "startDate", "in": "query", "description": "Optional. Default:null", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default:null", "required": false, "type": "string", "format": "date-time" }, { "name": "clientId", "in": "query", "description": "Optional. Default:null", "required": false, "type": "integer", "format": "int32" }, { "name": "repId", "in": "query", "description": "Optional. Default:null", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.NewsFeedCompilationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Blogging/Newsfeed/Statement": { "get": { "tags": [ "Blogging/Newsfeed" ], "summary": "Gets Newsfeed of type Statement", "operationId": "Newsfeed_GetStatementAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "token", "in": "header", "description": "The token.", "required": true }, { "name": "startDate", "in": "query", "description": "Optional. Default:null", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default:null", "required": false, "type": "string", "format": "date-time" }, { "name": "clientId", "in": "query", "description": "Optional. Default:null", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.NewsFeedCompilationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Blogging/Newsfeed/Statement/View": { "get": { "tags": [ "Blogging/Newsfeed" ], "summary": "Gets the viewable statement.", "operationId": "Newsfeed_GetViewableStatement", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true }, { "name": "fileId", "in": "query", "description": "The file identifier.", "required": true, "type": "integer", "format": "int32" }, { "name": "clientId", "in": "query", "description": "The client identifier.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Blogging/Newsfeed/Summary": { "get": { "tags": [ "Blogging/Newsfeed" ], "summary": "Gets counts of all Newsfeed types", "operationId": "Newsfeed_GetSummaryAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true }, { "name": "clientId", "in": "query", "description": "Optional. Default:null", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.NewsFeedTypeCountDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Blogging/Newsfeed/Webinar": { "get": { "tags": [ "Blogging/Newsfeed" ], "summary": "Gets Newsfeed of type Webinar for user display", "operationId": "Newsfeed_GetWebinarAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true }, { "name": "startDate", "in": "query", "description": "Optional. Default:null", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default:null", "required": false, "type": "string", "format": "date-time" }, { "name": "repId", "in": "query", "description": "Optional. Default:null", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.NewsFeedCompilationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Archive": { "get": { "tags": [ "Compliance/Archive" ], "summary": "Gets all report Pdf archive items.", "operationId": "ReportPdfArchive_GetAllAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.ReportPdfArchiveDto" }, "xml": { "name": "ReportPdfArchiveDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Compliance/Archive" ], "summary": "Gets all reportPdfArchive items.", "operationId": "ReportPdfArchive_CreateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "newDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.ReportPdfArchiveDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.ReportPdfArchiveDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Archive/{key}": { "put": { "tags": [ "Compliance/Archive" ], "summary": "Updates the properties of a {OAS.DataModel.Compliance.ReportPdfArchive} with the specified primary key, using the properties of the provided {OAS.WebApi.DTO.Compliance.ReportPdfArchiveDto}.", "operationId": "ReportPdfArchive_UpdateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.ReportPdfArchiveDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.ReportPdfArchiveDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Compliance/Archive" ], "summary": "Used to delete an existing report PDF Archive. Upon successful deletion a 204 will be returned.", "operationId": "ReportPdfArchive_DeleteEntityAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Archive/{key}/TestMetaData": { "get": { "tags": [ "Compliance/Archive" ], "summary": "Tests the metadata archive process by generating and directly downloading archive files for the specified date range and report PDF archive configuration.", "operationId": "ReportPdfArchive_TestMetaDataAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The ID of the report PDF archive configuration", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "description": "Start date for the metadata query", "required": true, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "End date for the metadata query", "required": true, "type": "string", "format": "date-time" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Archive/Test": { "put": { "tags": [ "Compliance/Archive" ], "summary": "Tests the upload target properties for a valid SFTP endpoint and credentials.", "operationId": "ReportPdfArchive_Test", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "testItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.ReportPdfArchiveDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Archive/Types": { "get": { "tags": [ "Compliance/Archive" ], "operationId": "ReportPdfArchive_GetTypes", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "properties": { "custom": { "type": "string" }, "lpl": { "type": "string" }, "sai": { "type": "string" } }, "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditRequests": { "post": { "tags": [ "Compliance/AuditRequests" ], "summary": "Create a new Audit Request", "operationId": "AuditRequests_PostV1ComplianceAuditRequests", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "newDto", "in": "body", "description": "Object to be created", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditRequestDto" } }, { "name": "ct", "in": "header", "description": "CancellationToken", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditRequestDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditRequests/{auditRequestId}/DownloadZipAttachments": { "get": { "tags": [ "Compliance/AuditRequests" ], "summary": "Download a single attachment", "operationId": "AuditRequests_GetAllAttachmentsZip", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "auditRequestId", "in": "path", "description": "Audit Request ID", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditRequests/{key}": { "get": { "tags": [ "Compliance/AuditRequests" ], "summary": "Get a audit request for a given key", "operationId": "AuditRequests_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditRequestDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Compliance/AuditRequests" ], "summary": "update a audit request record for the key given", "operationId": "AuditRequests_UpdateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "updateDto", "in": "body", "description": "Object to be updated", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditRequestDto" } }, { "name": "ct", "in": "header", "description": "cancellation token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditRequestDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Compliance/AuditRequests" ], "summary": "Delete an Audit request item and all attached records for a given key", "operationId": "AuditRequests_ActionDelete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditRequests/{key}/DataQuery": { "post": { "tags": [ "Compliance/AuditRequests" ], "summary": "Create a .csv attachment based on a data query", "operationId": "AuditRequests_GenerateDataQueryAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Audit Request item Query is being attached to", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "The custom report with paramaters to run.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportFullDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditRequests/{key}/Items": { "get": { "tags": [ "Compliance/AuditRequests" ], "summary": "Get a list of audit request items for a given audit request key", "operationId": "AuditRequests_GetList", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditRequestItemDto" }, "xml": { "name": "AuditRequestItemDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditRequests/DefaultCategories": { "get": { "tags": [ "Compliance/AuditRequests" ], "summary": "Get a list of audit request default item", "operationId": "AuditRequests_GetCategories", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditDefaultRequestCategoryDto" }, "xml": { "name": "AuditDefaultRequestCategoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Compliance/AuditRequests" ], "summary": "Update list of default request items", "operationId": "AuditRequests_UpdateDefaults", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "updateDto", "in": "body", "description": "List of AuditDefaultRequestCategoryDto", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditDefaultRequestCategoryDto" }, "xml": { "name": "AuditDefaultRequestCategoryDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditDefaultRequestCategoryDto" }, "xml": { "name": "AuditDefaultRequestCategoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditRequests/DefaultItem": { "get": { "tags": [ "Compliance/AuditRequests" ], "summary": "Get a list of audit request default item", "operationId": "AuditRequests_GetDefaultItem", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "query", "description": "Entity", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditDefaultRequestCategoryDto" }, "xml": { "name": "AuditDefaultRequestCategoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Compliance/AuditRequests" ], "summary": "Create a new audit request default item", "operationId": "AuditRequests_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newDto", "in": "body", "description": "Object to be created.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditDefaultRequestItemDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditDefaultRequestItemDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditRequests/DefaultItem/Test": { "get": { "tags": [ "Compliance/AuditRequests" ], "summary": "Get a list of audit request default item", "operationId": "AuditRequests_GetDefaultTestItem", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "query", "description": "Entity", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditDefaultRequestItemDto" }, "xml": { "name": "AuditDefaultRequestItemDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditRequests/DownloadRequestLetter/{key}": { "get": { "tags": [ "Compliance/AuditRequests" ], "summary": "Download the file loaded as the request letter", "operationId": "AuditRequests_GetRequestLetter", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditRequests/Item/{id}/DeleteAttachments": { "delete": { "tags": [ "Compliance/AuditRequests" ], "summary": "Delete a single attachment", "operationId": "AuditRequests_DeleteItemAttachment", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "description": "Audit Request Item Id", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditRequests/Items": { "put": { "tags": [ "Compliance/AuditRequests" ], "summary": "Takes a list of items and adds/updates as needed.", "operationId": "AuditRequests_UpdateItemListAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dtoList", "in": "body", "description": "Object to be created", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditRequestItemDto" }, "xml": { "name": "AuditRequestItemDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditRequestItemDto" }, "xml": { "name": "AuditRequestItemDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Compliance/AuditRequests" ], "summary": "Create a new audit request item, will execute stored procedures as defined on the items", "operationId": "AuditRequests_PostV1ComplianceAuditRequestsItems", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "newDto", "in": "body", "description": "Object to be created", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditRequestItemDto" } }, { "name": "ct", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditRequestItemDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditRequests/Items/{auditRequestItemId}/UploadAttachment": { "post": { "tags": [ "Compliance/AuditRequests" ], "summary": "Create a new audit reqeuest item attachment", "operationId": "AuditRequests_CreateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "auditRequestItemId", "in": "path", "description": "Key of the Request Audit item", "required": true, "type": "integer", "format": "int32" }, { "name": "newDto", "in": "body", "description": "Object to be created", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditRequestItemAttachmentDto" } }, { "name": "ct", "in": "header", "description": "Object to be created", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditRequestItemAttachmentDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditRequests/Items/{id}/DownloadZipAttachments": { "get": { "tags": [ "Compliance/AuditRequests" ], "summary": "Download a single attachment", "operationId": "AuditRequests_GetItemAttachmentsZip", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "description": "Audit Request Item ID", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditRequests/Items/{key}": { "get": { "tags": [ "Compliance/AuditRequests" ], "summary": "Get an audit request items for a given audit request key", "operationId": "AuditRequests_GetAuditItemEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditRequestItemDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Compliance/AuditRequests" ], "summary": "update an audit request item", "operationId": "AuditRequests_UpdateItemEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "updateDto", "in": "body", "description": "Object to be updated", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditRequestItemDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditRequestItemDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditRequests/Items/DownloadAttachment/{key}": { "get": { "tags": [ "Compliance/AuditRequests" ], "summary": "Download a single attachment", "operationId": "AuditRequests_GetAttachment", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key for the Blob Item Record", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditRequests/Summary": { "post": { "tags": [ "Compliance/AuditRequests" ], "summary": "Gets a list of audit requests that the logged in user has access to.", "operationId": "AuditRequests_GetAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "complianceFilters", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.ComplianceFilterDto" }, "xml": { "name": "ComplianceFilterDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditRequestDto" }, "xml": { "name": "AuditRequestDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditTests/{auditTestResultId}/ResultRows": { "get": { "tags": [ "Compliance/AuditTests" ], "summary": "Get a list of Result Rows by Restult Id", "operationId": "AuditTest_GetResultRowsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "auditTestResultId", "in": "path", "description": "Id of the result set", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditTests/{AuditTestResultId}/ResultRows/{cacheKey}": { "get": { "tags": [ "Compliance/AuditTests" ], "summary": "Retrieve the previously generated slick grid result.", "operationId": "AuditTest_GetResultRowsCached", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "AuditTestResultId", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "cacheKey", "in": "path", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditTests/{testResultId}/DownloadAllAttachments": { "get": { "tags": [ "Compliance/AuditTests" ], "summary": "Download All Attachments for the testResultId", "operationId": "AuditTest_DownloadAllAttachments", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "testResultId", "in": "path", "description": "BlobId", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditTests/{testResultRowId}/DownloadAttachments": { "get": { "tags": [ "Compliance/AuditTests" ], "summary": "Download a single attachment", "operationId": "AuditTest_DownloadAttachments", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "testResultRowId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditTests/ActiveSchedule": { "put": { "tags": [ "Compliance/AuditTests" ], "summary": "End a test schedule", "operationId": "AuditTest_ActiveScheduleAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "Schedule to be ended", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditTestScheduleDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditTestScheduleDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditTests/Categories": { "get": { "tags": [ "Compliance/AuditTests" ], "summary": "Get a list of categories\r\nOptional Filter Parameters", "operationId": "AuditTest_GetCategories", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "manage", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditTestCategoryDto" }, "xml": { "name": "AuditTestCategoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditTests/Category": { "put": { "tags": [ "Compliance/AuditTests" ], "summary": "Update category name item", "operationId": "AuditTest_UpdateCategories", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "list of categories", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditTestCategoryDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditTestCategoryDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditTests/Category/{key}": { "delete": { "tags": [ "Compliance/AuditTests" ], "summary": "Delete an test template item", "operationId": "AuditTest_DeleteCategory", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditTests/DefaultSchedule": { "post": { "tags": [ "Compliance/AuditTests" ], "summary": "Create a schedule based on a template", "operationId": "AuditTest_AddDefaultScheduleAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "templateId", "in": "query", "description": "The template identifier.", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true }, { "name": "dbId", "in": "query", "description": "The database identifier.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditTestScheduleDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditTests/EndSchedule": { "put": { "tags": [ "Compliance/AuditTests" ], "summary": "End a test schedule", "operationId": "AuditTest_EndScheduleAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "Schedule to be ended", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditTestScheduleDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditTestScheduleDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditTests/Result/Completed/{isCompleted}": { "put": { "tags": [ "Compliance/AuditTests" ], "summary": "Set Archive Flag on Restult Record", "operationId": "AuditTest_Archive", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "list", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Compliance.AuditTestController.CompletedListDto" } }, { "name": "isCompleted", "in": "path", "required": true, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditTests/ResultRow": { "put": { "tags": [ "Compliance/AuditTests" ], "summary": "Update a single Row Details", "operationId": "AuditTest_UpdateRowAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "Object to be updated", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditTestResultRowDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditTestResultRowDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditTests/ResultRow/{auditTestResultRowId}/DeleteAttachment/{blobId}": { "delete": { "tags": [ "Compliance/AuditTests" ], "summary": "Delete a single attachment", "operationId": "AuditTest_DeleteItemAttachment", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "auditTestResultRowId", "in": "path", "description": "Audit test restult row id", "required": true, "type": "integer", "format": "int32" }, { "name": "blobId", "in": "path", "description": "Blob Id", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditTests/ResultRow/{id}": { "get": { "tags": [ "Compliance/AuditTests" ], "summary": "Get a single result record by id", "operationId": "AuditTest_GetResultRow", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "description": "Id of the result set", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditTestResultRowDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditTests/ResultRow/Action/Update/{reviewed}": { "put": { "tags": [ "Compliance/AuditTests" ], "operationId": "AuditTest_UpdateRows", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reviewed", "in": "path", "required": true, "type": "boolean" }, { "name": "auditTestResultRowIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditTestResultRowDto" }, "xml": { "name": "AuditTestResultRowDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditTests/ResultRow/Action/Update/Comment": { "put": { "tags": [ "Compliance/AuditTests" ], "operationId": "AuditTest_PutV1ComplianceAuditTestsResultRowActionUpdateComment", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "auditTestResultRowIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "comment", "in": "query", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Compliance.AuditTestResultRow" }, "xml": { "name": "AuditTestResultRow", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditTests/ResultRow/Action/Update/Exception/{isException}": { "put": { "tags": [ "Compliance/AuditTests" ], "operationId": "AuditTest_UpdateRowsAsExceptions", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "isException", "in": "path", "required": true, "type": "boolean" }, { "name": "auditTestResultRowIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditTestResultRowDto" }, "xml": { "name": "AuditTestResultRowDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditTests/ResultRow/CommentHistory/{key}": { "get": { "tags": [ "Compliance/AuditTests" ], "summary": "Get a list of comment history for result row", "operationId": "AuditTest_GetResultRowCommentHistory", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Id of the result set", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Compliance.AuditTestResultCommentHistory" }, "xml": { "name": "AuditTestResultCommentHistory", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditTests/ResultRow/Exceptions": { "get": { "tags": [ "Compliance/AuditTests" ], "summary": "Gets the exception result rows.", "operationId": "AuditTest_GetExceptionResultRowsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "complianceFilterDtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.ComplianceFilterDto" }, "xml": { "name": "ComplianceFilterDto", "wrapped": true }, "type": "array" } }, { "name": "token", "in": "header", "required": true }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditTestExceptionResultRowDto" }, "xml": { "name": "AuditTestExceptionResultRowDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditTests/Results": { "post": { "tags": [ "Compliance/AuditTests" ], "summary": "Populate the Slick Grid\r\nOptional Filter Parameters", "operationId": "AuditTest_GetAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "complianceFilterDtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.ComplianceFilterDto" }, "xml": { "name": "ComplianceFilterDto", "wrapped": true }, "type": "array" } }, { "name": "token", "in": "header", "required": true }, { "name": "completed", "in": "query", "required": false, "type": "boolean" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditTestResultDto" }, "xml": { "name": "AuditTestResultDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditTests/Results/{auditTestResultId}": { "get": { "tags": [ "Compliance/AuditTests" ], "summary": "Get a single Result for breadcrumb\r\nOptional Filter Parameters", "operationId": "AuditTest_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "auditTestResultId", "in": "path", "description": "id of results to be returned", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditTestResultDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Compliance/AuditTests" ], "summary": "Update a single result record", "operationId": "AuditTest_UpdateResult", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "Object to be Updated", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditTestResultDto" } }, { "name": "auditTestResultId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditTestResultDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditTests/RunTest": { "post": { "tags": [ "Compliance/AuditTests" ], "summary": "Update a schedule", "operationId": "AuditTest_RunTestAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "Object to be added", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditTestScheduleDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditTestResultDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditTests/Schedule": { "put": { "tags": [ "Compliance/AuditTests" ], "summary": "Update a schedule", "operationId": "AuditTest_UpdateScheduleAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "Object to be updated", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditTestScheduleDto" } }, { "name": "token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditTestScheduleDto" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Compliance/AuditTests" ], "summary": "Update a schedule", "operationId": "AuditTest_AddScheduleAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "Object to be added", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditTestScheduleDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditTestScheduleDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditTests/Schedules": { "post": { "tags": [ "Compliance/AuditTests" ], "summary": "Get a list of schedules", "operationId": "AuditTest_GetSchedulesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "complianceFilterDto", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.ComplianceFilterDto" }, "xml": { "name": "ComplianceFilterDto", "wrapped": true }, "type": "array" } }, { "name": "isActive", "in": "query", "required": true, "type": "boolean" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditTestScheduleDto" }, "xml": { "name": "AuditTestScheduleDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditTests/Template": { "post": { "tags": [ "Compliance/AuditTests" ], "summary": "Create new test template", "operationId": "AuditTest_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newDto", "in": "body", "description": "Object to be created", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditTestTemplateDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditTestTemplateDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditTests/Template/{key}": { "get": { "tags": [ "Compliance/AuditTests" ], "summary": "Get a specific template by id", "operationId": "AuditTest_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditTestTemplateDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Compliance/AuditTests" ], "summary": "Update test template", "operationId": "AuditTest_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "updateDto", "in": "body", "description": "Object to be updated", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditTestTemplateDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditTestTemplateDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Compliance/AuditTests" ], "summary": "Delete an test template item", "operationId": "AuditTest_ActionDelete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/AuditTests/Templates/List": { "post": { "tags": [ "Compliance/AuditTests" ], "summary": "List of all templates", "operationId": "AuditTest_GetTemplates", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "complianceFilterDtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.ComplianceFilterDto" }, "xml": { "name": "ComplianceFilterDto", "wrapped": true }, "type": "array" } }, { "name": "entity", "in": "query", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "categoryId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditTestTemplateDto" }, "xml": { "name": "AuditTestTemplateDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Bcc/Accounts": { "get": { "tags": [ "Compliance/Bcc" ], "operationId": "Bcc_GetAccountsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "sources", "in": "query", "required": false, "items": { "type": "string", "enum": [ "Unknown", "Quovo", "Retirement", "OrionConnect", "Plaid", "ByAll" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "openOnly", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformAccountForBccDto" }, "xml": { "name": "InformAccountForBccDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Bcc/Consultants": { "get": { "tags": [ "Compliance/Bcc" ], "summary": "Gets a list of consultants.", "description": "GET /Compliance/Bcc/Consultants", "operationId": "Bcc_GetConsultantsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Bcc/Consultants/Email": { "post": { "tags": [ "Compliance/Bcc" ], "summary": "Sends consultants emails.", "description": "POST /Compliance/Bcc/Consultants/Email\r\n{\r\n \"name\": \"Abc User\",\r\n \"email\" \"abc@testcompany.com\",\r\n \"company\" \"Test Company\",\r\n \"consultantIds\": [123],\r\n \"comment\" : \"Test Comment\"\r\n}", "operationId": "Bcc_SendConsultantsEmailAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "model", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Compliance.NotifyConsultantsModel" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Bcc/Holdings": { "get": { "tags": [ "Compliance/Bcc" ], "operationId": "Bcc_GetHoldingsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isActiveAccessPerson", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "startAsOfDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endAsOfDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "startEditDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endEditDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformHoldingForBccDto" }, "xml": { "name": "InformHoldingForBccDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Bcc/Households/Representatives": { "post": { "tags": [ "Compliance/Bcc" ], "operationId": "Bcc_GetRepresentativesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "model", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Compliance.GetRepresentativesModel" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Bcc/Integration/Redirect": { "get": { "tags": [ "Compliance/Bcc" ], "summary": "Redirects a user to a page in the OC web application.", "description": "GET /Compliance/Bcc/Integration/Redirect", "operationId": "Bcc_RedirectAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "p", "in": "query", "description": "The page to redirect to.", "required": true, "type": "string" }, { "name": "ct", "in": "header", "description": "A token used to cancel the current process.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Bcc/Platforms/Simple": { "get": { "tags": [ "Compliance/Bcc" ], "summary": "Gets a simple list of platforms that the logged in user has access to.", "operationId": "Bcc_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isActive", "in": "query", "description": "Optional. When provided will only return platforms that are active (true) or aren't active (false).", "required": false, "type": "boolean" }, { "name": "riaId", "in": "query", "description": "Optional. When provided will only return platforms that are associated to accounts under this riaId.", "required": false, "type": "integer", "format": "int32" }, { "name": "brokerDealerId", "in": "query", "description": "Optional. When provided will only return platforms that are associated to accounts under this brokerDealerId.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Bcc/Transactions": { "get": { "tags": [ "Compliance/Bcc" ], "operationId": "Bcc_GetTransactionsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isActiveAccessPerson", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "startTransDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endTransDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "startEditDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endEditDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformTransactionForBccDto" }, "xml": { "name": "InformTransactionForBccDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Bcc/Users": { "get": { "tags": [ "Compliance/Bcc" ], "operationId": "Bcc_GetUsersAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isActiveAccessPerson", "in": "query", "required": false, "type": "boolean" }, { "name": "isActiveOcUser", "in": "query", "required": false, "type": "boolean" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformUserForBccDto" }, "xml": { "name": "InformUserForBccDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Bcc/UsersByRiaOrBrokerDealer": { "get": { "tags": [ "Compliance/Bcc" ], "summary": "BCC needs search results of users who are associated with an RIA or BrokerDealer Id when selecting users\r\nfor a One2Many client.", "operationId": "Bcc_GetUsersByRiaOrBrokerDealer", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "userid", "in": "query", "required": false, "type": "string" }, { "name": "email", "in": "query", "required": false, "type": "string" }, { "name": "lastname", "in": "query", "required": false, "type": "string" }, { "name": "firstname", "in": "query", "required": false, "type": "string" }, { "name": "riaId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "brokerDealerId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.UserInfoDetailsDto" }, "xml": { "name": "UserInfoDetailsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Dashboard/Inform": { "get": { "tags": [ "Compliance/Dashboard" ], "summary": "Populate the Inform Widget on the Compliance Dashboard", "operationId": "CompassDashboard_GetCompassInform", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.CompassDashboardInformDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Dashboard/OpenAudits": { "post": { "tags": [ "Compliance/Dashboard" ], "summary": "Populate the Verify Widget on the Compliance Dashboard", "operationId": "CompassDashboard_GetOpenAuditsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "complianceFilter", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.ComplianceFilterDto" }, "xml": { "name": "ComplianceFilterDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.CompassDashboardWidgetDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Dashboard/OpenLexisNexis": { "post": { "tags": [ "Compliance/Dashboard" ], "summary": "Populate the Verify Widget on the Compliance Dashboard", "operationId": "CompassDashboard_GetLexisNexisAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "complianceFilterDtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.ComplianceFilterDto" }, "xml": { "name": "ComplianceFilterDto", "wrapped": true }, "type": "array" } }, { "name": "token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.CompassDashboardVerifyDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Dashboard/OpenTests": { "post": { "tags": [ "Compliance/Dashboard" ], "summary": "Populate Supervise on the Compliance Dashboard", "operationId": "CompassDashboard_GetOpenTestsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "complianceFilter", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.ComplianceFilterDto" }, "xml": { "name": "ComplianceFilterDto", "wrapped": true }, "type": "array" } }, { "name": "token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.CompassDashboardTestsDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Disclose/{type}/{asOfDate}": { "post": { "tags": [ "Compliance/Disclose" ], "summary": "Populate ADV/AUM Tiles by type on Disclose Dashboard", "description": "POST /Compliance/Disclose/ByClientCategory/8-8-2023\r\n[{\r\n \"label\": \"RIA\",\r\n \"selected\": [\"test\"],\r\n \"entity\": 17,\r\n \"searchText\": null,\r\n \"hideSection\": false,\r\n \"exclude\": false\r\n}]", "operationId": "Disclose_GetAdvAumByTypeAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "type", "in": "path", "required": true, "type": "string", "enum": [ "None", "Domestic", "Discretionary", "Custodian", "ByAssetCategory", "ByClientCategory", "WrapManaged", "AdvAum", "Filing13F", "FormReport13F", "AuaAum", "AuaProducts", "AdvSloa", "AdvCustody", "AuaCustodian" ] }, { "name": "asOfDate", "in": "path", "description": "Used to filter data by a specific date", "required": true, "type": "string", "format": "date-time" }, { "name": "complianceFilterDtos", "in": "body", "description": "Various additional filters with toggles for exclude/include", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.ComplianceFilterDto" }, "xml": { "name": "ComplianceFilterDto", "wrapped": true }, "type": "array" } }, { "name": "isSubClient", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "restrictDatabaseSelectionWhenImpersonating", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.DisclosDashboardEntityDto" }, "xml": { "name": "DisclosDashboardEntityDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Disclose/{type}/{asOfDate}/Detail": { "post": { "tags": [ "Compliance/Disclose" ], "summary": "Detail Result by Type", "description": "POST /Compliance/Disclose/ByCustodian/8-8-2023/Detail\r\n[{\r\n \"label\": \"RIA\",\r\n \"selected\": [\"test\"],\r\n \"entity\": 17,\r\n \"searchText\": null,\r\n \"hideSection\": false,\r\n \"exclude\": false\r\n}]", "operationId": "Disclose_GetDetailAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "type", "in": "path", "description": "DiscloseAdvTypeEnum", "required": true, "type": "string", "enum": [ "None", "Domestic", "Discretionary", "Custodian", "ByAssetCategory", "ByClientCategory", "WrapManaged", "AdvAum", "Filing13F", "FormReport13F", "AuaAum", "AuaProducts", "AdvSloa", "AdvCustody", "AuaCustodian" ] }, { "name": "asOfDate", "in": "path", "description": "Used to filter data by a specific date", "required": true, "type": "string" }, { "name": "complianceFilterDtos", "in": "body", "description": "Various additional filters with toggles for exclude/include", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.ComplianceFilterDto" }, "xml": { "name": "ComplianceFilterDto", "wrapped": true }, "type": "array" } }, { "name": "isSubClient", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Disclose/{type}/{asOfDate}/Detail/{cacheKey}": { "get": { "tags": [ "Compliance/Disclose" ], "summary": "Retrieve the previously generated slick grid result.", "description": "GET /Compliance/Disclose/ByClientCategory/8-8-2023/Detail/{cacheKey:guid}", "operationId": "Disclose_GetV1ComplianceDiscloseByTypeByAsOfDateDetailByCacheKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "type", "in": "path", "description": "DiscloseAdvTypeEnum", "required": true, "type": "string", "enum": [ "None", "Domestic", "Discretionary", "Custodian", "ByAssetCategory", "ByClientCategory", "WrapManaged", "AdvAum", "Filing13F", "FormReport13F", "AuaAum", "AuaProducts", "AdvSloa", "AdvCustody", "AuaCustodian" ] }, { "name": "asOfDate", "in": "path", "description": "Used to filter data by a specific date", "required": true, "type": "string" }, { "name": "cacheKey", "in": "path", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Disclose/13f/FormReportSummary/{asOfDate}": { "post": { "tags": [ "Compliance/Disclose" ], "summary": "Gets the 13f summary report asynchronous.", "description": "POST /Compliance/Disclose/13f/FormReportSummary/8-8-2023\r\n[{\r\n \"label\": \"RIA\",\r\n \"selected\": [\"test\"],\r\n \"entity\": 17,\r\n \"searchText\": null,\r\n \"hideSection\": false,\r\n \"exclude\": false\r\n}]", "operationId": "Disclose_Get13FSummaryReportTileAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "Used to filter data by a specific date", "required": true, "type": "string", "format": "date-time" }, { "name": "complianceFilterDtos", "in": "body", "description": "Various additional filters with toggles for exclude/include", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.ComplianceFilterDto" }, "xml": { "name": "ComplianceFilterDto", "wrapped": true }, "type": "array" } }, { "name": "isSubClient", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.Disclose13FSummaryReportDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Disclose/13f/InformationSummary/{asOfDate}": { "post": { "tags": [ "Compliance/Disclose" ], "summary": "Populate the 13F Filing Requirements Tile", "description": "POST /Compliance/Disclose/13f/InformationSummary/8-8-2023\r\n[{\r\n \"label\": \"RIA\",\r\n \"selected\": [\"test\"],\r\n \"entity\": 17,\r\n \"searchText\": null,\r\n \"hideSection\": false,\r\n \"exclude\": false\r\n}]", "operationId": "Disclose_GetAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "Used to filter data by a specific date", "required": true, "type": "string", "format": "date-time" }, { "name": "complianceFilterDtos", "in": "body", "description": "Various additional filters with toggles for exclude/include", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.ComplianceFilterDto" }, "xml": { "name": "ComplianceFilterDto", "wrapped": true }, "type": "array" } }, { "name": "isSubClient", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.Disclose13FDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Disclose/AdvCategories/AssetCategories": { "get": { "tags": [ "Compliance/Disclose" ], "operationId": "Disclose_GetAdvAssetCategories", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AdvAssetCategoryDto" }, "xml": { "name": "AdvAssetCategoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Disclose/AdvCategories/ClientCategories": { "get": { "tags": [ "Compliance/Disclose" ], "operationId": "Disclose_GetAdvClientCategories", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AdvClientCategoryDto" }, "xml": { "name": "AdvClientCategoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Disclose/AdvCategories/ResetAdvAssetCategories": { "put": { "tags": [ "Compliance/Disclose" ], "operationId": "Disclose_UpdateAdvAssetCategoriesAsync", "consumes": [], "produces": [], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Disclose/ADVConsolidated/Detail/{asOfDate}": { "post": { "tags": [ "Compliance/Disclose" ], "summary": "Populate ADV Consolidated Tile on Disclose Dashboard", "description": "POST /Compliance/Disclose/ADVConsolidated/Detail/8-8-2023?resetCache=true\r\n[{\r\n \"label\": \"RIA\",\r\n \"selected\": [\"test\"],\r\n \"entity\": 17,\r\n \"searchText\": null,\r\n \"hideSection\": false,\r\n \"exclude\": false\r\n}]", "operationId": "Disclose_GetADVConsolidatedAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "Used to filter data by a specific date", "required": true, "type": "string", "format": "date-time" }, { "name": "resetCache", "in": "query", "description": "Bool to determine if to reset ADV Cache", "required": true, "type": "boolean" }, { "name": "complianceFilterDtos", "in": "body", "description": "Various additional filters with toggles for exclude/include", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.ComplianceFilterDto" }, "xml": { "name": "ComplianceFilterDto", "wrapped": true }, "type": "array" } }, { "name": "isSubClient", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataProcess.DTO.Compliance.ADVConsolidatedDetailDto" }, "xml": { "name": "ADVConsolidatedDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Disclose/AdvCustody/{asOfDate}": { "post": { "tags": [ "Compliance/Disclose" ], "summary": "Gets Adv Custody Tile data", "description": "POST /Compliance/Disclose/AdvCustody/8-8-2023\r\n[{\r\n \"label\": \"RIA\",\r\n \"selected\": [\"test\"],\r\n \"entity\": 17,\r\n \"searchText\": null,\r\n \"hideSection\": false,\r\n \"exclude\": false\r\n}]", "operationId": "Disclose_GetAdvCustodyAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "Used to filter data by a specific date", "required": true, "type": "string", "format": "date-time" }, { "name": "complianceFilterDtos", "in": "body", "description": "Various additional filters with toggles for exclude/include", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.ComplianceFilterDto" }, "xml": { "name": "ComplianceFilterDto", "wrapped": true }, "type": "array" } }, { "name": "isSubClient", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "restrictDatabaseSelectionWhenImpersonating", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.DiscloseAdvCustodyDto" }, "xml": { "name": "DiscloseAdvCustodyDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Disclose/AdvCustodyTypes": { "get": { "tags": [ "Compliance/Disclose" ], "summary": "Gets Custody Types for Adv", "description": "GET /Compliance/Disclose/AdvCustodyTypes", "operationId": "Disclose_GetAdvCustodyTypesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Disclose/AdvSloa/{asOfDate}": { "post": { "tags": [ "Compliance/Disclose" ], "summary": "Gets Adv Sloa Tile data", "description": "POST /Compliance/Disclose/AdvSloa/8-8-2023\r\n[{\r\n \"label\": \"RIA\",\r\n \"selected\": [\"test\"],\r\n \"entity\": 17,\r\n \"searchText\": null,\r\n \"hideSection\": false,\r\n \"exclude\": false\r\n}]", "operationId": "Disclose_GetAdvSloaAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "Used to filter data by a specific date", "required": true, "type": "string", "format": "date-time" }, { "name": "complianceFilterDtos", "in": "body", "description": "Various additional filters with toggles for exclude/include", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.ComplianceFilterDto" }, "xml": { "name": "ComplianceFilterDto", "wrapped": true }, "type": "array" } }, { "name": "isSubClient", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "restrictDatabaseSelectionWhenImpersonating", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.DiscloseAdvSloaDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Disclose/AUA/{asOfDate}": { "post": { "tags": [ "Compliance/Disclose" ], "summary": "Populate ADV AUM Tile on Disclose Dashboard", "description": "POST /Compliance/Disclose/AUA/8-8-2023\r\n[{\r\n \"label\": \"RIA\",\r\n \"selected\": [\"test\"],\r\n \"entity\": 17,\r\n \"searchText\": null,\r\n \"hideSection\": false,\r\n \"exclude\": false\r\n}]", "operationId": "Disclose_GetAuaAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "Used to filter data by a specific date", "required": true, "type": "string", "format": "date-time" }, { "name": "complianceFilterDtos", "in": "body", "description": "Various additional filters with toggles for exclude/include", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.ComplianceFilterDto" }, "xml": { "name": "ComplianceFilterDto", "wrapped": true }, "type": "array" } }, { "name": "isSubClient", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.DiscloseAuaAumDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Disclose/AUAProducts/{asOfDate}": { "post": { "tags": [ "Compliance/Disclose" ], "summary": "Populate AUA Products Tile on Disclose Dashboard", "description": "POST /Compliance/Disclose/AUAProducts/8-8-2023\r\n[{\r\n \"label\": \"RIA\",\r\n \"selected\": [\"test\"],\r\n \"entity\": 17,\r\n \"searchText\": null,\r\n \"hideSection\": false,\r\n \"exclude\": false\r\n}]", "operationId": "Disclose_GetAuaProductsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "Used to filter data by a specific date", "required": true, "type": "string", "format": "date-time" }, { "name": "complianceFilterDtos", "in": "body", "description": "Various additional filters with toggles for exclude/include", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.ComplianceFilterDto" }, "xml": { "name": "ComplianceFilterDto", "wrapped": true }, "type": "array" } }, { "name": "isSubClient", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.DiscloseAuaProductDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Disclose/AUM/{asOfDate}": { "post": { "tags": [ "Compliance/Disclose" ], "summary": "Populate ADV AUM Tile on Disclose Dashboard", "description": "POST /Compliance/Disclose/AUM/8-8-2023\r\n[{\r\n \"label\": \"RIA\",\r\n \"selected\": [\"test\"],\r\n \"entity\": 17,\r\n \"searchText\": null,\r\n \"hideSection\": false,\r\n \"exclude\": false\r\n}]", "operationId": "Disclose_GetAumAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "Used to filter data by a specific date", "required": true, "type": "string", "format": "date-time" }, { "name": "complianceFilterDtos", "in": "body", "description": "Various additional filters with toggles for exclude/include", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.ComplianceFilterDto" }, "xml": { "name": "ComplianceFilterDto", "wrapped": true }, "type": "array" } }, { "name": "isSubClient", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "restrictDatabaseSelectionWhenImpersonating", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.DiscloseAdvAumDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Disclose/Detail/{type}": { "put": { "tags": [ "Compliance/Disclose" ], "summary": "Update Account Status", "description": "PUT /Compliance/Disclose/Detail/AuaAum\r\n{\r\n \"AlClientId\": 493,\r\n \"Ids\": [1, 2],\r\n \"Field\": \"Test\",\r\n \"Value\": \"Value Test\",\r\n \"AsOfDate\": \"8-8-2023\"\r\n }", "operationId": "Disclose_MassUpdateValuesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "type", "in": "path", "required": true, "type": "string", "enum": [ "None", "Domestic", "Discretionary", "Custodian", "ByAssetCategory", "ByClientCategory", "WrapManaged", "AdvAum", "Filing13F", "FormReport13F", "AuaAum", "AuaProducts", "AdvSloa", "AdvCustody", "AuaCustodian" ] }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Compliance.DiscloseController.AdvDetailUpdateDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Disclose/Discretionary/{asOfDate}": { "post": { "tags": [ "Compliance/Disclose" ], "summary": "Populate ADV Discretionary Tile on Disclose Dashboard", "description": "POST /Compliance/Disclose/Discretionary/8-8-2023\r\n[{\r\n \"label\": \"RIA\",\r\n \"selected\": [\"test\"],\r\n \"entity\": 17,\r\n \"searchText\": null,\r\n \"hideSection\": false,\r\n \"exclude\": false\r\n}]", "operationId": "Disclose_GetAdvDiscretionaryAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "Used to filter data by a specific date", "required": true, "type": "string", "format": "date-time" }, { "name": "complianceFilterDtos", "in": "body", "description": "Various additional filters with toggles for exclude/include", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.ComplianceFilterDto" }, "xml": { "name": "ComplianceFilterDto", "wrapped": true }, "type": "array" } }, { "name": "isSubClient", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "restrictDatabaseSelectionWhenImpersonating", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.DisclosDashboardEntityDto" }, "xml": { "name": "DisclosDashboardEntityDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Disclose/Domestic/{asOfDate}": { "post": { "tags": [ "Compliance/Disclose" ], "summary": "Populate ADV Domestic vs Foreign Tile on Disclose Dashboard", "description": "POST /Compliance/Disclose/Domestic/8-8-2023\r\n[{\r\n \"label\": \"RIA\",\r\n \"selected\": [\"test\"],\r\n \"entity\": 17,\r\n \"searchText\": null,\r\n \"hideSection\": false,\r\n \"exclude\": false\r\n}]", "operationId": "Disclose_GetAdvDomesticAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "Used to filter data by a specific date", "required": true, "type": "string", "format": "date-time" }, { "name": "complianceFilterDtos", "in": "body", "description": "Various additional filters with toggles for exclude/include", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.ComplianceFilterDto" }, "xml": { "name": "ComplianceFilterDto", "wrapped": true }, "type": "array" } }, { "name": "isSubClient", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "restrictDatabaseSelectionWhenImpersonating", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.DisclosDashboardEntityDto" }, "xml": { "name": "DisclosDashboardEntityDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Disclose/FormReport13F/{asOfDate}/XML": { "post": { "tags": [ "Compliance/Disclose" ], "summary": "13F Reporting XML Output.", "description": "POST /Compliance/Disclose/FormReport13F/8-8-2023/XML", "operationId": "Disclose_Get13fXml", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "Used to filter data by a specific date", "required": true, "type": "string" }, { "name": "complianceFilterDtos", "in": "body", "description": "Various additional filters with toggles for exclude/include", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.ComplianceFilterDto" }, "xml": { "name": "ComplianceFilterDto", "wrapped": true }, "type": "array" } }, { "name": "isSubClient", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Disclose/NeedEmployeeHouseholdsBanner": { "get": { "tags": [ "Compliance/Disclose" ], "summary": "Checks if user has access to Employee Households", "description": "GET /Compliance/Disclose/NeedEmployeeHouseholdsBanner", "operationId": "Disclose_NeedEmployeeHouseholdsBanner", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Disclose/UserAdvFilters": { "post": { "tags": [ "Compliance/Disclose" ], "summary": "Update Adv or Aua Filter Settings from Compliance", "description": "POST /Compliance/Disclose/UserAdvFilters\r\n[{\r\n \"Entity\": 16,\r\n \"Exclude\": false\r\n \"HideSelection\": false,\r\n \"SearchText\": null,\r\n \"Selected\": [\"Aggressive\"],\r\n \"SelectedDatabases\": []\r\n }]", "operationId": "Disclose_SaveUserAdvFiltersAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "filters", "in": "body", "required": true, "schema": { "type": "object" } }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Disclose/WrapManaged/{asOfDate}": { "post": { "tags": [ "Compliance/Disclose" ], "summary": "Populate ADV Wrap Managed Tile on Disclose Dashboard", "description": "POST /Compliance/Disclose/WrapManaged/8-8-2023\r\n[{\r\n \"label\": \"RIA\",\r\n \"selected\": [\"test\"],\r\n \"entity\": 17,\r\n \"searchText\": null,\r\n \"hideSection\": false,\r\n \"exclude\": false\r\n}]", "operationId": "Disclose_GetAdvWrapManagedAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "Used to filter data by a specific date", "required": true, "type": "string", "format": "date-time" }, { "name": "complianceFilterDtos", "in": "body", "description": "Various additional filters with toggles for exclude/include", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.ComplianceFilterDto" }, "xml": { "name": "ComplianceFilterDto", "wrapped": true }, "type": "array" } }, { "name": "isSubClient", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "restrictDatabaseSelectionWhenImpersonating", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.DisclosDashboardEntityDto" }, "xml": { "name": "DisclosDashboardEntityDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Filter/{type}/{searchText}": { "post": { "tags": [ "Compliance/Filter" ], "summary": "List of Filter Choices by", "operationId": "ComplianceFilter_GetFilterListAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "type", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "searchText", "in": "path", "required": true, "type": "string" }, { "name": "complianceFilterDtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.ComplianceFilterDto" }, "xml": { "name": "ComplianceFilterDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/AccessPerson/{accessPersonId}/Connection/{connectionId}": { "delete": { "tags": [ "Compliance/Inform" ], "summary": "Deletes the connection asynchronous.", "operationId": "Inform_DeleteConnectionWithNoAccountsAsync", "consumes": [], "produces": [], "parameters": [ { "name": "accessPersonId", "in": "path", "description": "The access person identifier.", "required": true, "type": "integer", "format": "int32" }, { "name": "connectionId", "in": "path", "description": "The connection identifier.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/AccessPerson/{isActive}": { "put": { "tags": [ "Compliance/Inform" ], "summary": "Update Access person status", "operationId": "Inform_AccessPersonsActive", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isActive", "in": "path", "required": true, "type": "boolean" }, { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Compliance/Inform" ], "summary": "Creates new Access Person Records with status provided", "operationId": "Inform_NewAccessPersons", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isActive", "in": "path", "required": true, "type": "boolean" }, { "name": "userDetailIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/AccessPerson/{key}": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns Access Person Details", "operationId": "Inform_GetAccessPerson", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "userDtlId of the access person", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformAccessPersonDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Compliance/Inform" ], "summary": "Update access person details", "operationId": "Inform_UpdateAccessPerson", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformAccessPersonDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformAccessPersonDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/AccessPerson/{key}/CloseAll": { "post": { "tags": [ "Compliance/Inform" ], "summary": "Closes all access person asynchronous.", "operationId": "Inform_CloseAllAccessPersonAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The key.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformAccessPersonDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/AccessPerson/{key}/Preclearances/CloseAll": { "put": { "tags": [ "Compliance/Inform" ], "summary": "Closes all access person preclearances asynchronous.", "operationId": "Inform_CloseAllAccessPersonPreclearancesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The key.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformPreClearanceDto" }, "xml": { "name": "InformPreClearanceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/AccessPerson/BrokenConnections": { "post": { "tags": [ "Compliance/Inform" ], "operationId": "Inform_InformBrokenConnectionEmailsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/AccessPerson/CurrentUser": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns Access Person Details", "operationId": "Inform_GetV1ComplianceInformAccessPersonCurrentUser", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformAccessPersonDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/AccessPerson/Email/{type}": { "post": { "tags": [ "Compliance/Inform" ], "summary": "Sends Email sand generates access person documents based on the list of users provided", "operationId": "Inform_EmailAccessPerson", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "type", "in": "path", "required": true, "type": "string", "enum": [ "Task", "Questionnaire", "PreClearance", "BrokerageAccount", "TradeViolation", "AccessPerson", "AccessPersonNew", "AccessPersonInactive", "AccessPersonAll", "DuplicateAccessPerson", "TaskWithMultiple" ] }, { "name": "dtoList", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.SentEmailDto" }, "xml": { "name": "SentEmailDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.SentEmailDto" }, "xml": { "name": "SentEmailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/AccessPerson/MergeProfilesInDatabase": { "put": { "tags": [ "Compliance/Inform" ], "summary": "Run Trade Rules", "operationId": "Inform_MergeAccessPersonFromProfilesOnSameDatabase", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "profileIdFrom", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "profileIdTo", "in": "query", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Compliance.AccessPerson" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/AccessPerson/NewInformAccountsEmail": { "post": { "tags": [ "Compliance/Inform" ], "operationId": "Inform_InformNewAccountsEmailsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/AccessPerson/V2/Holdings": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns a list of the holdings for the access person", "operationId": "Inform_GetAccessPersonHoldingsV2", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accessPersonId", "in": "query", "description": "if not provided will return for the current user", "required": false, "type": "integer", "format": "int32" }, { "name": "allAccessPersons", "in": "query", "description": "All access persons.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformHoldingDto" }, "xml": { "name": "InformHoldingDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/AccessPerson/V2/Trades": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns a combined list of Pre-Clearance and Transactions", "operationId": "Inform_GetAccessPersonTrades", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accessPersonId", "in": "query", "description": "The access person identifier.", "required": false, "type": "integer", "format": "int32" }, { "name": "allTrades", "in": "query", "description": "All trades.", "required": false, "type": "boolean", "default": false }, { "name": "startDate", "in": "query", "description": "The start date.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "The end date.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformTradeHistoryDto" }, "xml": { "name": "InformTradeHistoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/AccessPerson/V2/Transactions": { "get": { "tags": [ "Compliance/Inform" ], "operationId": "Inform_GetAccessPersonTransactions", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "accessPersonId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformTransactionDto" }, "xml": { "name": "InformTransactionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/AccessPerson/V2/Users/{accessPersonId}": { "get": { "tags": [ "Compliance/Inform" ], "operationId": "Inform_GetInformUsersV2", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accessPersonId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Compliance.InformUser" }, "xml": { "name": "InformUser", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/AccessPersons/{type}": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns a list of access person records based on the type", "operationId": "Inform_GetAccessPersons", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "type", "in": "path", "required": true, "type": "string", "enum": [ "Task", "Questionnaire", "PreClearance", "BrokerageAccount", "TradeViolation", "AccessPerson", "AccessPersonNew", "AccessPersonInactive", "AccessPersonAll", "DuplicateAccessPerson", "TaskWithMultiple" ] }, { "name": "templateId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "isActive", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformAccessPersonDto" }, "xml": { "name": "InformAccessPersonDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/AccessPersons/Alert": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns count of all new access person or access persons who's active status does not match", "operationId": "Inform_GetAccessPersonAlert", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformAccessPersonAlertDto" }, "xml": { "name": "InformAccessPersonAlertDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/AccessPersons/ByDepartment/{id}": { "get": { "tags": [ "Compliance/Inform" ], "operationId": "Inform_GetAccessPersonsByDepartmentAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "isActive", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformAccessPersonDto" }, "xml": { "name": "InformAccessPersonDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/AccessPersons/ByLocation/{id}": { "get": { "tags": [ "Compliance/Inform" ], "operationId": "Inform_GetAccessPersonsByLocationAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "isActive", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformAccessPersonDto" }, "xml": { "name": "InformAccessPersonDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Affirmation": { "put": { "tags": [ "Compliance/Inform" ], "summary": "Update Affirmation Record", "operationId": "Inform_UpdateAffirmations", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformAffirmationDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformAffirmationDto" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Compliance/Inform" ], "summary": "Create Affirmation Record", "operationId": "Inform_CreateAffirmations", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformAffirmationDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformAffirmationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Affirmation/Responses": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns a list of all affirmation responses", "operationId": "Inform_GetAffirmationResponses", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformAffirmationResponseDto" }, "xml": { "name": "InformAffirmationResponseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Affirmations": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns a list of all affirmation types", "operationId": "Inform_GetAffirmations", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "isActive", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformAffirmationDto" }, "xml": { "name": "InformAffirmationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Affirmations/{key}": { "delete": { "tags": [ "Compliance/Inform" ], "summary": "Delete Affirmation", "operationId": "Inform_DeleteAffirmationById", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Affirmations/{key}/{status}": { "put": { "tags": [ "Compliance/Inform" ], "summary": "Updates updates active status on Affirmations", "operationId": "Inform_UpdatePolicyStatus", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "status", "in": "path", "required": true, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformAffirmationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/AssetClass/{productId}": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns asset class for a product id", "operationId": "Inform_GetAssetClass", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/BrokerageAccount/{key}": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Gets the accounts.", "operationId": "Inform_GetAccount", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformBrokerageAccountDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/BrokerageAccount/{key}/V2": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Gets the accounts.", "operationId": "Inform_GetV1ComplianceInformBrokerageAccountByKeyV2", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformBrokerageAccountDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/BrokerageAccount/CanBeReactivated/{key}": { "get": { "tags": [ "Compliance/Inform" ], "operationId": "Inform_CanBeReactivatedAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/BrokerageAccounts": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Gets the accounts.", "operationId": "Inform_GetAccountsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true }, { "name": "allAccounts", "in": "query", "description": "if set to true [all accounts].", "required": false, "type": "boolean", "default": false }, { "name": "openOnly", "in": "query", "description": "if set to true [open only].", "required": false, "type": "boolean", "default": false }, { "name": "accessPersonId", "in": "query", "description": "The access person identifier.", "required": false, "type": "integer", "format": "int32" }, { "name": "simpleList", "in": "query", "description": "if set to true [simple list].", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformBrokerageAccountDto" }, "xml": { "name": "InformBrokerageAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Compliance/Inform" ], "summary": "Updates brokerage account details", "operationId": "Inform_UpdateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "The dto.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformBrokerageAccountDto" } }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformBrokerageAccountDto" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Compliance/Inform" ], "summary": "Adds the account not linked to Quovo", "operationId": "Inform_PostV1ComplianceInformBrokerageAccounts", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "The dto.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformBrokerageAccountDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformBrokerageAccountDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/BrokerageAccounts/{key}/AccountNumberUpdate": { "put": { "tags": [ "Compliance/Inform" ], "summary": "Update the Account Number for a Brokerage Account", "operationId": "Inform_AccountNumberUpdate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Brokerage Account Id", "required": true, "type": "integer", "format": "int32" }, { "name": "accountNumber", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/BrokerageAccounts/{key}/Attachments": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Get Attachments for a Brokerage Account", "operationId": "Inform_BrokerageAccountAttachments", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Brokerage Account Id", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformDocumentAnswerAttachmentDto" }, "xml": { "name": "InformDocumentAnswerAttachmentDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Compliance/Inform" ], "summary": "Adds the account.", "operationId": "Inform_CreateBlobAttachmentAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "The dto.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformDocumentAnswerAttachmentFilesDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/BrokerageAccounts/Alert": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Gets the accounts.", "operationId": "Inform_AccountAlert", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "myDocuments", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.DocumentAlert" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/BrokerageAccounts/Attachment/Download/{key}": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Download a single Policy File", "operationId": "Inform_DownloadAttachment", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Blob ID to be downloaded", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/BrokerageAccounts/DeactivateByAll": { "put": { "tags": [ "Compliance/Inform" ], "summary": "Used to deactivate brokerage accounts from Inform and ByAll", "operationId": "Inform_DeactivateByAllAccountsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "brokerageAccountIds", "in": "body", "description": "List of ids to be deactivated", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Compliance.AggregatorMessage" }, "xml": { "name": "AggregatorMessage", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/BrokerageAccounts/DownloadAllAttachments": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Download All Attachments for all Brokerage Accounts", "operationId": "Inform_DownloadAllBrokerageAccountAttachments", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/BrokerageAccounts/ElectraSetup": { "put": { "tags": [ "Compliance/Inform" ], "operationId": "Inform_ElectraAccountSetupAsync", "consumes": [], "produces": [], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/BrokerageAccounts/StaleHoldings": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Gets the accounts with stale holdings.", "operationId": "Inform_GetAccountsWithStaleHoldingAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformBrokerageAccountDto" }, "xml": { "name": "InformBrokerageAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/BrokerageAccounts/StaleHoldings/Alert": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Gets the count for accounts with stale holdings.", "operationId": "Inform_StaleHoldingsAlert", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "myDocuments", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.DocumentAlert" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/BrokerageAccounts/Status/{status}": { "put": { "tags": [ "Compliance/Inform" ], "operationId": "Inform_UpdateAccountStatusAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "status", "in": "path", "required": true, "type": "string", "enum": [ "New", "NotSubmitted", "Submitted", "Approved", "Denied", "AutoApprove", "AutoDeny", "ClosePending", "Closed", "Active", "FollowUp", "Canceled", "BrokenConnection" ] }, { "name": "idsAndComments", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Compliance.InformComment" }, "xml": { "name": "InformComment", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/BrokerageAccounts/V2": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Gets the accounts.", "operationId": "Inform_GetV1ComplianceInformBrokerageAccountsV2", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true }, { "name": "allAccounts", "in": "query", "description": "if set to true [all accounts].", "required": false, "type": "boolean", "default": false }, { "name": "openOnly", "in": "query", "description": "if set to true [open only].", "required": false, "type": "boolean", "default": false }, { "name": "accessPersonId", "in": "query", "description": "The access person identifier.", "required": false, "type": "integer", "format": "int32" }, { "name": "simpleList", "in": "query", "description": "if set to true [simple list].", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformBrokerageAccountDto" }, "xml": { "name": "InformBrokerageAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/ByAll/AccountDiscovery/ClaimCheck": { "post": { "tags": [ "Compliance/Inform" ], "summary": "Use to call the Off Hour Investor clean up process from this database", "operationId": "Inform_AccountDiscoveryClaimCheckAsync", "consumes": [], "produces": [], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/ByAll/Discovery/ForAllUsers": { "post": { "tags": [ "Compliance/Inform" ], "summary": "Use to call the Off Hour Account Discovery process for this database", "operationId": "Inform_DiscoveryAllUsersAsync", "consumes": [], "produces": [], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/ByAll/DiscoveryAndAdd/ForAllUsers": { "post": { "tags": [ "Compliance/Inform" ], "summary": "Use to call the Discovery And Add For All Users For clean up", "operationId": "Inform_DiscoveryAndAddForAllUsersAsync", "consumes": [], "produces": [], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/ByAll/Investor/CleanUp": { "post": { "tags": [ "Compliance/Inform" ], "summary": "Use to call the Off Hour Investor clean up process from this database", "operationId": "Inform_InvestorCleanUpAsync", "consumes": [], "produces": [], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/ByAllSSOToken": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Get the SSO Token if advisor creds or investor creds do not exist it will create them", "description": "Sample Request\r\nGET /Compliance/Inform/GetSSOToken\r\n\t{\r\n\t}", "operationId": "Inform_GetByAllSSOTokenAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.Compliance.ByAllConsolidateSSOResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/CanDistribute/{templateId}": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns a list of all affirmation types", "operationId": "Inform_GetCanDistribute", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "templateId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Connection": { "post": { "tags": [ "Compliance/Inform" ], "summary": "Creates the connection asynchronous.", "operationId": "Inform_CreateConnectionAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "The dto.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformConnectionDto" } }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformConnectionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Connection/{connectionId}": { "put": { "tags": [ "Compliance/Inform" ], "summary": "Updates the connection asynchronous.", "operationId": "Inform_UpdateConnectionAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "connectionId", "in": "path", "description": "The connection identifier.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "The dto.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformConnectionDto" } }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformConnectionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Connection/InformUser": { "get": { "tags": [ "Compliance/Inform" ], "operationId": "Inform_GetOrCreateInformUserAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "downloadSourceId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "sourceUserId", "in": "query", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformUserDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Connection/V2/Manual": { "post": { "tags": [ "Compliance/Inform" ], "summary": "Creates the connection.", "operationId": "Inform_CreateManualConnectionAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "The dto.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformConnectionDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformConnectionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Connection/V2/Orion": { "post": { "tags": [ "Compliance/Inform" ], "summary": "Creates the user and connection for OC Accounts - Current User ONLY", "operationId": "Inform_CreateOrionConnectionForCurrentUserAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "the user detail.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.UserProfileDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.UserProfileDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Connection/V2/Quovo/ConnectionStatus/{connectionId}": { "put": { "tags": [ "Compliance/Inform" ], "summary": "Updates the connection status asynchronous.", "operationId": "Inform_UpdateQuovoConnectionStatusAsyncV2", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "connectionId", "in": "path", "description": "The connection identifier.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "The dto.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformConnectionDto" } }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformConnectionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Connections/AccessPerson/{key}": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Get connections for the compliance user", "operationId": "Inform_GetAccessPersonConnectionsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The key.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformUserDto" }, "xml": { "name": "InformUserDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Connections/CurrentUser": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Gets the connections.", "operationId": "Inform_GetCurrentUserConnectionsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformUserDto" }, "xml": { "name": "InformUserDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Connections/Disable": { "put": { "tags": [ "Compliance/Inform" ], "summary": "Updates the connections for removal asynchronous.", "operationId": "Inform_UpdateConnectionsForRemovalAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "The dto.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.ConnectionsToDeleteDto" } }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Connections/DiscoverByAllAccounts": { "get": { "tags": [ "Compliance/Inform" ], "operationId": "Inform_DiscoverByAllAccounts", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Connections/LinkToByAllConnections": { "get": { "tags": [ "Compliance/Inform" ], "summary": "This needs tyo be removed", "description": "This needs tyo be removed", "operationId": "Inform_GetLinkToByAllConnectionsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformConnectionDto" }, "xml": { "name": "InformConnectionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Connections/V2/Broken": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Get broken connections details for the compliance user", "operationId": "Inform_GetBrokenInformConnectionsV2", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformConnectionDto" }, "xml": { "name": "InformConnectionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Connections/V2/Broken/AccessPerson/{key}": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Get broken connections details for the compliance user by access person id", "operationId": "Inform_GetInformConnectionsByAccessPersonV2", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformConnectionDto" }, "xml": { "name": "InformConnectionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Connections/V2/Broken/Alert": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Get broken connections: either all or for user", "operationId": "Inform_GetBrokenConnectionAlertsV2", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true }, { "name": "myConnections", "in": "query", "description": "My connections.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformConnectionAlertDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Connections/V2/ConnectionSources": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Gets the inform connection sources.", "operationId": "Inform_GetInformConnectionSourcesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformConnectionSourceDto" }, "xml": { "name": "InformConnectionSourceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Dashboard/Preclearances/V2": { "get": { "tags": [ "Compliance/Inform" ], "summary": "", "operationId": "Inform_GetPreClearancesV2", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "statuses", "in": "query", "required": false, "items": { "type": "string", "enum": [ "New", "NotSubmitted", "Submitted", "Approved", "Denied", "AutoApprove", "AutoDeny", "ClosePending", "Closed", "Active", "FollowUp", "Canceled", "BrokenConnection" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Deactivation": { "post": { "tags": [ "Compliance/Inform" ], "summary": "", "operationId": "Inform_DeactivationAsync", "consumes": [], "produces": [], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Departments": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns a list of all departments documents", "operationId": "Inform_GetDepartments", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.Inform.InformDepartmentDto" }, "xml": { "name": "InformDepartmentDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Compliance/Inform" ], "summary": "Returns a list of all departments documents", "operationId": "Inform_UpdateDepartments", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updatedDepartments", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.Inform.InformDepartmentDto" }, "xml": { "name": "InformDepartmentDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.Inform.InformDepartmentDto" }, "xml": { "name": "InformDepartmentDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Compliance/Inform" ], "summary": "Returns a list of all departments documents", "operationId": "Inform_NewDepartment", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.Inform.InformDepartmentDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.Inform.InformDepartmentDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Distribute/{templateId}": { "delete": { "tags": [ "Compliance/Inform" ], "summary": "Updates the distributed template documents.", "operationId": "Inform_DeleteDistributedTemplateDocumentsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "templateId", "in": "path", "description": "The template identifier.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformTemplateDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Distribute/{templateId}/{dueDate}": { "post": { "tags": [ "Compliance/Inform" ], "summary": "Sends Email sand generates access person documents based on the list of users provided\r\nAccess persons that have already received the questionnaire will be removed from the list", "operationId": "Inform_DistributeTemplate", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "templateId", "in": "path", "description": "template to be distributed", "required": true, "type": "integer", "format": "int32" }, { "name": "dueDate", "in": "path", "description": "date questionnaire is due", "required": true, "type": "string", "format": "date-time" }, { "name": "dtoList", "in": "body", "description": "list of access person", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformAccessPersonDto" }, "xml": { "name": "InformAccessPersonDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformAccessPersonDto" }, "xml": { "name": "InformAccessPersonDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Distribute/UpdateDueDate/{templateId}/{dueDate}": { "put": { "tags": [ "Compliance/Inform" ], "summary": "Update due date for distributed documents that are have an open status", "operationId": "Inform_UpdateDueDate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "templateId", "in": "path", "description": "template to be distributed", "required": true, "type": "integer", "format": "int32" }, { "name": "dueDate", "in": "path", "description": "date questionnaire is due", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Document": { "post": { "tags": [ "Compliance/Inform" ], "summary": "create new document", "operationId": "Inform_Create", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "The dto.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformDocumentDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformDocumentDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Document/{id}": { "put": { "tags": [ "Compliance/Inform" ], "summary": "updates document", "operationId": "Inform_UpdateDocumentAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "description": "The identifier.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "The dto.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformDocumentDto" } }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformDocumentDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Document/{key}": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Gets the document.", "operationId": "Inform_GetDocumentAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The key.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformDocumentDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Document/{key}/Attachments": { "post": { "tags": [ "Compliance/Inform" ], "summary": "creates documents", "operationId": "Inform_CreateDocumentBlobAttachmentAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "The dto.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformDocumentAnswerAttachmentFilesDto" } }, { "name": "ct", "in": "header", "description": "The ct.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Document/Attachment/Download/{key}": { "get": { "tags": [ "Compliance/Inform" ], "summary": "download document attachment", "operationId": "Inform_DownloadDocumentAttachment", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Blob ID to be downloaded", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Document/EmptyTaskDocument/{templateKey}": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Gets the document.", "operationId": "Inform_GetEmptyDocumentByTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "templateKey", "in": "path", "description": "The template key.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformDocumentDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Document/Reminders": { "post": { "tags": [ "Compliance/Inform" ], "summary": "sends questionnaire reminder emails", "operationId": "Inform_InformQuestionnaireRemindersAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "description": "The ct.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Document/Status": { "put": { "tags": [ "Compliance/Inform" ], "operationId": "Inform_UpdateDocumentStatusAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "model", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.DocumentStatusDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformDocumentDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Documents/{key}": { "delete": { "tags": [ "Compliance/Inform" ], "summary": "Delete Document", "operationId": "Inform_DeleteDocument", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Documents/{templateId}": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns a list of all documents for a given template id\r\nUsed for Compass Inform Admin App", "operationId": "Inform_GetListAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "templateId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "currentUser", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "accessPersonId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Documents/{templateId}/{cacheKey}": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Retrieve the previously generated slick grid result for documents.", "operationId": "Inform_GetListCache", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "templateId", "in": "path", "description": "key for template", "required": true, "type": "integer", "format": "int32" }, { "name": "cacheKey", "in": "path", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Documents/AccessPerson/{key}": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns all custom tasks and questionnaires for a given access person", "operationId": "Inform_GetAccessPersonDocuments", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "access person id.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformDocumentDto" }, "xml": { "name": "InformDocumentDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Documents/Alert": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns all documents that have an \r\nAlertStatus for Compliance User or OpenStatus for Access Person", "operationId": "Inform_DocumentAlerts", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "myDocuments", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.DocumentAlert" }, "xml": { "name": "DocumentAlert", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Documents/MyDocuments": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns a list of all documents for the logged in user", "operationId": "Inform_GetMyDocumentList", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "status", "in": "query", "description": "The status.", "required": false, "type": "string", "enum": [ "New", "NotSubmitted", "Submitted", "Approved", "Denied", "AutoApprove", "AutoDeny", "ClosePending", "Closed", "Active", "FollowUp", "Canceled", "BrokenConnection" ] }, { "name": "onlyOpen", "in": "query", "description": "if set to true [only open].", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformDocumentDto" }, "xml": { "name": "InformDocumentDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Documents/MyTasks": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns a list of all documents for the logged in user", "operationId": "Inform_GetMyTasks", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformTemplateTaskGridDto" }, "xml": { "name": "InformTemplateTaskGridDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Documents/Status/{status}": { "put": { "tags": [ "Compliance/Inform" ], "operationId": "Inform_UpdateDocumentsStatusAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "status", "in": "path", "required": true, "type": "string", "enum": [ "New", "NotSubmitted", "Submitted", "Approved", "Denied", "AutoApprove", "AutoDeny", "ClosePending", "Closed", "Active", "FollowUp", "Canceled", "BrokenConnection" ] }, { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/HistoricalDocuments": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns a list of all historical documents", "operationId": "Inform_GetHistoricalDocuments", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformHistoricalDocumentDto" }, "xml": { "name": "InformHistoricalDocumentDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Compliance/Inform" ], "summary": "Creates new historical document", "operationId": "Inform_CreateHistoricalDocumentAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "object to be updated", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformHistoricalDocumentDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformHistoricalDocumentDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/HistoricalDocuments/{key}": { "put": { "tags": [ "Compliance/Inform" ], "summary": "Updates historical document by ID", "operationId": "Inform_UpdateHistoricalDocumentAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformHistoricalDocumentDto" } }, { "name": "ct", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformHistoricalDocumentDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Compliance/Inform" ], "summary": "Delete Historical Document", "operationId": "Inform_DeleteHistoricalDocumentById", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/HistoricalDocuments/AccessPerson": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns a list of all historical documents for current user", "operationId": "Inform_GetHistoricalDocumentsForAccessPerson", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformHistoricalDocumentSimpleDto" }, "xml": { "name": "InformHistoricalDocumentSimpleDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/HistoricalDocuments/AccessPerson/{accessPersonId}": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns a list of all historical documents by access person ID", "operationId": "Inform_GetHistoricalDocumentsByAccessPersonId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accessPersonId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformHistoricalDocumentDto" }, "xml": { "name": "InformHistoricalDocumentDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/HistoricalDocuments/Download/HistoricalDocuments/{historicalDocumentId}": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Download a single Policy File by policyid", "operationId": "Inform_DownloadByHistoricalDocumentId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "historicalDocumentId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/License": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns list of Inform licenses", "operationId": "Inform_GetInformLicenseList", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformLicenseDto" }, "xml": { "name": "InformLicenseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Compliance/Inform" ], "summary": "Updates all the licenses, but does not allow additions. Use Post method to create.", "operationId": "Inform_UpdateLicenses", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updatedLicenses", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformLicenseDto" }, "xml": { "name": "InformLicenseDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformLicenseDto" }, "xml": { "name": "InformLicenseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Compliance/Inform" ], "summary": "Creates new License record", "operationId": "Inform_NewLicense", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "license", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformLicenseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformLicenseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/License/{key}/AccessPersons": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns License and Access Person infrom mation\r\nAccess Person list with the given license id", "operationId": "Inform_GetLicenseAccessPerson", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformLicenseAccessPersonDto" }, "xml": { "name": "InformLicenseAccessPersonDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/License/AccessPersons": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns License and Access Person infrom mation", "operationId": "Inform_GetLicenseAccessPersonAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformLicenseAccessPersonDto" }, "xml": { "name": "InformLicenseAccessPersonDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/License/Simple": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns list of Inform licenses", "operationId": "Inform_GetSimpleAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/License/Summary": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns list of Inform licenses", "operationId": "Inform_GetInformLicenseSummary", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformLicenseSummaryDto" }, "xml": { "name": "InformLicenseSummaryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/MonitoredProductsHistory": { "get": { "tags": [ "Compliance/Inform" ], "operationId": "Inform_GetMonitoredProductsHistory", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformMonitoredProductAuditDto" }, "xml": { "name": "InformMonitoredProductAuditDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Office/AllEmployees": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns list of all active access persons.", "operationId": "Inform_GetAllActiveEmployees", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformOfficeEmployeeDto" }, "xml": { "name": "InformOfficeEmployeeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Office/Locations": { "get": { "tags": [ "Compliance/Inform" ], "operationId": "Inform_GetLocations", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "activeOnly", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformOfficeLocationDto" }, "xml": { "name": "InformOfficeLocationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Compliance/Inform" ], "summary": "Creates the location.", "operationId": "Inform_CreateLocationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "The dto.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformOfficeLocationDto" } }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformOfficeLocationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Office/Locations/{id}": { "put": { "tags": [ "Compliance/Inform" ], "summary": "Updates the location asynchronous.", "operationId": "Inform_UpdateLocationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "description": "The identifier.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "The dto.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformOfficeLocationDto" } }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformOfficeLocationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Policy": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns a list of all Policies\r\nWith the current document", "operationId": "Inform_GetPolicyList", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "isActive", "in": "query", "required": false, "type": "boolean" }, { "name": "isVisible", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformPolicyDto" }, "xml": { "name": "InformPolicyDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Compliance/Inform" ], "summary": "Updates meta data about the document", "operationId": "Inform_UpdatePolicyAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "object to be updated", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformPolicyDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformPolicyDto" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Compliance/Inform" ], "summary": "Updates meta data about the document", "operationId": "Inform_CreateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "object to be updated", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformPolicyDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformPolicyDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Policy/{key}": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns single Policy for key provided", "operationId": "Inform_GetPolicy", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformPolicyDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Compliance/Inform" ], "summary": "Updates updates active and visibility status on policies", "operationId": "Inform_UpdatePolicyStatusAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "isActive", "in": "query", "required": true, "type": "boolean" }, { "name": "isVisible", "in": "query", "required": true, "type": "boolean" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformPolicyDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Compliance/Inform" ], "summary": "Delete Library Item", "operationId": "Inform_DeletePolicyById", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Policy/Download/{key}": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Download a single Policy File", "operationId": "Inform_DownloadPolicy", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Blob ID to be downloaded", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Policy/Download/Policy/{policyId}": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Download a single Policy File by policyid", "operationId": "Inform_DownloadByPolicyId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "policyId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Preclearance": { "post": { "tags": [ "Compliance/Inform" ], "summary": "Creates the pre-clearance for the access person user", "operationId": "Inform_CreatePreclearanceAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "The pre-clearance.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformPreClearanceDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformPreClearanceDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Preclearance/{id}": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Gets the Pre-Clearance by ID", "operationId": "Inform_GetPreClearanceV2", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "description": "The identifier.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformPreClearanceDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Compliance/Inform" ], "summary": "Update pre-clearance", "operationId": "Inform_UpdatePreclearanceAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "The pre-clearance.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformPreClearanceDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformPreClearanceDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Preclearance/{id}/V2": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Gets the Pre-Clearance by ID", "operationId": "Inform_GetV1ComplianceInformPreclearanceByIdV2", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "description": "The identifier.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformPreClearanceDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Preclearances": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns a list of Pre-Clearances", "operationId": "Inform_GetV1ComplianceInformPreclearances", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "brokerageAccountId", "in": "query", "description": "preclearances for a specific brokerageAccount", "required": false, "type": "integer", "format": "int32" }, { "name": "allPreclearances", "in": "query", "description": "if set to true [all preclearances].", "required": false, "type": "boolean", "default": false }, { "name": "accessPersonDashboard", "in": "query", "description": "The access person dashboard.", "required": false, "type": "boolean", "default": false }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformPreClearanceDto" }, "xml": { "name": "InformPreClearanceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Preclearances/AccessPerson/{key}": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns the last 100 pre-clearance requests for the given access person", "operationId": "Inform_GetV1ComplianceInformPreclearancesAccessPersonByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "accessPersonId", "required": true, "type": "integer", "format": "int32" }, { "name": "forExceptionMatch", "in": "query", "description": "limits returned items ot last 45 days and no matched transaction", "required": false, "type": "boolean", "default": false }, { "name": "onlyOpenStatuses", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformPreClearanceDto" }, "xml": { "name": "InformPreClearanceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Preclearances/Alert": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Gets Pre-Clearances Alerts", "operationId": "Inform_PreClearancesAlerts", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "myDocuments", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.DocumentAlert" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Preclearances/Simple": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns simple pre-clearance list for ids provided", "operationId": "Inform_GetPreClearanceSimple", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformPreClearanceDto" }, "xml": { "name": "InformPreClearanceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Preclearances/Status/{status}": { "put": { "tags": [ "Compliance/Inform" ], "operationId": "Inform_UpdatePreclearanceStatusAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "status", "in": "path", "required": true, "type": "string", "enum": [ "New", "NotSubmitted", "Submitted", "Approved", "Denied", "AutoApprove", "AutoDeny", "ClosePending", "Closed", "Active", "FollowUp", "Canceled", "BrokenConnection" ] }, { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Preclearances/V2": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns a list of Pre-Clearances", "operationId": "Inform_GetPreClearances", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "brokerageAccountId", "in": "query", "description": "preclearances for a specific brokerageAccount", "required": false, "type": "integer", "format": "int32" }, { "name": "allPreclearances", "in": "query", "description": "if set to true [all preclearances].", "required": false, "type": "boolean", "default": false }, { "name": "accessPersonDashboard", "in": "query", "description": "The access person dashboard.", "required": false, "type": "boolean", "default": false }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformPreClearanceDto" }, "xml": { "name": "InformPreClearanceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Preclearances/V2/AccessPerson/{key}": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns the last 100 pre-clearance requests for the given access person", "operationId": "Inform_GetPreClearanceForAccessPerson", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "accessPersonId", "required": true, "type": "integer", "format": "int32" }, { "name": "forExceptionMatch", "in": "query", "description": "limits returned items ot last 45 days and no matched transaction", "required": false, "type": "boolean", "default": false }, { "name": "onlyOpenStatuses", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformPreClearanceDto" }, "xml": { "name": "InformPreClearanceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Rules": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns rules for the database", "operationId": "Inform_GetRules", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformRulesEngineDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Compliance/Inform" ], "summary": "Update Rule", "operationId": "Inform_UpdateRules", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformRulesEngineDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformRulesEngineDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Rules/Run": { "post": { "tags": [ "Compliance/Inform" ], "summary": "Run Trade Rules", "operationId": "Inform_RunRulesEngineAsync", "consumes": [], "produces": [], "parameters": [ { "name": "ct", "in": "header", "description": "cancellation tocken", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Rules/RunPrepareInformRecon/{alClientId}/{downloadFormatId}": { "post": { "tags": [ "Compliance/Inform" ], "operationId": "Inform_RunPrepareInformReconAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "alClientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "downloadFormatId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Template": { "put": { "tags": [ "Compliance/Inform" ], "summary": "Returns a template by key", "operationId": "Inform_UpdateTemplateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "object to be updated", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformTemplateDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformTemplateDto" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Compliance/Inform" ], "summary": "Returns a template by key", "operationId": "Inform_CreateTemplateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "object to be updated", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformTemplateDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformTemplateDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Template/{key}": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns a template by key", "operationId": "Inform_GetTemplateAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "unique identifier", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformTemplateDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Compliance/Inform" ], "summary": "Delete Template", "operationId": "Inform_DeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Template/{key}/{isActive}": { "put": { "tags": [ "Compliance/Inform" ], "summary": "Updates active status of template", "operationId": "Inform_ToggleActiveStatus", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "unique identifier", "required": true, "type": "integer", "format": "int32" }, { "name": "isActive", "in": "path", "required": true, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformTemplateTaskGridDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Template/{key}/DownloadAllAttachments": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Download All Attachments for the Template", "operationId": "Inform_DownloadAllAttachmentsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "unique identifier", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Template/Clone/{key}": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns a template by key", "operationId": "Inform_CloneTemplateAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "unique identifier", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformTemplateDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Template/EmptyTemplate": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Gets all simple question types.", "operationId": "Inform_GetEmptyTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "templateType", "in": "query", "description": "Type of the template.", "required": false, "type": "string", "default": 1, "enum": [ "Task", "Questionnaire", "PreClearance", "BrokerageAccount", "TradeViolation", "AccessPerson", "AccessPersonNew", "AccessPersonInactive", "AccessPersonAll", "DuplicateAccessPerson", "TaskWithMultiple" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformTemplateDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Template/EmptyTemplateQuestion": { "get": { "tags": [ "Compliance/Inform" ], "operationId": "Inform_GetEmptyTemplateQuestion", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "templateQuestionType", "in": "query", "required": false, "type": "string", "default": 1, "enum": [ "Text", "Radio", "AccountList", "UploadDocument", "Date", "Currency", "MultiCheckbox" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformTemplateQuestionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Template/QuestionTypes/Simple": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Gets all simple question types.", "operationId": "Inform_GetAllSimpleQuestionTypes", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "adminOnly", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Templates/Questionnaire": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns Questionnaires for slick grid", "operationId": "Inform_GetQuestionnaireGrid", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformTemplateQuestionnaireGridDto" }, "xml": { "name": "InformTemplateQuestionnaireGridDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/Templates/Task": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns Tasks for Access Person to choose from", "operationId": "Inform_GetTaskGrid", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "isActive", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformTemplateTaskGridDto" }, "xml": { "name": "InformTemplateTaskGridDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/TradeViolation": { "put": { "tags": [ "Compliance/Inform" ], "summary": "Create Trade Violation status record", "operationId": "Inform_UpdateTradeViolationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformTradeViolationDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformTradeViolationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/TradeViolation/{tradeViolationId}": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns exception by Id", "operationId": "Inform_GetTradeViolation", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "tradeViolationId", "in": "path", "description": "int", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformTradeViolationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/TradeViolation/{tradeViolationId}/V2": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns exception by Id", "operationId": "Inform_GetV1ComplianceInformTradeViolationByTradeViolationIdV2", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "tradeViolationId", "in": "path", "description": "int", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformTradeViolationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/TradeViolation/Alert": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns a list of rules", "operationId": "Inform_GetTradeViolationAlerts", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformTradeViolationAlertDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/TradeViolation/LinkedTransactions/{tradeViolationId}": { "get": { "tags": [ "Compliance/Inform" ], "operationId": "Inform_GetTradeViolationLinkedTransactions", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "tradeViolationId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformLinkedTransactionDto" }, "xml": { "name": "InformLinkedTransactionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/TradeViolation/MassUpdate": { "put": { "tags": [ "Compliance/Inform" ], "summary": "Create Trade Violation status record", "operationId": "Inform_MassUpdateTradeViolationsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformTradeViolationMassUpdateDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformTradeViolationDto" }, "xml": { "name": "InformTradeViolationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/TradeViolations/V2": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns a list of exceptions", "operationId": "Inform_GetV1ComplianceInformTradeViolationsV2", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ruleType", "in": "query", "required": false, "type": "string", "enum": [ "PreClearance", "DeMinimis", "IPO", "FrontRunning", "SecuritiesViolation", "ShortSale", "RoundTrip30" ] }, { "name": "currentUser", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformTradeViolationDto" }, "xml": { "name": "InformTradeViolationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/TradeViolations/V2/AccessPerson/{key}": { "get": { "tags": [ "Compliance/Inform" ], "summary": "Returns a list of trade violations for access person", "operationId": "Inform_GetTradeViolationsV2", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformTradeViolationDto" }, "xml": { "name": "InformTradeViolationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/ValidateImport/ProductMonitoring": { "post": { "tags": [ "Compliance/Inform" ], "operationId": "InformProductMontoringValidateImport_ImportProductMonitoringAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.ValidateMonitoredProductImportRowDto" }, "xml": { "name": "ValidateMonitoredProductImportRowDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/ValidateImport/ProductMonitoring/Import": { "put": { "tags": [ "Compliance/Inform" ], "summary": "Imports the monitored products.", "operationId": "InformProductMontoringValidateImport_ImportMonitoredProductsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "validateList", "in": "body", "description": "The validate list.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformMonitoredProductImportRowDto" }, "xml": { "name": "InformMonitoredProductImportRowDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformMonitoredProductDto" }, "xml": { "name": "InformMonitoredProductDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/ValidateImport/ProductMonitoring/Templates/Csv": { "get": { "tags": [ "Compliance/Inform" ], "operationId": "InformProductMontoringValidateImport_GetCsvTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/ValidateImport/ProductMonitoring/Templates/Xls": { "get": { "tags": [ "Compliance/Inform" ], "operationId": "InformProductMontoringValidateImport_GetXlsTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/ValidateImport/ProductMonitoring/Templates/Xlsx": { "get": { "tags": [ "Compliance/Inform" ], "operationId": "InformProductMontoringValidateImport_GetXlsxTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/ValidateImport/Questionnaire": { "post": { "tags": [ "Compliance/Inform" ], "operationId": "InformValidateImport_ImportQuestionnaireAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.ValidateTemplateImportRowDto" }, "xml": { "name": "ValidateTemplateImportRowDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/ValidateImport/Questionnaire/Import": { "put": { "tags": [ "Compliance/Inform" ], "operationId": "InformValidateImport_ImportQuestionnaire", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "validateList", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformTemplateImportRowDto" }, "xml": { "name": "InformTemplateImportRowDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformTemplateDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/ValidateImport/Questionnaire/Templates/Csv": { "get": { "tags": [ "Compliance/Inform" ], "operationId": "InformValidateImport_GetCsvTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/ValidateImport/Questionnaire/Templates/Xls": { "get": { "tags": [ "Compliance/Inform" ], "operationId": "InformValidateImport_GetXlsTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/Inform/ValidateImport/Questionnaire/Templates/Xlsx": { "get": { "tags": [ "Compliance/Inform" ], "operationId": "InformValidateImport_GetXlsxTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/InformEmail/Template/{key}": { "put": { "tags": [ "Compliance/InformEmail" ], "summary": "Endpoint to update custom values on template", "operationId": "InformEmailTemplate_UpdateEmailTemplateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.Inform.InformEmailTemplateDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.Inform.InformEmailTemplateDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/InformEmail/Templates": { "get": { "tags": [ "Compliance/InformEmail" ], "summary": "Endpoint to return list of Inform Email Templates", "operationId": "InformEmailTemplate_GetInformEmailTemplates", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.Inform.InformEmailTemplateDto" }, "xml": { "name": "InformEmailTemplateDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/InformEmail/TestEmail": { "post": { "tags": [ "Compliance/InformEmail" ], "summary": "Endpoint to send test email", "operationId": "InformEmailTemplate_SendTestEmail", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.Inform.InformTestEmailDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Utilities.Email.EmailResult" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/RiskDashboard/AccountAlerts": { "get": { "tags": [ "Compliance/RiskDashboard" ], "summary": "Returns risk dashboard account alerts", "description": "GET /Compliance/RiskDashboard/AccountAlerts?brokerDealerId=1", "operationId": "RiskDashboard_GetAccountAlertsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "brokerDealerId", "in": "query", "description": "Optional: Used to pull settings for a sub-client within a parent client", "required": false, "type": "integer", "format": "int32" }, { "name": "riaId", "in": "query", "description": "Optional: Used to pull settings for a sub-client within a parent client", "required": false, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.RiskAccountAlertDashboardDto" }, "xml": { "name": "RiskAccountAlertDashboardDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/RiskDashboard/NonRegisteredStatesTile": { "get": { "tags": [ "Compliance/RiskDashboard" ], "summary": "Returns risk dashboard non-registered states tile information", "description": "GET /Compliance/RiskDashboard/NonRegisteredStatesTile", "operationId": "RiskDashboard_GetNonRegisteredStates", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "brokerDealerId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "riaId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.NonRegisteredStatesDto" }, "xml": { "name": "NonRegisteredStatesDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/RiskDashboard/OutOfTolerance/{daysOut}": { "get": { "tags": [ "Compliance/RiskDashboard" ], "operationId": "RiskDashboard_GetOutOfToleranceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "daysOut", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "brokerDealerId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "riaId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "cancellation", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.RiskToleranceDto" }, "xml": { "name": "RiskToleranceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/RiskDashboard/OutOfToleranceDays": { "get": { "tags": [ "Compliance/RiskDashboard" ], "summary": "Returns risk dashboard settings", "description": "GET /Compliance/RiskDashboard/OutOfToleranceDays?brokerDealerId=1", "operationId": "RiskDashboard_GetOutOfToleranceDaysAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "brokerDealerId", "in": "query", "description": "Optional: Used to pull settings for a sub-client within a parent client", "required": false, "type": "integer", "format": "int32" }, { "name": "riaId", "in": "query", "description": "Optional: Used to pull settings for a sub-client within a parent client", "required": false, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.RiskAlertSettingDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/RiskDashboard/RiskTiles": { "get": { "tags": [ "Compliance/RiskDashboard" ], "summary": "Returns list of data to populate risk/suitability tiles", "description": "GET /Compliance/RiskDashboard/RiskTiles?brokerDealerId=1", "operationId": "RiskDashboard_GetRiskTilesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "brokerDealerId", "in": "query", "description": "Optional: Used to pull settings for a sub-client within a parent client", "required": false, "type": "integer", "format": "int32" }, { "name": "riaId", "in": "query", "description": "Optional: Used to pull settings for a sub-client within a parent client", "required": false, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.DashboardRiskTileDto" }, "xml": { "name": "DashboardRiskTileDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Compliance/RiskDashboard/Settings": { "get": { "tags": [ "Compliance/RiskDashboard" ], "summary": "Returns risk dashboard settings", "description": "GET /Compliance/RiskDashboard/Settings?brokerDealerId=1", "operationId": "RiskDashboard_GetRiskDashboardSettingsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "brokerDealerId", "in": "query", "description": "Optional: Used to pull settings for a sub-client within a parent client", "required": false, "type": "integer", "format": "int32" }, { "name": "riaId", "in": "query", "description": "Optional: Used to pull settings for a sub-client within a parent client", "required": false, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.RiskAlertSettingDto" }, "xml": { "name": "RiskAlertSettingDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Compliance/RiskDashboard" ], "summary": "Returns risk dashboard settings", "description": "PUT /Compliance/RiskDashboard/Settings\r\n[\r\n {\r\n \"id\": 1,\r\n \"alert\": \"Sitting in cash for X days\",\r\n \"isActive\": false,\r\n \"sortOrder\": 0,\r\n \"sectionNumber\": 1,\r\n \"cacheMinutes\": 1440,\r\n \"riskSettingType\": \"Account Alert\",\r\n \"brokerDealerId\": 1,\r\n \"riskAlertOptions\": [\r\n {\r\n \"id\": 1,\r\n \"riskAlertSettingId\": 1,\r\n \"parameterNumber\": 0,\r\n \"label\": \"Number of Days\",\r\n \"defaultValue\": 10,\r\n \"rangeLow\": 1,\r\n \"rangeHigh\": 365,\r\n \"currentValue\": 10,\r\n \"fieldType\": 0,\r\n \"sortOrder\": 1,\r\n \"auditedByDisplay\": null\r\n }\r\n ]\r\n }\r\n ]", "operationId": "RiskDashboard_UpdateRiskDashboardSettingsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.RiskAlertSettingDto" }, "xml": { "name": "RiskAlertSettingDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.RiskAlertSettingDto" }, "xml": { "name": "RiskAlertSettingDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Configuration/{configuration}": { "get": { "tags": [ "Configuration/{configuration}" ], "summary": "", "operationId": "ConfigurationService_GetConfiguration", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "configuration", "in": "path", "required": true, "type": "string", "enum": [ "RiskQuestionnaire", "ProposalFragments_CustomIndexing_OneYearTransition", "ProposalFragments_CustomIndexing_MuiltiYearTransition", "ProposalFragments_CustomIndexing_DepositCashIntoPortfolio", "ProposalFragments_CustomIndexing_WithdrawCashFromPortfolio", "ProposalFragments_CustomIndexing_NewPortfolioFromCash", "ProposalFragments_CompareTool", "UseHypotheticalPerformance" ] }, { "name": "entityEnum", "in": "query", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "Prospect", "BillEntityType", "AdditionalRepresentative" ] }, { "name": "decompress", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "entityId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "configurationCalculation", "in": "query", "required": false, "type": "string", "default": 1, "enum": [ "Standard", "RespectBrokerDealer" ] } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Configuration/raw/{configuration}": { "get": { "tags": [ "Configuration/raw" ], "summary": "", "operationId": "ConfigurationService_GetRawConfiguration", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "configuration", "in": "path", "required": true, "type": "string", "enum": [ "RiskQuestionnaire", "ProposalFragments_CustomIndexing_OneYearTransition", "ProposalFragments_CustomIndexing_MuiltiYearTransition", "ProposalFragments_CustomIndexing_DepositCashIntoPortfolio", "ProposalFragments_CustomIndexing_WithdrawCashFromPortfolio", "ProposalFragments_CustomIndexing_NewPortfolioFromCash", "ProposalFragments_CompareTool", "UseHypotheticalPerformance" ] }, { "name": "entityEnum", "in": "query", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "Prospect", "BillEntityType", "AdditionalRepresentative" ] }, { "name": "decompress", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "entityId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "configurationCalculation", "in": "query", "required": false, "type": "string", "default": 1, "enum": [ "Standard", "RespectBrokerDealer" ] } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/ABCompare": { "get": { "tags": [ "Confirm/ABCompare" ], "summary": "Gets the differences in AB format comparison for a specified date range. And optionally filter by signed off status.", "operationId": "ConfirmABFormatCompare_GetABFormatComparisonDifferencesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "description": "The Start date to filter records from", "required": true, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "The End date to filter records to", "required": true, "type": "string", "format": "date-time" }, { "name": "ct", "in": "header", "description": "Cancellation Token", "required": true }, { "name": "isSignedOff", "in": "query", "description": "Determines whether to filter to signed off records or not signed off records if present", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Confirm/ABCompare" ], "operationId": "ConfirmABFormatCompare_UpdateSignOffOnDifferencesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ABConfirmCompareDifferenceDto" }, "xml": { "name": "ABConfirmCompareDifferenceDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/AccountMergeBatch": { "get": { "tags": [ "Confirm/AccountMergeBatch" ], "summary": "Gets the list of Account Merge Batches.", "operationId": "AccountMergeBatch_GetAccountMergeBatchSummaryListAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "description": "Optional start date filter on CreatedDate.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional end date filter on CreatedDate.", "required": false, "type": "string", "format": "date-time" }, { "name": "ct", "in": "header", "description": "Cancellation token.", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/AccountMergeBatch/{id}": { "get": { "tags": [ "Confirm/AccountMergeBatch" ], "summary": "Gets an Account Merge Batch by id.", "operationId": "AccountMergeBatch_GetAccountMergeBatchByIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "description": "Account merge batch id.", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "description": "Cancellation token.", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/AccountMergeBatch/{id}/Cancel": { "put": { "tags": [ "Confirm/AccountMergeBatch" ], "summary": "Cancels all pending and errored account merge batch detail rows for a batch.", "operationId": "AccountMergeBatch_CancelAccountMergeBatchAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "description": "Account merge batch id.", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "description": "Cancellation token.", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/AccountMergeBatch/{id}/Retry": { "put": { "tags": [ "Confirm/AccountMergeBatch" ], "summary": "Retries all errored account merge batch detail rows for a batch.", "operationId": "AccountMergeBatch_RetryAccountMergeBatchAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "description": "Account merge batch id.", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "description": "Cancellation token.", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/AccountMergeBatchDetail": { "get": { "tags": [ "Confirm/AccountMergeBatchDetail" ], "summary": "Gets all account merge batch detail rows.", "operationId": "AccountMergeBatchDetail_GetAccountMergeBatchDetailsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/AccountMergeBatchDetail/{batchId}": { "get": { "tags": [ "Confirm/AccountMergeBatchDetail" ], "summary": "Gets account merge batch detail rows for a batch.", "operationId": "AccountMergeBatchDetail_GetAccountMergeBatchDetailsByBatchIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "batchId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Confirm/AccountMergeBatchDetail" ], "summary": "Bulk updates account merge batch detail rows for cancel or retry.", "operationId": "AccountMergeBatchDetail_UpdateAccountMergeBatchDetailsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "batchId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updates", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.AccountMerge.AccountMergeBatchDetailUpdateDto" }, "xml": { "name": "AccountMergeBatchDetailUpdateDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/AccountRestore/Simple": { "post": { "tags": [ "Confirm/AccountRestore" ], "summary": "Returns a list data for account restores based on account numbers", "description": "Sample Request\r\nPOST /Confirm/AccountRestore/Simple\r\n[\r\n {\r\n \"accountId\": 21390,\r\n \"accountNumber\": \"123456543\"\r\n }\r\n]", "operationId": "AccountRestore_GetRestoreAccountSimpleAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "restoreAccounts", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.AccountRestore.RestoreAccountDto" }, "xml": { "name": "RestoreAccountDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "description": "CancellationToken of the request", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.AccountRestore.AccountRestoreSimpleDto" }, "xml": { "name": "AccountRestoreSimpleDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/AccountRestoreBatch": { "get": { "tags": [ "Confirm/AccountRestoreBatch" ], "summary": "Gets the list of Account Restore Batches", "description": "Sample Request\r\n GET /Confirm/AccountRestoreBatch \r\n {\r\n \"startDate\": \"12/31/2009\",\r\n \"endDate\": \"04/10/2023\"\r\n }", "operationId": "AccountRestoreBatch_GetAccountRestoreBatchSummaryListAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "description": "Start Date to filter from", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "End Date to filter to", "required": false, "type": "string", "format": "date-time" }, { "name": "ct", "in": "header", "description": "Cancellation Token", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.AccountRestore.AccountRestoreSummaryDto" }, "xml": { "name": "AccountRestoreSummaryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Confirm/AccountRestoreBatch" ], "summary": "Creates an Account Restore batch", "description": "Sample Request\r\n POST /Confirm/AccountRestoreBatch\r\n [ {\r\n \"accountId\": 1,\r\n \"accountNumber\": \"123abc456def\",\r\n \"name\": \"My Account\",\r\n \"accountType\": \"Sample\",\r\n \"fundFamily\": \"My Fund\",\r\n \"currentValue\": 1000.0,\r\n \"downloadSource\": \"Source of the download\",\r\n \"effectiveDate\": \"2021-01-01\",\r\n \"lastPositionDate\": \"2023-11-06\",\r\n \"inBalance\": true,\r\n \"validationMessage\": null\r\n } ]", "operationId": "AccountRestoreBatch_CreateAccountRestoreBatchesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountRestores", "in": "body", "description": "A list of account restore objects.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.AccountRestore.AccountRestoreSimpleDto" }, "xml": { "name": "AccountRestoreSimpleDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "description": "A cancellation token", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/AccountRestoreBatch/{accountRestoreId}": { "get": { "tags": [ "Confirm/AccountRestoreBatch" ], "summary": "Returns a list of Account Restore Details for a given restore id", "description": "Sample Request\r\n GET /Confirm/AccountRestoreBatch/1", "operationId": "AccountRestoreBatch_GetAccountRestoreBatchDetailsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountRestoreId", "in": "path", "description": "Account Restore Id to filter.", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.AccountRestore.AccountRestoreBatchStatusDetailDto" }, "xml": { "name": "AccountRestoreBatchStatusDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/AccountRestoreBatch/Action/Retry/{accountRestoreId}": { "put": { "tags": [ "Confirm/AccountRestoreBatch" ], "summary": "Resets the status of the Restore Batch to New to be reprocessed", "description": "Sample Request\r\n PUT /Confirm/AccountRestoreBatch/Action/Retry/1", "operationId": "AccountRestoreBatch_RetryBatchAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountRestoreId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Alternative/AssetValuation": { "get": { "tags": [ "Confirm/Alternative" ], "summary": "Get all Asset Valuation", "operationId": "AssetValuation_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "description": "Limits the return to only those Asset Valuations with an AsOfDate greater than provided startDate.", "required": true, "type": "string" }, { "name": "endDate", "in": "query", "description": "Optional. Default: null. When provided limits the return to only those Asset Valuations with an AsOfDate less than provided endDate.", "required": false, "type": "string" }, { "name": "assetId", "in": "query", "description": "Optional. Default: null. When provided limits the return to only those Asset Valuations with provided assetId.", "required": false, "type": "integer", "format": "int32" }, { "name": "orionVisionPending", "in": "query", "description": "Optional. Default: false. When provided returns only pending orion vision valuations.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.AssetValuationDto" }, "xml": { "name": "AssetValuationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Confirm/Alternative" ], "summary": "Simple dto update", "operationId": "AssetValuation_UpdateValuationsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "modifiedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.AssetValuationDto" }, "xml": { "name": "AssetValuationDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.AssetValuationDto" }, "xml": { "name": "AssetValuationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Alternative/AssetValuation/{assetId}/{asOfDate}": { "put": { "tags": [ "Confirm/Alternative" ], "summary": "Simple dto update", "operationId": "AssetValuation_UpdateValuationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "assetId", "in": "path", "description": "Asset Id of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "asOfDate", "in": "path", "description": "As Of Date of the desired return object.", "required": true, "type": "string" }, { "name": "updatedItem", "in": "body", "description": "An updated AssetValuationDto to save.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.AssetValuationDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.AssetValuationDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Confirm/Alternative" ], "summary": "Used to delete an existing asset valuation. Upon successful deletion a 204 will be returned.", "operationId": "AssetValuation_DeleteAssetValuationAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "assetId", "in": "path", "description": "Asset Id of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "asOfDate", "in": "path", "description": "As Of Date of the desired return object.", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Alternative/AssetValuation/Action/Delete": { "put": { "tags": [ "Confirm/Alternative" ], "operationId": "AssetValuation_ActionDeleteAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.AssetValuationKeyDto" }, "xml": { "name": "AssetValuationKeyDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.AssetValuationKeyDto" }, "xml": { "name": "AssetValuationKeyDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Alternative/CommitmentLedger": { "get": { "tags": [ "Confirm/Alternative" ], "summary": "Get all Commitmen tLedger", "operationId": "CommitmentLedger_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "assetId", "in": "query", "description": "Optional. Default: null. When provided limits the return to only those CommitmentLedgers with provided AssetId.", "required": false, "type": "integer", "format": "int32" }, { "name": "asOfDate", "in": "query", "description": "Optional. Default: null. When provided limits the return to only those CommitmentLedgers with provided date.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.CommitmentLedgerDto" }, "xml": { "name": "CommitmentLedgerDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Alternative/CommitmentLedger/{key}": { "get": { "tags": [ "Confirm/Alternative" ], "summary": "Gets the Commitment Ledger that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "CommitmentLedger_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.CommitmentLedgerDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Alternative/Equity/ActivityTypes": { "get": { "tags": [ "Confirm/Alternative" ], "summary": "Get all Asset Valuation", "operationId": "EquityActivityTypes_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.EquityActivityTypeDto" }, "xml": { "name": "EquityActivityTypeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Alternative/Equity/FundingTypes": { "get": { "tags": [ "Confirm/Alternative" ], "summary": "Get all Asset Valuation", "operationId": "EquityFundingTypes_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.EquityFundingTypeDto" }, "xml": { "name": "EquityFundingTypeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Alternative/Equity/ValuationStatuses": { "get": { "tags": [ "Confirm/Alternative" ], "summary": "Gets all valuation statuses", "operationId": "ValuationStatuses_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.ValuationStatusDto" }, "xml": { "name": "ValuationStatusDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Alternative/ExpectedReturn": { "get": { "tags": [ "Confirm/Alternative" ], "summary": "Get all ExpectedReturn", "operationId": "ExpectedReturns_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productKey", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.ExpectedReturnDto" }, "xml": { "name": "ExpectedReturnDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Confirm/Alternative" ], "summary": "Adds a new ExpectedReturn to the database.", "operationId": "ExpectedReturns_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "Expected Return object to create", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.ExpectedReturnDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.ExpectedReturnDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Alternative/ExpectedReturn/Products/{productKey}": { "get": { "tags": [ "Confirm/Alternative" ], "summary": "Get all ExpectedReturn", "operationId": "ExpectedReturns_GetV1ConfirmAlternativeExpectedReturnProductsByProductKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productKey", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.ExpectedReturnDto" }, "xml": { "name": "ExpectedReturnDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Alternative/ExpectedReturn/Products/{productKey}/DateStart/{startDate}": { "get": { "tags": [ "Confirm/Alternative" ], "summary": "Gets the ExpectedReturn that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ExpectedReturns_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productKey", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "path", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.ExpectedReturnDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Confirm/Alternative" ], "summary": "Updates the ExpectedReturn that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ExpectedReturns_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productKey", "in": "path", "description": "Key of the desired update object.", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "path", "required": true, "type": "string", "format": "date-time" }, { "name": "dto", "in": "body", "description": "ExpectedReturn object to update", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.ExpectedReturnDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.ExpectedReturnDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Alternative/InvestmentPlatform/AssetHistory/{assetId}": { "get": { "tags": [ "Confirm/Alternative" ], "summary": "Gets Asset Transaction History and Valuation History.", "operationId": "InvestmentPlatform_GetAssetHistory", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "assetId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.InvestmentPlatformAssetHistoryDto" }, "xml": { "name": "InvestmentPlatformAssetHistoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Alternative/ProductTransaction": { "get": { "tags": [ "Confirm/Alternative" ], "summary": "Get all Product Transaction", "operationId": "ProductTransaction_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "query", "description": "Optional. Default: null. When provided limits the return to only those Product Transactions with provided productId.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.ProductTransactionDto" }, "xml": { "name": "ProductTransactionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Confirm/Alternative" ], "summary": "Adds a new Product Transaction to the database.", "operationId": "ProductTransaction_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.ProductTransactionDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.ProductTransactionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Alternative/ProductTransaction/{key}": { "get": { "tags": [ "Confirm/Alternative" ], "summary": "Gets the Product Transaction that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ProductTransaction_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.ProductTransactionDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Confirm/Alternative" ], "summary": "Updates the Product Transaction that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ProductTransaction_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired update object.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "object to update", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.ProductTransactionDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.ProductTransactionDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Confirm/Alternative" ], "summary": "Used to delete an existing Product Transaction. Upon successful deletion a 204 will be returned.", "operationId": "ProductTransaction_Delete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Alternative/ProductTransaction/TransactionPreview": { "get": { "tags": [ "Confirm/Alternative" ], "summary": "Get a Preview of Transaction changes", "operationId": "ProductTransaction_GetTransactionPreview", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "percent", "in": "query", "description": "Percent Of Commitment Amount", "required": true, "type": "number", "format": "double" }, { "name": "transactionDate", "in": "query", "description": "Optional. Default: null.", "required": true, "type": "string" }, { "name": "alternativeEquityActivityTypeId", "in": "query", "description": "Optional. Default: null.", "required": false, "type": "integer", "format": "int32" }, { "name": "transactionTypeId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.TransactionPreviewDto" }, "xml": { "name": "TransactionPreviewDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Alternative/ProductValuation": { "get": { "tags": [ "Confirm/Alternative" ], "summary": "Get all Product Valuation", "operationId": "ProductValuation_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "query", "description": "Optional. Default: null. When provided limits the return to only those Product Valuations with provided productId.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.ProductValuationDto" }, "xml": { "name": "ProductValuationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Confirm/Alternative" ], "summary": "Adds a new Product Valuation to the database.", "description": "Sample Request\r\n\tpost /Confirm/Alternative/ProductValuation\r\n {\r\n \"id\": 0,\r\n \"productId\": 1166611,\r\n \"valuationDate\": \"2024-10-31T06:00:00.000Z\",\r\n \"changePercent\": 0.1,\r\n \"isEstimate\": false,\r\n \"notes\": \"scscscsd\",\r\n \"preview\": false\r\n }", "operationId": "ProductValuation_CreateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "object to insert", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.ProductValuationDto" } }, { "name": "ct", "in": "header", "description": "CancellationToken", "required": true } ], "responses": { "200": { "description": "Returns the created product valuation", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.ProductValuationDto" } }, "400": { "description": "If the request is null, has future date, or missing ProductId" }, "404": { "description": "If the product does not exist or is not an alternative product" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Alternative/ProductValuation/{key}": { "get": { "tags": [ "Confirm/Alternative" ], "summary": "Gets the Product Valuation that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "description": "Sample Request\r\n\tget /Confirm/Alternative/ProductValuation/8798\r\nSample Response\r\n{\r\n \"id\": 60,\r\n \"productId\": 2047940,\r\n \"ticker\": \"SAMPLE_TRICKER\",\r\n \"productName\": \"Sample product name\",\r\n \"valuationDate\": \"2019-05-31\",\r\n \"changePercent\": 0.001800000,\r\n \"isEstimated\": true,\r\n \"notes\": null,\r\n \"auditedDate\": \"2019-06-07T06:51:34.1923892-05:00\",\r\n \"auditedByDisplay\": \"sampleData@orion.com\"\r\n}", "operationId": "ProductValuation_GetEntityByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "Returns the requested Product Valuation", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.ProductValuationDto" } }, "404": { "description": "If Product Valuation is not found" } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Confirm/Alternative" ], "summary": "Updates the Product Valuation that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "description": "Sample Request\r\n\tput /Confirm/Alternative/ProductValuation/89789\r\n {\r\n \"id\": 89789,\r\n \"productId\": 1166611,\r\n \"valuationDate\": \"2024-10-31T06:00:00.000Z\",\r\n \"changePercent\": 0.1,\r\n \"isEstimate\": false,\r\n \"notes\": \"scscscsd\",\r\n \"preview\": false\r\n }", "operationId": "ProductValuation_UpdateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired update object.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "object to update", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.ProductValuationDto" } }, { "name": "ct", "in": "header", "description": "CancellationToken", "required": true } ], "responses": { "200": { "description": "Returns the created product valuation", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.ProductValuationDto" } }, "400": { "description": "If the request is null, has future date, or missing ProductId" }, "404": { "description": "If the product does not exist or is not an alternative product" } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Confirm/Alternative" ], "summary": "Used to delete an existing Product Valuation. Upon successful deletion a 204 will be returned.", "description": "Sample Request\r\n\tdelete /Confirm/Alternative/ProductValuation/89789", "operationId": "ProductValuation_DeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "description": "CancellationToken", "required": true } ], "responses": { "204": { "description": "Product Valuation successfully deleted", "schema": { "type": "object" } }, "404": { "description": "If Product Valuation is not found" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Alternative/ProductValuation/ValuationPreview": { "get": { "tags": [ "Confirm/Alternative" ], "summary": "Get a Preview of Valuation changes", "operationId": "ProductValuation_GetValuationPreview", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "valuationPercent", "in": "query", "required": true, "type": "number", "format": "double" }, { "name": "asOfDate", "in": "query", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.ValuationPreviewDto" }, "xml": { "name": "ValuationPreviewDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Alternative/ValidateImport/Assets": { "post": { "tags": [ "Confirm/Alternative" ], "operationId": "AlternativeValidateImportAssets_ImportAlternativeAssetsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.AssetVerboseValidationDto" }, "xml": { "name": "AssetVerboseValidationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Alternative/ValidateImport/Assets/Templates/Csv": { "get": { "tags": [ "Confirm/Alternative" ], "operationId": "AlternativeValidateImportAssets_GetCsvTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Alternative/ValidateImport/Assets/Templates/Xls": { "get": { "tags": [ "Confirm/Alternative" ], "operationId": "AlternativeValidateImportAssets_GetXlsTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Alternative/ValidateImport/Assets/Templates/Xlsx": { "get": { "tags": [ "Confirm/Alternative" ], "operationId": "AlternativeValidateImportAssets_GetXlsxTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Alternative/ValidateImport/AssetValuation": { "post": { "tags": [ "Confirm/Alternative" ], "operationId": "AlternativeValidateImportAssetValuation_ImportAssetValuationsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.AssetValuationValidationDto" }, "xml": { "name": "AssetValuationValidationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Alternative/ValidateImport/AssetValuation/Templates/Csv": { "get": { "tags": [ "Confirm/Alternative" ], "operationId": "AlternativeValidateImportAssetValuation_GetCsvTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Alternative/ValidateImport/AssetValuation/Templates/Xls": { "get": { "tags": [ "Confirm/Alternative" ], "operationId": "AlternativeValidateImportAssetValuation_GetXlsTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Alternative/ValidateImport/AssetValuation/Templates/Xlsx": { "get": { "tags": [ "Confirm/Alternative" ], "operationId": "AlternativeValidateImportAssetValuation_GetXlsxTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Alternative/ValidateImport/AssetValuation/Update": { "post": { "tags": [ "Confirm/Alternative" ], "operationId": "AlternativeValidateImportAssetValuation_UpdateAssetValuationValidationsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "assetValuations", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.AssetValuationValidationDto" }, "xml": { "name": "AssetValuationValidationDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Alternative/ValidateImport/Transactions": { "post": { "tags": [ "Confirm/Alternative" ], "operationId": "AlternativeValidateImportTransactions_ImportAlternativeTransactionsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.TransactionAlternativeValidationDto" }, "xml": { "name": "TransactionAlternativeValidationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Alternative/ValidateImport/Transactions/Templates/Csv": { "get": { "tags": [ "Confirm/Alternative" ], "operationId": "AlternativeValidateImportTransactions_GetCsvTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Alternative/ValidateImport/Transactions/Templates/Xls": { "get": { "tags": [ "Confirm/Alternative" ], "operationId": "AlternativeValidateImportTransactions_GetXlsTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Alternative/ValidateImport/Transactions/Templates/Xlsx": { "get": { "tags": [ "Confirm/Alternative" ], "operationId": "AlternativeValidateImportTransactions_GetXlsxTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/CorporateAction/Processing": { "get": { "tags": [ "Confirm/CorporateAction" ], "summary": "Get all Corporate Action Processes\r\nThe return is limited to pages of 10000. Use $top and $skip in the query string to page through the data.", "operationId": "CorporateActionProcessing_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "corpActionId", "in": "query", "description": "Optional. Default null. Return Processes which belong to a particular Corporate Action by PK", "required": false, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "description": "Optional. Default null. Return Processes which have an EffectiveDate on or after this", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default null. Return Processes which have an EffectiveDate on or before this", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.CorpAction.CorporateActionProcessingDto" }, "xml": { "name": "CorporateActionProcessingDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Confirm/CorporateAction" ], "summary": "Adds a new Corporate Action Extension to the database.", "operationId": "CorporateActionProcessing_CreateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "CorporateActionProcessingDto to create", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.CorpAction.CorporateActionProcessingDto" } }, { "name": "cancellationToken", "in": "header", "description": "CancellationToken of the request", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.CorpAction.CorporateActionProcessingDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/CorporateAction/Processing/{key}": { "get": { "tags": [ "Confirm/CorporateAction" ], "summary": "Gets the Corporate Action Extension that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "CorporateActionProcessing_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Primary Key of the CorpActionProcessing record.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.CorpAction.CorporateActionProcessingDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Confirm/CorporateAction" ], "summary": "TO BE REMOVED\r\nUpdates the desired CorpActionProcessing record. \r\nIf the passed key and CorpActionProcessing ID do not match, a 400 will be thrown.", "operationId": "CorporateActionProcessing_UpdateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Primary key of the desired record to update.", "required": true, "type": "integer", "format": "int32" }, { "name": "update", "in": "body", "description": "CorpActionProcessing record to update", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Confirm.CorpAction.CorpActionProcessing" } }, { "name": "cancellationToken", "in": "header", "description": "CancellationToken of the request", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Confirm.CorpAction.CorpActionProcessing" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Confirm/CorporateAction" ], "summary": "Deletes the CorpActionProcessing record. If the record ProcessStatus is not new or the record is associated to Task Queue Records a 403 will be thrown.", "operationId": "CorporateActionProcessing_DeleteEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Primary Key of the CorpActionProcessing record.", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "description": "CancellationToken of the request", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/CorporateAction/Processing/{key}/Action/ProcessTask": { "put": { "tags": [ "Confirm/CorporateAction" ], "summary": "Perform a Corporate Action task", "operationId": "CorporateActionProcessing_ActionProcessTaskAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "description": "CancellationToken of the request", "required": true }, { "name": "dto", "in": "body", "description": "The task to perform and details needed to perform the task, if necessary.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.CorpAction.CorpActionProcessingTaskDto" } }, { "name": "key", "in": "path", "description": "CorpActionProcessingId key of the object on which to perform the task.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.CorpAction.CorporateActionProcessingDetailDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/CorporateAction/Processing/Detail": { "get": { "tags": [ "Confirm/CorporateAction" ], "summary": "Get all Corporate Action Processes, including Corporate Action Details\r\nThe return is limited to pages of 10000. Use $top and $skip in the query string to page through the data.", "operationId": "CorporateActionProcessing_GetDetail", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "corpActionId", "in": "query", "description": "Optional. Default null. Return Processes which belong to a particular Corporate Action by PK", "required": false, "type": "integer", "format": "int32" }, { "name": "corpActionProcessingId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "description": "Optional. Default null. Return Processes which have an EffectiveDate on or after this", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default null. Return Processes which have an EffectiveDate on or before this", "required": false, "type": "string", "format": "date-time" }, { "name": "skipDates", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.CorpAction.CorporateActionProcessingDetailDto" }, "xml": { "name": "CorporateActionProcessingDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/CorporateAction/Processing/Detail/{key}": { "put": { "tags": [ "Confirm/CorporateAction" ], "summary": "Updates the desired CorpActionProcessing record. \r\nReturns the Corporate Action Processing with Details\r\nIf the passed key and CorpActionProcessing ID do not match, a 400 will be thrown.", "operationId": "CorporateActionProcessing_UpdateEntityDetailAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Primary key of the CorpActionProcessing to update.", "required": true, "type": "integer", "format": "int32" }, { "name": "update", "in": "body", "description": "CorpActionProcessing record to update", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Confirm.CorpAction.CorpActionProcessing" } }, { "name": "cancellationToken", "in": "header", "description": "CancellationToken of the request", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.CorpAction.CorporateActionProcessingDetailDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/CorporateAction/Processing/Status": { "get": { "tags": [ "Confirm/CorporateAction" ], "summary": "Checks task status of each database", "operationId": "CorporateActionProcessing_GetProcessingQueueStatus", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "processingIds", "in": "query", "description": "Optional. Filters by a list of Corporate Action Processing Ids.", "required": true, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "incompleteOnly", "in": "query", "description": "Optional. Default True. Include only incomplete task by databases.", "required": false, "type": "boolean", "default": true }, { "name": "alClientId", "in": "query", "description": "Optional. Default 0. Filter to for a given AlClientId.", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.CorpAction.CorpActionProcessingStatusDto" }, "xml": { "name": "CorpActionProcessingStatusDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/CorporateAction/Processing/Status/Counts": { "get": { "tags": [ "Confirm/CorporateAction" ], "summary": "Returns a count of all Complete, Pending, Skipped Processing Tasks.", "operationId": "CorporateActionProcessing_GetProcessingQueueStatusCounts", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "processingIds", "in": "query", "description": "Optional. List of Corporate Action Processing Ids.", "required": true, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "incompleteOnly", "in": "query", "description": "Optional. Default false. Include only incomplete task by databases.", "required": false, "type": "boolean", "default": false }, { "name": "alClientId", "in": "query", "description": "Optional. Default 0. Filter for a given AlClientId.", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.CorpAction.CorpActionProcessingStatusCountsDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/CorporateAction/ProcessingType": { "get": { "tags": [ "Confirm/CorporateAction" ], "summary": "Get all Corporate Action Processing Types\r\nThe return is limited to pages of 10000. Use $top and $skip in the query string to page through the data.", "operationId": "CorporateActionProcessingType_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.CorpAction.CorpActionProcessingTypeDto" }, "xml": { "name": "CorpActionProcessingTypeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Confirm/CorporateAction" ], "summary": "This endpoint has been deprecated. It previously added a new Corporate Action Processing Type to the database.\r\nDue to the need to update database processes to process new corporate action processing types, these have to be\r\nadded to the database via script.", "operationId": "CorporateActionProcessingType_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "Details of the object to create.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.CorpAction.CorpActionProcessingTypeDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/CorporateAction/ProcessingType/{key}": { "get": { "tags": [ "Confirm/CorporateAction" ], "summary": "Gets the Corporate Action Extension that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "CorporateActionProcessingType_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Primary Key of the CorpActionProcessingType.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.CorpAction.CorpActionProcessingTypeDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Confirm/CorporateAction" ], "summary": "This endpoint has been deprecated. It previously updated the Corporate Action Extension that has the provided key.\r\nDue to the need to update database processes to process new corporate action processing types, these have to be\r\nupdated via script.", "operationId": "CorporateActionProcessingType_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the object to update.", "required": true, "type": "integer", "format": "int32" }, { "name": "update", "in": "body", "description": "Details of the object to update.", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Confirm.CorpAction.CorpActionProcessingType" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/CorporateAction/TaskQueueSkipped": { "get": { "tags": [ "Confirm/CorporateAction" ], "summary": "Get all Corporate Action Task Queue Skipped\r\nThe return is limited to pages of 10000. Use $top and $skip in the query string to page through the data.", "operationId": "CorporateActionTaskQueueSkipped_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "corpActionProcessingId", "in": "query", "description": "Optional. Default null. Return Processes which belong to a particular Corporate Action Process by PK", "required": false, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "description": "Optional. *NOT USED*", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. *NOT USED*", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.CorpAction.CorpActionTaskQueueSkippedDto" }, "xml": { "name": "CorpActionTaskQueueSkippedDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Confirm/CorporateAction" ], "summary": "Adds a new Corporate Action Task Queue Skipped record to the database.", "operationId": "CorporateActionTaskQueueSkipped_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "CorpActionTaskQueueSkippedDto to create", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.CorpAction.CorpActionTaskQueueSkippedDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.CorpAction.CorpActionTaskQueueSkippedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/CorporateAction/TaskQueueSkipped/{key}": { "get": { "tags": [ "Confirm/CorporateAction" ], "summary": "Get Corporate Action Task Queue Skipped by key", "operationId": "CorporateActionTaskQueueSkipped_GetItemByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Primary Key of the CorpActionTaskQueueSkipped", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.CorpAction.CorpActionTaskQueueSkippedDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Confirm/CorporateAction" ], "summary": "Updates a Corporate Action Task Queue Skipped record", "operationId": "CorporateActionTaskQueueSkipped_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Primary Key ID of the CorpActionTaskQueueSkippedDto to validate", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "CorpActionTaskQueueSkippedDto to create", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.CorpAction.CorpActionTaskQueueSkippedDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.CorpAction.CorpActionTaskQueueSkippedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/CorporateAction/Transactions/V2": { "get": { "tags": [ "Confirm/CorporateAction" ], "operationId": "CorporateActionTransactions_GetTransactionsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "alClientId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "corporateActionId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "processingIds", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "tradeStatuses", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" }, { "name": "productIds", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "startRange", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endRange", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.CorpAction.CorpActionTransactionV2Dto" }, "xml": { "name": "CorpActionTransactionV2Dto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/CustomImportFiles": { "get": { "tags": [ "Confirm/CustomImportFiles" ], "summary": "Gets a list of custom import files that the logged in user has access to.", "operationId": "CustomImportFiles_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.CustomImportFileDto" }, "xml": { "name": "CustomImportFileDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/CustomImportFiles/{key}": { "get": { "tags": [ "Confirm/CustomImportFiles" ], "summary": "Gets the custom import file that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "CustomImportFiles_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.CustomImportFileDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/CustomImportFiles/History": { "get": { "tags": [ "Confirm/CustomImportFiles" ], "summary": "Gets a list of custom import files that the logged in user has access to that are historic and were created within the last month.", "operationId": "CustomImportFiles_GetHistory", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.CustomImportFileDto" }, "xml": { "name": "CustomImportFileDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/CustomImportFiles/Processing": { "get": { "tags": [ "Confirm/CustomImportFiles" ], "summary": "Gets a list of custom import files that the logged in user has access to that are being processed.", "operationId": "CustomImportFiles_GetProcessing", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.CustomImportFileDto" }, "xml": { "name": "CustomImportFileDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/CustomImports": { "get": { "tags": [ "Confirm/CustomImports" ], "summary": "Gets a list of custom imports that the logged in user has access to.", "operationId": "CustomImports_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.CustomImportDto" }, "xml": { "name": "CustomImportDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/CustomImports/{key}": { "get": { "tags": [ "Confirm/CustomImports" ], "summary": "Gets the custom import that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "CustomImports_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.CustomImportDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DatabaseBackupFileRestore": { "get": { "tags": [ "Confirm/DatabaseBackupFileRestore" ], "operationId": "DatabaseBackupFileRestore_GetAllDatabaseBackupFileRestoreHistoryAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DatabaseBackupFileRestoreHistoryDto" }, "xml": { "name": "DatabaseBackupFileRestoreHistoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Confirm/DatabaseBackupFileRestore" ], "operationId": "DatabaseBackupFileRestore_ExecuteDatabaseBackupFileRestoreHistoryAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DatabaseBackupFileRestoreHistoryDto" } }, { "name": "token", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DataQueryEntityExcludes": { "get": { "tags": [ "Confirm/DataQueryEntityExcludes" ], "summary": "Gets a list of Data Query Entity Excludes that the logged in user has access to.", "operationId": "DataQueryEntityExcludes_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DataQueryEntityExcludeDto" }, "xml": { "name": "DataQueryEntityExcludeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Confirm/DataQueryEntityExcludes" ], "summary": "Used to create a new Data Query Entity Exclude. Upon successful creation the created data is returned.", "operationId": "DataQueryEntityExcludes_Create", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DataQueryEntityExcludeDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DataQueryEntityExcludeDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DataQueryEntityExcludes/{key}": { "get": { "tags": [ "Confirm/DataQueryEntityExcludes" ], "summary": "Gets the Data Query Entity Excludes that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "DataQueryEntityExcludes_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DataQueryEntityExcludeDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Confirm/DataQueryEntityExcludes" ], "summary": "Used to update an existing Data Query Entity Excludes. Upon successful modification a 200 will be returned.", "operationId": "DataQueryEntityExcludes_Update", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DataQueryEntityExcludeDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DataQueryEntityExcludeDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Confirm/DataQueryEntityExcludes" ], "summary": "Deletes Data Query Entity Exclude provided in the key.", "operationId": "DataQueryEntityExcludes_Delete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DataQueryEntityExcludes/Action/Delete": { "put": { "tags": [ "Confirm/DataQueryEntityExcludes" ], "operationId": "DataQueryEntityExcludes_ActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles": { "get": { "tags": [ "Confirm/DownloadFiles" ], "operationId": "DownloadFiles_GetAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "recordType", "in": "query", "required": false, "items": { "type": "string", "enum": [ "Name", "Position", "Transaction", "Price", "Dividend", "Product", "NotImported", "Header", "Security", "CorpAction", "TranDetail", "Generic", "CostBasis", "Beneficiary", "StoredPerformance", "Systematic", "RMD", "Banking" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "memoCode", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFileDto" }, "xml": { "name": "DownloadFileDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/{downloadFileId}/Details": { "get": { "tags": [ "Confirm/DownloadFiles" ], "operationId": "DownloadFiles_GetFileDetails", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "downloadFileId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "downloadStatus", "in": "query", "required": false, "items": { "type": "string", "enum": [ "NotConfirmed", "Confirmed", "Excluded", "AggregationOnly" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFileDetailDto" }, "xml": { "name": "DownloadFileDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Confirm/DownloadFiles" ], "operationId": "DownloadFiles_UpdateFileDetailsRoute", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "downloadFileId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFileDetailDto" }, "xml": { "name": "DownloadFileDetailDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFileDetailDto" }, "xml": { "name": "DownloadFileDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/{downloadFileId}/Details/{key}": { "get": { "tags": [ "Confirm/DownloadFiles" ], "summary": "Gets the download file detail record for the download file with the provided key.", "operationId": "DownloadFiles_GetFileDetailByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "downloadFileId", "in": "path", "description": "The key of the download file.", "required": true, "type": "integer", "format": "int32" }, { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFileDetailDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Confirm/DownloadFiles" ], "operationId": "DownloadFiles_UpdateFileDetail", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "downloadFileId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFileDetailDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFileDetailDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/{downloadFileId}/Details/Action/FindReplace": { "put": { "tags": [ "Confirm/DownloadFiles" ], "operationId": "DownloadFiles_FindReplace", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "downloadFileId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "findString", "in": "query", "required": true, "type": "string" }, { "name": "replaceString", "in": "query", "required": true, "type": "string" }, { "name": "findReplaceFlag", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "None", "Address1", "Address2", "Address3", "City", "ClientName", "ProductName" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFileDetailDto" }, "xml": { "name": "DownloadFileDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/{downloadFileId}/Details/Action/Prefix": { "put": { "tags": [ "Confirm/DownloadFiles" ], "operationId": "DownloadFiles_ActionPrefix", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "downloadFileId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "prefixString", "in": "query", "required": true, "type": "string" }, { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "prefixFlag", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "None", "ProductName" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFileDetailDto" }, "xml": { "name": "DownloadFileDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/{downloadFileId}/Details/Action/Proper": { "put": { "tags": [ "Confirm/DownloadFiles" ], "operationId": "DownloadFiles_ActionProper", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "downloadFileId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "properFlag", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "None", "Address1", "Address2", "Address3", "City", "ClientName", "ProductName" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFileDetailDto" }, "xml": { "name": "DownloadFileDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/{downloadFileId}/Details/Action/Undo": { "put": { "tags": [ "Confirm/DownloadFiles" ], "operationId": "DownloadFiles_ActionUndoRecordsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "downloadFileId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/{downloadFileId}/Details/Action/VerifyApply": { "put": { "tags": [ "Confirm/DownloadFiles" ], "operationId": "DownloadFiles_ActionVerifyOrApplyRecordsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "downloadFileId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "apply", "in": "query", "required": true, "type": "boolean" }, { "name": "allowDuplicateTransactions", "in": "query", "required": true, "type": "boolean" }, { "name": "allowAddProductToDatabase", "in": "query", "required": true, "type": "boolean" }, { "name": "allowAddDividend", "in": "query", "required": true, "type": "boolean" }, { "name": "allowCreateUnverifiedSells", "in": "query", "required": true, "type": "boolean" }, { "name": "newAccountCreation", "in": "query", "required": true, "type": "string", "enum": [ "Default", "DoNotCreate", "Create", "AutoExclude" ] }, { "name": "matchDownloadSource", "in": "query", "required": true, "type": "boolean" }, { "name": "bypassExclusion", "in": "query", "required": true, "type": "boolean" }, { "name": "priceHolidayOverride", "in": "query", "required": true, "type": "boolean" }, { "name": "allowSymbolCreate", "in": "query", "required": true, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/{downloadFileId}/Details/List": { "post": { "tags": [ "Confirm/DownloadFiles" ], "summary": "Gets the download file detail records for the download file with the provided keys.", "operationId": "DownloadFiles_GetFileDetailByKeyList", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "downloadFileId", "in": "path", "description": "The key of the download file.", "required": true, "type": "integer", "format": "int32" }, { "name": "keys", "in": "body", "description": "Keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFileDetailDto" }, "xml": { "name": "DownloadFileDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/{downloadFileId}/Details/List/Id": { "post": { "tags": [ "Confirm/DownloadFiles" ], "summary": "Gets the download file detail records for the download file with the provided keys.", "operationId": "DownloadFiles_PostV1ConfirmDownloadFilesByDownloadFileIdDetailsListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "downloadFileId", "in": "path", "description": "The key of the download file.", "required": true, "type": "integer", "format": "int32" }, { "name": "keys", "in": "body", "description": "Keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFileDetailDto" }, "xml": { "name": "DownloadFileDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/{downloadFileId}/Download": { "get": { "tags": [ "Confirm/DownloadFiles" ], "summary": "Used download the raw file for the download file specified.", "operationId": "DownloadFiles_DownloadFile", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "downloadFileId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/{key}": { "get": { "tags": [ "Confirm/DownloadFiles" ], "summary": "Gets the download file that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "DownloadFiles_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFileDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/{key}/Positions/Import": { "post": { "tags": [ "Confirm/DownloadFiles" ], "operationId": "ReviewedPositionFiles_ImportTransactionsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/{key}/UpdateAgentAnalysisStatus": { "put": { "tags": [ "Confirm/DownloadFiles" ], "operationId": "DownloadFiles_UpdateAgentAnalysisStatusToCompleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/Action/ConfirmDetails": { "put": { "tags": [ "Confirm/DownloadFiles" ], "operationId": "DownloadFiles_ManualConfirmAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "isValidated", "in": "query", "required": true, "type": "boolean" }, { "name": "reason", "in": "query", "required": true, "type": "string", "enum": [ "ThirdPartyWebsite", "InstituteWebsite", "AdvisorConfirmed", "Other", "MultiplyPriceFactor", "BondPricingFirstIn", "LessRoundedPrice", "CorrectingDecimalOnPrice", "UpdatingCSIPrice", "NotUSPrice", "DifferentEffectiveDate" ] }, { "name": "notes", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFileDetailDto" }, "xml": { "name": "DownloadFileDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/Action/Download/{sessionId}": { "get": { "tags": [ "Confirm/DownloadFiles" ], "summary": "", "operationId": "DownloadFiles_DownloadFiles", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "sessionId", "in": "path", "description": "The identifier for a specific download session.", "required": true, "type": "string", "format": "uuid" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/Action/DownloadFiles": { "post": { "tags": [ "Confirm/DownloadFiles" ], "summary": "Downloads zip file with the set of files selected.", "operationId": "DownloadFiles_PrepareDownloadFiles", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys for desired files to download.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/Action/DownloadMany": { "post": { "tags": [ "Confirm/DownloadFiles" ], "summary": "Downloads several confirmation files across one or more advisor databases", "operationId": "DownloadFiles_DownloadManyFiles", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "filesOptionList", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFilesOptionsDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/Action/DownloadTestFiles": { "get": { "tags": [ "Confirm/DownloadFiles" ], "operationId": "DownloadFiles_DownloadTestFilesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "alClientId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "fileIds", "in": "query", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/Action/ExcludeDetails": { "put": { "tags": [ "Confirm/DownloadFiles" ], "operationId": "DownloadFiles_ManualExcludeAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFileDetailDto" }, "xml": { "name": "DownloadFileDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/Action/ImportFile": { "post": { "tags": [ "Confirm/DownloadFiles" ], "summary": "Import file", "operationId": "DownloadFiles_ImportFileAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "downloadFile", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFileImportFileDto" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/Action/ImportFiles": { "post": { "tags": [ "Confirm/DownloadFiles" ], "summary": "Import file", "operationId": "DownloadFiles_ImportFilesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "downloadFiles", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFileImportMultiFileDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFileImportMultiFileReturnDto" }, "xml": { "name": "DownloadFileImportMultiFileReturnDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/Action/ImportFilesByDownloadSources": { "post": { "tags": [ "Confirm/DownloadFiles" ], "summary": "Imports the files by download sources asynchronous.", "description": " Sample Request\r\n POST /Confirm/DownloadFiles/Action/ImportFilesByDownloadSources\r\n{\"downloadSourceIds\":[189,170,184,96,251,75,81],\"autoApply\":0}", "operationId": "DownloadFiles_ImportFilesByDownloadSourcesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true }, { "name": "downloadSourcesToImport", "in": "body", "description": "The download sources to import.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFileImportFilesMultiDownloadSourceDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFileImportMultiFileReturnDto" }, "xml": { "name": "DownloadFileImportMultiFileReturnDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/Action/ResetPositionFile/{downloadFileId}": { "put": { "tags": [ "Confirm/DownloadFiles" ], "summary": "", "operationId": "DownloadFiles_ResetPositionFileAsync", "consumes": [], "produces": [], "parameters": [ { "name": "downloadFileId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/Action/VerifyApplyFile": { "post": { "tags": [ "Confirm/DownloadFiles" ], "operationId": "DownloadFiles_VerifyApplyFileAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "verifyApplyFileRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Remote.Confirmation.VerifyApplyFileRequest" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/Details": { "get": { "tags": [ "Confirm/DownloadFiles" ], "operationId": "DownloadFiles_GetAllDetailsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "recordType", "in": "query", "required": false, "type": "string", "enum": [ "Name", "Position", "Transaction", "Price", "Dividend", "Product", "NotImported", "Header", "Security", "CorpAction", "TranDetail", "Generic", "CostBasis", "Beneficiary", "StoredPerformance", "Systematic", "RMD", "Banking" ] }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "downloadStatus", "in": "query", "required": false, "items": { "type": "string", "enum": [ "NotConfirmed", "Confirmed", "Excluded", "AggregationOnly" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "downloadSourceId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "accountNumber", "in": "query", "required": false, "type": "string" }, { "name": "downloadFileId", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" }, { "name": "memoCode", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "effStartDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "effEndDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "cusip", "in": "query", "required": false, "type": "string" }, { "name": "readOnly", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Confirm/DownloadFiles" ], "operationId": "DownloadFiles_GetAllDetailsPostAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "downloadFileId", "in": "body", "required": true, "schema": { "items": { "type": "string" }, "xml": { "name": "IntArray", "wrapped": true }, "type": "array" } }, { "name": "recordType", "in": "query", "required": false, "type": "string", "enum": [ "Name", "Position", "Transaction", "Price", "Dividend", "Product", "NotImported", "Header", "Security", "CorpAction", "TranDetail", "Generic", "CostBasis", "Beneficiary", "StoredPerformance", "Systematic", "RMD", "Banking" ] }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "downloadStatus", "in": "query", "required": false, "items": { "type": "string", "enum": [ "NotConfirmed", "Confirmed", "Excluded", "AggregationOnly" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "downloadSourceId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "accountNumber", "in": "query", "required": false, "type": "string" }, { "name": "memoCode", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "effStartDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "effEndDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "cusip", "in": "query", "required": false, "type": "string" }, { "name": "readOnly", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/Details/Action/RateAgentNextBestAction": { "put": { "tags": [ "Confirm/DownloadFiles" ], "summary": "Persists analyst ratings and optional feedback for agent next-best-action suggestions on the given download records (possibly spanning multiple download files).", "operationId": "DownloadFiles_SaveAgentNextBestActionRatingsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.RateAgentNextBestActionRequestDto" } }, { "name": "token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/Details/Records": { "get": { "tags": [ "Confirm/DownloadFiles" ], "summary": "Get Download Records By FileId, RecordId, And RecordType", "operationId": "DownloadFiles_GetAllDetailsByRecordAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "fileSessionId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "recordSessionId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "recordType", "in": "query", "required": true, "type": "string", "enum": [ "Name", "Position", "Transaction", "Price", "Dividend", "Product", "NotImported", "Header", "Security", "CorpAction", "TranDetail", "Generic", "CostBasis", "Beneficiary", "StoredPerformance", "Systematic", "RMD", "Banking" ] }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/ExclusionReason": { "get": { "tags": [ "Confirm/DownloadFiles" ], "operationId": "DownloadFiles_GetReasonAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Confirm/DownloadFiles" ], "operationId": "DownloadFiles_AddReason", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "reason", "in": "query", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Confirm.ConfirmExclusionReason" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Confirm/DownloadFiles" ], "operationId": "DownloadFiles_DeleteReason", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "Id", "in": "query", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/FileImports": { "get": { "tags": [ "Confirm/DownloadFiles" ], "operationId": "DownloadFiles_GetAllConfirmationBatchProcessing", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "includeErrors", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "status", "in": "query", "required": false, "items": { "type": "string", "enum": [ "New", "Processing", "Failed", "PartiallyComplete", "Complete", "Canceled" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.BatchProcessingDto" }, "xml": { "name": "BatchProcessingDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/FileImports/Counts": { "get": { "tags": [ "Confirm/DownloadFiles" ], "operationId": "DownloadFiles_GetAllConfirmationBatchProcessingCounts", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "includeErrors", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "status", "in": "query", "required": false, "items": { "type": "string", "enum": [ "New", "Processing", "Failed", "PartiallyComplete", "Complete", "Canceled" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.GridCountDto" }, "xml": { "name": "GridCountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/Positions/CreateTrans": { "post": { "tags": [ "Confirm/DownloadFiles" ], "operationId": "ReviewedPositionFiles_ImportTrasactionByStoredProcAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/Positions/Transactions": { "post": { "tags": [ "Confirm/DownloadFiles" ], "operationId": "ReviewedPositionFiles_CreateTrasactionByStoredProcAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFileCreateTransDto" }, "xml": { "name": "DownloadFileCreateTransDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/Recommendations": { "post": { "tags": [ "Confirm/DownloadFiles" ], "operationId": "DownloadFiles_UpsertRecommendationsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/RecordType/{recordType}/Details": { "put": { "tags": [ "Confirm/DownloadFiles" ], "operationId": "DownloadFiles_UpdateRecordTypeFileDetails", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "recordType", "in": "path", "required": true, "type": "string", "enum": [ "Name", "Position", "Transaction", "Price", "Dividend", "Product", "NotImported", "Header", "Security", "CorpAction", "TranDetail", "Generic", "CostBasis", "Beneficiary", "StoredPerformance", "Systematic", "RMD", "Banking" ] }, { "name": "updatedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFileDetailDto" }, "xml": { "name": "DownloadFileDetailDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFileDetailDto" }, "xml": { "name": "DownloadFileDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/RecordType/{recordType}/Details/List": { "post": { "tags": [ "Confirm/DownloadFiles" ], "summary": "Gets the download file detail records for the provided keys of the given record type.", "operationId": "DownloadFiles_GetRecordTypeDetailByKeyList", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "recordType", "in": "path", "description": "The key of the record type.", "required": true, "type": "string", "enum": [ "Name", "Position", "Transaction", "Price", "Dividend", "Product", "NotImported", "Header", "Security", "CorpAction", "TranDetail", "Generic", "CostBasis", "Beneficiary", "StoredPerformance", "Systematic", "RMD", "Banking" ] }, { "name": "keys", "in": "body", "description": "Keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFileDetailDto" }, "xml": { "name": "DownloadFileDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/Simple": { "get": { "tags": [ "Confirm/DownloadFiles" ], "operationId": "DownloadFiles_GetSimpleAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/SleeveColumnData": { "get": { "tags": [ "Confirm/DownloadFiles" ], "operationId": "DownloadFiles_GetSleeveColumnData", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Confirm/DownloadFiles" ], "operationId": "DownloadFiles_SaveSleeveColumnData", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "sleeveColumnDataDto", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.SleeveColumnDataDto" }, "xml": { "name": "SleeveColumnDataDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFiles/SleeveData": { "post": { "tags": [ "Confirm/DownloadFiles" ], "operationId": "DownloadFiles_GetSleeveData", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "transactionIDs", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFormat/DownloadSubFormatSchedulerDefault/{formatId}": { "get": { "tags": [ "Confirm/DownloadFormat" ], "summary": "Gets the Download Format Source Default that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "description": "Sample Request\r\n\tGET /Confirm/DownloadFormat/DownloadSubFormatSchedulerDefault/14\r\n\t[\r\n {\r\n \"downloadFormatId\": 14,\r\n \"downloadFormatSubTypeId\": 66,\r\n \"isAltSchedule\": true,\r\n \"notificationGroup\": null,\r\n \"notifyOnSuccess\": false,\r\n \"active\": false,\r\n \"priorityJob\": false,\r\n \"interval\": \"Minute\",\r\n \"frequency\": 1,\r\n \"offset\": 1,\r\n \"offsetInterval\": \"Minute\",\r\n \"startTime\": \"1900-01-01T00:10:00-06:00\",\r\n \"endTime\": \"1900-01-01T00:20:00-06:00\",\r\n \"runDays\": \"Weekends\",\r\n \"businessDayOfMonth\": \"Tuesday\",\r\n \"schedulerTypeName\": \"FixedIntervalScheduler\",\r\n \"filePath\": \"myFilePath.json\",\r\n \"folderPath\": \"my/Folder/Path\",\r\n \"searchPattern\": \"*.*\",\r\n \"searchOption\": \"TopDirectoryOnly\",\r\n \"importFiles\": true,\r\n \"applyPriceAndSecurity\": true,\r\n \"verifyPriceAndSecurity\": true,\r\n \"useThreading\": false,\r\n \"numberOfThreads\": 1,\r\n \"sizeOfBatch\": 0,\r\n \"useAlternateFilePattern\": false,\r\n \"expectedNumberOfFiles\": 0,\r\n \"parentJobID\": 0,\r\n \"editedDate\": null,\r\n \"editedBy\": null,\r\n \"createdDate\": null,\r\n \"createdBy\": null,\r\n \"isCostBasis\": false\r\n },\r\n {\r\n \"downloadFormatId\": 14,\r\n \"downloadFormatSubTypeId\": 101,\r\n \"isAltSchedule\": true,\r\n \"notificationGroup\": null,\r\n \"notifyOnSuccess\": false,\r\n \"active\": true,\r\n \"priorityJob\": true,\r\n \"interval\": \"Hour\",\r\n \"frequency\": 1,\r\n \"offset\": 3,\r\n \"offsetInterval\": \"Week\",\r\n \"startTime\": \"1900-01-01T00:10:00-06:00\",\r\n \"endTime\": \"1900-01-01T00:20:00-06:00\",\r\n \"runDays\": \"Tuesday\",\r\n \"businessDayOfMonth\": \"Tuesday\",\r\n \"schedulerTypeName\": \"FixedIntervalScheduler\",\r\n \"filePath\": \"myFilePath.json\",\r\n \"folderPath\": \"my/Folder/Path\",\r\n \"searchPattern\": \"*.*\",\r\n \"searchOption\": \"AllDirectories\",\r\n \"importFiles\": true,\r\n \"applyPriceAndSecurity\": true,\r\n \"verifyPriceAndSecurity\": true,\r\n \"useThreading\": false,\r\n \"numberOfThreads\": 1,\r\n \"sizeOfBatch\": 1,\r\n \"useAlternateFilePattern\": false,\r\n \"expectedNumberOfFiles\": 500,\r\n \"parentJobID\": 1,\r\n \"editedDate\": null,\r\n \"editedBy\": null,\r\n \"createdDate\": null,\r\n \"createdBy\": null,\r\n \"isCostBasis\": false\r\n }\r\n]", "operationId": "DownloadSubFormatSchedulerDefault_GetAllDownloadSubFormatSchedulerDefaultsByDownloadFormatIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "formatId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "token", "in": "header", "description": "The cancellation token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadSubFormatSchedulerDefaultDto" }, "xml": { "name": "DownloadSubFormatSchedulerDefaultDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFormat/DownloadSubFormatSchedulerDefault/BulkUpdate": { "post": { "tags": [ "Confirm/DownloadFormat" ], "summary": "Updates all Scheduler Default SubFormats", "description": "Sample Request\r\n\tPost /Confirm/DownloadFormatSourceDefault/BulkUpdate\r\n\t{\r\n [{\"downloadFormatId\":14,\"downloadFormatSubTypeId\":66,\"isAltSchedule\":true,\"notificationGroup\":null,\"notifyOnSuccess\":false,\"active\":false,\"priorityJob\":false,\"interval\":\"Minute\",\"frequency\":1,\"offset\":1,\"offsetInterval\":\"Minute\",\"startTime\":\"1900-01-01T00:10:00-06:00\",\"endTime\":\"1900-01-01T00:20:00-06:00\",\"runDays\":\"Weekends\",\"businessDayOfMonth\":\"Tuesday\",\"schedulerTypeName\":\"FixedIntervalScheduler\",\"filePath\":\"myFilePath.json\",\"folderPath\":\"my/Folder/Path\",\"searchPattern\":\"*.*\",\"searchOption\":\"TopDirectoryOnly\",\"importFiles\":true,\"applyPriceAndSecurity\":true,\"verifyPriceAndSecurity\":true,\"useThreading\":false,\"numberOfThreads\":1,\"sizeOfBatch\":0,\"useAlternateFilePattern\":false,\"expectedNumberOfFiles\":0,\"parentJobID\":0,\"editedDate\":null,\"editedBy\":null,\"createdDate\":null,\"createdBy\":null,\"isCostBasis\":false,\"isFromDB\":true},{\"downloadFormatId\":14,\"downloadFormatSubTypeId\":101,\"isAltSchedule\":true,\"notificationGroup\":null,\"notifyOnSuccess\":false,\"active\":true,\"priorityJob\":true,\"interval\":\"Hour\",\"frequency\":1,\"offset\":3,\"offsetInterval\":\"Week\",\"startTime\":\"1900-01-01T00:10:00-06:00\",\"endTime\":\"1900-01-01T00:20:00-06:00\",\"runDays\":\"Tuesday\",\"businessDayOfMonth\":\"Tuesday\",\"schedulerTypeName\":\"FixedIntervalScheduler\",\"filePath\":\"myFilePath.json\",\"folderPath\":\"my/Folder/Path\",\"searchPattern\":\"*.*\",\"searchOption\":\"AllDirectories\",\"importFiles\":true,\"applyPriceAndSecurity\":true,\"verifyPriceAndSecurity\":true,\"useThreading\":false,\"numberOfThreads\":1,\"sizeOfBatch\":1,\"useAlternateFilePattern\":false,\"expectedNumberOfFiles\":500,\"parentJobID\":1,\"editedDate\":null,\"editedBy\":null,\"createdDate\":null,\"createdBy\":null,\"isCostBasis\":false,\"isFromDB\":true},{ \"downloadFormatId\":14,\"downloadFormatSubTypeId\":0,\"isCostBasis\":false,\"isAltSchedule\":false,\"notificationGroup\":null,\"notifyOnSuccess\":false,\"active\":false,\"priorityJob\":false,\"interval\":\"Day\",\"frequency\":1,\"offset\":0,\"offsetInterval\":\"Day\",\"startTime\":\"2000-01-01 00:00:00.000\",\"endTime\":\"2000-01-01 23:59:00.000\",\"runDays\":\"Everyday\",\"businessDayofMonth\":null,\"schedulerTypeName\":\"FixedIntervalScheduler\",\"filePath\":null,\"folderPath\":null,\"searchPattern\":null,\"searchOption\":\"TopDirectoryOnly\",\"importFiles\":true,\"applyPriceAndSecurity\":true,\"verifyPriceAndSecurity\":true,\"numberOfThreads\":4,\"sizeOfBatch\":20000,\"useAlternateFilePattern\":false,\"expectedNumberOfFiles\":0,\"parentJobID\":null,\"isFromDB\":true}]\r\n\t}", "operationId": "DownloadSubFormatSchedulerDefault_BulkUpdateDownloadSubFormatSchedulerDefaultsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "data", "in": "body", "description": "The collection of data we should update the subformats to", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadSubFormatSchedulerDefaultDto" }, "xml": { "name": "DownloadSubFormatSchedulerDefaultDto", "wrapped": true }, "type": "array" } }, { "name": "token", "in": "header", "description": "The cancellation token", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFormat/DownloadSubFormatSchedulerDefault/DeleteCostBasisRows": { "post": { "tags": [ "Confirm/DownloadFormat" ], "summary": "Deletes rows from DownloadSubFormatSchedulerDefaults based on the input parameters which must be cost basis rows", "description": "Sample Request\r\nPOST /Confirm/DownloadFormat/DownloadSubFormatSchedulerDefault/DeleteCostBasisRows\r\n{\r\n [{\"downloadFormatId\":14,\"downloadFormatSubTypeId\":0,\"isCostBasis\":true},{\"downloadFormatId\":14,\"downloadFormatSubTypeId\":101,\"isCostBasis\":true}]\r\n}\r\n", "operationId": "DownloadSubFormatSchedulerDefault_RemoveCostBasisDownloadSubFormatSchedulerDefaultsByKeyAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "data", "in": "body", "description": "The data we should delete", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadSubFormatSchedulerDefaultKey" }, "xml": { "name": "DownloadSubFormatSchedulerDefaultKey", "wrapped": true }, "type": "array" } }, { "name": "token", "in": "header", "description": "The cancellation token", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFormats": { "get": { "tags": [ "Confirm/DownloadFormats" ], "summary": "Gets a list of Download Formats that the logged in user has access to.", "operationId": "DownloadFormats_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFormatDto" }, "xml": { "name": "DownloadFormatDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Confirm/DownloadFormats" ], "summary": "Creates a new Download Format.", "operationId": "DownloadFormats_CreateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "DownloadFormat", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFormatDto" } }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFormatDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFormats/{key}": { "get": { "tags": [ "Confirm/DownloadFormats" ], "summary": "Gets the Download Format that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "description": "Sample Request\r\n\tGET /Confirm/DownloadFormats/1", "operationId": "DownloadFormats_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFormatDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Confirm/DownloadFormats" ], "operationId": "DownloadFormats_UpdateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFormatDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFormatDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFormats/{key}/Markup": { "get": { "tags": [ "Confirm/DownloadFormats" ], "summary": "Gets the XML from the Download Format that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "DownloadFormats_GetMarkupByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFormatMarkupDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Confirm/DownloadFormats" ], "summary": "Used to update an existing Download Format's XML. Upon successful modification a 200 will be returned.", "operationId": "DownloadFormats_UpdateMarkupAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFormatMarkupDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFormatMarkupDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFormats/{key}/Rectype": { "put": { "tags": [ "Confirm/DownloadFormats" ], "summary": "Updates the rectype asynchronous.", "operationId": "DownloadFormats_UpdateRectypeAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "key", "in": "path", "description": "The key.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "The dto.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFormatRectypeDto" } }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true }, { "name": "versionCode", "in": "query", "required": false, "type": "string" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFormats/{key}/Rectype/{versionCode}": { "put": { "tags": [ "Confirm/DownloadFormats" ], "summary": "Updates the rectype asynchronous.", "operationId": "DownloadFormats_PutV1ConfirmDownloadFormatsByKeyRectypeByVersionCode", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "key", "in": "path", "description": "The key.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "The dto.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFormatRectypeDto" } }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true }, { "name": "versionCode", "in": "path", "required": true, "type": "string" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFormats/{key}/SubTypesSimple": { "get": { "tags": [ "Confirm/DownloadFormats" ], "summary": "Gets a list of download format sub types by format key asynchronous.", "description": "Sample Request\r\n\tGET /Confirm/DownloadFormats/1/SubTypesSimple", "operationId": "DownloadFormats_GetDownloadFormatSubTypeByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The key of the format.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFormats/{key}/SubTypesSimpleWithDefault": { "get": { "tags": [ "Confirm/DownloadFormats" ], "summary": "Gets a list of download format sub types by format key asynchronous including the default 0 value", "description": "Sample Request\r\n\tGET /Confirm/DownloadFormats/1/SubTypesSimple", "operationId": "DownloadFormats_GetDownloadFormatSubTypeWithDefaultByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The key of the format.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFormats/Simple": { "get": { "tags": [ "Confirm/DownloadFormats" ], "operationId": "DownloadFormats_GetSimpleAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFormats/Verbose": { "get": { "tags": [ "Confirm/DownloadFormats" ], "operationId": "DownloadFormats_GetVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "DownloadFormat", "DownloadFormatNoteMapping", "DownloadFormatLocalSecurityMapping", "DownloadFormatUniqueSymbolMapping", "DownloadFormatTransactionNoteMapping", "DownloadFormatSubType", "DownloadFormatCashOffsetMapping", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFormatVerboseDto" }, "xml": { "name": "DownloadFormatVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFormats/Verbose/{key}": { "get": { "tags": [ "Confirm/DownloadFormats" ], "operationId": "DownloadFormats_GetVerboseByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "DownloadFormat", "DownloadFormatNoteMapping", "DownloadFormatLocalSecurityMapping", "DownloadFormatUniqueSymbolMapping", "DownloadFormatTransactionNoteMapping", "DownloadFormatSubType", "DownloadFormatCashOffsetMapping", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFormatVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Confirm/DownloadFormats" ], "operationId": "DownloadFormats_UpdateVerboseAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFormatVerboseDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFormatVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFormatSourceDefault": { "get": { "tags": [ "Confirm/DownloadFormatSourceDefault" ], "summary": "Gets a list of Download Format Source Default that the logged in user has access to.", "description": "Sample Request\r\n\tGET /Confirm/DownloadFormatSourceDefault", "operationId": "DownloadFormatSourceDefault_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFormatSourceDefaultDto" }, "xml": { "name": "DownloadFormatSourceDefaultDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Confirm/DownloadFormatSourceDefault" ], "summary": "Insert Download Format Source Default", "description": "Sample Request\r\n POST /Confirm/DownloadFormatSourceDefault\r\n {\r\n \"downloadFormatId\": 14,\r\n \"downloadDescription\": \"Under Review - DST\",\r\n \"custodianCommonCode\": \"DST\",\r\n \"serviceTeamReconId\": 52,\r\n \"serviceTeamMemberId\": null,\r\n \"newAccounts\": \"Don't Create\",\r\n \"reconTargetTime\": \"2017-06-22T10:00:00-05:00\",\r\n \"note\": \"New test sreeja test\",\r\n \"transmitMethod\": \"DSTHTTP\",\r\n \"url\": \"\",\r\n \"filePattern\": \"*.*\",\r\n \"altFilePattern\": \"\",\r\n \"patternMatchType\": \"Included\",\r\n \"zipPassword\": \"\",\r\n \"userId\": \"***Required***\",\r\n \"password\": \"***Required***\",\r\n \"transPercTolerance\": 15,\r\n \"transDaysTolerance\": 5,\r\n \"cashCusip\": null,\r\n \"deleteSourceFile\": true,\r\n \"registrationBaseNumber\": 0,\r\n \"positionOnlyReconcile\": \"No\",\r\n \"dailyAccrualTolerance\": 0,\r\n \"useReversal\": true,\r\n \"ignoreRepVerify\": false,\r\n \"isAutoHouseholding\": true,\r\n \"noOrionPriceCopy\": false,\r\n \"newAccountCenterSuppression\": false,\r\n \"isFixSmallBalance\": false,\r\n \"isDividendTransactionCombination\": false,\r\n \"alwaysCreateNewRegistration\": false,\r\n \"namePercentMatch\": 0,\r\n \"positionPercentMatch\": 0,\r\n \"transactionPercentMatch\": 0,\r\n \"comparePositionValue\": false,\r\n \"runAssetValueComparison\": true,\r\n \"isSourceExclusionCB\": false,\r\n \"isSourceExclusionTran\": true,\r\n \"isUnVerifiedSells\": false,\r\n \"allowPriceZero\": false,\r\n \"allowAcctCodeMatch\": true,\r\n \"allowAcctCodeMatchWOZero\": false,\r\n \"allowSecondaryAcctCodeMatch\": false,\r\n \"allowPriceImport\": false,\r\n \"allowNameImport\": true,\r\n \"allowPositionImport\": true,\r\n \"allowTransactionImport\": true,\r\n \"allowSecurityImport\": true,\r\n \"allowCorpActionImport\": false,\r\n \"allowDivImport\": false,\r\n \"allowBeneficiaryImport\": false,\r\n \"allowSystematicImport\": null,\r\n \"allowRMDImport\": null,\r\n \"allowBankingImport\": null,\r\n \"allowTranDetailImport\": false,\r\n \"allowGenericImport\": false,\r\n \"allowCostBasisImport\": false,\r\n \"isActive\": true,\r\n \"autoCreateStartingValues\": false,\r\n \"archiveFiles\": false,\r\n \"underReview\": false,\r\n \"isOrionEnterpriseEnabled\": false,\r\n \"allowDuplicateAssets\": false,\r\n \"allowProperName\": false,\r\n \"removeSettleDateTrades\": false,\r\n \"principalAndIncome\": false,\r\n \"createTransactionInPendingStatus\": false,\r\n \"isSshEnabled\": false,\r\n \"hasSftpKey\": false,\r\n \"editedDate\": \"2022-06-14T12:05:29.54-05:00\",\r\n \"editedBy\": \"cameron.stoner\",\r\n \"createdDate\": null,\r\n \"createdBy\": null,\r\n \"options\": [\r\n {\r\n \"code\": \"AutoConfirmUnmatchedPrices\",\r\n \"name\": \"Auto Confirm Unmatched Prices\",\r\n \"type\": \"checkbox\",\r\n \"value\": \"false\",\r\n \"privilegeCode\": \"manualPriceConfirm\"\r\n },\r\n {\r\n \"code\": \"COMBINESWEEP\",\r\n \"name\": \"Remove Self-Sweep Activity\",\r\n \"type\": \"checkbox\",\r\n \"value\": \"false\",\r\n \"privilegeCode\": null\r\n },\r\n {\r\n \"code\": \"ProductDailyAccrual\",\r\n \"name\": \"Product Daily Accrual\",\r\n \"type\": \"checkbox\",\r\n \"value\": \"false\",\r\n \"privilegeCode\": null\r\n },\r\n {\r\n \"code\": \"SleeveFileNoExclusion\",\r\n \"name\": \"Sleeve File No Exclusion\",\r\n \"type\": \"checkbox\",\r\n \"value\": \"false\",\r\n \"privilegeCode\": null\r\n },\r\n {\r\n \"code\": \"SPLITPOSITIONROLLUP\",\r\n \"name\": \"Split Position Rollup\",\r\n \"type\": \"checkbox\",\r\n \"value\": \"false\",\r\n \"privilegeCode\": null\r\n },\r\n {\r\n \"code\": \"SweepToFrom\",\r\n \"name\": \"Sweep To From\",\r\n \"type\": \"checkbox\",\r\n \"value\": \"false\",\r\n \"privilegeCode\": null\r\n },\r\n {\r\n \"code\": \"UseNewPosVerifyApply\",\r\n \"name\": \"Use New Position Verify|Apply\",\r\n \"type\": \"checkbox\",\r\n \"value\": \"false\",\r\n \"privilegeCode\": null\r\n },\r\n {\r\n \"code\": \"UseNewPriceVerifyApply\",\r\n \"name\": \"Use New Price Verify|Apply\",\r\n \"type\": \"checkbox\",\r\n \"value\": \"false\",\r\n \"privilegeCode\": null\r\n },\r\n {\r\n \"code\": \"UseNewSecurityMasterVerifyApply\",\r\n \"name\": \"Use New Security Master Verify|Apply\",\r\n \"type\": \"checkbox\",\r\n \"value\": \"false\",\r\n \"privilegeCode\": null\r\n },\r\n {\r\n \"code\": \"UseNewTransactionVerifyApply\",\r\n \"name\": \"Use New Transaction Verify/Apply\",\r\n \"type\": \"checkbox\",\r\n \"value\": \"false\",\r\n \"privilegeCode\": null\r\n },\r\n {\r\n \"code\": \"UseTDAllocationToTomForEclipseDB\",\r\n \"name\": \"TD Trade Allocations to TOM for Eclipse DB\",\r\n \"type\": \"checkbox\",\r\n \"value\": \"false\",\r\n \"privilegeCode\": null\r\n },\r\n {\r\n \"code\": \"PRICEROLLUPPRECISION\",\r\n \"name\": \"Price Rollup Precision\",\r\n \"type\": \"number\",\r\n \"value\": \"8\",\r\n \"privilegeCode\": null\r\n },\r\n {\r\n \"code\": \"emailList\",\r\n \"name\": \"Watcher Email List\",\r\n \"type\": \"textarea\",\r\n \"value\": \"\",\r\n \"privilegeCode\": null\r\n }\r\n ]\r\n }", "operationId": "DownloadFormatSourceDefault_CreateDownloadSourceDefaultAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "The dto.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFormatSourceDefaultDto" } }, { "name": "token", "in": "header", "description": "The token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFormatSourceDefaultDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFormatSourceDefault/{key}": { "get": { "tags": [ "Confirm/DownloadFormatSourceDefault" ], "summary": "Gets the Download Format Source Default that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "description": "Sample Request\r\n\tGET /Confirm/DownloadFormatSourceDefault/14", "operationId": "DownloadFormatSourceDefault_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "token", "in": "header", "description": "The token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFormatSourceDefaultDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Confirm/DownloadFormatSourceDefault" ], "summary": "Update Download Format Source Default", "description": "Sample Request\r\n GET /Confirm/DownloadFormatSourceDefault/14\r\n {\r\nSample Request\r\n POST /Confirm/DownloadFormatSourceDefault\r\n {\r\n \"downloadFormatId\": 14,\r\n \"downloadDescription\": \"Under Review - DST\",\r\n \"custodianCommonCode\": \"DST\",\r\n \"serviceTeamReconId\": 52,\r\n \"serviceTeamMemberId\": null,\r\n \"newAccounts\": \"Don't Create\",\r\n \"reconTargetTime\": \"2017-06-22T10:00:00-05:00\",\r\n \"note\": \"New test sreeja test\",\r\n \"transmitMethod\": \"DSTHTTP\",\r\n \"url\": \"\",\r\n \"filePattern\": \"*.*\",\r\n \"altFilePattern\": \"\",\r\n \"patternMatchType\": \"Included\",\r\n \"zipPassword\": \"\",\r\n \"userId\": \"***Required***\",\r\n \"password\": \"***Required***\",\r\n \"transPercTolerance\": 15,\r\n \"transDaysTolerance\": 5,\r\n \"cashCusip\": null,\r\n \"deleteSourceFile\": true,\r\n \"registrationBaseNumber\": 0,\r\n \"positionOnlyReconcile\": \"No\",\r\n \"dailyAccrualTolerance\": 0,\r\n \"useReversal\": true,\r\n \"ignoreRepVerify\": false,\r\n \"isAutoHouseholding\": true,\r\n \"noOrionPriceCopy\": false,\r\n \"newAccountCenterSuppression\": false,\r\n \"isFixSmallBalance\": false,\r\n \"isDividendTransactionCombination\": false,\r\n \"alwaysCreateNewRegistration\": false,\r\n \"namePercentMatch\": 0,\r\n \"positionPercentMatch\": 0,\r\n \"transactionPercentMatch\": 0,\r\n \"comparePositionValue\": false,\r\n \"runAssetValueComparison\": true,\r\n \"isSourceExclusionCB\": false,\r\n \"isSourceExclusionTran\": true,\r\n \"isUnVerifiedSells\": false,\r\n \"allowPriceZero\": false,\r\n \"allowAcctCodeMatch\": true,\r\n \"allowAcctCodeMatchWOZero\": false,\r\n \"allowSecondaryAcctCodeMatch\": false,\r\n \"allowPriceImport\": false,\r\n \"allowNameImport\": true,\r\n \"allowPositionImport\": true,\r\n \"allowTransactionImport\": true,\r\n \"allowSecurityImport\": true,\r\n \"allowCorpActionImport\": false,\r\n \"allowDivImport\": false,\r\n \"allowBeneficiaryImport\": false,\r\n \"allowSystematicImport\": null,\r\n \"allowRMDImport\": null,\r\n \"allowBankingImport\": null,\r\n \"allowTranDetailImport\": false,\r\n \"allowGenericImport\": false,\r\n \"allowCostBasisImport\": false,\r\n \"isActive\": true,\r\n \"autoCreateStartingValues\": false,\r\n \"archiveFiles\": false,\r\n \"underReview\": false,\r\n \"isOrionEnterpriseEnabled\": false,\r\n \"allowDuplicateAssets\": false,\r\n \"allowProperName\": false,\r\n \"removeSettleDateTrades\": false,\r\n \"principalAndIncome\": false,\r\n \"createTransactionInPendingStatus\": false,\r\n \"isSshEnabled\": false,\r\n \"hasSftpKey\": false,\r\n \"editedDate\": \"2022-06-14T12:05:29.54-05:00\",\r\n \"editedBy\": \"cameron.stoner\",\r\n \"createdDate\": null,\r\n \"createdBy\": null,\r\n \"options\": [\r\n {\r\n \"code\": \"AutoConfirmUnmatchedPrices\",\r\n \"name\": \"Auto Confirm Unmatched Prices\",\r\n \"type\": \"checkbox\",\r\n \"value\": \"false\",\r\n \"privilegeCode\": \"manualPriceConfirm\"\r\n },\r\n {\r\n \"code\": \"COMBINESWEEP\",\r\n \"name\": \"Remove Self-Sweep Activity\",\r\n \"type\": \"checkbox\",\r\n \"value\": \"false\",\r\n \"privilegeCode\": null\r\n },\r\n {\r\n \"code\": \"ProductDailyAccrual\",\r\n \"name\": \"Product Daily Accrual\",\r\n \"type\": \"checkbox\",\r\n \"value\": \"false\",\r\n \"privilegeCode\": null\r\n },\r\n {\r\n \"code\": \"SleeveFileNoExclusion\",\r\n \"name\": \"Sleeve File No Exclusion\",\r\n \"type\": \"checkbox\",\r\n \"value\": \"false\",\r\n \"privilegeCode\": null\r\n },\r\n {\r\n \"code\": \"SPLITPOSITIONROLLUP\",\r\n \"name\": \"Split Position Rollup\",\r\n \"type\": \"checkbox\",\r\n \"value\": \"false\",\r\n \"privilegeCode\": null\r\n },\r\n {\r\n \"code\": \"SweepToFrom\",\r\n \"name\": \"Sweep To From\",\r\n \"type\": \"checkbox\",\r\n \"value\": \"false\",\r\n \"privilegeCode\": null\r\n },\r\n {\r\n \"code\": \"UseNewPosVerifyApply\",\r\n \"name\": \"Use New Position Verify|Apply\",\r\n \"type\": \"checkbox\",\r\n \"value\": \"false\",\r\n \"privilegeCode\": null\r\n },\r\n {\r\n \"code\": \"UseNewPriceVerifyApply\",\r\n \"name\": \"Use New Price Verify|Apply\",\r\n \"type\": \"checkbox\",\r\n \"value\": \"false\",\r\n \"privilegeCode\": null\r\n },\r\n {\r\n \"code\": \"UseNewSecurityMasterVerifyApply\",\r\n \"name\": \"Use New Security Master Verify|Apply\",\r\n \"type\": \"checkbox\",\r\n \"value\": \"false\",\r\n \"privilegeCode\": null\r\n },\r\n {\r\n \"code\": \"UseNewTransactionVerifyApply\",\r\n \"name\": \"Use New Transaction Verify/Apply\",\r\n \"type\": \"checkbox\",\r\n \"value\": \"false\",\r\n \"privilegeCode\": null\r\n },\r\n {\r\n \"code\": \"UseTDAllocationToTomForEclipseDB\",\r\n \"name\": \"TD Trade Allocations to TOM for Eclipse DB\",\r\n \"type\": \"checkbox\",\r\n \"value\": \"false\",\r\n \"privilegeCode\": null\r\n },\r\n {\r\n \"code\": \"PRICEROLLUPPRECISION\",\r\n \"name\": \"Price Rollup Precision\",\r\n \"type\": \"number\",\r\n \"value\": \"8\",\r\n \"privilegeCode\": null\r\n },\r\n {\r\n \"code\": \"emailList\",\r\n \"name\": \"Watcher Email List\",\r\n \"type\": \"textarea\",\r\n \"value\": \"\",\r\n \"privilegeCode\": null\r\n }\r\n ]\r\n }", "operationId": "DownloadFormatSourceDefault_UpdateDownloadFormatSourceDefaultAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The key.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "The dto.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFormatSourceDefaultDto" } }, { "name": "token", "in": "header", "description": "The token.", "required": true }, { "name": "subtypeId", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFormatSourceDefaultDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFormatSourceDefault/{key}/{subtypeId}": { "put": { "tags": [ "Confirm/DownloadFormatSourceDefault" ], "summary": "Update Download Format Source Default", "description": "Sample Request\r\n GET /Confirm/DownloadFormatSourceDefault/14\r\n {\r\nSample Request\r\n POST /Confirm/DownloadFormatSourceDefault\r\n {\r\n \"downloadFormatId\": 14,\r\n \"downloadDescription\": \"Under Review - DST\",\r\n \"custodianCommonCode\": \"DST\",\r\n \"serviceTeamReconId\": 52,\r\n \"serviceTeamMemberId\": null,\r\n \"newAccounts\": \"Don't Create\",\r\n \"reconTargetTime\": \"2017-06-22T10:00:00-05:00\",\r\n \"note\": \"New test sreeja test\",\r\n \"transmitMethod\": \"DSTHTTP\",\r\n \"url\": \"\",\r\n \"filePattern\": \"*.*\",\r\n \"altFilePattern\": \"\",\r\n \"patternMatchType\": \"Included\",\r\n \"zipPassword\": \"\",\r\n \"userId\": \"***Required***\",\r\n \"password\": \"***Required***\",\r\n \"transPercTolerance\": 15,\r\n \"transDaysTolerance\": 5,\r\n \"cashCusip\": null,\r\n \"deleteSourceFile\": true,\r\n \"registrationBaseNumber\": 0,\r\n \"positionOnlyReconcile\": \"No\",\r\n \"dailyAccrualTolerance\": 0,\r\n \"useReversal\": true,\r\n \"ignoreRepVerify\": false,\r\n \"isAutoHouseholding\": true,\r\n \"noOrionPriceCopy\": false,\r\n \"newAccountCenterSuppression\": false,\r\n \"isFixSmallBalance\": false,\r\n \"isDividendTransactionCombination\": false,\r\n \"alwaysCreateNewRegistration\": false,\r\n \"namePercentMatch\": 0,\r\n \"positionPercentMatch\": 0,\r\n \"transactionPercentMatch\": 0,\r\n \"comparePositionValue\": false,\r\n \"runAssetValueComparison\": true,\r\n \"isSourceExclusionCB\": false,\r\n \"isSourceExclusionTran\": true,\r\n \"isUnVerifiedSells\": false,\r\n \"allowPriceZero\": false,\r\n \"allowAcctCodeMatch\": true,\r\n \"allowAcctCodeMatchWOZero\": false,\r\n \"allowSecondaryAcctCodeMatch\": false,\r\n \"allowPriceImport\": false,\r\n \"allowNameImport\": true,\r\n \"allowPositionImport\": true,\r\n \"allowTransactionImport\": true,\r\n \"allowSecurityImport\": true,\r\n \"allowCorpActionImport\": false,\r\n \"allowDivImport\": false,\r\n \"allowBeneficiaryImport\": false,\r\n \"allowSystematicImport\": null,\r\n \"allowRMDImport\": null,\r\n \"allowBankingImport\": null,\r\n \"allowTranDetailImport\": false,\r\n \"allowGenericImport\": false,\r\n \"allowCostBasisImport\": false,\r\n \"isActive\": true,\r\n \"autoCreateStartingValues\": false,\r\n \"archiveFiles\": false,\r\n \"underReview\": false,\r\n \"isOrionEnterpriseEnabled\": false,\r\n \"allowDuplicateAssets\": false,\r\n \"allowProperName\": false,\r\n \"removeSettleDateTrades\": false,\r\n \"principalAndIncome\": false,\r\n \"createTransactionInPendingStatus\": false,\r\n \"isSshEnabled\": false,\r\n \"hasSftpKey\": false,\r\n \"editedDate\": \"2022-06-14T12:05:29.54-05:00\",\r\n \"editedBy\": \"cameron.stoner\",\r\n \"createdDate\": null,\r\n \"createdBy\": null,\r\n \"options\": [\r\n {\r\n \"code\": \"AutoConfirmUnmatchedPrices\",\r\n \"name\": \"Auto Confirm Unmatched Prices\",\r\n \"type\": \"checkbox\",\r\n \"value\": \"false\",\r\n \"privilegeCode\": \"manualPriceConfirm\"\r\n },\r\n {\r\n \"code\": \"COMBINESWEEP\",\r\n \"name\": \"Remove Self-Sweep Activity\",\r\n \"type\": \"checkbox\",\r\n \"value\": \"false\",\r\n \"privilegeCode\": null\r\n },\r\n {\r\n \"code\": \"ProductDailyAccrual\",\r\n \"name\": \"Product Daily Accrual\",\r\n \"type\": \"checkbox\",\r\n \"value\": \"false\",\r\n \"privilegeCode\": null\r\n },\r\n {\r\n \"code\": \"SleeveFileNoExclusion\",\r\n \"name\": \"Sleeve File No Exclusion\",\r\n \"type\": \"checkbox\",\r\n \"value\": \"false\",\r\n \"privilegeCode\": null\r\n },\r\n {\r\n \"code\": \"SPLITPOSITIONROLLUP\",\r\n \"name\": \"Split Position Rollup\",\r\n \"type\": \"checkbox\",\r\n \"value\": \"false\",\r\n \"privilegeCode\": null\r\n },\r\n {\r\n \"code\": \"SweepToFrom\",\r\n \"name\": \"Sweep To From\",\r\n \"type\": \"checkbox\",\r\n \"value\": \"false\",\r\n \"privilegeCode\": null\r\n },\r\n {\r\n \"code\": \"UseNewPosVerifyApply\",\r\n \"name\": \"Use New Position Verify|Apply\",\r\n \"type\": \"checkbox\",\r\n \"value\": \"false\",\r\n \"privilegeCode\": null\r\n },\r\n {\r\n \"code\": \"UseNewPriceVerifyApply\",\r\n \"name\": \"Use New Price Verify|Apply\",\r\n \"type\": \"checkbox\",\r\n \"value\": \"false\",\r\n \"privilegeCode\": null\r\n },\r\n {\r\n \"code\": \"UseNewSecurityMasterVerifyApply\",\r\n \"name\": \"Use New Security Master Verify|Apply\",\r\n \"type\": \"checkbox\",\r\n \"value\": \"false\",\r\n \"privilegeCode\": null\r\n },\r\n {\r\n \"code\": \"UseNewTransactionVerifyApply\",\r\n \"name\": \"Use New Transaction Verify/Apply\",\r\n \"type\": \"checkbox\",\r\n \"value\": \"false\",\r\n \"privilegeCode\": null\r\n },\r\n {\r\n \"code\": \"UseTDAllocationToTomForEclipseDB\",\r\n \"name\": \"TD Trade Allocations to TOM for Eclipse DB\",\r\n \"type\": \"checkbox\",\r\n \"value\": \"false\",\r\n \"privilegeCode\": null\r\n },\r\n {\r\n \"code\": \"PRICEROLLUPPRECISION\",\r\n \"name\": \"Price Rollup Precision\",\r\n \"type\": \"number\",\r\n \"value\": \"8\",\r\n \"privilegeCode\": null\r\n },\r\n {\r\n \"code\": \"emailList\",\r\n \"name\": \"Watcher Email List\",\r\n \"type\": \"textarea\",\r\n \"value\": \"\",\r\n \"privilegeCode\": null\r\n }\r\n ]\r\n }", "operationId": "DownloadFormatSourceDefault_PutV1ConfirmDownloadFormatSourceDefaultByKeyBySubtypeId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The key.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "The dto.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFormatSourceDefaultDto" } }, { "name": "token", "in": "header", "description": "The token.", "required": true }, { "name": "subtypeId", "in": "path", "required": true, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFormatSourceDefaultDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFormatSourceDefault/BulkUpdate": { "put": { "tags": [ "Confirm/DownloadFormatSourceDefault" ], "operationId": "DownloadFormatSourceDefault_BulkUpdateDownloadFormatSourceDefaultsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFormatSourceDefaultDto" }, "xml": { "name": "DownloadFormatSourceDefaultDto", "wrapped": true }, "type": "array" } }, { "name": "token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFormatSourceDefaultDto" }, "xml": { "name": "DownloadFormatSourceDefaultDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFormatSourceDefault/KeyFile/{key}": { "post": { "tags": [ "Confirm/DownloadFormatSourceDefault" ], "summary": "Adds the SFTP key file.", "description": "Sample Request\r\n POST /Confirm/DownloadFormatSourceDefault/14\r\n {\r\n \"file\": {\r\n \"fileName\": \"string\",\r\n \"mediaType\": \"string\",\r\n \"data\": {}\r\n }\r\n }", "operationId": "DownloadFormatSourceDefault_AddSftpKeyFileAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The key.", "required": true, "type": "integer", "format": "int32" }, { "name": "keyFile", "in": "body", "description": "The file.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.SourceFileDto" } }, { "name": "token", "in": "header", "description": "The token.", "required": true }, { "name": "subtypeId", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFormatSourceDefault/KeyFile/{key}/{subtypeId}": { "post": { "tags": [ "Confirm/DownloadFormatSourceDefault" ], "summary": "Adds the SFTP key file.", "description": "Sample Request\r\n POST /Confirm/DownloadFormatSourceDefault/14\r\n {\r\n \"file\": {\r\n \"fileName\": \"string\",\r\n \"mediaType\": \"string\",\r\n \"data\": {}\r\n }\r\n }", "operationId": "DownloadFormatSourceDefault_PostV1ConfirmDownloadFormatSourceDefaultKeyFileByKeyBySubtypeId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The key.", "required": true, "type": "integer", "format": "int32" }, { "name": "keyFile", "in": "body", "description": "The file.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.SourceFileDto" } }, { "name": "token", "in": "header", "description": "The token.", "required": true }, { "name": "subtypeId", "in": "path", "required": true, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFormatSourceDefault/Subtypes/{formatId}": { "get": { "tags": [ "Confirm/DownloadFormatSourceDefault" ], "summary": "Gets the download format source defaults by format.", "description": "Sample Request\r\nGET /Confirm/DownloadFormatSourceDefault/Subtypes/-1", "operationId": "DownloadFormatSourceDefault_GetDownloadFormatSourceDefaultsByFormatAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "formatId", "in": "path", "description": "The format identifier.", "required": true, "type": "integer", "format": "int32" }, { "name": "token", "in": "header", "description": "The token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFormatSourceDefaultDto" }, "xml": { "name": "DownloadFormatSourceDefaultDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFormatVersion/{formatId}": { "get": { "tags": [ "Confirm/DownloadFormatVersion" ], "summary": "Gets a list of Download Formats that the logged in user has access to.", "operationId": "DownloadFormatVersions_GetDownloadFormatVersionsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "formatId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadFormatVersion/{formatId}/AlClient": { "get": { "tags": [ "Confirm/DownloadFormatVersion" ], "summary": "Get a list of download Format versions set for each alClient", "operationId": "DownloadFormatVersions_GetDownloadFormatVersionsForDatabasesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "formatId", "in": "path", "description": "the format to check the version assigned to each alClient", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Confirm/DownloadFormatVersion" ], "summary": "Save format version for each alClient", "operationId": "DownloadFormatVersions_SaveAllDownloadFormatVersionsForDatabasesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "formatId", "in": "path", "description": "the format id for the versions to set for each alClient", "required": true, "type": "integer", "format": "int32" }, { "name": "requests", "in": "body", "description": "A collection of objects determining which version to be set each alClient for the format id", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFormatVersionALClientDto" }, "xml": { "name": "DownloadFormatVersionALClientDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadMap/{key}": { "put": { "tags": [ "Confirm/DownloadMap" ], "summary": "Update download mapping.", "operationId": "Confirm_UpdateDownloadMapAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "mapping", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.LocalDownloadMapDto" } }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Confirm/DownloadMap" ], "summary": "Delete a mapping.", "operationId": "Confirm_DeletedownloadMapAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadMap/Account/{key}": { "get": { "tags": [ "Confirm/DownloadMap" ], "summary": "Get all mappings using the download source of an account.", "operationId": "Confirm_GetDownloadMapAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.LocalDownloadMapDto" }, "xml": { "name": "LocalDownloadMapDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Confirm/DownloadMap" ], "summary": "Create new mapping based on the download source of the account.", "operationId": "Confirm_CreateDownloadMapAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.LocalDownloadMapDto" } }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadMap/Common": { "get": { "tags": [ "Confirm/DownloadMap" ], "operationId": "DownloadMapCommon_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "downloadFormatId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "tableName", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadMapDto" }, "xml": { "name": "DownloadMapDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Confirm/DownloadMap" ], "summary": "Adds a new common download map to the database.", "operationId": "DownloadMapCommon_CreateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadMapDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadMapDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadMap/Common/{key}": { "get": { "tags": [ "Confirm/DownloadMap" ], "summary": "Gets the common download map that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "DownloadMapCommon_GetEntityByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadMapDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Confirm/DownloadMap" ], "summary": "Updates the common download map that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "DownloadMapCommon_UpdateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadMapDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadMapDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Confirm/DownloadMap" ], "summary": "Used to delete an existing common download map. Upon successful deletion a 204 will be returned.", "operationId": "DownloadMapCommon_DeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadMap/Firm": { "get": { "tags": [ "Confirm/DownloadMap" ], "operationId": "DownloadMapFirm_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Confirm/DownloadMap" ], "operationId": "DownloadMapFirm_UpsertAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "recordsToUpsert", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.Domains.Confirm.DownloadMapALClientDto" }, "xml": { "name": "DownloadMapALClientDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadMap/List": { "put": { "tags": [ "Confirm/DownloadMap" ], "summary": "Update a list of mappings", "operationId": "Confirm_UpdateDownloadMapsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "mappings", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.LocalDownloadMapDto" }, "xml": { "name": "LocalDownloadMapDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadMap/Local": { "get": { "tags": [ "Confirm/DownloadMap" ], "summary": "Get all local download maps\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "DownloadMapLocal_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "downloadFormatId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "downloadSourceId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "tableName", "in": "query", "required": false, "type": "string" }, { "name": "includeUnassigned", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadMapDto" }, "xml": { "name": "DownloadMapDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Confirm/DownloadMap" ], "summary": "Adds a new local download map to the database.", "description": "Sample Request\r\n\tPost /Confirm/DownloadMap/common\r\n {\r\n downloadFormat: \"TDAmeritradeGeneric\"\r\n downloadFormatId: 59\r\n downloadFormatSubTypeId: 0\r\n downloadSourceId: null\r\n externalCode: \"11\"\r\n mappingLevel: \"Common - Sub-Format\"\r\n orionKey: 41\r\n tableName: \"TransactionType\"\r\n }", "operationId": "DownloadMapLocal_CreateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "The dto.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadMapDto" } }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadMapDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadMap/Local/{key}": { "get": { "tags": [ "Confirm/DownloadMap" ], "summary": "Gets the local download map that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "description": "Sample Request\r\n\tGET /Confirm/DownloadMap/Local/1", "operationId": "DownloadMapLocal_GetEntityByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadMapDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Confirm/DownloadMap" ], "summary": "Updates the local download map that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "DownloadMapLocal_UpdateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadMapDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadMapDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Confirm/DownloadMap" ], "summary": "Used to delete an existing local download map. Upon successful deletion a 204 will be returned.", "operationId": "DownloadMapLocal_DeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadMap/Tables": { "get": { "tags": [ "Confirm/DownloadMap" ], "summary": "Get a list of orion tables used in download mappings.", "operationId": "Confirm_GetDownloadMapTablesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadMapTableDto" }, "xml": { "name": "DownloadMapTableDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadMap/Tables/{tableName}": { "get": { "tags": [ "Confirm/DownloadMap" ], "summary": "Get available options for the specified table", "operationId": "Confirm_GetDownloadMapTableValues", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "tableName", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadPositionProcess": { "get": { "tags": [ "Confirm/DownloadPositionProcess" ], "summary": "Gets all the sleeve rules from tblDownloadSleeveRules.", "operationId": "DownloadPositionProcesses_GetPositionSettings", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadPositionProcess/Save": { "put": { "tags": [ "Confirm/DownloadPositionProcess" ], "summary": "Saves the sleeve json arrays to userDefinedData.", "operationId": "DownloadPositionProcesses_SavePositionProcesses", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "positionRulesDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadPositionRuleDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadProcess/{typeId}": { "get": { "tags": [ "Confirm/DownloadProcess" ], "summary": "Gets the list of download processes for the supplied download process type. Read-only; the underlying\r\ntable is maintained by scripts.", "operationId": "DownloadProcess_GetDownloadProcessesByTypeAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "typeId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadProcess/AutoScrubAdHocBatch": { "get": { "tags": [ "Confirm/DownloadProcess" ], "summary": "Gets all ad-hoc AutoScrub batches.", "operationId": "DownloadProcessAutoScrubAdHocBatch_GetAutoScrubAdHocBatchesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Confirm/DownloadProcess" ], "summary": "Creates an ad-hoc AutoScrub batch in AddingTransactionsToQueue status and enqueues queue population.", "operationId": "DownloadProcessAutoScrubAdHocBatch_CreateAutoScrubAdHocBatchAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "createDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.AutoScrubAdHocBatchCreateDto" } }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadProcess/AutoScrubAdHocBatch/{id}": { "get": { "tags": [ "Confirm/DownloadProcess" ], "summary": "Gets an ad-hoc AutoScrub batch by id.", "operationId": "DownloadProcessAutoScrubAdHocBatch_GetAutoScrubAdHocBatchByIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Confirm/DownloadProcess" ], "summary": "Cancels an ad-hoc AutoScrub batch.", "operationId": "DownloadProcessAutoScrubAdHocBatch_UpdateAutoScrubAdHocBatchAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updateDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.AutoScrubAdHocBatchUpdateDto" } }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadProcess/AutoScrubAdHocBatch/Action/Start/{id}": { "put": { "tags": [ "Confirm/DownloadProcess" ], "summary": "Starts processing an ad-hoc AutoScrub batch via Hangfire.", "operationId": "DownloadProcessAutoScrubAdHocBatch_StartAutoScrubAdHocBatchAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadProcess/Configuration/{typeId}": { "get": { "tags": [ "Confirm/DownloadProcess" ], "summary": "Gets all download process configurations (with their ALClient lists) for the supplied download process type.", "operationId": "DownloadProcess_GetConfigurationByTypeAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "typeId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Confirm/DownloadProcess" ], "summary": "Replaces all download process configurations (and their ALClient lists) for the supplied download process\r\ntype with the supplied payload. Permission is governed by the PrivilegeCode of the target download process type.", "operationId": "DownloadProcess_SaveConfigurationByTypeAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "typeId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "configurations", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadProcessConfigurationDto" }, "xml": { "name": "DownloadProcessConfigurationDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadProcess/ConfigurationAdHoc/{typeId}": { "get": { "tags": [ "Confirm/DownloadProcess" ], "summary": "Gets all ad-hoc download process configurations for the supplied download process type.", "operationId": "DownloadProcess_GetConfigurationAdHocByTypeAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "typeId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Confirm/DownloadProcess" ], "summary": "Replaces all ad-hoc download process configurations for the supplied download process type\r\nwith the supplied payload. Permission is governed by the PrivilegeCodeAdHoc of the target download process type.", "operationId": "DownloadProcess_SaveConfigurationAdHocByTypeAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "typeId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "configurations", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadProcessConfigurationAdHocDto" }, "xml": { "name": "DownloadProcessConfigurationAdHocDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadScrubAutomation": { "get": { "tags": [ "Confirm/DownloadScrubAutomation" ], "summary": "Gets all the sleeve rules from tblDownloadSleeveRules.", "operationId": "DownloadScrubAutomation_GetScrubAutomationSettings", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadScrubAutomation/Save": { "put": { "tags": [ "Confirm/DownloadScrubAutomation" ], "summary": "Saves the sleeve json arrays to userDefinedData.", "operationId": "DownloadScrubAutomation_SavePositionProcesses", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "scrubAutomationRulesDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ScrubAutomationRulesDTO" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadSourceNote": { "get": { "tags": [ "Confirm/DownloadSourceNote" ], "summary": "Returns a list of Download Source Notes", "description": "Sample Request\r\n GET /Confirm/DownloadSourceNote", "operationId": "DownloadSourceNote_GetDownloadSourceNotesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadSourceNoteDto" }, "xml": { "name": "DownloadSourceNoteDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadSourceNote/Upsert/{downloadSourceNoteType}": { "put": { "tags": [ "Confirm/DownloadSourceNote" ], "summary": "Will either create or update a given download source note depending if one already exists or not", "description": "Sample Request\r\n PUT /Confirm/DownloadSourceNote/Upsert\r\n {\r\n \"downloadSourceId\": 1,\r\n \"analystNote\": \"test note\",\r\n \"advisorNote\": \"test note 2\"\r\n }", "operationId": "DownloadSourceNote_UpsertDownloadSourceNoteAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "downloadSourceNoteType", "in": "path", "required": true, "type": "string", "enum": [ "AdvisorNote", "AnalystNote" ] }, { "name": "downloadSourceNoteDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadSourceNoteDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadSourceNoteDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadSources": { "get": { "tags": [ "Confirm/DownloadSources" ], "operationId": "DownloadSources_GetAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadSourceDto" }, "xml": { "name": "DownloadSourceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadSources/{id}": { "get": { "tags": [ "Confirm/DownloadSources" ], "operationId": "DownloadSources_GetItem", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadSourceDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadSources/{key}": { "delete": { "tags": [ "Confirm/DownloadSources" ], "operationId": "DownloadSources_DeleteAsync", "consumes": [], "produces": [], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadSources/Audit": { "get": { "tags": [ "Confirm/DownloadSources" ], "summary": "Retrieves the unencrypted columns from DownloadSourceHistory in order to view them properly for troubleshooting and debugging PIs", "operationId": "DownloadSourceHistoryReader_GetDownloadSourceHistoryUnencryptedAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "fromDate", "in": "query", "description": "AsOfDate must be greater than or equal to this date", "required": true, "type": "string", "format": "date-time" }, { "name": "downloadFormatIds", "in": "query", "description": "Inclusive filter for format ids", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadSources/List/Delete": { "put": { "tags": [ "Confirm/DownloadSources" ], "operationId": "DownloadSources_PutV1ConfirmDownloadSourcesListDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "idList", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadSources/Properties": { "get": { "tags": [ "Confirm/DownloadSources" ], "operationId": "DownloadSources_GetProperties", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadSources/Recon": { "get": { "tags": [ "Confirm/DownloadSources" ], "operationId": "DownloadSources_GetReconAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "object" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadSources/Schedules": { "get": { "tags": [ "Confirm/DownloadSources" ], "operationId": "DownloadSourceSchedules_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadSources/Schedules/Logs/Messages": { "get": { "tags": [ "Confirm/DownloadSources" ], "operationId": "DownloadSourceQueueLog_GetMessages", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string" }, { "name": "endDate", "in": "query", "required": false, "type": "string" }, { "name": "downloadSourceId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadSourceQueueLogMessageDto" }, "xml": { "name": "DownloadSourceQueueLogMessageDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadSources/Schedules/RunNow/{key}": { "put": { "tags": [ "Confirm/DownloadSources" ], "operationId": "DownloadSourceSchedules_RunScheduleNowAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadSources/Simple": { "get": { "tags": [ "Confirm/DownloadSources" ], "operationId": "DownloadSources_GetSimpleAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadSources/Simple/Active": { "get": { "tags": [ "Confirm/DownloadSources" ], "operationId": "DownloadSources_GetSimpleActiveAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadSources/Verbose": { "get": { "tags": [ "Confirm/DownloadSources" ], "operationId": "DownloadSources_GetVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Schedules", "Logs", "Defaults", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DownloadSourceVerboseDto" }, "xml": { "name": "DownloadSourceVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Confirm/DownloadSources" ], "operationId": "DownloadSources_UpdateVerboseListAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "updatedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DownloadSourceVerboseDto" }, "xml": { "name": "DownloadSourceVerboseDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DownloadSourceVerboseDto" }, "xml": { "name": "DownloadSourceVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Confirm/DownloadSources" ], "summary": "Create Download Source", "operationId": "DownloadSources_CreateVerboseAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "newDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DownloadSourceVerboseDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DownloadSourceVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadSources/Verbose/{key}": { "get": { "tags": [ "Confirm/DownloadSources" ], "operationId": "DownloadSources_GetVerboseByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Schedules", "Logs", "Defaults", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DownloadSourceVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Confirm/DownloadSources" ], "operationId": "DownloadSources_UpdateVerboseAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DownloadSourceVerboseDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DownloadSourceVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadSources/Verbose/Duplicate": { "post": { "tags": [ "Confirm/DownloadSources" ], "operationId": "DownloadSources_CheckDuplicateUserIdPasswordAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "downloadSource", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DownloadSourceVerboseDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadSources/Verbose/KeyFile/{key}": { "post": { "tags": [ "Confirm/DownloadSources" ], "summary": "Adds the SFTP key file asynchronous.", "description": "Sample Request\r\n POST Confirm/DownloadSources/Verbose/KeyFile/1\r\n {\r\n file: (binary)\r\n }", "operationId": "DownloadSources_AddSftpKeyFileAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The key.", "required": true, "type": "integer", "format": "int32" }, { "name": "file", "in": "body", "description": "The file.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.SourceFileDto" } }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadSources/Verbose/List": { "post": { "tags": [ "Confirm/DownloadSources" ], "operationId": "DownloadSources_GetVerboseListById", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Schedules", "Logs", "Defaults", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DownloadSourceVerboseDto" }, "xml": { "name": "DownloadSourceVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadSources/Verbose/List/Id": { "post": { "tags": [ "Confirm/DownloadSources" ], "operationId": "DownloadSources_PostV1ConfirmDownloadSourcesVerboseListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Schedules", "Logs", "Defaults", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DownloadSourceVerboseDto" }, "xml": { "name": "DownloadSourceVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadSources/Verbose/New": { "get": { "tags": [ "Confirm/DownloadSources" ], "operationId": "DownloadSources_GetNewVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Schedules", "Logs", "Defaults", "All" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "downloadFormatId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "subtypeId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DownloadSourceVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadTextModification": { "get": { "tags": [ "Confirm/DownloadTextModification" ], "operationId": "DownloadTextModification_GetAllAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "downloadFormatId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "token", "in": "header", "required": true }, { "name": "formatSubTypeId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "recordType", "in": "query", "required": false, "type": "string", "enum": [ "Name", "Position", "Transaction", "Price", "Dividend", "Product", "NotImported", "Header", "Security", "CorpAction", "TranDetail", "Generic", "CostBasis", "Beneficiary", "StoredPerformance", "Systematic", "RMD", "Banking" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadTextModificationDto" }, "xml": { "name": "DownloadTextModificationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Confirm/DownloadTextModification" ], "summary": "Updates the asynchronous.", "description": "Sample Request\r\nPUT v1/Confirm/DownloadTextModification\r\n[\r\n {\r\n \"id\": 108,\r\n \"downloadFormatId\": 166,\r\n \"downloadFormatSubtype\": null,\r\n \"modificationType\": \"Proper\",\r\n \"externalText\": \"UNITED STATES TREAS \",\r\n \"newText\": \"US Treasury Test\",\r\n \"recordType\": \"Security\",\r\n \"runOrder\": 555\r\n },\r\n {\r\n \"id\": 107,\r\n \"downloadFormatId\": 166,\r\n \"downloadFormatSubtype\": null,\r\n \"modificationType\":\"Proper\",\r\n \"externalText\": \"UNITED STATES TREAS \",\r\n \"newText\": \"US Treasury Test\",\r\n \"recordType\": \"Security\",\r\n \"runOrder\": 555\r\n },\r\n {\r\n \"id\": 106,\r\n \"downloadFormatId\": 166,\r\n \"downloadFormatSubtype\": null,\r\n \"modificationType\": \"Proper\",\r\n \"externalText\": \"UNITED STATES TREAS \",\r\n \"newText\": \"US Treasury Test\",\r\n \"recordType\": \"Security\",\r\n \"runOrder\": 555\r\n },\r\n {\r\n \"id\": 105,\r\n \"downloadFormatId\": 166,\r\n \"downloadFormatSubtype\": null,\r\n \"modificationType\": \"Proper\",\r\n \"externalText\": \"UNITED STATES TREAS \",\r\n \"newText\": \"US Treasury Test\",\r\n \"recordType\": \"Security\",\r\n \"runOrder\": 555\r\n }\r\n]", "operationId": "DownloadTextModification_UpdateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "downloadFormatId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "dtos", "in": "body", "description": "The dtos.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadTextModificationDto" }, "xml": { "name": "DownloadTextModificationDto", "wrapped": true }, "type": "array" } }, { "name": "token", "in": "header", "description": "The token.", "required": true }, { "name": "formatSubTypeId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "recordType", "in": "query", "required": false, "type": "string", "enum": [ "Name", "Position", "Transaction", "Price", "Dividend", "Product", "NotImported", "Header", "Security", "CorpAction", "TranDetail", "Generic", "CostBasis", "Beneficiary", "StoredPerformance", "Systematic", "RMD", "Banking" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadTextModificationDto" }, "xml": { "name": "DownloadTextModificationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Confirm/DownloadTextModification" ], "summary": "Adds the asynchronous.", "description": "Sample Request\r\nPOST v1/Confirm/DownloadTextModification\r\n{\r\n \"downloadFormatId\": 166,\r\n \"downloadFormatSubtype\": null,\r\n \"modificationType\": \"Proper\",\r\n \"externalText\": \"UNITED STATES TREAS \",\r\n \"newText\": \"US Treasury \",\r\n \"recordType\": \"Security\",\r\n \"runOrder\": 666,\r\n \"downloadFormatName\": \"FidelitySingle\"\r\n }", "operationId": "DownloadTextModification_AddAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "The dto.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadTextModificationDto" } }, { "name": "token", "in": "header", "description": "The token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadTextModificationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DownloadTextModification/ManipulationTypes": { "get": { "tags": [ "Confirm/DownloadTextModification" ], "summary": "Gets all but SmartProper, 3.", "description": "Sample Request\r\nGET /Confirm/ManipulationTypes", "operationId": "DownloadTextModification_GetAllModificationTypes", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string", "enum": [ "FindAndReplace", "Proper", "SmartProper", "Remove", "RemoveTextAfterText", "RemovingLeadingZeroes", "DateFormatting" ] }, "xml": { "name": "TextManipulationType", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DuplicateAccountMapping": { "get": { "tags": [ "Confirm/DuplicateAccountMapping" ], "summary": "Gets All Duplicate Account Mappings in the advisors database", "operationId": "ConfirmationDuplicateAccountMapping_GetDuplicateAccountMappings", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Recon.DuplicateAccountMappingDto" }, "xml": { "name": "DuplicateAccountMappingDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Confirm/DuplicateAccountMapping" ], "summary": "Upsert Duplicate Account Mappings", "operationId": "ConfirmationDuplicateAccountMapping_SaveDuplicateAccountMappings", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "A dto containing the original mapping and the new mapping.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Recon.DuplicateAccountMappingUpsertRequestDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Recon.DuplicateAccountMappingDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/DuplicateAccountMapping/Delete": { "post": { "tags": [ "Confirm/DuplicateAccountMapping" ], "operationId": "ConfirmationDuplicateAccountMapping_DeleteDuplicateAccountMappings", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Recon.DuplicateAccountMappingDto" }, "xml": { "name": "DuplicateAccountMappingDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Exclusions": { "get": { "tags": [ "Confirm/Exclusions" ], "summary": "Gets the specified account number.", "operationId": "DownloadExclusions_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountNumber", "in": "query", "description": "The account number.", "required": true, "type": "string" }, { "name": "downloadFormatId", "in": "query", "description": "The download format identifier.", "required": false, "type": "integer", "format": "int32" }, { "name": "cusip", "in": "query", "description": "The cusip.", "required": false, "type": "string" }, { "name": "ct", "in": "header", "description": "Cancellation Token", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadExcludeDto" }, "xml": { "name": "DownloadExcludeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Confirm/Exclusions" ], "summary": "Creates a new confirmgroup record, and returns the new record in the location header.", "operationId": "DownloadExclusions_CreateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "ConfirmGroup", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadExcludeDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Exclusions/{key}": { "get": { "tags": [ "Confirm/Exclusions" ], "summary": "Gets the ConfirmGroup that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "DownloadExclusions_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadExcludeDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Confirm/Exclusions" ], "summary": "Update the exclusion record", "operationId": "DownloadExclusions_UpdateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadExcludeDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadExcludeDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Confirm/Exclusions" ], "summary": "Deletes the specified key.", "operationId": "DownloadExclusions_DeleteAsync", "consumes": [], "produces": [], "parameters": [ { "name": "key", "in": "path", "description": "The key.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Exclusions/Action/AdvisorNotes": { "put": { "tags": [ "Confirm/Exclusions" ], "summary": "Update Advisor Notes on the specified exclusion records", "operationId": "DownloadExclusions_ActionUpdateAdvisorNotesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "noteList", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.NoteListDtoOfSystem.Int32" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.NoteListDtoOfSystem.Int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Exclusions/Action/Delete": { "put": { "tags": [ "Confirm/Exclusions" ], "operationId": "DownloadExclusions_ActionDeleteAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Exclusions/CommonExclusions": { "get": { "tags": [ "Confirm/Exclusions" ], "summary": "Gets all common download exclusions.", "operationId": "DownloadExclusions_GetAllCommonDownloadExclusions", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadExcludeCommonDto" }, "xml": { "name": "DownloadExcludeCommonDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Exclusions/CommonExclusions/{id}": { "get": { "tags": [ "Confirm/Exclusions" ], "summary": "Gets all common download exclusions.", "description": "Sample Request\r\n\tGET /Confirm/Exclusions/CommonExclusions/72", "operationId": "DownloadExclusions_GetCommonDownloadExclusionByIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "description": "The identifier.", "required": true, "type": "integer", "format": "int32" }, { "name": "token", "in": "header", "description": "The token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadExcludeCommonDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Exclusions/CommonExclusions/Actions/Create": { "post": { "tags": [ "Confirm/Exclusions" ], "summary": "Creates the download exclude common entity asynchronous.", "description": "Sample Request\r\n\t/Confirm/Exclusions/CommonExclusions/Actions/Create\r\n {\r\n \"id\": 0,\r\n \"downloadFormatId\": 17,\r\n \"downloadFormat\": \"DataLynx\",\r\n \"cusip\": \"cusip\",\r\n \"ticker\": null,\r\n \"recordTypeDisplay\": \"Price\",\r\n \"recordTypeKey\": 3,\r\n \"excludeCommonCustodian\": false\r\n }", "operationId": "DownloadExclusions_CreateDownloadExcludeCommonEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "The dto.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadExcludeCommonDto" } }, { "name": "token", "in": "header", "description": "The token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Exclusions/CommonExclusions/Actions/Delete": { "put": { "tags": [ "Confirm/Exclusions" ], "operationId": "DownloadExclusions_DeleteDownloadExcludeCommonByIdAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "token", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Exclusions/CommonExclusions/Actions/Update/{id}": { "put": { "tags": [ "Confirm/Exclusions" ], "summary": "Update the exclusion record", "description": "Sample Request\r\n\t/Confirm/Exclusions/CommonExclusions/Actions/Update/16195\r\n {\r\n \"id\": 16195,\r\n \"downloadFormatId\": 17,\r\n \"downloadFormat\": \"DataLynx\",\r\n \"cusip\": \"cusip\",\r\n \"ticker\": null,\r\n \"recordTypeDisplay\": \"Price\",\r\n \"recordTypeKey\": 3,\r\n \"excludeCommonCustodian\": false\r\n }", "operationId": "DownloadExclusions_UpdateDownloadExcludeCommonEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "description": "The key.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "The dto.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadExcludeCommonDto" } }, { "name": "token", "in": "header", "description": "The token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadExcludeCommonDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Exclusions/Current": { "get": { "tags": [ "Confirm/Exclusions" ], "summary": "Returns Download Exclusion Records", "operationId": "DownloadExclusions_GetCurrentAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "lastDownloadedDays", "in": "query", "description": "The last downloaded days.", "required": false, "type": "integer", "format": "int32" }, { "name": "accountNumber", "in": "query", "description": "The account number.", "required": false, "type": "string" }, { "name": "cusip", "in": "query", "description": "The cusip.", "required": false, "type": "string" }, { "name": "startDate", "in": "query", "description": "Optional. StartDate", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. EndDate", "required": false, "type": "string", "format": "date-time" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadExcludeCurrentDto" }, "xml": { "name": "DownloadExcludeCurrentDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/ExclusionSync": { "get": { "tags": [ "Confirm/ExclusionSync" ], "summary": "Returns a list of recon job statuses.", "operationId": "ExclusionSync_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "description": "Optional. Default: null. If provided returns only recon job statuses with a process start date greater than date provided.", "required": false, "type": "string" }, { "name": "endDate", "in": "query", "description": "Optional. Default: null. If provided returns only recon job statuses with a process start date less than date provided.", "required": false, "type": "string" }, { "name": "userTeamOnly", "in": "query", "description": "Optional. Default: false If provided, the return will be limited to just the admin's service team.", "required": false, "type": "boolean", "default": false }, { "name": "serviceTeamId", "in": "query", "description": "Optional. Default: null If provided, the return will be limited to the service team Id given.", "required": false, "type": "integer", "format": "int32" }, { "name": "serviceTeamUserManagerId", "in": "query", "description": "Optional. Default: null If provided, the return will be limited to the service teams assigned the the given Id.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Recon.ExclusionSyncDto" }, "xml": { "name": "ExclusionSyncDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/ExclusionSync/{key}": { "get": { "tags": [ "Confirm/ExclusionSync" ], "summary": "Get ExclusionSyncDto Sync by key", "operationId": "ExclusionSync_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Recon.ExclusionSyncDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/ExclusionSync/Action/SignOff": { "put": { "tags": [ "Confirm/ExclusionSync" ], "summary": "Sign off ExclusionSync", "operationId": "ExclusionSync_ExclusionSyncSignOffAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "syncSignOffs", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Recon.SyncSignOffsDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Recon.ExclusionSyncDto" }, "xml": { "name": "ExclusionSyncDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/FileExports": { "get": { "tags": [ "Confirm/FileExports" ], "operationId": "FileExport_GetAllFileExportsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "token", "in": "header", "required": true }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.FileExportDto" }, "xml": { "name": "FileExportDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/FileExports/{fileId}/Send": { "post": { "tags": [ "Confirm/FileExports" ], "summary": "Transmits a Matrix B50 file export to its configured upload target, matching the Advisor Desktop\r\n\"Send File\" behavior. Only files that have not yet been sent can be transmitted.", "description": "Sample Request\r\nPOST /Confirm/FileExports/123/Send", "operationId": "FileExport_SendFileAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "fileId", "in": "path", "description": "The File Id (tblDwnldPrepFile.pkDPFile) of the Matrix B50 file to send.", "required": true, "type": "integer", "format": "int32" }, { "name": "token", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.FileExportDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/FileExports/DownloadFile": { "get": { "tags": [ "Confirm/FileExports" ], "summary": "Gets the file by identifier.", "description": "Sample Request\r\nGET /Confirm/FileExport/DownloadFile?blobFileId=123", "operationId": "FileExport_GetFileByIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "blobFileId", "in": "query", "description": "The BLOB file identifier.", "required": true, "type": "integer", "format": "int32" }, { "name": "token", "in": "header", "description": "The token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Groups": { "get": { "tags": [ "Confirm/Groups" ], "operationId": "ConfirmGroups_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmGroupDto" }, "xml": { "name": "ConfirmGroupDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Confirm/Groups" ], "summary": "Creates a new confirmgroup record, and returns the new record in the location header.", "operationId": "ConfirmGroups_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "ConfirmGroup", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmGroupDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Groups/{confirmGroupKey}/DataQueries": { "get": { "tags": [ "Confirm/Groups" ], "operationId": "ConfirmGroups_GetDataQueryList", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "confirmGroupKey", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmGroupDataQueryDto" }, "xml": { "name": "ConfirmGroupDataQueryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Groups/{confirmGroupKey}/DataQueries/{reportKey}": { "get": { "tags": [ "Confirm/Groups" ], "operationId": "ConfirmGroups_GetDataQuery", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "confirmGroupKey", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "reportKey", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmGroupDataQueryDto" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Confirm/Groups" ], "operationId": "ConfirmGroups_UpsertDataQuery", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "confirmGroupKey", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "reportKey", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmGroupDataQueryDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmGroupDataQueryDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Confirm/Groups" ], "operationId": "ConfirmGroups_DeleteConfirmGroupDataQuery", "consumes": [], "produces": [], "parameters": [ { "name": "confirmGroupKey", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "reportKey", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Groups/{confirmGroupKey}/DataQueries/List": { "put": { "tags": [ "Confirm/Groups" ], "operationId": "ConfirmGroups_PutV1ConfirmGroupsByConfirmGroupKeyDataQueriesList", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "items", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmGroupDataQueryDto" }, "xml": { "name": "ConfirmGroupDataQueryDto", "wrapped": true }, "type": "array" } }, { "name": "confirmGroupKey", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmGroupDataQueryDto" }, "xml": { "name": "ConfirmGroupDataQueryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Confirm/Groups" ], "operationId": "ConfirmGroups_PostV1ConfirmGroupsByConfirmGroupKeyDataQueriesList", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "items", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmGroupDataQueryDto" }, "xml": { "name": "ConfirmGroupDataQueryDto", "wrapped": true }, "type": "array" } }, { "name": "confirmGroupKey", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmGroupDataQueryDto" }, "xml": { "name": "ConfirmGroupDataQueryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Groups/{key}": { "get": { "tags": [ "Confirm/Groups" ], "summary": "Gets the ConfirmGroup that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ConfirmGroups_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmGroupDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Confirm/Groups" ], "summary": "Updates an existing confirmgroup record.", "operationId": "ConfirmGroups_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "ConfirmGroup Id to update", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "New Confirm Group values", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmGroupDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmGroupDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Confirm/Groups" ], "operationId": "ConfirmGroups_Delete", "consumes": [], "produces": [], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Groups/{key}/Overview": { "get": { "tags": [ "Confirm/Groups" ], "operationId": "ConfirmGroups_GetOverviewAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "suppressInactiveDatabases", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmOverviewDto" }, "xml": { "name": "ConfirmOverviewDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Groups/{key}/RefreshData": { "get": { "tags": [ "Confirm/Groups" ], "operationId": "ConfirmGroups_RefreshDataAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmOverviewDto" }, "xml": { "name": "ConfirmOverviewDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Groups/Action/Delete": { "put": { "tags": [ "Confirm/Groups" ], "operationId": "ConfirmGroups_PutV1ConfirmGroupsActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "groupId", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Groups/DataQueries/List": { "put": { "tags": [ "Confirm/Groups" ], "operationId": "ConfirmGroups_UpsertDataQueryList", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "items", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmGroupDataQueryDto" }, "xml": { "name": "ConfirmGroupDataQueryDto", "wrapped": true }, "type": "array" } }, { "name": "confirmGroupKey", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmGroupDataQueryDto" }, "xml": { "name": "ConfirmGroupDataQueryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Confirm/Groups" ], "operationId": "ConfirmGroups_PostV1ConfirmGroupsDataQueriesList", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "items", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmGroupDataQueryDto" }, "xml": { "name": "ConfirmGroupDataQueryDto", "wrapped": true }, "type": "array" } }, { "name": "confirmGroupKey", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmGroupDataQueryDto" }, "xml": { "name": "ConfirmGroupDataQueryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Groups/DataQuery": { "post": { "tags": [ "Confirm/Groups" ], "summary": "Creates a new confirmgroup record, and returns the new record in the location header.", "operationId": "ConfirmGroups_CreateConfirmGroupDataQuery", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "ConfirmGroup", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmGroupDataQueryDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Groups/Simple": { "get": { "tags": [ "Confirm/Groups" ], "summary": "Returns a simple Id/Name for all Confirm Group records", "operationId": "ConfirmGroups_GetSimpleAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/HeldAway/Accounts": { "get": { "tags": [ "Confirm/HeldAway" ], "summary": "Gets Held Away Accounts.", "operationId": "HeldAway_GetAccountData", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "description": "Required. The start date of the range of Asset Confirm Errors for.", "required": true, "type": "string" }, { "name": "endDate", "in": "query", "description": "Optional. Default: null, Today wil be used if not set", "required": false, "type": "string" }, { "name": "errorsOnly", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.HeldAwayAccountDto" }, "xml": { "name": "HeldAwayAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/HeldAway/Accounts/AssetValueConfirmError": { "get": { "tags": [ "Confirm/HeldAway" ], "operationId": "HeldAway_GetAssetValueChangeWithErrors", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountIds", "in": "query", "required": true, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" }, { "name": "startDate", "in": "query", "required": true, "type": "string" }, { "name": "endDate", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.HeldAwayAssetValueWithErrorDto" }, "xml": { "name": "HeldAwayAssetValueWithErrorDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/HeldAway/Accounts/Transactions": { "get": { "tags": [ "Confirm/HeldAway" ], "operationId": "HeldAway_GetTransactionsByAccounts", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountIds", "in": "query", "required": true, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" }, { "name": "startDate", "in": "query", "required": true, "type": "string" }, { "name": "endDate", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.HeldAwayTransactionithErrorDto" }, "xml": { "name": "HeldAwayTransactionithErrorDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/HeldAway/Action/AcceptableConfirmError": { "put": { "tags": [ "Confirm/HeldAway" ], "summary": "Change Acceptable heldAways value", "operationId": "HeldAway_AcceptableConfirmErrorAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "heldAways", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.HeldAwayAssetConfirmErrorUpdateKeyDto" }, "xml": { "name": "HeldAwayAssetConfirmErrorUpdateKeyDto", "wrapped": true }, "type": "array" } }, { "name": "acceptable", "in": "query", "required": true, "type": "boolean" }, { "name": "note", "in": "query", "required": false, "type": "string", "default": "" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/HeldAway/Action/RefreshConfirmErrors": { "post": { "tags": [ "Confirm/HeldAway" ], "summary": "Refreshes Confirm error counts for the requested accounts. Limited to no more than 20 accounts at a time", "operationId": "HeldAway_RefreshConfirmErrorsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "accountList", "in": "body", "description": "List of account Ids to refresh", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "waitLimit", "in": "query", "description": "Deprectaed parameter", "required": false, "type": "integer", "format": "int32", "default": 20 } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/HeldAway/Action/UpdateExcludedFromPositionOnly": { "post": { "tags": [ "Confirm/HeldAway" ], "operationId": "HeldAway_UpdateExcludedFromPositionOnly", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "excludedFromPositionOnly", "in": "query", "required": true, "type": "boolean" }, { "name": "assetIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/HeldAway/Assets": { "get": { "tags": [ "Confirm/HeldAway" ], "summary": "Gets Held Away Assets.", "operationId": "HeldAway_GetAssetsByAccount", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "query", "description": "Required.", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "description": "Required. The start date of the range of Asset Confirm Errors for.", "required": true, "type": "string" }, { "name": "endDate", "in": "query", "description": "Optional. Default: null, Today wil be used if not set", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.HeldAwayAssetDto" }, "xml": { "name": "HeldAwayAssetDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/HeldAway/AssetValueConfirmError": { "get": { "tags": [ "Confirm/HeldAway" ], "summary": "Gets Held Away asset value changes with asset confirm errors. Account Id or Asset Id is required.", "operationId": "HeldAway_GetV1ConfirmHeldAwayAssetValueConfirmError", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "description": "Required..", "required": true, "type": "string" }, { "name": "endDate", "in": "query", "description": "Optional. Default: null, Today wil be used if not set", "required": false, "type": "string" }, { "name": "accountId", "in": "query", "description": "Optional. Default: null, Asset Id will override if provided", "required": false, "type": "integer", "format": "int32" }, { "name": "assetId", "in": "query", "description": "Optional. Default: null", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.HeldAwayAssetValueWithErrorDto" }, "xml": { "name": "HeldAwayAssetValueWithErrorDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/HeldAway/AssetValues": { "get": { "tags": [ "Confirm/HeldAway" ], "summary": "Gets all asset values.", "operationId": "HeldAway_GetAssetValuesByAccount", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "query", "description": "Required.", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "description": "Required. The start date of the range of Asset Confirm Errors for.", "required": true, "type": "string" }, { "name": "endDate", "in": "query", "description": "Optional. Default: null, Today wil be used if not set", "required": false, "type": "string" }, { "name": "balanceDate", "in": "query", "description": "Optional. Default: null, Today wil be used if not set", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.HeldAwayAllAssetValueDto" }, "xml": { "name": "HeldAwayAllAssetValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/HeldAway/Counts": { "get": { "tags": [ "Confirm/HeldAway" ], "summary": "Gets Held Away counts.", "operationId": "HeldAway_GetPositionOnlyCounts", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "description": "Required. The start date of the range of Asset Confirm Errors for.", "required": true, "type": "string" }, { "name": "endDate", "in": "query", "description": "Optional. Default: null, Today wil be used if not set", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.HeldAwayCountDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/HeldAway/CreateTransactions": { "post": { "tags": [ "Confirm/HeldAway" ], "summary": "Used to create transactions and assets if need.", "operationId": "HeldAway_CreateTransactions", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "dtoList", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.HeldAwayTransactionCreateDto" }, "xml": { "name": "HeldAwayTransactionCreateDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/HeldAway/DownloadTransToTransaction": { "put": { "tags": [ "Confirm/HeldAway" ], "summary": "Used to create transaction from the download tran.", "operationId": "HeldAway_ConvertDownloadTransToTransactionAsync", "consumes": [], "produces": [], "parameters": [ { "name": "downloadTransId", "in": "query", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "assetId", "in": "query", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/HeldAway/Transactions": { "get": { "tags": [ "Confirm/HeldAway" ], "summary": "Gets Held Away transactions with asset confirm errors. Account Id or Asset Id is required.", "operationId": "HeldAway_GetTransactions", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "description": "Required.", "required": true, "type": "string" }, { "name": "endDate", "in": "query", "description": "Optional. Default: null, Today wil be used if not set", "required": false, "type": "string" }, { "name": "accountId", "in": "query", "description": "Optional. Default: null, Asset Id will override if provided", "required": false, "type": "integer", "format": "int32" }, { "name": "assetId", "in": "query", "description": "Optional. Default: null", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.HeldAwayTransactionithErrorDto" }, "xml": { "name": "HeldAwayTransactionithErrorDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/HeldAway/TransactionTypes": { "get": { "tags": [ "Confirm/HeldAway" ], "summary": "Gets Held Away transactions types and their offsets.", "operationId": "HeldAway_GetTransactionTypesWithOffset", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "usagePriority", "in": "query", "description": "Optional. Default 10. Used to limit transaction type on its usage priority. Will return number enter and higher", "required": false, "type": "integer", "format": "int32", "default": 10 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.HeldAwayTransactionTypeWithOffsetDto" }, "xml": { "name": "HeldAwayTransactionTypeWithOffsetDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/InterfaceReconciliations": { "get": { "tags": [ "Confirm/InterfaceReconciliations" ], "summary": "Gets a list of interface reconciliations that the logged in user has access to.", "operationId": "InterfaceReconciliations_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "isActive", "in": "query", "description": "Optional. Default null. If provided only recons for active (when true) or inactive (when false) download sources will be returned.", "required": false, "type": "boolean" }, { "name": "startDate", "in": "query", "description": "Optional. Default null. If provided only recons that come after the start date will be returned.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default null. If provided only recons that come before the end date will be returned.", "required": false, "type": "string", "format": "date-time" }, { "name": "transactionStatus", "in": "query", "required": false, "type": "string" }, { "name": "positionStatus", "in": "query", "required": false, "type": "string" }, { "name": "costBasisStatus", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.InterfaceReconciliationDto" }, "xml": { "name": "InterfaceReconciliationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/InterfaceReconciliations/{downloadSourceId}/{createDate}": { "get": { "tags": [ "Confirm/InterfaceReconciliations" ], "summary": "Gets the interface reconciliation that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "InterfaceReconciliations_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "downloadSourceId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "createDate", "in": "path", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.InterfaceReconciliationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/InterfaceReconciliations/{downloadSourceId}/SourceName": { "get": { "tags": [ "Confirm/InterfaceReconciliations" ], "summary": "Returns the download source name using the download source id provided.", "operationId": "InterfaceReconciliations_GetDownloadSourceName", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "downloadSourceId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/InterfaceReconciliations/Action/SendReconCompleteNotification": { "get": { "tags": [ "Confirm/InterfaceReconciliations" ], "operationId": "InterfaceReconciliations_GetReconCompleteNotification", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Confirm.InterfaceReconciliationsController.ReconNotificationDto" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Confirm/InterfaceReconciliations" ], "operationId": "InterfaceReconciliations_SendReconCompleteNotificationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "notifySettings", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Confirm.InterfaceReconciliationsController.ReconNotificationDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/InterfaceReconciliations/Counts": { "get": { "tags": [ "Confirm/InterfaceReconciliations" ], "summary": "Returns summary counts of unconfirmed records.", "operationId": "InterfaceReconciliations_GetCounts", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.InterfaceReconciliationCountsDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/InterfaceReconciliations/Status": { "get": { "tags": [ "Confirm/InterfaceReconciliations" ], "summary": "Returns the current reconcillation status.", "operationId": "InterfaceReconciliations_GetReconStatus", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.InterfaceReconciliationStatusDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/InterfaceSyncs": { "get": { "tags": [ "Confirm/InterfaceSyncs" ], "summary": "Returns a list of recon interface syncs.", "operationId": "InterfaceSyncs_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "description": "Optional. Default: null. If provided returns only recon interface syncss with a process start date greater than date provided.", "required": false, "type": "string" }, { "name": "endDate", "in": "query", "description": "Optional. Default: null. If provided returns only recon interface syncs with a process start date less than date provided.", "required": false, "type": "string" }, { "name": "syncType", "in": "query", "description": "Optional. Default: null If provided, the return will be filter to only the syncTypes requested.", "required": false, "type": "string", "enum": [ "Daily", "Weekly", "Exclusion", "Price" ] }, { "name": "userTeamOnly", "in": "query", "description": "Optional. Default: false If provided, the return will be limited to just the admin's service team.", "required": false, "type": "boolean", "default": false }, { "name": "serviceTeamId", "in": "query", "description": "Optional. Default: null If provided, the return will be limited to the service team Id given.", "required": false, "type": "integer", "format": "int32" }, { "name": "serviceTeamUserManagerId", "in": "query", "description": "Optional. Default: null If provided, the return will be limited to the service teams assigned the the given Id.", "required": false, "type": "integer", "format": "int32" }, { "name": "downloadFileId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "userAnalystId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "databaseId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Recon.InterfaceSyncDto" }, "xml": { "name": "InterfaceSyncDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/InterfaceSyncs/{key}": { "get": { "tags": [ "Confirm/InterfaceSyncs" ], "summary": "Get interface Sync by key", "operationId": "InterfaceSyncs_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Recon.InterfaceSyncDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/InterfaceSyncs/Action/SignOff": { "put": { "tags": [ "Confirm/InterfaceSyncs" ], "summary": "Sign off InterfaceSyncs", "operationId": "InterfaceSyncs_InterfaceSyncSignOffAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "syncSignOffs", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Recon.SyncSignOffsDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Recon.InterfaceSyncDto" }, "xml": { "name": "InterfaceSyncDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/InterfaceSyncs/Files": { "get": { "tags": [ "Confirm/InterfaceSyncs" ], "summary": "", "operationId": "InterfaceSyncs_GetInterfaceSyncsByFile", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": true, "type": "string" }, { "name": "endDate", "in": "query", "required": true, "type": "string" }, { "name": "userAnalystId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Recon.InterfaceSyncsByFileDto" }, "xml": { "name": "InterfaceSyncsByFileDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/localexclusion": { "get": { "tags": [ "Confirm/localexclusion" ], "operationId": "ConfirmDownloadLocalExclusion_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "downloadFormat", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "acctNum", "in": "query", "required": false, "type": "string" }, { "name": "cusip", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadExcludeDto" }, "xml": { "name": "DownloadExcludeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/localexclusion/AdvisorNumber": { "get": { "tags": [ "Confirm/localexclusion" ], "operationId": "ConfirmDownloadLocalExclusion_ValidateAdvisorNumber", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "advisorNumber", "in": "query", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/localexclusion/List/Delete": { "put": { "tags": [ "Confirm/localexclusion" ], "operationId": "ConfirmDownloadLocalExclusion_DeleteAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/localexclusion/List/Upsert": { "put": { "tags": [ "Confirm/localexclusion" ], "operationId": "ConfirmDownloadLocalExclusion_BulkUpsertAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "downloadExcludeDtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadExcludeDto" }, "xml": { "name": "DownloadExcludeDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadExcludeDto" }, "xml": { "name": "DownloadExcludeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/MatrixCashActivityGemini/Action/Convert": { "post": { "tags": [ "Confirm/MatrixCashActivityGemini" ], "operationId": "MatrixCashActivityGemini_ConvertAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.MatrixCashActivityGemini.MatrixCashActivityGeminiConvertDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/MatrixCashActivityGemini/Action/Inspect": { "post": { "tags": [ "Confirm/MatrixCashActivityGemini" ], "operationId": "MatrixCashActivityGemini_InspectAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.MatrixCashActivityGemini.MatrixCashActivityGeminiInspectDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.MatrixCashActivityGemini.MatrixCashActivityGeminiInspectResultDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/MatrixCashActivityGemini/Action/Validate": { "post": { "tags": [ "Confirm/MatrixCashActivityGemini" ], "operationId": "MatrixCashActivityGemini_ValidateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.MatrixCashActivityGemini.MatrixCashActivityGeminiValidateDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.MatrixCashActivityGemini.MatrixCashActivityGeminiValidateResultDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/MissingPriceSyncs": { "get": { "tags": [ "Confirm/MissingPriceSyncs" ], "summary": "Returns a list of recon job statuses.", "operationId": "MissingPriceSyncs_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "description": "Optional. Default: null. If provided returns only recon job statuses with a process start date greater than date provided.", "required": false, "type": "string" }, { "name": "endDate", "in": "query", "description": "Optional. Default: null. If provided returns only recon job statuses with a process start date less than date provided.", "required": false, "type": "string" }, { "name": "userTeamOnly", "in": "query", "description": "Optional. Default: false If provided, the return will be limited to just the admin's service team.", "required": false, "type": "boolean", "default": false }, { "name": "serviceTeamId", "in": "query", "description": "Optional. Default: null If provided, the return will be limited to the service team Id given.", "required": false, "type": "integer", "format": "int32" }, { "name": "serviceTeamUserManagerId", "in": "query", "description": "Optional. Default: null If provided, the return will be limited to the service teams assigned the the given Id.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Recon.MissingPriceSyncDto" }, "xml": { "name": "MissingPriceSyncDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/MissingPriceSyncs/{key}": { "get": { "tags": [ "Confirm/MissingPriceSyncs" ], "summary": "Get MissingPriceSyncs by key", "operationId": "MissingPriceSyncs_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Recon.MissingPriceSyncDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/MissingPriceSyncs/Action/PriceNote": { "put": { "tags": [ "Confirm/MissingPriceSyncs" ], "summary": "Update Price Notes", "operationId": "MissingPriceSyncs_UpdatePriceNoteAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "syncs", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Recon.MissingPriceSyncPriceNoteDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Recon.MissingPriceSyncDto" }, "xml": { "name": "MissingPriceSyncDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/MissingPriceSyncs/Action/SignOff": { "put": { "tags": [ "Confirm/MissingPriceSyncs" ], "summary": "Sign off MissingPriceSyncs", "operationId": "MissingPriceSyncs_SyncSignOffAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "syncSignOffs", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Recon.SyncSignOffsDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Recon.MissingPriceSyncDto" }, "xml": { "name": "MissingPriceSyncDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview": { "get": { "tags": [ "Confirm/Overview" ], "summary": "Gets the confirm overview records the current user has access to.", "operationId": "ConfirmOverview_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "description": "Optional. Default is all time.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default is today.", "required": false, "type": "string", "format": "date-time" }, { "name": "confirmGroupId", "in": "query", "description": "Optional. Default is null. When specified, the results will be filtered for this ConfirmGroup", "required": false, "type": "integer", "format": "int32" }, { "name": "databaseId", "in": "query", "description": "Optional. Default is null. When specified, the reuslts will be filtered for this Database. (alClientId).", "required": false, "type": "integer", "format": "int32" }, { "name": "recordType", "in": "query", "description": "Optional. Default is null. When specified, the results will be filtered for this RecordType.", "required": false, "type": "string", "enum": [ "Name", "Position", "Transaction", "Price", "Dividend", "Product", "NotImported", "Header", "Security", "CorpAction", "TranDetail", "Generic", "CostBasis", "Beneficiary", "StoredPerformance", "Systematic", "RMD", "Banking" ] }, { "name": "downloadFormatId", "in": "query", "description": "Optional. Default is null. When specified, the results will be filtered fo rthis DownloadFormat.", "required": false, "type": "integer", "format": "int32" }, { "name": "batchProcessingId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "query", "description": "Optional. Default is null. When specified, the results will filter by file download id", "required": false, "type": "integer", "format": "int32" }, { "name": "downloadSourceKeys", "in": "query", "description": "Optional. Comma-separated alClientId:downloadSourceId pairs to load specific sources across databases (Recon Sign Off → Files Received).", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmOverviewDto" }, "xml": { "name": "ConfirmOverviewDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/AccountsNotInFile": { "get": { "tags": [ "Confirm/Overview" ], "summary": "Get all confirm overview where account not in file", "operationId": "ConfirmOverviewDashboardAccountsNotInFiles_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "downloadSourceId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "alClientId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "confirmGroupId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "recordType", "in": "query", "required": false, "type": "string", "enum": [ "Name", "Position", "Transaction", "Price", "Dividend", "Product", "NotImported", "Header", "Security", "CorpAction", "TranDetail", "Generic", "CostBasis", "Beneficiary", "StoredPerformance", "Systematic", "RMD", "Banking" ] }, { "name": "downloadFormatId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Dashboard.AccountNotInFileConfirmOverviewDashboardDto" }, "xml": { "name": "AccountNotInFileConfirmOverviewDashboardDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/AccountsNotInFile/Action/RefreshData": { "put": { "tags": [ "Confirm/Overview" ], "summary": "Refresh data for Accounts Not In File confirm overview dashboard", "operationId": "ConfirmOverviewDashboardAccountsNotInFiles_RefreshData", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "alClientId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "confirmGroupId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Dashboard.AccountNotInFileConfirmOverviewDashboardDto" }, "xml": { "name": "AccountNotInFileConfirmOverviewDashboardDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/AccountsNotInFile/Action/SignOff": { "put": { "tags": [ "Confirm/Overview" ], "summary": "Sign off dashboards", "operationId": "ConfirmOverviewDashboardAccountsNotInFiles_SignOff", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "overviewIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Dashboard.AccountNotInFileConfirmOverviewDashboardDto" }, "xml": { "name": "AccountNotInFileConfirmOverviewDashboardDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/Action/Delete": { "put": { "tags": [ "Confirm/Overview" ], "operationId": "ConfirmOverview_ActionDeleteAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/Action/FixShares005/{effectiveDate}": { "put": { "tags": [ "Confirm/Overview" ], "summary": "", "operationId": "ConfirmOverview_FixShares005Async", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "effectiveDate", "in": "path", "required": true, "type": "string" }, { "name": "confirmOverviewIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.FixShares005Dto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/Action/ReConfirm": { "put": { "tags": [ "Confirm/Overview" ], "operationId": "ConfirmOverview_ActionReConfirmAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "token", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/Action/RefreshData": { "put": { "tags": [ "Confirm/Overview" ], "operationId": "ConfirmOverview_RefreshDataAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "confimOverviewIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmOverviewDto" }, "xml": { "name": "ConfirmOverviewDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/Action/RefreshDatabaseData": { "put": { "tags": [ "Confirm/Overview" ], "summary": "Takes an array of database Ids, a start and end date, and updates the Confirm Overview data with the current information for that database within those dates (confirmed counts, not confirmed counts ect.)", "operationId": "ConfirmOverview_RefreshDataByDatabaseAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "alClientId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmOverviewDto" }, "xml": { "name": "ConfirmOverviewDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/Action/ReprocessFiles": { "put": { "tags": [ "Confirm/Overview" ], "operationId": "ConfirmOverview_ReprocessFileAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "itemList", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmOverviewDto" }, "xml": { "name": "ConfirmOverviewDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmOverviewDto" }, "xml": { "name": "ConfirmOverviewDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/Action/ReprocessFiles/NewConfirmReprocessHandling": { "put": { "tags": [ "Confirm/Overview" ], "summary": "Reprocess Files that are 2.0 and 1.0 also handles them in bulk", "operationId": "ConfirmOverview_NewConfirmReprocessFilesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "itemList", "in": "body", "description": "The list of dtos to reprocess Undo and Imports them", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmOverviewDto" }, "xml": { "name": "ConfirmOverviewDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "description": "The Cancellation token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmOverviewBatchProcessingPollingDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/Action/SignOff": { "put": { "tags": [ "Confirm/Overview" ], "summary": "Sign off overviews", "operationId": "ConfirmOverview_SignOff", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "confirmOverviewIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmOverviewDto" }, "xml": { "name": "ConfirmOverviewDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/Action/SleeveFixSmallBalancePositions": { "put": { "tags": [ "Confirm/Overview" ], "operationId": "ConfirmOverview_SleeveFixSmallBalancePositionsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "confirmOverviewIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.FixSleeveSharesDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/Action/Undo/Records": { "put": { "tags": [ "Confirm/Overview" ], "summary": "Undo Apply for download files", "description": "Sample Request\r\nPOST /Confirm/Overview/Action/Undo/Records?recordType=0\r\n[189,170,184,96,251,75,81]", "operationId": "ConfirmOverview_UndoAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "description": "A list of tblDownload... PKs", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "recordType", "in": "query", "required": true, "type": "string", "enum": [ "Name", "Position", "Transaction", "Price", "Dividend", "Product", "NotImported", "Header", "Security", "CorpAction", "TranDetail", "Generic", "CostBasis", "Beneficiary", "StoredPerformance", "Systematic", "RMD", "Banking" ] }, { "name": "blockVerifyApply", "in": "query", "required": false, "type": "boolean" }, { "name": "token", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/Action/UndoMany": { "put": { "tags": [ "Confirm/Overview" ], "operationId": "ConfirmOverview_ActionUndoManyFilesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "confirmationOverviewIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmOverviewBatchProcessingPollingDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/Action/VerifyApply": { "put": { "tags": [ "Confirm/Overview" ], "operationId": "ConfirmOverview_ActionVerifyOrApplyAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "apply", "in": "query", "required": true, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/Action/VerifyApply/Records": { "put": { "tags": [ "Confirm/Overview" ], "operationId": "ConfirmOverview_ActionVerifyOrApplyRecordsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "recordType", "in": "query", "required": true, "type": "string", "enum": [ "Name", "Position", "Transaction", "Price", "Dividend", "Product", "NotImported", "Header", "Security", "CorpAction", "TranDetail", "Generic", "CostBasis", "Beneficiary", "StoredPerformance", "Systematic", "RMD", "Banking" ] }, { "name": "apply", "in": "query", "required": true, "type": "boolean" }, { "name": "allowDuplicateTransactions", "in": "query", "required": true, "type": "boolean" }, { "name": "allowAddProductToDatabase", "in": "query", "required": true, "type": "boolean" }, { "name": "allowAddDividend", "in": "query", "required": true, "type": "boolean" }, { "name": "allowCreateUnverifiedSells", "in": "query", "required": true, "type": "boolean" }, { "name": "newAccountCreation", "in": "query", "required": true, "type": "string", "enum": [ "Default", "DoNotCreate", "Create", "AutoExclude" ] }, { "name": "matchDownloadSource", "in": "query", "required": true, "type": "boolean" }, { "name": "bypassExclusion", "in": "query", "required": true, "type": "boolean" }, { "name": "priceHolidayOverride", "in": "query", "required": true, "type": "boolean" }, { "name": "allowSymbolCreate", "in": "query", "required": false, "type": "boolean" }, { "name": "toleranceOverride", "in": "query", "required": false, "type": "boolean" }, { "name": "blockVerifyApply", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/CheckStatus": { "post": { "tags": [ "Confirm/Overview" ], "operationId": "ConfirmOverview_CheckbatchProcessingStatus", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "correlationIds", "in": "body", "required": true, "schema": { "items": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "additionalProperties": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.BatchProcessingDto" }, "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/CheckStatus/{batchId}": { "get": { "tags": [ "Confirm/Overview" ], "summary": "Gets the status of batch processing record for the batchId provided.", "operationId": "ConfirmOverview_CheckBatchStatus", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "batchId", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "includeErrors", "in": "query", "description": "Default is True. When true, the Errors collection will be populated with Errors, Warnings, and Informational Messages", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.BatchProcessingDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/CheckStatus/Universal": { "post": { "tags": [ "Confirm/Overview" ], "summary": "Handles both s3(correlationIds) and remote(pkbatchprocessing) statuses when inputed will return the status of those batchProcessing records", "operationId": "ConfirmOverview_CheckBatchProcessingStatusIndifferent", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "an {OAS.WebApi.DTO.Confirm.ConfirmOverviewBatchProcessingPollingDto} with a collection of correlationids and pkBatchProcessingids", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmOverviewBatchProcessingPollingDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.BatchProcessingDto" }, "xml": { "name": "BatchProcessingDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/DataAudits": { "get": { "tags": [ "Confirm/Overview" ], "summary": "Get all confirm overview where account not in file", "operationId": "ConfirmOverviewDashboardDataAudits_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "downloadSourceId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "alClientId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "confirmGroupId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "recordType", "in": "query", "required": false, "type": "string", "enum": [ "Name", "Position", "Transaction", "Price", "Dividend", "Product", "NotImported", "Header", "Security", "CorpAction", "TranDetail", "Generic", "CostBasis", "Beneficiary", "StoredPerformance", "Systematic", "RMD", "Banking" ] }, { "name": "downloadFormatId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Dashboard.DataAuditsConfirmOverviewDashboardDto" }, "xml": { "name": "DataAuditsConfirmOverviewDashboardDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/DataAudits/Action/RefreshData": { "put": { "tags": [ "Confirm/Overview" ], "operationId": "ConfirmOverviewDashboardDataAudits_RefreshDataAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "confirmOverviewDashboardIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "alClientId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "confirmGroupId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Dashboard.DataAuditsConfirmOverviewDashboardDto" }, "xml": { "name": "DataAuditsConfirmOverviewDashboardDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/DataAudits/Action/SignOff": { "put": { "tags": [ "Confirm/Overview" ], "summary": "Sign off dashboards", "operationId": "ConfirmOverviewDashboardDataAudits_SignOff", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "overviewIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Dashboard.DataAuditsConfirmOverviewDashboardDto" }, "xml": { "name": "DataAuditsConfirmOverviewDashboardDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/DataAudits/List": { "post": { "tags": [ "Confirm/Overview" ], "operationId": "ConfirmOverviewDashboardDataAudits_GetByKeyList", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "confirmOverviewDashboardIds", "in": "body", "required": false, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Dashboard.DataAuditsConfirmOverviewDashboardDto" }, "xml": { "name": "DataAuditsConfirmOverviewDashboardDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/DataAudits/List/Id": { "post": { "tags": [ "Confirm/Overview" ], "operationId": "ConfirmOverviewDashboardDataAudits_PostV1ConfirmOverviewDataAuditsListId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "confirmOverviewDashboardIds", "in": "body", "required": false, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Dashboard.DataAuditsConfirmOverviewDashboardDto" }, "xml": { "name": "DataAuditsConfirmOverviewDashboardDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/ExclusionTable": { "get": { "tags": [ "Confirm/Overview" ], "summary": "Get all confirm overview where account not in file", "operationId": "ConfirmOverviewDashboardExclusionTable_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "downloadSourceId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "alClientId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "confirmGroupId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "recordType", "in": "query", "required": false, "type": "string", "enum": [ "Name", "Position", "Transaction", "Price", "Dividend", "Product", "NotImported", "Header", "Security", "CorpAction", "TranDetail", "Generic", "CostBasis", "Beneficiary", "StoredPerformance", "Systematic", "RMD", "Banking" ] }, { "name": "downloadFormatId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Dashboard.ExclusionTableConfirmOverviewDashboardDto" }, "xml": { "name": "ExclusionTableConfirmOverviewDashboardDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/ExclusionTable/Action/RefreshData": { "put": { "tags": [ "Confirm/Overview" ], "summary": "Refresh data for Exclusion Tables confirm overview dashboard", "operationId": "ConfirmOverviewDashboardExclusionTable_RefreshData", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "alClientId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "confirmGroupId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Dashboard.ExclusionTableConfirmOverviewDashboardDto" }, "xml": { "name": "ExclusionTableConfirmOverviewDashboardDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/ExclusionTable/Action/SignOff": { "put": { "tags": [ "Confirm/Overview" ], "summary": "Sign off dashboards", "operationId": "ConfirmOverviewDashboardExclusionTable_SignOff", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "overviewIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Dashboard.ExclusionTableConfirmOverviewDashboardDto" }, "xml": { "name": "ExclusionTableConfirmOverviewDashboardDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/ForGroup": { "post": { "tags": [ "Confirm/Overview" ], "operationId": "ConfirmOverview_GetForGroup", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "group", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Confirm.ConfirmGroup" } }, { "name": "startDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmOverviewDto" }, "xml": { "name": "ConfirmOverviewDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/InformRecon": { "get": { "tags": [ "Confirm/Overview" ], "summary": "Gets a list of Inform Reconciliation Records", "operationId": "ConfirmOverview_GetInformOverview", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isSignedOff", "in": "query", "required": false, "type": "boolean" }, { "name": "startDate", "in": "query", "description": "Optional.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional.", "required": false, "type": "string", "format": "date-time" }, { "name": "databaseId", "in": "query", "description": "Optional.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformReconciliationDto" }, "xml": { "name": "InformReconciliationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/InformRecon/{key}/Transactions/v2": { "get": { "tags": [ "Confirm/Overview" ], "summary": "Get Recon Transaction Details Grid", "operationId": "ConfirmOverview_GetInformTransactionsV2", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "transactionId", "in": "query", "required": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformReconciliationTransactionDto" }, "xml": { "name": "InformReconciliationTransactionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/InformRecon/Action/SignOff/V2": { "put": { "tags": [ "Confirm/Overview" ], "summary": "Adds current user signoff to reconciliation records passed\r\nSkips records that are already signed off", "operationId": "ConfirmOverview_SignOffInformReconAsyncV2", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "informReconIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int64" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformReconciliationDto" }, "xml": { "name": "InformReconciliationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/InformRecon/Transactions/Action/Dividend/V2": { "put": { "tags": [ "Confirm/Overview" ], "summary": "Change Transaction Recon Status to Confirmed and update Transaction type to 'Dividends/Interest/Fees'", "operationId": "ConfirmOverview_UpdateToDividendV2Async", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "description": "transaction ids to be updated", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformReconciliationTransactionDto" }, "xml": { "name": "InformReconciliationTransactionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/InformRecon/Transactions/Action/UpdateStatus/V2/{status}": { "put": { "tags": [ "Confirm/Overview" ], "summary": "Change Transaction Recon Status", "operationId": "ConfirmOverview_UpdateStatusV2Async", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "status", "in": "path", "description": "new InformReconStatus", "required": true, "type": "string", "enum": [ "NotConfirmed", "Confirmed", "Excluded" ] }, { "name": "ids", "in": "body", "description": "transaction ids to be updated", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformReconciliationTransactionDto" }, "xml": { "name": "InformReconciliationTransactionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/InformRecon/Transactions/V2/{key}": { "put": { "tags": [ "Confirm/Overview" ], "summary": "Update Inform Transaction\r\nSkips records that are already signed off", "operationId": "ConfirmOverview_UpdateTransactionV2Async", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformReconciliationTransactionDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformReconciliationTransactionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/List": { "post": { "tags": [ "Confirm/Overview" ], "summary": "Returns a list of Confirm Overviews that are found for the list of Id's posted in the message body.", "operationId": "ConfirmOverview_GetListById", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "Array of Confirm Overview ID's", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmOverviewDto" }, "xml": { "name": "ConfirmOverviewDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/List/Id": { "post": { "tags": [ "Confirm/Overview" ], "summary": "Returns a list of Confirm Overviews that are found for the list of Id's posted in the message body.", "operationId": "ConfirmOverview_PostV1ConfirmOverviewListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "Array of Confirm Overview ID's", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmOverviewDto" }, "xml": { "name": "ConfirmOverviewDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/ManualExclusions": { "get": { "tags": [ "Confirm/Overview" ], "summary": "Get all confirm overview where account not in file", "operationId": "ConfirmOverviewDashboardManualExclusions_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "downloadSourceId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "alClientId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "confirmGroupId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "recordType", "in": "query", "required": false, "type": "string", "enum": [ "Name", "Position", "Transaction", "Price", "Dividend", "Product", "NotImported", "Header", "Security", "CorpAction", "TranDetail", "Generic", "CostBasis", "Beneficiary", "StoredPerformance", "Systematic", "RMD", "Banking" ] }, { "name": "downloadFormatId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Dashboard.ManualExclusionsConfirmOverviewDashboardDto" }, "xml": { "name": "ManualExclusionsConfirmOverviewDashboardDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/ManualExclusions/Action/RefreshData": { "put": { "tags": [ "Confirm/Overview" ], "summary": "Refresh data for Manual Exclusions confirm overview dashboard", "operationId": "ConfirmOverviewDashboardManualExclusions_RefreshData", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "alClientId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "confirmGroupId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Dashboard.ManualExclusionsConfirmOverviewDashboardDto" }, "xml": { "name": "ManualExclusionsConfirmOverviewDashboardDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/ManualExclusions/Action/SignOff": { "put": { "tags": [ "Confirm/Overview" ], "summary": "Sign off dashboards", "operationId": "ConfirmOverviewDashboardManualExclusions_SignOff", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "overviewIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Dashboard.ManualExclusionsConfirmOverviewDashboardDto" }, "xml": { "name": "ManualExclusionsConfirmOverviewDashboardDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/MissingFiles": { "get": { "tags": [ "Confirm/Overview" ], "summary": "Return all confirm overviews that are missing files.", "operationId": "ConfirmOverviewDashboardMissingFiles_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "downloadSourceId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "alClientId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "confirmGroupId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "recordType", "in": "query", "required": false, "type": "string", "enum": [ "Name", "Position", "Transaction", "Price", "Dividend", "Product", "NotImported", "Header", "Security", "CorpAction", "TranDetail", "Generic", "CostBasis", "Beneficiary", "StoredPerformance", "Systematic", "RMD", "Banking" ] }, { "name": "downloadFormatId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Dashboard.MissingFileConfirmOverviewDashboardDto" }, "xml": { "name": "MissingFileConfirmOverviewDashboardDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/MissingFiles/Action/RefreshData": { "put": { "tags": [ "Confirm/Overview" ], "summary": "Refresh data for Missing Files confirm overview dashboard", "operationId": "ConfirmOverviewDashboardMissingFiles_RefreshData", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "alClientId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "confirmGroupId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Dashboard.MissingFileConfirmOverviewDashboardDto" }, "xml": { "name": "MissingFileConfirmOverviewDashboardDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/MissingFiles/Action/SignOff": { "put": { "tags": [ "Confirm/Overview" ], "summary": "Sign off dashboards", "operationId": "ConfirmOverviewDashboardMissingFiles_SignOff", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "overviewIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Dashboard.MissingFileConfirmOverviewDashboardDto" }, "xml": { "name": "MissingFileConfirmOverviewDashboardDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/Notes": { "get": { "tags": [ "Confirm/Overview" ], "summary": "Get all notes based on filter values", "operationId": "ConfirmOverviewNotes_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "parentId", "in": "query", "description": "Filters notes by associated parent record. However in the case of \"Accounts Not In File\" it will return notes for all records for the account that associated with the parent record.", "required": false, "type": "integer", "format": "int32" }, { "name": "sourceType", "in": "query", "required": false, "type": "string", "enum": [ "MissingFile", "AccountNotInFile", "DownloadFile", "DownloadSource", "ScheduleJobs", "DataAudits", "ManualExclusions", "ExclusionTable", "FilesReceived" ] }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "downloadSourceId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "alClientId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "isAdvisorVisible", "in": "query", "required": false, "type": "boolean" }, { "name": "globalOnly", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmOverviewNoteDto" }, "xml": { "name": "ConfirmOverviewNoteDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Confirm/Overview" ], "summary": "Create new confirm overview note", "operationId": "ConfirmOverviewNotes_CreateNewItem", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmOverviewNoteDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmOverviewNoteDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/Notes/{key}": { "get": { "tags": [ "Confirm/Overview" ], "summary": "Get confirm overview note by key", "operationId": "ConfirmOverviewNotes_GetItemByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmOverviewNoteDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Confirm/Overview" ], "operationId": "ConfirmOverviewNotes_UpdateItem", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmOverviewNoteDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmOverviewNoteDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Confirm/Overview" ], "summary": "Delete a note", "operationId": "ConfirmOverviewNotes_DeleteItem", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/Notes/List": { "post": { "tags": [ "Confirm/Overview" ], "summary": "Create new confirm overview notes", "operationId": "ConfirmOverviewNotes_CreateNewItems", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmOverviewNoteDto" }, "xml": { "name": "ConfirmOverviewNoteDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmOverviewNoteDto" }, "xml": { "name": "ConfirmOverviewNoteDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/OrionVision": { "get": { "tags": [ "Confirm/Overview" ], "summary": "Gets a list of Inform Reconciliation Records", "operationId": "ConfirmOverview_GetOrionVisonOverviewAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.OrionVisionConfirmDto" }, "xml": { "name": "OrionVisionConfirmDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/ScheduledJobs": { "get": { "tags": [ "Confirm/Overview" ], "summary": "Get all confirm overview where account not in file", "operationId": "ConfirmOverviewDashboardScheduledJobs_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "downloadSourceId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "alClientId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "confirmGroupId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "recordType", "in": "query", "required": false, "type": "string", "enum": [ "Name", "Position", "Transaction", "Price", "Dividend", "Product", "NotImported", "Header", "Security", "CorpAction", "TranDetail", "Generic", "CostBasis", "Beneficiary", "StoredPerformance", "Systematic", "RMD", "Banking" ] }, { "name": "downloadFormatId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Dashboard.ScheduleJobsConfirmOverviewDashboardDto" }, "xml": { "name": "ScheduleJobsConfirmOverviewDashboardDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/ScheduledJobs/Action/RefreshData": { "put": { "tags": [ "Confirm/Overview" ], "summary": "Refresh data for Schedule Jobs confirm overview dashboard", "operationId": "ConfirmOverviewDashboardScheduledJobs_RefreshData", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "alClientId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "confirmGroupId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Dashboard.ScheduleJobsConfirmOverviewDashboardDto" }, "xml": { "name": "ScheduleJobsConfirmOverviewDashboardDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/ScheduledJobs/Action/Reschedule": { "put": { "tags": [ "Confirm/Overview" ], "operationId": "ConfirmOverviewDashboardScheduledJobs_CreateBlocks", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dashboardIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Dashboard.ScheduleJobsConfirmOverviewDashboardDto" }, "xml": { "name": "ScheduleJobsConfirmOverviewDashboardDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/ScheduledJobs/Action/SignOff": { "put": { "tags": [ "Confirm/Overview" ], "summary": "Sign off dashboards", "operationId": "ConfirmOverviewDashboardScheduledJobs_SignOff", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "overviewIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Dashboard.ScheduleJobsConfirmOverviewDashboardDto" }, "xml": { "name": "ScheduleJobsConfirmOverviewDashboardDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Overview/Summary": { "get": { "tags": [ "Confirm/Overview" ], "summary": "Gets summary counts for download files.", "operationId": "ConfirmOverview_SummaryCount", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "description": "Required. The start date of the range of files to return the summary for.", "required": true, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Required. The end date of the range of files to return the summary for.", "required": true, "type": "string", "format": "date-time" }, { "name": "groupBy", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "RecordType", "Database", "Format", "Group", "BatchProcessing" ] }, { "name": "confirmGroupId", "in": "query", "description": "Optional. Default is null. When specified, the results will be filtered for this ConfirmGroup", "required": false, "type": "integer", "format": "int32" }, { "name": "databaseId", "in": "query", "description": "Optional. Default is null. When specified, the reuslts will be filtered for this Database. (alClientId).", "required": false, "type": "integer", "format": "int32" }, { "name": "recordType", "in": "query", "description": "Optional. Default is null. When specified, the results will be filtered for this RecordType.", "required": false, "type": "string", "enum": [ "Name", "Position", "Transaction", "Price", "Dividend", "Product", "NotImported", "Header", "Security", "CorpAction", "TranDetail", "Generic", "CostBasis", "Beneficiary", "StoredPerformance", "Systematic", "RMD", "Banking" ] }, { "name": "downloadFormatId", "in": "query", "description": "Optional. Default is null. When specified, the results will be filtered fo rthis DownloadFormat.", "required": false, "type": "integer", "format": "int32" }, { "name": "batchProcessingId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmOverviewSummaryDto" }, "xml": { "name": "ConfirmOverviewSummaryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Pgp/Action/Decrypt": { "post": { "tags": [ "Confirm/Pgp" ], "operationId": "ConfirmPgp_DecryptAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Pgp/Action/Encrypt": { "post": { "tags": [ "Confirm/Pgp" ], "operationId": "ConfirmPgp_EncryptAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Pgp/UserIds": { "get": { "tags": [ "Confirm/Pgp" ], "operationId": "ConfirmPgp_GetUserIdsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Recon/AgentActionReview": { "get": { "tags": [ "Confirm/Recon" ], "operationId": "AgentActionReview_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "groupId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "alClientId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Recon/AgentActionReview/Action/RefreshData": { "put": { "tags": [ "Confirm/Recon" ], "operationId": "AgentActionReview_RefreshDataAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "groupId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "alClientId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Recon/AgentActionReview/Action/RefreshDatabaseData": { "put": { "tags": [ "Confirm/Recon" ], "operationId": "AgentActionReview_RefreshDataByDatabaseAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "alClientId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Recon/AgentActionReview/UnmappedTransTypes": { "get": { "tags": [ "Confirm/Recon" ], "operationId": "AgentActionReview_GetUnmappedTransTypesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "alClientId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Recon/AgentActionReview/UnmappedTransTypes/CreateImport": { "post": { "tags": [ "Confirm/Recon" ], "operationId": "AgentActionReview_CreateUnmappedTransTypeImportAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "fileTranCode", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportCommonDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Recon/AgentActionReview/UnmappedTransTypes/Details": { "get": { "tags": [ "Confirm/Recon" ], "operationId": "AgentActionReview_GetUnmappedTransTypeDetailsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "fileTranCode", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Recon/AgentActionReview/UnmappedTransTypes/Map": { "post": { "tags": [ "Confirm/Recon" ], "operationId": "AgentActionReview_ConfirmUnmappedTransTypeMappingAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.UnmappedTransTypeConfirmMappingRequestDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Recon/SignOff": { "get": { "tags": [ "Confirm/Recon" ], "summary": "Gets a list of recon sign off records from spocDownloadSourceSignOff_Fetch.", "operationId": "ReconSignOff_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "description": "Optional. Default: current day.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default: current day.", "required": false, "type": "string", "format": "date-time" }, { "name": "formatId", "in": "query", "description": "Optional. Filter by download format.", "required": false, "type": "integer", "format": "int32" }, { "name": "groupId", "in": "query", "description": "Optional. Filter by confirm group.", "required": false, "type": "integer", "format": "int32" }, { "name": "alClientId", "in": "query", "description": "Optional. Filter by client.", "required": false, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Confirm/Recon" ], "summary": "Inserts new rows into tblDownloadSourceSignOff for each distinct (client, source) in the body when business rules pass.\r\nfileDateStart and fileDateEnd define the file date range used to count unconfirmed positions and files received notes; when omitted, the same default file date range as GET is used.\r\nIf multiple body entries share the same (AlClientId, SourceId), the one with a non empty Notes value is used when any exists.", "operationId": "ReconSignOff_PostAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "fileDateStart", "in": "query", "description": "Optional. Start of file date range for metrics. When omitted, defaults the same way as GET startDate.", "required": true, "type": "string", "format": "date-time" }, { "name": "fileDateEnd", "in": "query", "description": "Optional. End of file date range for metrics. When omitted, defaults the same way as GET endDate.", "required": true, "type": "string", "format": "date-time" }, { "name": "items", "in": "body", "description": "Body array of ReconSignOffCreateRequestDto: AlClientId, SourceId, optional Notes.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Recon.ReconSignOffCreateRequestDto" }, "xml": { "name": "ReconSignOffCreateRequestDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "description": "Cancellation token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Confirm/Recon" ], "summary": "Clears ReconSignOffBy and ReconSignOffDate on tblDownloadSourceSignOff for the given sign-off row primary keys\r\nwhen the sign-off date is on or after the day after the previous business day. The row is not removed; other fields such as Notes are unchanged.\r\nThe database trigger on tblDownloadSourceSignOff records the update in tblDownloadSourceSignOffHistory.", "operationId": "ReconSignOff_DeleteAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "description": "Primary keys of sign-off rows to clear. When null or empty, no work is performed and the result is OK.", "required": true, "schema": { "items": { "type": "integer", "format": "int64" }, "type": "array" } }, { "name": "ct", "in": "header", "description": "Cancellation token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/ReconJobStatuses": { "get": { "tags": [ "Confirm/ReconJobStatuses" ], "summary": "Returns a list of recon job statuses.", "operationId": "ReconJobStatuses_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "description": "Optional. Default: null. If provided returns only recon job statuses with a process start date greater than date provided.", "required": false, "type": "string" }, { "name": "endDate", "in": "query", "description": "Optional. Default: null. If provided returns only recon job statuses with a process start date less than date provided.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Recon.ReconJobStatusDto" }, "xml": { "name": "ReconJobStatusDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/RecordTypes/Simple": { "get": { "tags": [ "Confirm/RecordTypes" ], "summary": "Returns the ID and Name of File Record Types that can be imported to the orion system.", "operationId": "RecordTypes_GetSimpleAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Results": { "get": { "tags": [ "Confirm/Results" ], "summary": "Get all Confirm Group Data Query Results", "operationId": "ConfirmGroupDataQueryResultsAccess_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmGroupDataQueryResultDto" }, "xml": { "name": "ConfirmGroupDataQueryResultDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Confirm/Results" ], "summary": "Adds a new Confirm Group Data Query Result to the database.", "operationId": "ConfirmGroupDataQueryResultsAccess_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmGroupDataQueryResultDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmGroupDataQueryResultDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Results/{key}": { "get": { "tags": [ "Confirm/Results" ], "summary": "Gets the Confirm Group Data Query Result that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ConfirmGroupDataQueryResultsAccess_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmGroupDataQueryResultDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Confirm/Results" ], "summary": "Updates the Confirm Group Data Query Result that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ConfirmGroupDataQueryResultsAccess_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired update object.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "Confirm Group Data Query Result object to update", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmGroupDataQueryResultDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Confirm.ConfirmGroupDataQueryResult" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Rules": { "get": { "tags": [ "Confirm/Rules" ], "summary": "Gets all of the rules.\r\nThe return is limited to pages of 1000. Use $top and $skip in the query string to page through the data.", "operationId": "Rules_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Recon.RulesDto" }, "xml": { "name": "RulesDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Confirm/Rules" ], "summary": "Create new Rule", "operationId": "Rules_CreateRule", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Recon.RulesDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Recon.RulesDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/Rules/{key}": { "get": { "tags": [ "Confirm/Rules" ], "summary": "Get Rule by key", "operationId": "Rules_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Recon.RulesDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Confirm/Rules" ], "summary": "Update Rule", "operationId": "Rules_UpdateRule", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Recon.RulesDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Recon.RulesDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Confirm/Rules" ], "operationId": "Rules_Delete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/SchedulerMaintenance": { "get": { "tags": [ "Confirm/SchedulerMaintenance" ], "summary": "Gets all of the scheduler Maintenance items targets.", "operationId": "SchedulerMaintenance_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.SchedulerMaintenanceDto" }, "xml": { "name": "SchedulerMaintenanceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Confirm/SchedulerMaintenance" ], "summary": "Update scheduler maintenance item", "operationId": "SchedulerMaintenance_UpdateSchedulerMaintenanceAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.SchedulerMaintenanceDto" }, "xml": { "name": "SchedulerMaintenanceDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.SchedulerMaintenanceDto" }, "xml": { "name": "SchedulerMaintenanceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/SchedulerMaintenance/{key}": { "get": { "tags": [ "Confirm/SchedulerMaintenance" ], "summary": "Get scheduler maintenance by key", "operationId": "SchedulerMaintenance_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.SchedulerMaintenanceDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Confirm/SchedulerMaintenance" ], "summary": "Update scheduler maintenance item", "operationId": "SchedulerMaintenance_PutV1ConfirmSchedulerMaintenanceByKey", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.SchedulerMaintenanceDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.SchedulerMaintenanceDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/SignOffs": { "get": { "tags": [ "Confirm/SignOffs" ], "summary": "Gets a list of Sign Off that the logged in user has access to.\r\nThe return is limited to pages of 1000. Use $top and $skip in the query string to page through the data.", "operationId": "SignOffs_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.SignOffDto" }, "xml": { "name": "SignOffDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/SignOffs/{key}": { "get": { "tags": [ "Confirm/SignOffs" ], "summary": "Gets the Sign Off that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "SignOffs_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.SignOffDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/SignOffs/Action/SignOff": { "put": { "tags": [ "Confirm/SignOffs" ], "operationId": "SignOffs_SignOff", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "signOffIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "note", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/SignOffs/Simple": { "get": { "tags": [ "Confirm/SignOffs" ], "summary": "Gets a simple list of Sign Off that the logged in user has access to.", "operationId": "SignOffs_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/SleeveSettings": { "get": { "tags": [ "Confirm/SleeveSettings" ], "summary": "Gets all the sleeve rules from tblDownloadSleeveRules.", "operationId": "DownloadSleeveSettings_GetSleeveSettings", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/SleeveSettings/Save": { "put": { "tags": [ "Confirm/SleeveSettings" ], "summary": "Saves the sleeve json arrays to userDefinedData.", "operationId": "DownloadSleeveSettings_SaveSleeveRules", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "sleeveUserRules", "in": "body", "description": "The reequest object to be sent contains ids and json arrays.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.SleeveUserRuleDto" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/StatusTypes": { "get": { "tags": [ "Confirm/StatusTypes" ], "summary": "Gets all of the status types.", "operationId": "StatusTypes_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Recon.StatusTypeDto" }, "xml": { "name": "StatusTypeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/SyncDashboard": { "get": { "tags": [ "Confirm/SyncDashboard" ], "summary": "Gets all of the sync types.", "operationId": "SyncDashboard_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "date", "in": "query", "required": false, "type": "string" }, { "name": "userTeamOnly", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Recon.SyncDashboardDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/SyncDashboard/Counts": { "get": { "tags": [ "Confirm/SyncDashboard" ], "summary": "Gets all of the sync error counts for each day.", "operationId": "SyncDashboard_GetCountsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string" }, { "name": "endDate", "in": "query", "required": false, "type": "string" }, { "name": "userTeamOnly", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Recon.SyncCountsDto" }, "xml": { "name": "SyncCountsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/SyncTypes": { "get": { "tags": [ "Confirm/SyncTypes" ], "summary": "Gets all of the sync types.", "operationId": "SyncTypes_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Recon.SyncTypeDto" }, "xml": { "name": "SyncTypeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/TaxCenter/Action/Reviewed": { "post": { "tags": [ "Confirm/TaxCenter" ], "summary": "Flip reviewed flag", "operationId": "Confirm_ActionReviewedAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "taxErorIds", "in": "body", "description": "The list of tax errors ids.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "reviewed", "in": "query", "description": "Sets the reviewed flag on the Cost Basis records", "required": true, "type": "boolean" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/TaxCenter/Counts": { "get": { "tags": [ "Confirm/TaxCenter" ], "summary": "", "operationId": "Confirm_GetCountsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.TaxCenterCountsDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/TaxCenter/DownloadSourceSummary": { "get": { "tags": [ "Confirm/TaxCenter" ], "summary": "", "operationId": "Confirm_GetDownloadSourceSummary", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string" }, { "name": "endDate", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.TaxCenterDownloadSourceSummaryDto" }, "xml": { "name": "TaxCenterDownloadSourceSummaryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/TaxCenter/Errors/List": { "post": { "tags": [ "Confirm/TaxCenter" ], "summary": "Return a list of errors by ids", "operationId": "Confirm_GetErrorsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "taxErorIds", "in": "body", "description": "The list of tax errors ids.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.TaxCenterErrorDto" }, "xml": { "name": "TaxCenterErrorDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/TaxCenter/GetTaxErrorAudit": { "get": { "tags": [ "Confirm/TaxCenter" ], "summary": "", "operationId": "Confirm_GetTaxErrorAudit", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "auditType", "in": "query", "required": false, "items": { "type": "string", "enum": [ "CustodialRealizedSharesDoNotMatch", "CustodialRealizedMissing", "CustodialUnrealizedMissing", "CustodialRealizedUnknownAcquiredDate", "CustodialUnrealizedUnknownAcquiredDate", "CustodialRealizedUnknownCostBasis", "CustodialUnrealizedUnknownCostBasis", "OrionUnknownCostBasis", "MoneyMarketProducts", "OrionMissingCostBasis" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "downloadFormatId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "downloadSourceId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.TaxCenterAuditTypeCountDto" }, "xml": { "name": "TaxCenterAuditTypeCountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/TaxCenter/UpdateTaxErrorAudit": { "post": { "tags": [ "Confirm/TaxCenter" ], "operationId": "Confirm_UpdateTaxErrorAuditAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "assetIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/TaxError": { "get": { "tags": [ "Confirm/TaxError" ], "summary": "Gets the Tax Errors", "operationId": "TaxError_GetAllAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.TaxErrorPortfolioDto" }, "xml": { "name": "TaxErrorPortfolioDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/TaxError/Realized/{key}/AcquiredDate": { "put": { "tags": [ "Confirm/TaxError" ], "summary": "Updates A Realized AssetCostBasis's AcquiredDate", "operationId": "TaxError_UpdateRealizedAcquiredDateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The CostodianRealizedId from tblAssetCostBasis.pkAssetCostBasis", "required": true, "type": "integer", "format": "int32" }, { "name": "acquiredDate", "in": "body", "description": "The Acquired Date to update to", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ct", "in": "header", "description": "the cancellation token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/TaxError/Realized/{key}/CostAmt": { "put": { "tags": [ "Confirm/TaxError" ], "summary": "Updates A Realized AssetCostBasis's Cost Amount", "operationId": "TaxError_UpdateRealizedCostAmountAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The CostodianRealizedId from tblAssetCostBasis.pkAssetCostBasis", "required": true, "type": "integer", "format": "int32" }, { "name": "costAmt", "in": "body", "description": "The amount to update to", "required": true, "schema": { "type": "number", "format": "double" } }, { "name": "ct", "in": "header", "description": "the cancellation token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/TaxError/Realized/Filter": { "get": { "tags": [ "Confirm/TaxError" ], "summary": "Get Realized Errors", "operationId": "TaxError_GetRealizedErrorsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "entityEnum", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "entityId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "auditType", "in": "query", "required": false, "type": "string" }, { "name": "entitySession", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/TaxError/Unrealized/{key}/AcquiredDate": { "put": { "tags": [ "Confirm/TaxError" ], "summary": "Updates an unrealized AssetCostCustodian's AcquiredDate", "operationId": "TaxError_UpdateUnrealizedAcquiredDateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The Unrealized AssetCostCostodianID from tblAssetCostCustodian.pkAssetCostCustodian", "required": true, "type": "integer", "format": "int32" }, { "name": "acquiredDate", "in": "body", "description": "The Acquired Date to update to", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ct", "in": "header", "description": "the cancellation token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/TaxError/Unrealized/{key}/CostAmt": { "put": { "tags": [ "Confirm/TaxError" ], "summary": "Updates an unrealized AssetCostCustodian's CostAmount based on existing units and acquired date", "operationId": "TaxError_UpdateUnrealizedCostAmountAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The Unrealized AssetCostCostodianID from tblAssetCostCustodian.pkAssetCostCustodian", "required": true, "type": "integer", "format": "int32" }, { "name": "costAmt", "in": "body", "description": "the cost amount to update to", "required": true, "schema": { "type": "number", "format": "double" } }, { "name": "ct", "in": "header", "description": "the cancellation token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/TaxError/Unrealized/Filter": { "get": { "tags": [ "Confirm/TaxError" ], "summary": "Get Unrealized Errors", "operationId": "TaxError_GetFilteredAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "entityEnum", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "entityId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "auditType", "in": "query", "required": false, "type": "string" }, { "name": "entitySession", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.TaxErrorPortfolioDto" }, "xml": { "name": "TaxErrorPortfolioDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/TaxError/UpdateReviewed/List": { "post": { "tags": [ "Confirm/TaxError" ], "summary": "Gets the Tax Errors", "operationId": "TaxError_UpdateReviewedValueAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "idList", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "reviewValue", "in": "query", "required": true, "type": "boolean" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/UploadFormats": { "get": { "tags": [ "Confirm/UploadFormats" ], "summary": "Gets a list of Upload Formats that the logged in user has access to.", "operationId": "UploadFormats_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.UploadFormatDto" }, "xml": { "name": "UploadFormatDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/UploadFormats/{key}": { "get": { "tags": [ "Confirm/UploadFormats" ], "summary": "Gets the Upload Format that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "UploadFormats_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.UploadFormatDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/UploadTarget": { "get": { "tags": [ "Confirm/UploadTarget" ], "operationId": "UploadTarget_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.UploadTargetDto" }, "xml": { "name": "UploadTargetDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Confirm/UploadTarget" ], "operationId": "UploadTarget_CreateUploadTargetAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.UploadTargetDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.UploadTargetDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/UploadTarget/{key}": { "get": { "tags": [ "Confirm/UploadTarget" ], "operationId": "UploadTarget_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.UploadTargetDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Confirm/UploadTarget" ], "operationId": "UploadTarget_UpdateUploadTargetAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.UploadTargetDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.UploadTargetDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Confirm/UploadTarget" ], "operationId": "UploadTarget_Delete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Confirm/UploadTarget/Action/Delete": { "put": { "tags": [ "Confirm/UploadTarget" ], "operationId": "UploadTarget_ActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Dashboards/Cards/Card": { "get": { "tags": [ "Dashboards/Cards" ], "summary": "Retrieve card by card type and name", "operationId": "Cards_GetCardByNameAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "name", "in": "query", "required": true, "type": "string" }, { "name": "cardType", "in": "query", "required": true, "type": "string", "enum": [ "None", "Homepage", "View" ] }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Dashboards/Cards/Settings": { "put": { "tags": [ "Dashboards/Cards" ], "summary": "", "operationId": "Cards_UpdateCardSettingsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.CardSettingSaveDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Dashboards/Cards/Simple": { "get": { "tags": [ "Dashboards/Cards" ], "summary": "", "operationId": "Cards_GetCardsSimpleAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cardType", "in": "query", "required": true, "type": "string", "enum": [ "None", "Homepage", "View" ] }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/DataMaintenance/DataProvider/Setup": { "get": { "tags": [ "DataMaintenance/DataProvider" ], "operationId": "DataProviderSetup_GetAllSetupsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "DataMaintenance/DataProvider" ], "operationId": "DataProviderSetup_UpdateAndProcessDataProviderSetupStepAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dataProviderSetupDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.DataMaintenance.DataProvider.DataProviderSetupDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "DataMaintenance/DataProvider" ], "operationId": "DataProviderSetup_CreateDataProviderSetupAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dataProviderSetupDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.DataMaintenance.DataProvider.DataProviderSetupDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/DataMaintenance/DataProvider/Setup/{id}": { "get": { "tags": [ "DataMaintenance/DataProvider" ], "operationId": "DataProviderSetup_GetSetupByIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "DataMaintenance/DataProvider" ], "operationId": "DataProviderSetup_AdminOverrideStepAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "DataMaintenance/DataProvider" ], "operationId": "DataProviderSetup_DeleteDataProviderSetupAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/DataMaintenance/DataProvider/Setup/{id}/InputDatapoints": { "get": { "tags": [ "DataMaintenance/DataProvider" ], "operationId": "DataProviderSetup_GetInputDatapointsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/DataMaintenance/DataProvider/Setup/Help/Email": { "post": { "tags": [ "DataMaintenance/DataProvider" ], "operationId": "DataProviderSetup_SendHelpEmailAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.DataMaintenance.DataProvider.DataProviderSetupSendHelpEmailRequestDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/DataMaintenance/DataProvider/Setup/RepAccess": { "get": { "tags": [ "DataMaintenance/DataProvider" ], "operationId": "DataProviderSetupRepAccess_GetAllAccessRecordsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/DataMaintenance/DataProvider/Setup/RepAccess/{dataProviderSetupId}": { "get": { "tags": [ "DataMaintenance/DataProvider" ], "operationId": "DataProviderSetupRepAccess_GetAccessRecordsForSetupIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dataProviderSetupId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "DataMaintenance/DataProvider" ], "operationId": "DataProviderSetupRepAccess_CreateAccessRecordAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dataProviderSetupId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "requestDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.DataMaintenance.DataProvider.DataProviderSetupRepAccessDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/DataMaintenance/DataProvider/Setup/RepAccess/{dataProviderSetupId}/Add": { "post": { "tags": [ "DataMaintenance/DataProvider" ], "operationId": "DataProviderSetupRepAccess_AddRepAccessForSetupOwnerRepCodeAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dataProviderSetupId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.DataMaintenance.DataProvider.DataProviderSetupOwnerRepCodeAddDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/DataMaintenance/DataProvider/Setup/RepAccess/{dataProviderSetupId}/AvailableRepCodes": { "get": { "tags": [ "DataMaintenance/DataProvider" ], "operationId": "DataProviderSetupRepAccess_GetAvailableRepCodesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dataProviderSetupId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/DataMaintenance/DataProvider/Setup/RepAccess/{dataProviderSetupId}/Reps": { "get": { "tags": [ "DataMaintenance/DataProvider" ], "operationId": "DataProviderSetupRepAccess_GetRepsByAlClientIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dataProviderSetupId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/DataMaintenance/DataProvider/Setup/RepAccess/{dataProviderSetupId}/SummaryCounts": { "get": { "tags": [ "DataMaintenance/DataProvider" ], "operationId": "DataProviderSetupRepAccess_GetRepSummaryCountsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dataProviderSetupId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "repCode", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/DataMaintenance/DataProvider/Setup/RepAccess/{repAccessId}": { "put": { "tags": [ "DataMaintenance/DataProvider" ], "operationId": "DataProviderSetupRepAccess_UpdateAccessRecordsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "repAccessId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "requestDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.DataMaintenance.DataProvider.DataProviderSetupRepAccessDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "DataMaintenance/DataProvider" ], "operationId": "DataProviderSetupRepAccess_DeleteAccessRecordAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "repAccessId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/DataMaintenance/DataProvider/Setup/RepAccess/{repAccessId}/AccountCodesCountByRep": { "get": { "tags": [ "DataMaintenance/DataProvider" ], "operationId": "DataProviderSetupRepAccess_GetAccountCodeCountForRepAccessAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "repAccessId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/DataMaintenance/DataProvider/Setup/RepAccess/actions": { "get": { "tags": [ "DataMaintenance/DataProvider" ], "operationId": "DataProviderSetupRepAccess_GetRepAccessActionsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/DataMaintenance/DataProvider/Setup/RepAccess/RequestAccess/{repAccessId}": { "post": { "tags": [ "DataMaintenance/DataProvider" ], "operationId": "DataProviderSetupRepAccess_RequestAccessAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "repAccessId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/DataMaintenance/DataProvider/Setup/RepAccess/ValidateAccountCodes/{dataProviderSetupId}/{repAccessId}": { "post": { "tags": [ "DataMaintenance/DataProvider" ], "operationId": "DataProviderSetupRepAccess_ValidateAccountCodesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dataProviderSetupId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "repAccessId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "accountCodes", "in": "body", "required": true, "schema": { "items": { "type": "string" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/DataMaintenance/DataProvider/SetupType": { "get": { "tags": [ "DataMaintenance/DataProvider" ], "summary": "Returns a list of all Data Provider Setup Types user has access to", "operationId": "DataProviderSetupType_GetAllDataProviderSetupTypesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "isActive", "in": "query", "description": "Filters out inactive records if true", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "DataMaintenance/DataProvider" ], "operationId": "DataProviderSetupType_UpdateDataProviderSetupTypeAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "setupTypeToCreate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.DataMaintenance.DataProvider.DataProviderSetupTypeDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "DataMaintenance/DataProvider" ], "operationId": "DataProviderSetupType_CreateDataProviderSetupTypeAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "setupTypeToCreate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.DataMaintenance.DataProvider.DataProviderSetupTypeDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/DataMaintenance/DataProvider/SetupType/{id}": { "delete": { "tags": [ "DataMaintenance/DataProvider" ], "operationId": "DataProviderSetupType_DeleteDataProviderSetupTypeAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/DataMaintenance/DataProvider/SetupType/{key}": { "get": { "tags": [ "DataMaintenance/DataProvider" ], "summary": "returns a single Data Provider Setup Type by its key", "operationId": "DataProviderSetupType_GetDataProviderSetupTypeByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Email/Clients": { "post": { "tags": [ "Email/Clients" ], "summary": "Used to email one message to a number of provided clients.", "operationId": "Email_SendEmailMessage", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "setting", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.EmailMessageSettingDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/FileImport/{key}/File": { "get": { "tags": [ "FileImport/{key}" ], "operationId": "FileImport_GetBlob", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/FileImport/Instance/{instanceId}": { "delete": { "tags": [ "FileImport/Instance" ], "summary": "Delete the file import instance records. Does not delete the blobs", "operationId": "FileImportInstance_DeleteFileImportInstanceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "instanceId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/FileImport/Instance/{instanceId}/Files": { "get": { "tags": [ "FileImport/Instance" ], "summary": "Given an instance id, return a list of associated documents", "operationId": "FileImportInstance_GetFileImportInstanceBlobs", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "instanceId", "in": "path", "description": "from uri, the instance id", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobViewStatusDto" }, "xml": { "name": "BlobViewStatusDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/FileImport/Instance/Files/UpdateViewStatus": { "post": { "tags": [ "FileImport/Instance" ], "summary": "Update the status for the files to make them hidden or viewable to clients", "operationId": "FileImportInstance_UpdateViewStatus", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "fileList", "in": "body", "description": "list of files we want to change view status", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobViewStatusDto" }, "xml": { "name": "BlobViewStatusDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" }, "xml": { "name": "BlobBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/FileImport/Instance/List": { "get": { "tags": [ "FileImport/Instance" ], "summary": "Get list of all file import instances", "operationId": "FileImportInstance_GetFileImportInstances", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.FileImportInstanceDto" }, "xml": { "name": "FileImportInstanceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/FileImport/Log/{filename}": { "get": { "tags": [ "FileImport/Log" ], "summary": "Used to download a previously generated log export.", "operationId": "FileImport_RunReportAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "filename", "in": "path", "description": "The filename provided by the generate endpoint.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/FileImport/Upload": { "post": { "tags": [ "FileImport/Upload" ], "summary": "This endpoint is no longer supported. Please use FileImport/Upload/New instead", "operationId": "FileImport_SetupUploadSessionAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "settings", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.FileImportRequestDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/FileImport/Upload/{sessionId}": { "post": { "tags": [ "FileImport/Upload" ], "summary": "This is no longer supported. Use FileImport/Upload/New then FileImport/Upload/File", "operationId": "FileImport_UploadFileForSessionAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "file", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.FileImportUploadDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.FileImportDto" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/FileImport/Upload/{sessionId}/Log": { "get": { "tags": [ "FileImport/Upload" ], "summary": "This is no longer supported. Use FileImport/Upload/New then FileImport/Upload/File then FileImport/Upload/GenerateLog", "operationId": "FileImport_GetUploadLogForSessionAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/FileImport/Upload/File": { "post": { "tags": [ "FileImport/Upload" ], "operationId": "FileImport_UploadFileForSessionNewAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "requestDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.FileImportSettingUploadDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.FileImportDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/FileImport/Upload/GenerateLog": { "post": { "tags": [ "FileImport/Upload" ], "operationId": "FileImport_GenerateUploadLogForSessionAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.FileImportDownloadLogsRequestDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/FileImport/Upload/New": { "post": { "tags": [ "FileImport/Upload" ], "operationId": "FileImport_SetupUploadSessionNewAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "settings", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.FileImportRequestDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.FileImportSettingDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Fuse/Config/Categories": { "get": { "tags": [ "Fuse/Config" ], "operationId": "FuseConfig_GetCategories", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Fuse.CategoryDto" }, "xml": { "name": "CategoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Fuse/Config/Categories/{categoryId}": { "get": { "tags": [ "Fuse/Config" ], "operationId": "FuseConfig_GetCategory", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "categoryId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Fuse.CategoryDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Fuse/Config/Environments/{environment}/PartnerApps/{partnerAppId}/WebhookUrlRoutes": { "get": { "tags": [ "Fuse/Config" ], "operationId": "FuseConfig_GetWebhookUrlRouteByEnvironmentAndPartnerAppId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "environment", "in": "path", "required": true, "type": "string" }, { "name": "partnerAppId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Fuse.WebhookUrlRouteDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Fuse/Config/Integrations": { "get": { "tags": [ "Fuse/Config" ], "operationId": "FuseConfig_GetIntegrations", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Fuse.IntegrationDto" }, "xml": { "name": "IntegrationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Fuse/Config" ], "summary": "Adds a new integration for the current user, and the specified partner app, to the database.", "operationId": "FuseConfig_PostIntegration", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "integrationDto", "in": "body", "description": "An {OAS.WebApi.DTO.Fuse.IntegrationDto} with properties to start setting up the integration record.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Fuse.IntegrationDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Fuse.IntegrationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Fuse/Config/Integrations/{integrationId}": { "put": { "tags": [ "Fuse/Config" ], "operationId": "FuseConfig_UpdateIntegration", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "integrationId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "integrationDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Fuse.IntegrationDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Fuse.IntegrationDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Fuse/Config" ], "operationId": "FuseConfig_DeleteIntegration", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "integrationId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Fuse/Config/Integrations/{integrationId}/Categories": { "get": { "tags": [ "Fuse/Config" ], "operationId": "FuseConfig_GetIntegrationCategories", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "integrationId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Fuse.CategoryDto" }, "xml": { "name": "CategoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Fuse/Config/Integrations/{integrationId}/Image": { "get": { "tags": [ "Fuse/Config" ], "operationId": "FuseConfig_GetIntegrationImage", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "integrationId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Fuse/Config/Integrations/{integrationId}/SmallImage": { "get": { "tags": [ "Fuse/Config" ], "operationId": "FuseConfig_GetIntegrationSmallImage", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "integrationId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Fuse/Config/PartnerApps/{partnerAppId}/Categories": { "get": { "tags": [ "Fuse/Config" ], "operationId": "FuseConfig_GetPartnerAppCategories", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "partnerAppId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Fuse.CategoryDto" }, "xml": { "name": "CategoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Fuse/Config/RegisteredApps": { "get": { "tags": [ "Fuse/Config" ], "operationId": "FuseConfig_GetRegisteredApps", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Fuse.RegisteredAppsDto" }, "xml": { "name": "RegisteredAppsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Fuse/Notifications/TDA": { "post": { "tags": [ "Fuse/Notifications" ], "operationId": "FusePublicNotification_TDACreate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Fuse/PartnerApps/{partnerAppId}/SmallImage": { "get": { "tags": [ "Fuse/PartnerApps" ], "operationId": "FusePublicNotification_GetPartnerAppSmallImage", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "partnerAppId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Fuse/Slack/OutgoingWebhook/Users/{userIntegrationGuid}/Notifications": { "post": { "tags": [ "Fuse/Slack" ], "operationId": "FusePublicNotification_SlackOutgoingWebhook", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "userIntegrationGuid", "in": "path", "required": true, "type": "string" }, { "name": "slackOutgoingWebhookDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Fuse.SlackOutgoingWebhookDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Fuse/Slack/Slash/Users/{userIntegrationGuid}/Notifications": { "post": { "tags": [ "Fuse/Slack" ], "operationId": "FusePublicNotification_SlackSlashNotifications", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "userIntegrationGuid", "in": "path", "required": true, "type": "string" }, { "name": "slackSlashDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Fuse.SlackSlashDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Fuse/Users/{userIntegrationGuid}/Notifications": { "get": { "tags": [ "Fuse/Users" ], "operationId": "FusePublicNotification_GetNotifications", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "userIntegrationGuid", "in": "path", "required": true, "type": "string" }, { "name": "firmId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "status", "in": "query", "required": false, "items": { "type": "string", "enum": [ "Unread", "Read", "Deleted" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "ignoreCallerNotifications", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Fuse/Users" ], "operationId": "FusePublicNotification_UpsertNotification", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "userIntegrationGuid", "in": "path", "required": true, "type": "string" }, { "name": "notificationDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Fuse.NotificationDto" } }, { "name": "notificationId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Fuse/Users" ], "operationId": "FusePublicNotification_CreateNotification", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "userIntegrationGuid", "in": "path", "required": true, "type": "string" }, { "name": "notificationDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Fuse.NotificationDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Fuse/Users/{userIntegrationGuid}/Notifications/{notificationId}": { "get": { "tags": [ "Fuse/Users" ], "operationId": "FusePublicNotification_GetNotification", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "userIntegrationGuid", "in": "path", "required": true, "type": "string" }, { "name": "notificationId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Fuse/Users" ], "operationId": "FusePublicNotification_PutV1FuseUsersByUserIntegrationGuidNotificationsByNotificationId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "userIntegrationGuid", "in": "path", "required": true, "type": "string" }, { "name": "notificationDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Fuse.NotificationDto" } }, { "name": "notificationId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Fuse/Users/{userIntegrationGuid}/Notifications/Redtail": { "post": { "tags": [ "Fuse/Users" ], "summary": "Creates a notification for a user about a Redtail event for account, activity,\r\nor contact changes.", "operationId": "FusePublicNotification_RedtailCreate", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "userIntegrationGuid", "in": "path", "description": "A string containing the unique Guid identifying the\r\n user for Redtail 2-way sync notifications.", "required": true, "type": "string" }, { "name": "message", "in": "body", "description": "The payload from Redtail sent to the webhook.", "required": true, "schema": { "type": "object" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Fuse/Users/{userIntegrationGuid}/Notifications/ShareFile": { "post": { "tags": [ "Fuse/Users" ], "summary": "Creates a notification from ShareFile webhook callbacks.", "operationId": "FusePublicNotification_CreateShareFileNotification", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "userIntegrationGuid", "in": "path", "required": true, "type": "string" }, { "name": "callbackBody", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.CloudStorage.ShareFile.Models.WebhookCallbackBody" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/CorporateActions": { "get": { "tags": [ "Global/CorporateActions" ], "summary": "Gets a list of corporate actions that the logged in user has access to.\r\nThe return is limited to pages of 1000. Use $top and $skip in the query string to page through the data.", "operationId": "GlobalCorporateActions_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "query", "description": "Optional. Default null. Product Id of the desired return object.", "required": false, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "description": "Optional. Default null. If provided, returns any corporate action with an effectiveDate on or after the date.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default null. If provided, returns any corporate action with an effectiveDate on or before the date.", "required": false, "type": "string", "format": "date-time" }, { "name": "corpActionId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CorporateActionDto" }, "xml": { "name": "CorporateActionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Global/CorporateActions" ], "summary": "Used to bulk update a list of existing corporate actions.", "operationId": "GlobalCorporateActions_UpdateCorporateActionsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updatedItems", "in": "body", "description": "List of CorporateActionDto to update.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CorporateActionDto" }, "xml": { "name": "CorporateActionDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "description": "CancellationToken of the request", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CorporateActionDto" }, "xml": { "name": "CorporateActionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Global/CorporateActions" ], "summary": "Used to create a new corporate action. Upon successful creation a 201 will be returned with the location of the nearly created corporate action.", "operationId": "GlobalCorporateActions_CreateCorporateActionsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "CorporateActionDto to create", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CorporateActionDto" } }, { "name": "cancellationToken", "in": "header", "description": "CancellationToken of the request", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/CorporateActions/{key}": { "get": { "tags": [ "Global/CorporateActions" ], "summary": "Gets the corporate action that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "GlobalCorporateActions_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Primary key of the desired CorporateAction.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "description": "CancellationToken of the request", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CorporateActionDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Global/CorporateActions" ], "summary": "Used to update an existing corporate action. Upon successful modification a 200 will be returned.", "operationId": "GlobalCorporateActions_UpdateCorporateActionAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Primary Key of the CorporateAction to compare against.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "CorporateActionDto to update", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CorporateActionDto" } }, { "name": "cancellationToken", "in": "header", "description": "CancellationToken of the request", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CorporateActionDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Global/CorporateActions" ], "summary": "Used to delete an existing corporate action. Upon successful deletion a 204 will be returned.", "operationId": "GlobalCorporateActions_DeleteCorporateActionAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Primary Key of the CorporateAction.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "description": "CancellationToken of the request", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/CorporateActions/Action/Delete": { "put": { "tags": [ "Global/CorporateActions" ], "operationId": "GlobalCorporateActions_ActionDeleteAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/CorporateActions/Processing": { "get": { "tags": [ "Global/CorporateActions" ], "summary": "Gets Corporate Action Processing Records.", "operationId": "GlobalCorporateActions_GetCorporateActionsProcessing", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "corporateActionId", "in": "query", "description": "Optional. Default null. Get the extensions for a specific corporate action.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.CorpAction.CorporateActionProcessingDto" }, "xml": { "name": "CorporateActionProcessingDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/CorporateActions/Processing/{key}": { "get": { "tags": [ "Global/CorporateActions" ], "summary": "Gets Corporate Action Processing Record", "operationId": "GlobalCorporateActions_GetCorporateActionProcessingByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Primary Key of the CorpActionProcessing record.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.CorpAction.CorporateActionProcessingDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/CorporateActions/Search": { "get": { "tags": [ "Global/CorporateActions" ], "summary": "Returns a list of Corporate Actions filtered by name", "operationId": "GlobalCorporateActions_Search", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "Used to filter by the name of the CorporateAction", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/CorporateActions/Search/{search}": { "get": { "tags": [ "Global/CorporateActions" ], "summary": "Returns a list of Corporate Actions filtered by name", "operationId": "GlobalCorporateActions_GetV1GlobalCorporateActionsSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "Used to filter by the name of the CorporateAction", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/CorporateActions/Verbose": { "get": { "tags": [ "Global/CorporateActions" ], "operationId": "GlobalCorporateActions_GetVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Processes", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CorporateActionVerboseDto" }, "xml": { "name": "CorporateActionVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Global/CorporateActions" ], "summary": "Used to bulk update a list of existing CorporateActions", "operationId": "GlobalCorporateActions_UpdateManyVerboseCorpActionsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updatedItems", "in": "body", "description": "List of CorporateActionVerboseDto to update", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CorporateActionVerboseDto" }, "xml": { "name": "CorporateActionVerboseDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "description": "CancellationToken of the request", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CorporateActionVerboseDto" }, "xml": { "name": "CorporateActionVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Global/CorporateActions" ], "summary": "Create a new corporate action", "operationId": "GlobalCorporateActions_CreateVerboseClientAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newDto", "in": "body", "description": "CorporateActionVerboseDto to create", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CorporateActionVerboseDto" } }, { "name": "cancellationToken", "in": "header", "description": "CancellationToken of the request", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CorporateActionVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/CorporateActions/Verbose/{key}": { "get": { "tags": [ "Global/CorporateActions" ], "operationId": "GlobalCorporateActions_GetVerboseByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Processes", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CorporateActionVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Global/CorporateActions" ], "summary": "Used to update an existing CorporateAction", "operationId": "GlobalCorporateActions_UpdateVerboseCorpActionAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Primary Key of the CorporateAction to update for validation", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "description": "CorporateActionVerboseDto to update", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CorporateActionVerboseDto" } }, { "name": "cancellationToken", "in": "header", "description": "CancellationToken of the request", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CorporateActionVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/CorporateActions/Verbose/List": { "post": { "tags": [ "Global/CorporateActions" ], "operationId": "GlobalCorporateActions_GetVerboseListById", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Processes", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CorporateActionVerboseDto" }, "xml": { "name": "CorporateActionVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/CorporateActions/Verbose/List/Id": { "post": { "tags": [ "Global/CorporateActions" ], "operationId": "GlobalCorporateActions_PostV1GlobalCorporateActionsVerboseListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Processes", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CorporateActionVerboseDto" }, "xml": { "name": "CorporateActionVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/CorporateActions/Verbose/New": { "get": { "tags": [ "Global/CorporateActions" ], "operationId": "GlobalCorporateActions_GetNewVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Processes", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CorporateActionVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Custodians/Simple": { "get": { "tags": [ "Global/Custodians" ], "operationId": "CommonCustodians_GetSimpleAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Dividends": { "get": { "tags": [ "Global/Dividends" ], "summary": "Gets a list of dividends that the logged in user has access to.\r\nThe return is limited to pages of 1000. Use $top and $skip in the query string to page through the data.", "operationId": "GlobalDividends_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "query", "description": "Optional. Default null. Product Id of the desired return object.", "required": false, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "description": "Optional. Default null. If provided, returns any dividend with an exDate on or after the date.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default null. If provided, returns any dividend with an exDate on or before the date.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DividendDto" }, "xml": { "name": "DividendDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Global/Dividends" ], "operationId": "GlobalDividends_UpdateDividends", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updatedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DividendDto" }, "xml": { "name": "DividendDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DividendDto" }, "xml": { "name": "DividendDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Global/Dividends" ], "summary": "Used to create a new dividend. Upon successful creation a 201 will be returned with the location of the nearly created dividend.", "operationId": "GlobalDividends_CreateDividends", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DividendDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Dividends/{key}": { "get": { "tags": [ "Global/Dividends" ], "summary": "Gets the dividend that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "GlobalDividends_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DividendDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Global/Dividends" ], "summary": "Used to update an existing dividend. Upon successful modification a 200 will be returned.", "operationId": "GlobalDividends_UpdateDividend", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DividendDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DividendDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Global/Dividends" ], "summary": "Used to delete an existing dividend. Upon successful deletion a 204 will be returned.", "operationId": "GlobalDividends_DeleteDividend", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Dividends/Action/Delete": { "put": { "tags": [ "Global/Dividends" ], "operationId": "GlobalDividends_ActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/DownloadSymbols/{key}": { "get": { "tags": [ "Global/DownloadSymbols" ], "summary": "Gets the download symbol that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "GlobalDownloadSymbols_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DownloadSymbolFullDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/DownloadSymbols/Full/Product": { "get": { "tags": [ "Global/DownloadSymbols" ], "summary": "Gets the full download symbol records for a given product ID", "description": "Sample Request\r\n GET /v1/Global/DownloadSymbols/Full/Product/1", "operationId": "GlobalDownloadSymbols_GetAllFullForProduct", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "query", "description": "Product ID to filter by", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DownloadSymbolFullDto" }, "xml": { "name": "DownloadSymbolFullDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/DownloadSymbols/Full/Product/{productId}": { "get": { "tags": [ "Global/DownloadSymbols" ], "summary": "Gets the full download symbol records for a given product ID", "description": "Sample Request\r\n GET /v1/Global/DownloadSymbols/Full/Product/1", "operationId": "GlobalDownloadSymbols_GetV1GlobalDownloadSymbolsFullProductByProductId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "path", "description": "Product ID to filter by", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DownloadSymbolFullDto" }, "xml": { "name": "DownloadSymbolFullDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/DownloadSymbols/Product": { "get": { "tags": [ "Global/DownloadSymbols" ], "summary": "Get all download symbols for the product", "operationId": "GlobalDownloadSymbols_GetAllForProduct", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DownloadSymbolSimpleDto" }, "xml": { "name": "DownloadSymbolSimpleDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/DownloadSymbols/Product/{productId}": { "get": { "tags": [ "Global/DownloadSymbols" ], "summary": "Get all download symbols for the product", "operationId": "GlobalDownloadSymbols_GetV1GlobalDownloadSymbolsProductByProductId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DownloadSymbolSimpleDto" }, "xml": { "name": "DownloadSymbolSimpleDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/FundFamilies": { "get": { "tags": [ "Global/FundFamilies" ], "summary": "Gets a list of fund families that the logged in user has access to.", "operationId": "GlobalFundFamilies_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.FundFamilyDto" }, "xml": { "name": "FundFamilyDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/FundFamilies/{key}": { "get": { "tags": [ "Global/FundFamilies" ], "summary": "Gets the fund families that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "GlobalFundFamilies_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.FundFamilyDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/FundFamilies/Simple": { "get": { "tags": [ "Global/FundFamilies" ], "summary": "Gets a simple list of fund families that the logged in user has access to.", "operationId": "GlobalFundFamilies_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/FundFamilies/Simple/Search": { "get": { "tags": [ "Global/FundFamilies" ], "summary": "Gets a simple list of fund families that the logged in user has access to where the fund family name begin with the search string or Id is exact match.", "operationId": "GlobalFundFamilies_GetFundFamilySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "Partial fund family name to search for.", "required": true, "type": "string" }, { "name": "top", "in": "query", "description": "Optional. Default: null. The maximum number of products to return. If null returns all.", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Optional. Default: 0. Defines number of items to skip.", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/FundFamilies/Simple/Search/{search}": { "get": { "tags": [ "Global/FundFamilies" ], "summary": "Gets a simple list of fund families that the logged in user has access to where the fund family name begin with the search string or Id is exact match.", "operationId": "GlobalFundFamilies_GetV1GlobalFundFamiliesSimpleSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "Partial fund family name to search for.", "required": true, "type": "string" }, { "name": "top", "in": "query", "description": "Optional. Default: null. The maximum number of products to return. If null returns all.", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Optional. Default: 0. Defines number of items to skip.", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/FundFamilies/Update": { "put": { "tags": [ "Global/FundFamilies" ], "summary": "Update fund family", "operationId": "GlobalFundFamilies_UpdateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "fundFamilyDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.FundFamilyDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.FundFamilyDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Prices/Review/{productId}": { "get": { "tags": [ "Global/Prices" ], "operationId": "GlobalProductsPricesReview_ListByProductAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PriceGlobalAuditReviewDto" }, "xml": { "name": "PriceGlobalAuditReviewDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Prices/Review/{productId}/Statistics": { "get": { "tags": [ "Global/Prices" ], "operationId": "GlobalProductsPricesReview_PriceStatisticsByProductAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PriceGlobalAuditReviewStatisticsDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Products": { "get": { "tags": [ "Global/Products" ], "summary": "Gets a list of global products that the logged in user has access to.\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "GlobalProducts_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "searchTicker", "in": "query", "description": "Optional. Default: null. If provided returns only products with a ticker that contains the text provided.", "required": false, "type": "string" }, { "name": "exactTicker", "in": "query", "description": "Optional. Default: null. If provided returns only products with a ticker that exactly matches the text provided.", "required": false, "type": "string" }, { "name": "exactCusip", "in": "query", "description": "Optional. Default: null. If provided returns only products with a cusip that exactly matches the text provided.", "required": false, "type": "string" }, { "name": "searchCusip", "in": "query", "description": "Optional. Default: null. If provided returns only products with a cusip that contains the text provided.", "required": false, "type": "string" }, { "name": "exactDownloadSymbol", "in": "query", "description": "Optional. Default: null. If provided returns only products with a download symbol that exactly matches the text provided.", "required": false, "type": "string" }, { "name": "searchDownloadSymbol", "in": "query", "description": "Optional. Default: null. If provided returns only products with a download symbol that contains the text provided.", "required": false, "type": "string" }, { "name": "exactSymbol", "in": "query", "description": "Optional. Default: null. If provided returns only products with a ticker, cusip, or download symbol that exactly matches the text provided.", "required": false, "type": "string" }, { "name": "searchSymbol", "in": "query", "description": "Optional. Default: null. If provided returns only products with a ticker, cusip, or download symbol that contains the text provided.", "required": false, "type": "string" }, { "name": "searchName", "in": "query", "description": "Optional. Default: null. If provided returns only products with a name that contains the text provided.", "required": false, "type": "string" }, { "name": "searchId", "in": "query", "description": "Optional. Default: null. If provided returns only products with the id specified.", "required": false, "type": "integer", "format": "int32" }, { "name": "productType", "in": "query", "description": "Optional. Default: null. If provided returns only products that are of the specified type.", "required": false, "items": { "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "returnStyle", "in": "query", "description": "Optional. Default: Standard.", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "Full" ] }, { "name": "filterType", "in": "query", "required": false, "type": "string", "enum": [ "BondWithoutBondRates", "BondWithBondRates" ] }, { "name": "fundFamilyId", "in": "query", "description": "Optional. Default: null. If provided returns only products that assigned to the provided fund family (not master fund family).", "required": false, "type": "integer", "format": "int32" }, { "name": "partialId", "in": "query", "description": "Optional. Default: null. If provided returns only products where the product id contains the partial id specified.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.GlobalProductDto" }, "xml": { "name": "GlobalProductDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Products/{key}": { "get": { "tags": [ "Global/Products" ], "summary": "Gets the global product that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "GlobalProducts_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "returnStyle", "in": "query", "description": "Optional. Default: Standard.", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "Full" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.GlobalProductDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Products/{key}/SubHolding": { "get": { "tags": [ "Global/Products" ], "summary": "Gets the subholding information for the global product that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "GlobalProducts_GetProductSubholdings", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "asOfDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SubHoldingWithAssetClassDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Products/Combine": { "get": { "tags": [ "Global/Products" ], "operationId": "GlobalProductsCombine_GetProductCombinesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "id", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "completedDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductCombineDto" }, "xml": { "name": "ProductCombineDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Global/Products" ], "summary": "Adds a new Product Combine request to the database.", "operationId": "GlobalProductsCombine_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "Product combine object that contains JArray instructions", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductCombineDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Products/Core/{productId}": { "get": { "tags": [ "Global/Products" ], "summary": "Returns the core global product based on a global product id", "description": "Sample Request\r\n GET /Global/Products/Core/1", "operationId": "GlobalProducts_GetGlobalProductCoreAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "path", "description": "Product ID to lookup", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "description": "Cancellation Token of the request", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.GlobalProductCoreDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Products/DividendTypes/Simple": { "get": { "tags": [ "Global/Products" ], "operationId": "GlobalDividendTypes_GetSimpleAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Products/ISIN/Validate": { "get": { "tags": [ "Global/Products" ], "summary": "Check if a specified ISIN is valid", "operationId": "GlobalProducts_GetIsISINValidAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isin", "in": "query", "description": "An ISIN", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "description": "A cancellation token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Products/List": { "post": { "tags": [ "Global/Products" ], "operationId": "GlobalProducts_GetListById", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "Full" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.GlobalProductDto" }, "xml": { "name": "GlobalProductDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Products/List/DownloadSymbol": { "post": { "tags": [ "Global/Products" ], "summary": "Get list of global products by DownloadSymbol\r\nNull attributes will be excluded from the payload", "description": "POST /Global/Products/List/DownloadSymbol\r\n[\"4578820\", \"4885661\"]\r\n \r\nReturns:\r\n[\r\n {\r\n \"searchString\": \"4578820\",\r\n \"productId\": 1234,\r\n \"productName\": \"PRODUCT NAME\",\r\n \"ticker\": \"1234\",\r\n \"cusip\": \"1234\",\r\n \"isin\": \"1234\",\r\n \"productType\": \"Option\",\r\n \"productSubTypeName\": null,\r\n \"defaultPrice\": null,\r\n \"priceStatus\": \"PRICE STATUS\",\r\n \"inceptionDate\": null\r\n },\r\n {\r\n \"searchString\": \"4885661\",\r\n \"productId\": 456,\r\n \"productName\": \"PRODUCT NAME\",\r\n \"ticker\": \"TICKER 456\",\r\n \"cusip\": \"456\",\r\n \"isin\": null,\r\n \"productType\": \"Option\",\r\n \"productSubTypeName\": null,\r\n \"defaultPrice\": null,\r\n \"priceStatus\": \"PRICE STATUS\",\r\n \"inceptionDate\": null\r\n }\r\n]", "operationId": "GlobalProducts_GetProductsByDownloadSymbolAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "downloadSymbols", "in": "body", "required": true, "schema": { "items": { "type": "string" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.GlobalProductSearchSimpleDto" }, "xml": { "name": "GlobalProductSearchSimpleDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Products/List/Id": { "post": { "tags": [ "Global/Products" ], "operationId": "GlobalProducts_PostV1GlobalProductsListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "Full" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.GlobalProductDto" }, "xml": { "name": "GlobalProductDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Products/List/Ticker": { "post": { "tags": [ "Global/Products" ], "summary": "Get list of global products with the supplied tickers.", "operationId": "GlobalProducts_GetListByTickersAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "tickers", "in": "body", "required": true, "schema": { "items": { "type": "string" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.GlobalProductDto" }, "xml": { "name": "GlobalProductDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Products/PriceFactors": { "get": { "tags": [ "Global/Products" ], "summary": "Gets a list of price factors that the logged in user has access to.\r\nThe return is limited to pages of 1000. Use $top and $skip in the query string to page through the data.", "operationId": "GlobalProductsPriceFactors_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "query", "description": "Optional. Default null. Product Id of the desired return object.", "required": false, "type": "integer", "format": "int32" }, { "name": "factorDate", "in": "query", "description": "Optional. Default null. Price Date of the desired return object.", "required": false, "type": "string", "format": "date-time" }, { "name": "startDate", "in": "query", "description": "Optional. Default null. If provided, returns any price factor on or after the date.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default null. If provided, returns any price factor on or before the date.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PriceFactorDto" }, "xml": { "name": "PriceFactorDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Global/Products" ], "operationId": "GlobalProductsPriceFactors_UpdatePriceFactors", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updatedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PriceFactorDto" }, "xml": { "name": "PriceFactorDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PriceFactorDto" }, "xml": { "name": "PriceFactorDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Global/Products" ], "summary": "Used to create a new price factor. Upon successful creation a 201 will be returned with the location of the nearly created price factor.", "operationId": "GlobalProductsPriceFactors_CreatePriceFactor", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PriceFactorDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Products/PriceFactors/{productId}/{factorDate}": { "put": { "tags": [ "Global/Products" ], "summary": "Used to update an existing price factor. Upon successful modification a 200 will be returned.", "operationId": "GlobalProductsPriceFactors_UpdatePriceFactor", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "path", "description": "Product Id of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "factorDate", "in": "path", "description": "Factor date of the desired return object.", "required": true, "type": "string", "format": "date-time" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PriceFactorDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PriceFactorDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Global/Products" ], "summary": "Used to delete an existing price factor. Upon successful deletion a 204 will be returned.", "operationId": "GlobalProductsPriceFactors_DeletePriceFactor", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "path", "description": "Product Id of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "factorDate", "in": "path", "description": "Factor date of the desired return object.", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Products/PriceFactors/{productId}/{priceDate}": { "get": { "tags": [ "Global/Products" ], "summary": "Gets the price factor that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "GlobalProductsPriceFactors_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "path", "description": "Product Id of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "factorDate", "in": "query", "description": "Factor date of the desired return object.", "required": true, "type": "string", "format": "date-time" }, { "name": "priceDate", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PriceFactorDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Products/PriceFactors/Action/Delete": { "put": { "tags": [ "Global/Products" ], "summary": "Deletes every price factor provided in the list of ids where the Id is formatted as {ProductId}/{FactorDate}.", "operationId": "GlobalProductsPriceFactors_ActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "description": "Optional. The ids of the price factors to delete.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PriceFactorKeyDto" }, "xml": { "name": "PriceFactorKeyDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PriceFactorKeyDto" }, "xml": { "name": "PriceFactorKeyDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Products/Prices": { "get": { "tags": [ "Global/Products" ], "operationId": "GlobalProductsPrices_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "custodianCommonId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "priceDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "maxPrice", "in": "query", "required": false, "type": "number", "format": "double" }, { "name": "minPrice", "in": "query", "required": false, "type": "number", "format": "double" }, { "name": "maxPriceInclusive", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "minPriceInclusive", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PriceGlobalDto" }, "xml": { "name": "PriceGlobalDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Global/Products" ], "summary": "Used to create a new global price. Upon successful creation a 201 will be returned with the location of the nearly created global price.", "operationId": "GlobalProductsPrices_CreateGlobalPrice", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PriceGlobalDto" } }, { "name": "isValidated", "in": "query", "description": "Whether the price has been verified.", "required": true, "type": "boolean" }, { "name": "reason", "in": "query", "description": "The reason for the change.", "required": true, "type": "string", "enum": [ "ThirdPartyWebsite", "InstituteWebsite", "AdvisorConfirmed", "Other", "MultiplyPriceFactor", "BondPricingFirstIn", "LessRoundedPrice", "CorrectingDecimalOnPrice", "UpdatingCSIPrice", "NotUSPrice", "DifferentEffectiveDate" ] }, { "name": "notes", "in": "query", "description": "Additional notes.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Products/Prices/{productId}/{custodianCommonId}/{priceDate}": { "get": { "tags": [ "Global/Products" ], "summary": "Gets the global price that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "GlobalProductsPrices_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "path", "description": "Product Id of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "custodianCommonId", "in": "path", "description": "Custodian Common Id of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "priceDate", "in": "path", "description": "Price date of the desired return object.", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PriceGlobalDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Global/Products" ], "summary": "Used to update an existing global price. Upon successful modification a 200 will be returned.", "operationId": "GlobalProductsPrices_UpdateGlobalPrice", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "path", "description": "Product Id of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "custodianCommonId", "in": "path", "description": "Custodian Common Id of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "priceDate", "in": "path", "description": "Price date of the desired return object.", "required": true, "type": "string", "format": "date-time" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PriceGlobalDto" } }, { "name": "isValidated", "in": "query", "description": "Whether the price has been verified.", "required": true, "type": "boolean" }, { "name": "reason", "in": "query", "description": "The reason for the change.", "required": true, "type": "string", "enum": [ "ThirdPartyWebsite", "InstituteWebsite", "AdvisorConfirmed", "Other", "MultiplyPriceFactor", "BondPricingFirstIn", "LessRoundedPrice", "CorrectingDecimalOnPrice", "UpdatingCSIPrice", "NotUSPrice", "DifferentEffectiveDate" ] }, { "name": "notes", "in": "query", "description": "Additional notes.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PriceGlobalDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Global/Products" ], "summary": "Used to delete an existing global price. Upon successful deletion a 204 will be returned.", "operationId": "GlobalProductsPrices_DeleteGlobalPrice", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "path", "description": "Product Id of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "custodianCommonId", "in": "path", "description": "Custodian Common Id of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "priceDate", "in": "path", "description": "Price date of the desired return object.", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Products/Prices/{productId}/{custodianCommonId}/{priceDate}/Audits": { "get": { "tags": [ "Global/Products" ], "summary": "Gets the audits for the price specified.", "operationId": "GlobalProductsPrices_GetAudits", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "path", "description": "Product Id of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "custodianCommonId", "in": "path", "description": "Custodian Common Id of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "priceDate", "in": "path", "description": "Price date of the desired return object.", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PriceAuditDto" }, "xml": { "name": "PriceAuditDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Products/Prices/Action/Delete": { "put": { "tags": [ "Global/Products" ], "operationId": "GlobalProductsPrices_ActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PriceGlobalKeyDto" }, "xml": { "name": "PriceGlobalKeyDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PriceGlobalKeyDto" }, "xml": { "name": "PriceGlobalKeyDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Products/Prices/CopyPrices/{copyToProductId}": { "post": { "tags": [ "Global/Products" ], "summary": "Copies Global prices from one product to another product", "operationId": "GlobalProductsPrices_CopyGlobalPrices", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "copyToProductId", "in": "path", "description": "Product ID to copy prices into", "required": true, "type": "integer", "format": "int32" }, { "name": "ids", "in": "body", "description": "List of PriceGlobalKeys where the Id is formatted as {ProductId}/{CustodianCommonId}/{PriceDate}", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PriceGlobalKeyDto" }, "xml": { "name": "PriceGlobalKeyDto", "wrapped": true }, "type": "array" } }, { "name": "auditNotes", "in": "query", "description": "Additional Notes.", "required": true, "type": "string" }, { "name": "ct", "in": "header", "description": "CancellationToken of the request", "required": true }, { "name": "overwriteOnMatch", "in": "query", "description": "Overwrite prices if it already exists on the product to move to", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Products/Prices/MovePrices/{moveToProductId}": { "post": { "tags": [ "Global/Products" ], "summary": "Moves Global prices from one product to another product", "operationId": "GlobalProductsPrices_MoveGlobalPrices", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "moveToProductId", "in": "path", "description": "Product ID to move prices into", "required": true, "type": "integer", "format": "int32" }, { "name": "ids", "in": "body", "description": "List of PriceGlobalKeys where the Id is formatted as {ProductId}/{CustodianCommonId}/{PriceDate}", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PriceGlobalKeyDto" }, "xml": { "name": "PriceGlobalKeyDto", "wrapped": true }, "type": "array" } }, { "name": "auditNotes", "in": "query", "description": "Additional Notes.", "required": true, "type": "string" }, { "name": "ct", "in": "header", "description": "CancellationToken of the request", "required": true }, { "name": "overwriteOnMatch", "in": "query", "description": "Overwrite prices if it already exists on the product to move to", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Products/Simple/Search": { "get": { "tags": [ "Global/Products" ], "operationId": "GlobalProducts_Search", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "searchText", "in": "query", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "searchMode", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "SearchByAll", "SearchByTicker", "SearchByName" ] }, { "name": "isCommunitiesSearch", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "resultSize", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 50 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductGlobalSearchDto" }, "xml": { "name": "ProductGlobalSearchDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Products/SubTypes/Simple": { "get": { "tags": [ "Global/Products" ], "summary": "Optional. Default: null. If true only alternative ProductSubType will be returned. If false only none alternative ProductSubType will be returned.", "operationId": "GlobalProductsSubTypes_GetSimpleAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "alternativeOnly", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Products/SymbolExists": { "get": { "tags": [ "Global/Products" ], "summary": "Gets whether a product with {symbol} as its ticker\r\nor download symbol exists.", "operationId": "GlobalProducts_GetSymbolExistsFromQueryStringAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "symbol", "in": "query", "description": "the symbol to check against product tickers and download symbols", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.GlobalProductSymbolExistsResult" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Products/SymbolExists/{symbol}": { "get": { "tags": [ "Global/Products" ], "summary": "Gets whether a product with {symbol} as its ticker\r\nor download symbol exists.\r\nSymbol does not support special characters, use the GET SymbolExists with symbol queryParam", "operationId": "GlobalProducts_GetSymbolExistsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "symbol", "in": "path", "description": "the symbol to check against product tickers and download symbols", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.GlobalProductSymbolExistsResult" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Products/Verbose": { "get": { "tags": [ "Global/Products" ], "operationId": "GlobalProducts_GetVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "DownloadSymbols", "FundFamilies", "GICS", "BondRates", "PreferredRates", "AlClients", "SubHoldings", "All" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "productType", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "filterType", "in": "query", "required": false, "type": "string", "enum": [ "BondWithoutBondRates", "BondWithBondRates" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.GlobalProductVerboseDto" }, "xml": { "name": "GlobalProductVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Global/Products" ], "operationId": "GlobalProducts_UpdateVerboseClientsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "updatedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.GlobalProductVerboseDto" }, "xml": { "name": "GlobalProductVerboseDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.GlobalProductVerboseDto" }, "xml": { "name": "GlobalProductVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Global/Products" ], "summary": "Create product", "operationId": "GlobalProducts_CreateVerboseClientAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "newDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.GlobalProductVerboseDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.GlobalProductVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Products/Verbose/{key}": { "get": { "tags": [ "Global/Products" ], "operationId": "GlobalProducts_GetVerboseByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "DownloadSymbols", "FundFamilies", "GICS", "BondRates", "PreferredRates", "AlClients", "SubHoldings", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.GlobalProductVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Global/Products" ], "operationId": "GlobalProducts_UpdateVerboseProductAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.GlobalProductVerboseDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.GlobalProductVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Products/Verbose/List": { "post": { "tags": [ "Global/Products" ], "operationId": "GlobalProducts_GetVerboseListById", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "DownloadSymbols", "FundFamilies", "GICS", "BondRates", "PreferredRates", "AlClients", "SubHoldings", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.GlobalProductVerboseDto" }, "xml": { "name": "GlobalProductVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Products/Verbose/List/Id": { "post": { "tags": [ "Global/Products" ], "operationId": "GlobalProducts_PostV1GlobalProductsVerboseListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "DownloadSymbols", "FundFamilies", "GICS", "BondRates", "PreferredRates", "AlClients", "SubHoldings", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.GlobalProductVerboseDto" }, "xml": { "name": "GlobalProductVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Products/Verbose/Many": { "post": { "tags": [ "Global/Products" ], "summary": "Creates one or more global products.\r\nCreates one or more local products if provided.", "operationId": "GlobalProducts_CreateGlobalProductsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "globalProductVerboseDtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.GlobalProductVerboseDto" }, "xml": { "name": "GlobalProductVerboseDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/Products/Verbose/New": { "get": { "tags": [ "Global/Products" ], "operationId": "GlobalProducts_GetNewVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "DownloadSymbols", "FundFamilies", "GICS", "BondRates", "PreferredRates", "AlClients", "SubHoldings", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.GlobalProductVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/ServiceTeamMembers": { "get": { "tags": [ "Global/ServiceTeamMembers" ], "summary": "Returns a list of ervice team members.", "operationId": "GlobalServiceTeamMembers_GetAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "userManagerId", "in": "query", "description": "Optional. Default: null. If provided returns service team members asigned the manager.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Authorization.ServiceTeamMemberDto" }, "xml": { "name": "ServiceTeamMemberDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Global/ServiceTeamMembers" ], "summary": "Create Service Team Member", "operationId": "GlobalServiceTeamMembers_CreateServiceTeamMemberAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Authorization.ServiceTeamMemberDto" } }, { "name": "ct", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Authorization.ServiceTeamMemberDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/ServiceTeamMembers/{key}": { "get": { "tags": [ "Global/ServiceTeamMembers" ], "summary": "Gets the Service Team Member that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "GlobalServiceTeamMembers_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Authorization.ServiceTeamMemberDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Global/ServiceTeamMembers" ], "summary": "Update the Service Team Member", "operationId": "GlobalServiceTeamMembers_UpdateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Authorization.ServiceTeamMemberDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Authorization.ServiceTeamMemberDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Global/ServiceTeamMembers" ], "summary": "Delete the Service Team Member", "operationId": "GlobalServiceTeamMembers_Delete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/ServiceTeamMembers/Action/Delete": { "put": { "tags": [ "Global/ServiceTeamMembers" ], "operationId": "GlobalServiceTeamMembers_ActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/ServiceTeamMembers/AllAnalystDatabaseAssignments": { "get": { "tags": [ "Global/ServiceTeamMembers" ], "summary": "Gets all of the Analyst Database Assignments", "description": "Sample Request\r\nGET /Global/ServiceTeamMembers/AllAnalystDatabaseAssignments", "operationId": "GlobalServiceTeamMembers_GetAllServiceTeamMemberAlClientsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "description": "Cancellation Token of the request", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Authorization.ServiceTeamMemberAlClientDto" }, "xml": { "name": "ServiceTeamMemberAlClientDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/ServiceTeamMembers/UserManagers": { "get": { "tags": [ "Global/ServiceTeamMembers" ], "summary": "Get User Managers for Service Team Member", "operationId": "GlobalServiceTeamMembers_GetUserManagers", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Authorization.SimpleServiceTeamMemberUserManagerDto" }, "xml": { "name": "SimpleServiceTeamMemberUserManagerDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/ServiceTeams": { "get": { "tags": [ "Global/ServiceTeams" ], "operationId": "GlobalServiceTeams_GetAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "teamType", "in": "query", "required": false, "type": "string", "enum": [ "ServiceTeam", "ReconTeam", "ApplicationTeam", "AlternateApplicationTeam", "RemovedServiceTeam" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Authorization.ServiceTeamDto" }, "xml": { "name": "ServiceTeamDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Global/ServiceTeams" ], "operationId": "GlobalServiceTeams_CreateServiceTeamAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Authorization.ServiceTeamDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/ServiceTeams/{key}": { "get": { "tags": [ "Global/ServiceTeams" ], "operationId": "GlobalServiceTeams_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Global/ServiceTeams" ], "operationId": "GlobalServiceTeams_UpdateServiceTeamAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Authorization.ServiceTeamDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Global/ServiceTeams" ], "operationId": "GlobalServiceTeams_DeleteServiceTeamAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/ServiceTeams/{teamId}/Members": { "get": { "tags": [ "Global/ServiceTeams" ], "operationId": "GlobalServiceTeams_GetTeamMembersAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "teamId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Global/ServiceTeams" ], "operationId": "GlobalServiceTeams_AddTeamMemberAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "teamId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Authorization.ServiceTeamMemberDto" }, "xml": { "name": "ServiceTeamMemberDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/ServiceTeams/{teamId}/Members/{memberId}": { "put": { "tags": [ "Global/ServiceTeams" ], "operationId": "GlobalServiceTeams_UpdateTeamMemberAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "teamId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "memberId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Authorization.ServiceTeamMemberDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Global/ServiceTeams" ], "operationId": "GlobalServiceTeams_RemoveTeamMemberAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "teamId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "memberId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/ServiceTeams/{teamId}/Members/{memberId}/DatabaseAssignments": { "get": { "tags": [ "Global/ServiceTeams" ], "operationId": "GlobalServiceTeams_GetMemberDatabaseAssignmentsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "teamId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "memberId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/ServiceTeams/{teamId}/Members/DatabaseAssignments/Available": { "get": { "tags": [ "Global/ServiceTeams" ], "operationId": "GlobalServiceTeams_GetMemberAvailableDatabaseAssignmentsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "teamId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true }, { "name": "memberId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/ServiceTeams/{teamId}/UserManagers": { "get": { "tags": [ "Global/ServiceTeams" ], "operationId": "GlobalServiceTeams_GetTeamUserManagersAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "teamId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/ServiceTeams/DatabaseAssignments": { "get": { "tags": [ "Global/ServiceTeams" ], "operationId": "GlobalServiceTeams_GetDatabaseAssignmentsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "serviceTeamId", "in": "query", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Global/ServiceTeams" ], "operationId": "GlobalServiceTeams_SyncDatabaseAssignmentsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Authorization.ServiceTeamDatabaseAssignRequestDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/ServiceTeams/DatabaseAssignments/Available": { "get": { "tags": [ "Global/ServiceTeams" ], "operationId": "GlobalServiceTeams_GetAvailableDatabaseAssignmentsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "serviceTeamId", "in": "query", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/ServiceTeams/Manager": { "get": { "tags": [ "Global/ServiceTeams" ], "operationId": "GlobalServiceTeams_GetManagerTeamsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "teamType", "in": "query", "required": false, "type": "string", "enum": [ "ServiceTeam", "ReconTeam", "ApplicationTeam", "AlternateApplicationTeam", "RemovedServiceTeam" ] }, { "name": "excludeTeamType", "in": "query", "required": false, "type": "string", "enum": [ "ServiceTeam", "ReconTeam", "ApplicationTeam", "AlternateApplicationTeam", "RemovedServiceTeam" ] } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/ServiceTeams/Manager/Export": { "get": { "tags": [ "Global/ServiceTeams" ], "operationId": "GlobalServiceTeams_GetManagerTeamsExportAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "teamType", "in": "query", "required": false, "type": "string", "enum": [ "ServiceTeam", "ReconTeam", "ApplicationTeam", "AlternateApplicationTeam", "RemovedServiceTeam" ] }, { "name": "excludeTeamType", "in": "query", "required": false, "type": "string", "enum": [ "ServiceTeam", "ReconTeam", "ApplicationTeam", "AlternateApplicationTeam", "RemovedServiceTeam" ] } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/ServiceTeams/Simple": { "get": { "tags": [ "Global/ServiceTeams" ], "operationId": "GlobalServiceTeams_GetSimpleAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "teamType", "in": "query", "required": false, "type": "string", "enum": [ "ServiceTeam", "ReconTeam", "ApplicationTeam", "AlternateApplicationTeam", "RemovedServiceTeam" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/StatesMunicipalBondTax": { "get": { "tags": [ "Global/StatesMunicipalBondTax" ], "summary": "Gets a list of StateMunicipalBondTax that the logged in user has access to.\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "GlobalStatesMunicipalBondTax_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "addressStateId", "in": "query", "description": "Optional. Default:Null. If provided then only objects with provided Address State Id will be returned.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.StateMunicipalBondTaxDto" }, "xml": { "name": "StateMunicipalBondTaxDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/StatesMunicipalBondTax/{addressStateId}/{issueStateId}": { "get": { "tags": [ "Global/StatesMunicipalBondTax" ], "summary": "Gets the StatesMunicipalBondTax that has the provided Address State Id and Issue State Id. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "GlobalStatesMunicipalBondTax_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "addressStateId", "in": "path", "description": "The addressee's State Id", "required": true, "type": "integer", "format": "int32" }, { "name": "issueStateId", "in": "path", "description": "State Id from which the bond was issued", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.StateMunicipalBondTaxDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Global/StatesMunicipalBondTax" ], "summary": "Used to update a Stat eMunicipal Bond Tax. Upon successful modification a 200 will be returned.", "operationId": "GlobalStatesMunicipalBondTax_Update", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "addressStateId", "in": "path", "description": "The addressee's State Id", "required": true, "type": "integer", "format": "int32" }, { "name": "issueStateId", "in": "path", "description": "State Id from which the bond was issued", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.StateMunicipalBondTaxDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.StateMunicipalBondTaxDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/StatesMunicipalBondTax/Action/MakeTaxable": { "put": { "tags": [ "Global/StatesMunicipalBondTax" ], "operationId": "GlobalStatesMunicipalBondTax_ActionMakeTaxable", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.StateMunicipalBondTaxKeyDto" }, "xml": { "name": "StateMunicipalBondTaxKeyDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.StateMunicipalBondTaxKeyDto" }, "xml": { "name": "StateMunicipalBondTaxKeyDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/StatesMunicipalBondTax/Action/MakeTaxExempt": { "put": { "tags": [ "Global/StatesMunicipalBondTax" ], "operationId": "GlobalStatesMunicipalBondTax_ActionMakeTaxExempt", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.StateMunicipalBondTaxKeyDto" }, "xml": { "name": "StateMunicipalBondTaxKeyDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.StateMunicipalBondTaxKeyDto" }, "xml": { "name": "StateMunicipalBondTaxKeyDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/StaticFiles": { "post": { "tags": [ "Global/StaticFiles" ], "operationId": "GlobalStaticFiles_PostV1GlobalStaticFiles", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "file", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.GlobalStaticFileDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/StaticFiles/{fileType}": { "get": { "tags": [ "Global/StaticFiles" ], "summary": "Gets a list of specific static documents.", "operationId": "GlobalStaticFiles_GetBlobs", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "fileType", "in": "path", "required": true, "type": "string", "enum": [ "CustodialCostBasisForm" ] }, { "name": "startDate", "in": "query", "description": "Optional. Default null. If provided only documents that come after the start date will be returned.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default null. If provided only documents that come before the end date will be returned.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" }, "xml": { "name": "BlobBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Global/StaticFiles" ], "summary": "Adds a new advisor file.", "operationId": "GlobalStaticFiles_CreateBlobAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "fileType", "in": "path", "description": "The type of file to add. Can be set to any of the following:\r\n ClientPortalStatic", "required": true, "type": "string", "enum": [ "CustodialCostBasisForm" ] } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/StaticFiles/{fileType}/{fileId}": { "get": { "tags": [ "Global/StaticFiles" ], "summary": "Gets the raw data of the specific file with the blobId provided which is an advisor file.", "operationId": "GlobalStaticFiles_GetBlob", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "fileType", "in": "path", "description": "The type of file to return. Can be set to any of the following:\r\n ClientPortalStatic", "required": true, "type": "string", "enum": [ "CustodialCostBasisForm" ] }, { "name": "fileId", "in": "path", "description": "Key of the file to be downloaded.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Global/StaticFiles" ], "summary": "Deletes the specific file with the blobId provided which is an advisor file.", "operationId": "GlobalStaticFiles_DeleteBlob", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "fileType", "in": "path", "description": "The type of file to delete. Can be set to any of the following:\r\n ClientPortalStatic", "required": true, "type": "string", "enum": [ "CustodialCostBasisForm" ] }, { "name": "fileId", "in": "path", "description": "Key of the file to be deleted.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/StaticFiles/{key}": { "get": { "tags": [ "Global/StaticFiles" ], "operationId": "GlobalStaticFiles_GetBlobDto", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/SubHoldings/Simple": { "get": { "tags": [ "Global/SubHoldings" ], "operationId": "GlobalSubHoldings_GetSimpleAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Global/UserFeedback/Response": { "post": { "tags": [ "Global/UserFeedback" ], "summary": "Saves a user feedback response.", "description": "Captures user feedback including rating values, codes, and notes.\r\nThe user and ALClient are automatically determined from the authenticated user's context.\r\n\r\nSample request:\r\n\r\n POST /v1/Global/UserFeedback/Response\r\n {\r\n \"code\": \"NPS\",\r\n \"ratingValue\": 9,\r\n \"note\": \"Great experience with the platform!\"\r\n }", "operationId": "UserFeedback_CreateResponseAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "The feedback response to save.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.UserFeedbackResponseDto" } }, { "name": "ct", "in": "header", "description": "Cancellation token.", "required": true } ], "responses": { "200": { "description": "Returns the newly created feedback response.", "schema": { "type": "object" } }, "400": { "description": "If the request is invalid." }, "401": { "description": "If the user is not authenticated." }, "500": { "description": "If an internal error occurs." } }, "security": [ { "Authorization": [] } ] } }, "/v1/Homepage/Action/DataSources/{dataSourceId}": { "post": { "tags": [ "Homepage/Action" ], "summary": "", "operationId": "Dashboard_GetDataForDataSourceAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dataSourceId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "source", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.DataSourceDataRequestDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Homepage/Beneficiaries": { "get": { "tags": [ "Homepage/Beneficiaries" ], "operationId": "Dashboard_GetBeneficiaries", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "query", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "query", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Homepage/Dashboards": { "get": { "tags": [ "Homepage/Dashboards" ], "operationId": "Dashboard_GetDashboardByNameAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dashboardName", "in": "query", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Homepage/Dashboards" ], "operationId": "Dashboard_CreateDashboardAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "userDashboard", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.UserHomepageDashboardWithRoleDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Homepage/Dashboards/{dashboardId}": { "put": { "tags": [ "Homepage/Dashboards" ], "summary": "", "operationId": "Dashboard_UpdateDashboardAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dashboardId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.HomepageDashboardDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Homepage/Dashboards/{dashboardId}/Cards/{cardId}": { "post": { "tags": [ "Homepage/Dashboards" ], "operationId": "Dashboard_AddCardToDashboardAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dashboardId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cardId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "addCardDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.AddCardDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Homepage/Dashboards/{dashboardId}/DashboardCards/{dashboardCardId}": { "delete": { "tags": [ "Homepage/Dashboards" ], "summary": "Remove card from dashboard.", "operationId": "Dashboard_RemoveCardFromDashboardAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dashboardId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dashboardCardId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Homepage/Dashboards/{dashboardId}/DashboardCards/{dashboardCardId}/Clone": { "post": { "tags": [ "Homepage/Dashboards" ], "summary": "Clone existing card within the dashboard.", "operationId": "Dashboard_CloneAndAddCardToDashboardAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dashboardId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dashboardCardId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Homepage/Dashboards/{id}": { "get": { "tags": [ "Homepage/Dashboards" ], "summary": "", "operationId": "Dashboard_GetDashboardForLoginAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Homepage/Dashboards" ], "operationId": "Dashboard_DeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Homepage/Dashboards/{id}/ForDeletion": { "get": { "tags": [ "Homepage/Dashboards" ], "operationId": "Dashboard_GetSharedDefaultForDeletionAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Homepage/Dashboards/Cards/{id}": { "get": { "tags": [ "Homepage/Dashboards" ], "summary": "", "operationId": "Dashboard_GetCardAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Homepage/Dashboards" ], "summary": "", "operationId": "Dashboard_UpdateCardAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cardDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.CardDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Homepage/Dashboards/DataSources": { "post": { "tags": [ "Homepage/Dashboards" ], "summary": "", "operationId": "Dashboard_CreateDataSource", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.DataSourceDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Homepage/Dashboards/DataSources/{key}": { "get": { "tags": [ "Homepage/Dashboards" ], "summary": "", "operationId": "Dashboard_GetDataSource", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Homepage/Dashboards" ], "summary": "", "operationId": "Dashboard_UpdateDataSource", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.DataSourceDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Homepage/Dashboards" ], "summary": "", "operationId": "Dashboard_DeleteDataSource", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Homepage/Dashboards/PortfolioView/SearchHistories": { "get": { "tags": [ "Homepage/Dashboards" ], "operationId": "Dashboard_GetPortfolioViewSearchHistoriesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Homepage.PortfolioViewSearchHistoryResult" }, "xml": { "name": "PortfolioViewSearchHistoryResult", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Homepage/Dashboards" ], "operationId": "Dashboard_UpdatePortfolioViewSearchHistoriesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "searchHistoryItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Homepage.PortfolioViewSearchHistoryResult" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Homepage/ODataQueries/Counts": { "post": { "tags": [ "Homepage/ODataQueries" ], "summary": "Returns result counts and Portfolio Audit links for 1–10 OData query slots.", "operationId": "ODataQueries_GetCountsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.ODataQueryCountsRequestDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Homepage/ODataQueries/DashboardCards/{dashboardCardId}/Slots": { "get": { "tags": [ "Homepage/ODataQueries" ], "summary": "Returns ODATA_QUERY_SLOTS stored on an assigned dashboard card.", "operationId": "ODataQueries_GetSlotsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dashboardCardId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Homepage/ODataQueries" ], "summary": "Replaces ODATA_QUERY_SLOTS on an assigned dashboard card (Workflow Assistant / MCP only).", "operationId": "ODataQueries_UpdateSlotsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dashboardCardId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "update", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.ODataQuerySlotsUpdateDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Homepage/ODataQueries/EntityRoutes": { "get": { "tags": [ "Homepage/ODataQueries" ], "summary": "Returns supported OData entity routes for Workflow Assistant saved-query tiles.", "operationId": "ODataQueries_GetEntityRoutes", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Homepage/Performance": { "post": { "tags": [ "Homepage/Performance" ], "summary": "Gets combined database performance (from cache) and benchmark performance using representative IDs and benchmark info", "operationId": "Dashboard_GetPerformanceAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "homepagePerformanceRequestDto", "in": "body", "description": "DTO containing representative IDs and benchmark information", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.HomepagePerformanceRequestDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Homepage/PortfolioTree": { "get": { "tags": [ "Homepage/PortfolioTree" ], "summary": "Get a List of Assets with properties that can be used to show allocation by groupings.", "operationId": "Dashboard_GetPortfolioTreeAllocationAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "clientId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "displayName", "in": "query", "required": false, "type": "string" }, { "name": "showAccountNumberCharacters", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Homepage/PortfolioTree/PortfolioGroup": { "get": { "tags": [ "Homepage/PortfolioTree" ], "summary": "Get a List of Assets with properties that can be used to show allocation by groupings.", "operationId": "Dashboard_GetPortfolioTreePortfolioGroups", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "clientId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Homepage/PortfolioView/{dashboardId}": { "put": { "tags": [ "Homepage/PortfolioView" ], "summary": "", "operationId": "Dashboard_UpdatePortfolioViewDashboardAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dashboardId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.HomepageDashboardDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Homepage/PortfolioView/{id}": { "delete": { "tags": [ "Homepage/PortfolioView" ], "operationId": "Dashboard_DeletePortfolioViewAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Homepage/PortfolioView/CacheDataSource": { "post": { "tags": [ "Homepage/PortfolioView" ], "operationId": "Dashboard_PostV1HomepagePortfolioViewCacheDataSource", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "items", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.Domains.Homepage.CachedData" }, "xml": { "name": "CachedData", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Homepage/PortfolioView/CachedData/{keyString}": { "get": { "tags": [ "Homepage/PortfolioView" ], "operationId": "Dashboard_GetCachedDataSource", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "keyString", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Homepage/PortfolioView/MeetingAgenda/{keyString}": { "get": { "tags": [ "Homepage/PortfolioView" ], "operationId": "Dashboard_GetV1HomepagePortfolioViewMeetingAgendaByKeyString", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "keyString", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Homepage/PortfolioView/MeetingAgenda/Cache": { "post": { "tags": [ "Homepage/PortfolioView" ], "operationId": "Dashboard_GenerateCacheKey", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "meetingAgenda", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Integrations.OpenAI.MeetingAgenda" } }, { "name": "clientId", "in": "query", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Homepage/PortfolioViews": { "post": { "tags": [ "Homepage/PortfolioViews" ], "operationId": "Dashboard_CreatePortfolioViewAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "userDashboard", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.UserHomepageDashboardWithRoleDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Homepage/Roles/Dashboards/Simple": { "get": { "tags": [ "Homepage/Roles" ], "operationId": "Dashboard_GetRoleDashboardsSimpleAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Homepage/Roles/PortfolioView/Simple": { "get": { "tags": [ "Homepage/Roles" ], "operationId": "Dashboard_GetRolePortfolioViewsSimpleAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Homepage/Setting": { "get": { "tags": [ "Homepage/Setting" ], "summary": "Returns Portfolio View Firm Settings", "operationId": "PortfolioViewSetting_GetSettingsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Homepage/UserDashboard/{dashboardId}": { "put": { "tags": [ "Homepage/UserDashboard" ], "operationId": "Dashboard_PutV1HomepageUserDashboardByDashboardId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dashboardId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dashboardDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.HomepageDashboardForUpdateDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Homepage/Users/Dashboards/DefaultDashboard": { "post": { "tags": [ "Homepage/Users" ], "operationId": "Dashboard_CreateDefaultDashboardAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dashboardName", "in": "query", "required": true, "type": "string" }, { "name": "isPortfolioView", "in": "query", "required": true, "type": "boolean" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Homepage/Users/Dashboards/GetGlobalDashboardsAsync": { "get": { "tags": [ "Homepage/Users" ], "summary": "", "operationId": "Dashboard_GetGlobalDashboardsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "isPortfolioView", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Homepage/Users/Dashboards/Simple": { "get": { "tags": [ "Homepage/Users" ], "summary": "", "operationId": "Dashboard_GetDashboardForUserAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "isPortfolioView", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integration/Certs": { "get": { "tags": [ "Integration/Certs" ], "operationId": "Integration_TestCertsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integration/RolesForCode/{code}": { "get": { "tags": [ "Integration/RolesForCode" ], "summary": "Gets details about the privilege specified by the {code}, along with the Roles used by the firm.", "operationId": "Integration_GetRolesForPrivilegeCodeAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "code", "in": "path", "description": "The code uniquely identifying the privilege.", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integration.IntegrationPrivilegeRolesDto" } }, "404": { "description": "No items found." }, "500": { "description": "Internal Server Error" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integration/RolesForKey/{key}": { "get": { "tags": [ "Integration/RolesForKey" ], "summary": "Gets details about the privilege specified by the {key}, along with the Roles used by the firm.", "operationId": "Integration_GetRolesForPrivilegeKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The ID of the privilege.", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integration.IntegrationPrivilegeRolesDto" } }, "404": { "description": "No items found." }, "500": { "description": "Internal Server Error" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integration/UpdateRoles": { "post": { "tags": [ "Integration/UpdateRoles" ], "summary": "Updates the roles for a specified integration privilege.", "operationId": "Integration_UpdateRolesForPrivilegeAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "privilegeAndRoles", "in": "body", "description": "A DTO containing the integration privilege and available/assigned roles.", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integration.IntegrationPrivilegeRolesDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integration.IntegrationPrivilegeRolesDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdviceWorks/AdvisorId/{orionRepId}": { "get": { "tags": [ "Integrations/AdviceWorks" ], "operationId": "Cetera_CeteraAdvisorIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "orionRepId", "in": "path", "required": true, "type": "integer", "format": "int32", "default": 0 }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Integrations.CeteraController.RepCustomData" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdviceWorks/GetClientDetail/{clientId}": { "get": { "tags": [ "Integrations/AdviceWorks" ], "operationId": "Cetera_GetV1IntegrationsAdviceWorksGetClientDetailByClientId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.Cetera.DTOs.ClientDetailsResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdviceWorks/GetClientDetailRaw/{clientId}": { "get": { "tags": [ "Integrations/AdviceWorks" ], "operationId": "Cetera_GetClientDetailRawAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdviceWorks/GetToken": { "get": { "tags": [ "Integrations/AdviceWorks" ], "operationId": "Cetera_GetTokenAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Integration.Cetera.Token" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdviceWorks/ReserveAccount": { "post": { "tags": [ "Integrations/AdviceWorks" ], "operationId": "Cetera_ReserveAccountAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "reserveAccount", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.Cetera.DTOs.ReserveAccountRequest" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.Cetera.DTOs.ReserveAccountResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdviceWorks/ReserveAccountRaw": { "post": { "tags": [ "Integrations/AdviceWorks" ], "operationId": "Cetera_ReserveAccountRawAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "reserveAccount", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.Cetera.DTOs.ReserveAccountRequest" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdviceWorks/Search": { "post": { "tags": [ "Integrations/AdviceWorks" ], "operationId": "Cetera_GetClientSearchAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientSearch", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Integration.Cetera.ClientSearch" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.Cetera.DTOs.ClientSearchResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdviceWorks/SearchRaw": { "post": { "tags": [ "Integrations/AdviceWorks" ], "operationId": "Cetera_GetClientSearchRawAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientSearch", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Integration.Cetera.ClientSearch" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisorCloudStorage/{provider}/Credentials": { "put": { "tags": [ "Integrations/AdvisorCloudStorage" ], "summary": "Used to save cloud storage credentials. Each provider has a different representation of credentials that must be posted as json in the message body.", "operationId": "IntegrationsAdvisorCloudStorage_PutV1IntegrationsAdvisorCloudStorageByProviderCredentials", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "provider", "in": "path", "required": true, "type": "string", "enum": [ "AdvisorShared", "Box", "Dropbox", "Egnyte", "ShareFile", "Netdocuments", "Salesforce" ] }, { "name": "orionFolderLocation", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/AdvisorCloudStorage" ], "summary": "Used to save cloud storage credentials. Each provider has a different representation of credentials that must be posted as json in the message body.", "operationId": "IntegrationsAdvisorCloudStorage_SaveCredentialsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "provider", "in": "path", "required": true, "type": "string", "enum": [ "AdvisorShared", "Box", "Dropbox", "Egnyte", "ShareFile", "Netdocuments", "Salesforce" ] }, { "name": "orionFolderLocation", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisorCloudStorage/{provider}/Redirect": { "get": { "tags": [ "Integrations/AdvisorCloudStorage" ], "summary": "Used to automatically redirect the user's browser to the appropriate cloud storage provider's oauth page.", "operationId": "IntegrationsAdvisorCloudStorage_GetRedirectUrlAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "provider", "in": "path", "required": true, "type": "string", "enum": [ "AdvisorShared", "Box", "Dropbox", "Egnyte", "ShareFile", "Netdocuments", "Salesforce" ] }, { "name": "url", "in": "query", "required": true, "type": "string" }, { "name": "domain", "in": "query", "required": false, "type": "string" }, { "name": "token", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisorCloudStorage/Action/Share/{filepath}": { "post": { "tags": [ "Integrations/AdvisorCloudStorage" ], "summary": "Used to generate a share link to a file in cloud storage.", "operationId": "IntegrationsAdvisorCloudStorage_ShareCloudStorageAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "filepath", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisorCloudStorage/Browse/{filepath}": { "get": { "tags": [ "Integrations/AdvisorCloudStorage" ], "summary": "Used to browse folders and view file meta data from cloud storage.", "operationId": "IntegrationsAdvisorCloudStorage_BrowseCloudStorageAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "filepath", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisorCloudStorage/Credentials": { "delete": { "tags": [ "Integrations/AdvisorCloudStorage" ], "summary": "Used to remove previously saved cloud storage credentials.", "operationId": "IntegrationsAdvisorCloudStorage_DeleteCredentials", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisorCloudStorage/Data/{filepath}": { "get": { "tags": [ "Integrations/AdvisorCloudStorage" ], "summary": "Used to download a file from cloud storage.", "operationId": "IntegrationsAdvisorCloudStorage_DownloadCloudStorageAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "filepath", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/AdvisorCloudStorage" ], "summary": "Used to upload a file to cloud storage.", "operationId": "IntegrationsAdvisorCloudStorage_UploadCloudStorageAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "filepath", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Integrations/AdvisorCloudStorage" ], "summary": "Used to delete a file from cloud storage.", "operationId": "IntegrationsAdvisorCloudStorage_DeleteCloudStorageAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "filepath", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisorCloudStorage/List": { "get": { "tags": [ "Integrations/AdvisorCloudStorage" ], "summary": "Used to get list of configured cloud storage providers.", "operationId": "IntegrationsAdvisorCloudStorage_ListCloudStorageProvidersAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "checkCredentialsValid", "in": "query", "description": "Optional. Default: True. Will validate that the provider is valid before returning it. If false, any provider with credentials saved will be returned.", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "object" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisoryWorld/AssetFactSheet/{modelAggId}": { "get": { "tags": [ "Integrations/AdvisoryWorld" ], "summary": "Get asset fact sheet for a ModelAgg.", "operationId": "AdvisoryWorld_GetAssetFactSheetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "modelAggId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisoryWorld/Configuration": { "get": { "tags": [ "Integrations/AdvisoryWorld" ], "summary": "Retrieves AdvisoryWorld Integration details.", "operationId": "AdvisoryWorld_GetConfiguration", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Integration.AdvisoryWorld.IntegrationConfig" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/AdvisoryWorld" ], "summary": "Saves AdvisoryWorld integration settings.", "operationId": "AdvisoryWorld_UpdateConfiguration", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "integrationConfig", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Integration.AdvisoryWorld.IntegrationConfig" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Integration.AdvisoryWorld.IntegrationConfig" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisoryWorld/IPSBuilderSection/Model": { "get": { "tags": [ "Integrations/AdvisoryWorld" ], "summary": "Get Ips Builder section by Model", "operationId": "AdvisoryWorld_GetIPSBuilderSectionModelAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "category", "in": "query", "required": true, "type": "string" }, { "name": "modelId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "modelId2", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "modelPercent", "in": "query", "required": false, "type": "number", "format": "double", "default": 1.0 }, { "name": "modelPercent2", "in": "query", "required": false, "type": "number", "format": "double", "default": 1.0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.IpsBuilderSection" }, "xml": { "name": "IpsBuilderSection", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisoryWorld/IPSBuilderSection/ModelAgg": { "get": { "tags": [ "Integrations/AdvisoryWorld" ], "summary": "Get ips builder section info by Model Agg", "operationId": "AdvisoryWorld_GetIPSBuilderSectionModegAggAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "category", "in": "query", "required": true, "type": "string" }, { "name": "modelAggId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "modelPercent", "in": "query", "required": false, "type": "number", "format": "double", "default": 1.0 }, { "name": "modelAggId2", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "modelAggPercent2", "in": "query", "required": false, "type": "number", "format": "double", "default": 1.0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.IpsBuilderSection" }, "xml": { "name": "IpsBuilderSection", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisoryWorld/ManagerFactSheet/{modelAggId}": { "get": { "tags": [ "Integrations/AdvisoryWorld" ], "summary": "Get asset fact sheet for a ModelAgg.", "operationId": "AdvisoryWorld_GetManagerFactSheetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "modelAggId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisoryWorld/ModelFactSheet/{key}": { "get": { "tags": [ "Integrations/AdvisoryWorld" ], "summary": "Get asset fact sheet for a Strategy.", "operationId": "AdvisoryWorld_GetModelFactSheetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisoryWorld/Proposal/Activate": { "post": { "tags": [ "Integrations/AdvisoryWorld" ], "summary": "Accept proposal to apply changes through sleeving, Connect, or Eclipse\r\nProposal objectCancellationToken", "operationId": "AdvisoryWorld_AcceptProposalAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "proposal", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Integration.AdvisoryWorld.Proposal" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisoryWorld/Proposal/CompatableModelAttributes/List": { "post": { "tags": [ "Integrations/AdvisoryWorld" ], "summary": "Accept a list of modelagg ids to return the proposal compatibility for each model\r\nList of model agg ids", "operationId": "AdvisoryWorld_ModelAttributesByListAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "modelaggs", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.AdvisoryWorld.CompatibleModelAttributesDto" }, "xml": { "name": "CompatibleModelAttributesDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisoryWorld/Proposal/Portfolio": { "get": { "tags": [ "Integrations/AdvisoryWorld" ], "summary": "Accept parameters to return an aggregated list of accounts for accepting proposal\r\nCancellationTokenregistrationId intaccountId intportfolioId int?", "operationId": "AdvisoryWorld_ProposalGetPortfolio", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "registrationId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "portfolioId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.AdvisoryWorld.AggAccountDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisoryWorld/Redirect": { "get": { "tags": [ "Integrations/AdvisoryWorld" ], "summary": "Method to redirect to AdvisoryWorld SSO QuickStart", "operationId": "AdvisoryWorld_GetAdvisoryWorldRedirectUrl", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisoryWorld/Remove": { "post": { "tags": [ "Integrations/AdvisoryWorld" ], "summary": "Sets up Blaze integration for the current user.", "description": "The user must have the necessary privileges to setup the integration.", "operationId": "AdvisoryWorld_RemoveServiceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisoryWorld/Reports/CompariScan/{reportName}": { "post": { "tags": [ "Integrations/AdvisoryWorld" ], "summary": "Gets a compari scan report from Advisory World for the allocations provided. If the response is 500 an error occured \r\nand details of the error should be returned. If the response is 200 the location header is where the generated report can be retrieved.", "operationId": "AdvisoryWorld_GetCompariScanReportForCustomAllocationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reportName", "in": "path", "description": "What to name the report.", "required": true, "type": "string" }, { "name": "dto", "in": "body", "description": "The list of allocations and cashflows to report on. Consists of Ticker-Percentage pairs.", "required": true, "schema": { "$ref": "#/definitions/OAS.Integrations.AdvisoryWorld.Dto.AdvisoryWorldCompariScanDto" } }, { "name": "reportType", "in": "query", "description": "Optional. Default: Pdf. Determines how the report is returned. Options are Pdf and Xml.", "required": false, "type": "string", "default": 1, "enum": [ "Xml", "Pdf" ] }, { "name": "portfolioValue", "in": "query", "description": "Optional. Default: 10000. The value to use for the portfolio.", "required": false, "type": "number", "format": "double", "default": 10000.0 }, { "name": "asOfDate", "in": "query", "description": "Optional. Default: Today. Determines the date the report should reflect.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisoryWorld/Reports/CompariScan/Account/{accountId}/Model/{modelId}": { "get": { "tags": [ "Integrations/AdvisoryWorld" ], "summary": "Gets a compari scan report from Advisory World for the specific account provided. If the response is 500 an error occured \r\nand details of the error should be returned. If the response is 200 the location header is where the generated report can be retrieved.", "operationId": "AdvisoryWorld_GetCompariScanReportForAccountAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "description": "The account to show the compari scan report for.", "required": true, "type": "integer", "format": "int32" }, { "name": "modelId", "in": "path", "description": "The model to compare to.", "required": true, "type": "integer", "format": "int32" }, { "name": "reportType", "in": "query", "description": "Optional. Default: Pdf. Determines how the report is returned. Options are Pdf and Xml.", "required": false, "type": "string", "default": 1, "enum": [ "Xml", "Pdf" ] }, { "name": "asOfDate", "in": "query", "description": "Optional. Default: Today. Determines the date the report should reflect.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisoryWorld/Reports/CompariScan/Client/{clientId}/Model/{modelId}": { "get": { "tags": [ "Integrations/AdvisoryWorld" ], "summary": "Gets a compari scan report from Advisory World for the specific client provided. If the response is 500 an error occured \r\nand details of the error should be returned. If the response is 200 the location header is where the generated report can be retrieved.", "operationId": "AdvisoryWorld_GetCompariScanReportForClientAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "description": "The client to show the compari scan report for.", "required": true, "type": "integer", "format": "int32" }, { "name": "modelId", "in": "path", "description": "The model to compare to.", "required": true, "type": "integer", "format": "int32" }, { "name": "reportType", "in": "query", "description": "Optional. Default: Pdf. Determines how the report is returned. Options are Pdf and Xml.", "required": false, "type": "string", "default": 1, "enum": [ "Xml", "Pdf" ] }, { "name": "asOfDate", "in": "query", "description": "Optional. Default: Today. Determines the date the report should reflect.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisoryWorld/Reports/CompariScan/Registration/{registrationId}/Model/{modelId}": { "get": { "tags": [ "Integrations/AdvisoryWorld" ], "summary": "Gets a compari scan report from Advisory World for the specific registration provided. If the response is 500 an error occured \r\nand details of the error should be returned. If the response is 200 the location header is where the generated report can be retrieved.", "operationId": "AdvisoryWorld_GetCompariScanReportForRegistrationAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "registrationId", "in": "path", "description": "The registration to show the compari scan report for.", "required": true, "type": "integer", "format": "int32" }, { "name": "modelId", "in": "path", "description": "The model to compare to.", "required": true, "type": "integer", "format": "int32" }, { "name": "reportType", "in": "query", "description": "Optional. Default: Pdf. Determines how the report is returned. Options are Pdf and Xml.", "required": false, "type": "string", "default": 1, "enum": [ "Xml", "Pdf" ] }, { "name": "asOfDate", "in": "query", "description": "Optional. Default: Today. Determines the date the report should reflect.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisoryWorld/Reports/DetailedAnalytics/{reportName}": { "post": { "tags": [ "Integrations/AdvisoryWorld" ], "summary": "Gets a detailed analytics report from Advisory World for the allocations provided. If the response is 500 an error occured \r\nand details of the error should be returned. If the response is 200 the location header is where the generated report can be retrieved.", "operationId": "AdvisoryWorld_GetDetailedAnalyticsReportForCustomAllocationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reportName", "in": "path", "description": "What to name the report.", "required": true, "type": "string" }, { "name": "dto", "in": "body", "description": "The list of allocations and cashflows to report on. Consists of Ticker-Percentage pairs.", "required": true, "schema": { "$ref": "#/definitions/OAS.Integrations.AdvisoryWorld.Dto.AdvisoryWorldDetailedAnalyticsDto" } }, { "name": "reportType", "in": "query", "description": "Optional. Default: Pdf. Determines how the report is returned. Options are Pdf and Xml.", "required": false, "type": "string", "default": 1, "enum": [ "Xml", "Pdf" ] }, { "name": "includeInvestmentFactsheets", "in": "query", "description": "Optional. Default: true. Determines whether or not the investment factsheets should be included.", "required": false, "type": "boolean", "default": true }, { "name": "portfolioValue", "in": "query", "description": "Optional. Default: 10000. The value to use for the portfolio.", "required": false, "type": "number", "format": "double", "default": 10000.0 }, { "name": "asOfDate", "in": "query", "description": "Optional. Default: Today. Determines the date the report should reflect.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisoryWorld/Reports/DetailedAnalytics/Account/{accountId}": { "get": { "tags": [ "Integrations/AdvisoryWorld" ], "summary": "Gets a detailed analytics report from Advisory World for the specific account provided. If the response is 500 an error occured \r\nand details of the error should be returned. If the response is 200 the location header is where the generated report can be retrieved.", "operationId": "AdvisoryWorld_GetDetailedAnalyticsReportForAccountAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "description": "The account to show the detailed analytics report for.", "required": true, "type": "integer", "format": "int32" }, { "name": "reportType", "in": "query", "description": "Optional. Default: Pdf. Determines how the report is returned. Options are Pdf and Xml.", "required": false, "type": "string", "default": 1, "enum": [ "Xml", "Pdf" ] }, { "name": "includeInvestmentFactsheets", "in": "query", "description": "Optional. Default: true. Determines whether or not the investment factsheets should be included.", "required": false, "type": "boolean", "default": true }, { "name": "assumedReturn", "in": "query", "description": "Optional. Default: null. If provided it will be used instead of the estimated performance.", "required": false, "type": "number", "format": "double" }, { "name": "cashFlowAmount", "in": "query", "description": "Optional. Default: null. If provided it will be used instead of the actual cashflow value for the portfolio over the month prior to the date provided.", "required": false, "type": "number", "format": "double" }, { "name": "asOfDate", "in": "query", "description": "Optional. Default: Today. Determines the date the report should reflect.", "required": false, "type": "string", "format": "date-time" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisoryWorld/Reports/DetailedAnalytics/Client/{clientId}": { "get": { "tags": [ "Integrations/AdvisoryWorld" ], "summary": "Gets a detailed analytics report from Advisory World for the specific client provided. If the response is 500 an error occured \r\nand details of the error should be returned. If the response is 200 the location header is where the generated report can be retrieved.", "operationId": "AdvisoryWorld_GetDetailedAnalyticsReportForClientAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "description": "The client to show the detailed analytics report for.", "required": true, "type": "integer", "format": "int32" }, { "name": "reportType", "in": "query", "description": "Optional. Default: Pdf. Determines how the report is returned. Options are Pdf and Xml.", "required": false, "type": "string", "default": 1, "enum": [ "Xml", "Pdf" ] }, { "name": "includeInvestmentFactsheets", "in": "query", "description": "Optional. Default: true. Determines whether or not the investment factsheets should be included.", "required": false, "type": "boolean", "default": true }, { "name": "assumedReturn", "in": "query", "description": "Optional. Default: null. If provided it will be used instead of the estimated performance.", "required": false, "type": "number", "format": "double" }, { "name": "cashFlowAmount", "in": "query", "description": "Optional. Default: null. If provided it will be used instead of the actual cashflow value for the portfolio over the month prior to the date provided.", "required": false, "type": "number", "format": "double" }, { "name": "asOfDate", "in": "query", "description": "Optional. Default: Today. Determines the date the report should reflect.", "required": false, "type": "string", "format": "date-time" }, { "name": "excludedAccount", "in": "query", "description": "Optional. List of accounts to be excluded.", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "autoRedirect", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisoryWorld/Reports/DetailedAnalytics/Model/{modelId}": { "get": { "tags": [ "Integrations/AdvisoryWorld" ], "summary": "Gets a detailed analytics report from Advisory World for the specific model provided. If the response is 500 an error occured \r\nand details of the error should be returned. If the response is 200 the location header is where the generated report can be retrieved.", "operationId": "AdvisoryWorld_GetDetailedAnalyticsReportForModelAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "modelId", "in": "path", "description": "The model to show the detailed analytics report for.", "required": true, "type": "integer", "format": "int32" }, { "name": "reportType", "in": "query", "description": "Optional. Default: Pdf. Determines how the report is returned. Options are Pdf and Xml.", "required": false, "type": "string", "default": 1, "enum": [ "Xml", "Pdf" ] }, { "name": "includeInvestmentFactsheets", "in": "query", "description": "Optional. Default: true. Determines whether or not the investment factsheets should be included.", "required": false, "type": "boolean", "default": true }, { "name": "modelValue", "in": "query", "description": "Optional. Default: 10000. The value to use for the model.", "required": false, "type": "number", "format": "double", "default": 10000.0 }, { "name": "assumedReturn", "in": "query", "description": "Optional. Default: null. If provided it will be used instead of the estimated performance.", "required": false, "type": "number", "format": "double" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisoryWorld/Reports/DetailedAnalytics/Registration/{registrationId}": { "get": { "tags": [ "Integrations/AdvisoryWorld" ], "summary": "Gets a detailed analytics report from Advisory World for the specific registration provided. If the response is 500 an error occured \r\nand details of the error should be returned. If the response is 200 the location header is where the generated report can be retrieved.", "operationId": "AdvisoryWorld_GetDetailedAnalyticsReportForRegistrationAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "registrationId", "in": "path", "description": "The registration to show the detailed analytics report for.", "required": true, "type": "integer", "format": "int32" }, { "name": "reportType", "in": "query", "description": "Optional. Default: Pdf. Determines how the report is returned. Options are Pdf and Xml.", "required": false, "type": "string", "default": 1, "enum": [ "Xml", "Pdf" ] }, { "name": "includeInvestmentFactsheets", "in": "query", "description": "Optional. Default: true. Determines whether or not the investment factsheets should be included.", "required": false, "type": "boolean", "default": true }, { "name": "assumedReturn", "in": "query", "description": "Optional. Default: null. If provided it will be used instead of the estimated performance.", "required": false, "type": "number", "format": "double" }, { "name": "cashFlowAmount", "in": "query", "description": "Optional. Default: null. If provided it will be used instead of the actual cashflow value for the portfolio over the month prior to the date provided.", "required": false, "type": "number", "format": "double" }, { "name": "asOfDate", "in": "query", "description": "Optional. Default: Today. Determines the date the report should reflect.", "required": false, "type": "string", "format": "date-time" }, { "name": "excludedAccount", "in": "query", "description": "Optional. List of accounts to be excluded.", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisoryWorld/Reports/HoldingScan/{reportName}": { "post": { "tags": [ "Integrations/AdvisoryWorld" ], "summary": "Gets a holding scan report from Advisory World for the allocations provided. If the response is 500 an error occured \r\nand details of the error should be returned. If the response is 200 the location header is where the generated report can be retrieved.", "operationId": "AdvisoryWorld_GetHoldingScanReportForCustomAllocationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reportName", "in": "path", "description": "What to name the report.", "required": true, "type": "string" }, { "name": "dto", "in": "body", "description": "The list of allocations and cashflows to report on. Consists of Ticker-Percentage pairs.", "required": true, "schema": { "$ref": "#/definitions/OAS.Integrations.AdvisoryWorld.Dto.AdvisoryWorldCustomAllocationDto" } }, { "name": "reportType", "in": "query", "description": "Optional. Default: Pdf. Determines how the report is returned. Options are Pdf and Xml.", "required": false, "type": "string", "default": 1, "enum": [ "Xml", "Pdf" ] }, { "name": "includeInvestmentFactsheets", "in": "query", "description": "Optional. Default: true. Determines whether or not the investment factsheets should be included.", "required": false, "type": "boolean", "default": true }, { "name": "portfolioValue", "in": "query", "description": "Optional. Default: 10000. The value to use for the portfolio.", "required": false, "type": "number", "format": "double", "default": 10000.0 }, { "name": "asOfDate", "in": "query", "description": "Optional. Default: Today. Determines the date the report should reflect.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisoryWorld/Reports/HoldingScan/Account/{accountId}": { "get": { "tags": [ "Integrations/AdvisoryWorld" ], "summary": "Gets a holding scan report from Advisory World for the specific account provided. If the response is 500 an error occured \r\nand details of the error should be returned. If the response is 200 the location header is where the generated report can be retrieved.", "operationId": "AdvisoryWorld_GetHoldingScanReportForAccountAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "description": "The account to show the holding scan report for.", "required": true, "type": "integer", "format": "int32" }, { "name": "reportType", "in": "query", "description": "Optional. Default: Pdf. Determines how the report is returned. Options are Pdf and Xml.", "required": false, "type": "string", "default": 1, "enum": [ "Xml", "Pdf" ] }, { "name": "includeInvestmentFactsheets", "in": "query", "description": "Optional. Default: true. Determines whether or not the investment factsheets should be included.", "required": false, "type": "boolean", "default": true }, { "name": "asOfDate", "in": "query", "description": "Optional. Default: Today. Determines the date the report should reflect.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisoryWorld/Reports/HoldingScan/Asset/{assetId}": { "get": { "tags": [ "Integrations/AdvisoryWorld" ], "summary": "Gets a holding scan report from Advisory World for the specific asset provided. If the response is 500 an error occured \r\nand details of the error should be returned. If the response is 200 the location header is where the generated report can be retrieved.", "operationId": "AdvisoryWorld_GetHoldingScanReportForAssetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "assetId", "in": "path", "description": "The asset to show the holding scan report for.", "required": true, "type": "integer", "format": "int32" }, { "name": "reportType", "in": "query", "description": "Optional. Default: Pdf. Determines how the report is returned. Options are Pdf and Xml.", "required": false, "type": "string", "default": 1, "enum": [ "Xml", "Pdf" ] }, { "name": "includeInvestmentFactsheets", "in": "query", "description": "Optional. Default: true. Determines whether or not the investment factsheets should be included.", "required": false, "type": "boolean", "default": true }, { "name": "asOfDate", "in": "query", "description": "Optional. Default: Today. Determines the date the report should reflect.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisoryWorld/Reports/HoldingScan/Client/{clientId}": { "get": { "tags": [ "Integrations/AdvisoryWorld" ], "summary": "Gets a holding scan report from Advisory World for the specific client provided. If the response is 500 an error occured \r\nand details of the error should be returned. If the response is 200 the location header is where the generated report can be retrieved.", "operationId": "AdvisoryWorld_GetHoldingScanReportForClientAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "description": "The client to show the holding scan report for.", "required": true, "type": "integer", "format": "int32" }, { "name": "reportType", "in": "query", "description": "Optional. Default: Pdf. Determines how the report is returned. Options are Pdf and Xml.", "required": false, "type": "string", "default": 1, "enum": [ "Xml", "Pdf" ] }, { "name": "includeInvestmentFactsheets", "in": "query", "description": "Optional. Default: true. Determines whether or not the investment factsheets should be included.", "required": false, "type": "boolean", "default": true }, { "name": "asOfDate", "in": "query", "description": "Optional. Default: Today. Determines the date the report should reflect.", "required": false, "type": "string", "format": "date-time" }, { "name": "excludedAccount", "in": "query", "description": "Optional. List of account to be excluded.", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisoryWorld/Reports/HoldingScan/Model/{modelId}": { "get": { "tags": [ "Integrations/AdvisoryWorld" ], "summary": "Gets a holding scan report from Advisory World for the specific model provided. If the response is 500 an error occured \r\nand details of the error should be returned. If the response is 200 the location header is where the generated report can be retrieved.", "operationId": "AdvisoryWorld_GetHoldingScanReportForModelAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "modelId", "in": "path", "description": "The model to show the holding scan report for.", "required": true, "type": "integer", "format": "int32" }, { "name": "reportType", "in": "query", "description": "Optional. Default: Pdf. Determines how the report is returned. Options are Pdf and Xml.", "required": false, "type": "string", "default": 1, "enum": [ "Xml", "Pdf" ] }, { "name": "includeInvestmentFactsheets", "in": "query", "description": "Optional. Default: true. Determines whether or not the investment factsheets should be included.", "required": false, "type": "boolean", "default": true }, { "name": "modelValue", "in": "query", "description": "Optional. Default: 10000. The value to use for the model.", "required": false, "type": "number", "format": "double", "default": 10000.0 }, { "name": "asOfDate", "in": "query", "description": "Optional. Default: Today. Determines the date the report should reflect.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisoryWorld/Reports/HoldingScan/Registration/{registrationId}": { "get": { "tags": [ "Integrations/AdvisoryWorld" ], "summary": "Gets a holding scan report from Advisory World for the specific registration provided. If the response is 500 an error occured \r\nand details of the error should be returned. If the response is 200 the location header is where the generated report can be retrieved.", "operationId": "AdvisoryWorld_GetHoldingScanReportForRegistrationAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "registrationId", "in": "path", "description": "The registration to show the holding scan report for.", "required": true, "type": "integer", "format": "int32" }, { "name": "reportType", "in": "query", "description": "Optional. Default: Pdf. Determines how the report is returned. Options are Pdf and Xml.", "required": false, "type": "string", "default": 1, "enum": [ "Xml", "Pdf" ] }, { "name": "includeInvestmentFactsheets", "in": "query", "description": "Optional. Default: true. Determines whether or not the investment factsheets should be included.", "required": false, "type": "boolean", "default": true }, { "name": "asOfDate", "in": "query", "description": "Optional. Default: Today. Determines the date the report should reflect.", "required": false, "type": "string", "format": "date-time" }, { "name": "excludedAccount", "in": "query", "description": "Optional. List of account to be excluded", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisoryWorld/RiskScore": { "put": { "tags": [ "Integrations/AdvisoryWorld" ], "summary": "Get risk score for Sleeve Strategy.", "operationId": "AdvisoryWorld_GetRiskScoreAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "bucket", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Integration.AdvisoryWorld.StrategyAllocations" } }, { "name": "defaultValue", "in": "query", "required": false, "type": "number", "format": "double", "default": 10000.0 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.AdvisoryWorld.AdviosryWorldRiskStatisticsAndCompositesDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisoryWorld/RiskScoreModel": { "put": { "tags": [ "Integrations/AdvisoryWorld" ], "summary": "Get risk score for ModelAggs.", "operationId": "AdvisoryWorld_GetRiskScoreModelAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "modelAggIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "defaultValue", "in": "query", "required": false, "type": "number", "format": "double", "default": 10000.0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.AdvisoryWorld.AdvisoryWorldModelAggAndRiskScoreDto" }, "xml": { "name": "AdvisoryWorldModelAggAndRiskScoreDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisoryWorld/Run/{filename}": { "get": { "tags": [ "Integrations/AdvisoryWorld" ], "summary": "Used to download a previously generated report pdf.", "operationId": "AdvisoryWorld_RunAdvisoryWorldReportAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "filename", "in": "path", "description": "The filename provided by the generate endpoint.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisoryWorld/Setup": { "post": { "tags": [ "Integrations/AdvisoryWorld" ], "summary": "Sets up AdvisoryWorld integration for the current user.", "description": "The user must have the necessary privileges to setup the integration.", "operationId": "AdvisoryWorld_SetupService", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "description": "An {OAS.WebApi.DTO.Integrations.PartnerAppConfigurationDto} containing the parameters for the AdvisoryWorld setup.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.IntegrationSetupRequestDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisoryWorld/SetupComplete": { "post": { "tags": [ "Integrations/AdvisoryWorld" ], "summary": "Stores AdvisoryWorld integration completed remotely for the current user.", "description": "The user must have the necessary privileges to setup the integration.", "operationId": "AdvisoryWorld_SetupCompletedAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "setupCompleteDto", "in": "body", "description": "An {OAS.WebApi.DTO.Integrations.PartnerAppConfigurationDto} containing the parameters for the AdvisoryWorld setup.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.AdvisoryWorld.AdvisoryWorldSetupCompleteDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisoryWorld/SSOUrl": { "get": { "tags": [ "Integrations/AdvisoryWorld" ], "summary": "Method to build an AdvisoryWorld SSO link", "operationId": "AdvisoryWorld_GetAdvisoryWorldSsoUrl", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "pkModel", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "pkPlatform", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "pkFundFamily", "in": "query", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.AdvisoryWorld.Dto.AdvisoryWorldSsoUrlDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AdvisoryWorld/UpdateModelAggRiskScore": { "put": { "tags": [ "Integrations/AdvisoryWorld" ], "summary": "Update risk score for ModelAggs that have been added or edited in the past 24hrs.", "operationId": "AdvisoryWorld_UpdateRiskScoreModelAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "modelAggIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "defaultValue", "in": "query", "required": false, "type": "number", "format": "double", "default": 10000.0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.AdvisoryWorld.RiskScoreUpdateErrorListDto" }, "xml": { "name": "RiskScoreUpdateErrorListDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Advizr/Action/SAML": { "get": { "tags": [ "Integrations/Advizr" ], "operationId": "Advizr_StartSSOAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "householdId", "in": "query", "required": false, "type": "string" }, { "name": "frameAncestor", "in": "query", "required": false, "type": "string", "default": "" }, { "name": "useOrionPlanningHouseholdId", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "navigateToDecumulation", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "householdGlobalID", "in": "query", "required": false, "type": "string" }, { "name": "contactGlobalID", "in": "query", "required": false, "type": "string" }, { "name": "accountGlobalID", "in": "query", "required": false, "type": "string" }, { "name": "formCollectionID", "in": "query", "required": false, "type": "string" }, { "name": "clientWorkflowType", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "redtailUserKey", "in": "query", "required": false, "type": "string" }, { "name": "isStandaloneFirm", "in": "query", "required": false, "type": "boolean" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Advizr/Actions/Remove": { "post": { "tags": [ "Integrations/Advizr" ], "summary": "Removes the Schwab integration for the current user.", "description": "The user must have the necessary privileges to remove the integration.", "operationId": "Advizr_RemoveServiceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Advizr/Actions/Setup": { "post": { "tags": [ "Integrations/Advizr" ], "operationId": "Advizr_SetupServiceAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "setupRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.IntegrationSetupRequestDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Advizr/ApexAccount": { "get": { "tags": [ "Integrations/Advizr" ], "operationId": "Advizr_GetApexAccountAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/Advizr" ], "operationId": "Advizr_PostApexAccountAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountOpeningDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Integrations.Apex.DTOs.ApexAccountOpeningDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Advizr/ApexAccounts": { "post": { "tags": [ "Integrations/Advizr" ], "operationId": "Advizr_PostApexAccountsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountOpeningDtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataProcess.Integrations.Apex.DTOs.ApexAccountOpeningDto" }, "xml": { "name": "ApexAccountOpeningDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Advizr/FinancialPlan/{clientId}/3DRiskProfile": { "get": { "tags": [ "Integrations/Advizr" ], "operationId": "Advizr_Get3DRiskProfileAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Advizr/FinancialPlan/{clientId}/ActionSteps": { "get": { "tags": [ "Integrations/Advizr" ], "operationId": "Advizr_GetActionStepsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Advizr/FinancialPlan/{clientId}/BeFi20": { "get": { "tags": [ "Integrations/Advizr" ], "operationId": "Advizr_GetBeFi20Async", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Advizr/FinancialPlan/{clientId}/ProbabilityOfSuccess/{planType}": { "get": { "tags": [ "Integrations/Advizr" ], "summary": "Returns the monte carlo result for the current or proposed financial plan.", "operationId": "Advizr_GetProbOfSuccessAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "planType", "in": "path", "description": "Required.Current or proposed", "required": true, "type": "string" }, { "name": "clientId", "in": "path", "description": "Orion Client Id", "required": true, "type": "integer", "format": "int32" }, { "name": "planId", "in": "query", "description": "optional.Proposed Financial Plan Id", "required": false, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Advizr/FinancialPlan/{clientId}/ProtectLiveDream": { "get": { "tags": [ "Integrations/Advizr" ], "summary": "Returns the protect, live, dream for a household.", "operationId": "Advizr_GetProtectLiveDreamAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "description": "Orion Household Id", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Advizr/FinancialPlan/{clientId}/RetirementAssets/{planType}": { "get": { "tags": [ "Integrations/Advizr" ], "summary": "Returns the retirement assets chart data for the current or proposed financial plan.", "operationId": "Advizr_GetRetirementAssetsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "description": "Orion Household Id", "required": true, "type": "integer", "format": "int32" }, { "name": "planType", "in": "path", "description": "Financial Plan Type: 'current' or 'proposed'", "required": true, "type": "string" }, { "name": "planId", "in": "query", "description": "optional. Proposed Financial Plan Id", "required": false, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Advizr/FinancialPlan/{clientId}/suggestions": { "get": { "tags": [ "Integrations/Advizr" ], "operationId": "Advizr_GetSuggestionsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Advizr/FinancialPlan/{clientId}/Summary/{planType}": { "get": { "tags": [ "Integrations/Advizr" ], "summary": "Returns the plan summary goals for the current or proposed financial plan.", "operationId": "Advizr_GetSummaryAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "description": "Orion Household Id", "required": true, "type": "integer", "format": "int32" }, { "name": "planType", "in": "path", "description": "Financial Plan Type: 'current' or 'proposed'", "required": true, "type": "string" }, { "name": "planId", "in": "query", "description": "optional. Proposed Financial Plan Id", "required": false, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Advizr/FinancialPlan/Decumulation": { "post": { "tags": [ "Integrations/Advizr" ], "summary": "Returns the protect, live, dream for a household.", "operationId": "Advizr_CreateDecumulationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "decumulationRequestDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Integration.Advizr.CreateDecumulationRequestDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Advizr/GetConfig": { "get": { "tags": [ "Integrations/Advizr" ], "operationId": "Advizr_GetConfigAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.Advizr.OrionPlanningSAML" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Advizr/NetWorth/{clientId}": { "get": { "tags": [ "Integrations/Advizr" ], "summary": "List all net worth data for a client.", "operationId": "Advizr_GetNetWorthAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "description": "Required.Orion Client Id", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Advizr/Onboarding/AllFirms": { "get": { "tags": [ "Integrations/Advizr" ], "summary": "Lists all on-boarded firms that meet the specified search criteria.", "operationId": "Advizr_GetAllFirmsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "description": "Optional.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional.", "required": false, "type": "string", "format": "date-time" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Advizr/Onboarding/Firm": { "get": { "tags": [ "Integrations/Advizr" ], "summary": "Returns the on-boarded organization of the specified external firm id.", "operationId": "Advizr_GetFirmAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Advizr/Onboarding/Firm/Advisors": { "get": { "tags": [ "Integrations/Advizr" ], "summary": "Lists all on-boarded advisors of the specified external firm id.", "operationId": "Advizr_GetFirmAdvisorsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Advizr/Onboarding/Firm/Households": { "get": { "tags": [ "Integrations/Advizr" ], "summary": "Lists all on-boarded households of the specified external firm id.", "operationId": "Advizr_GetFirmHouseholdsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Advizr/Onboarding/Goals/{householdId}": { "get": { "tags": [ "Integrations/Advizr" ], "operationId": "Advizr_GetGoalsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "householdId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Advizr/Onboarding/Households": { "get": { "tags": [ "Integrations/Advizr" ], "summary": "Returns households for logged in user (id).", "operationId": "Advizr_GetHouseholdsByRepIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Advizr/Onboarding/OrionPlanningNewHouseholdId": { "post": { "tags": [ "Integrations/Advizr" ], "operationId": "Advizr_GetOrionPlanningHouseholdIdAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "householdInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Integration.Advizr.OrionPlanningNewHousehold" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Advizr/Onboarding/PlaidAccounts/{clientId}": { "get": { "tags": [ "Integrations/Advizr" ], "summary": "Returns all Advizr Plaid Accounts.", "operationId": "Advizr_GetPlaidAccountsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "description": "Orion Planning Household Id", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Advizr/Onboarding/RTQ/{advizrHouseholdId}/Ally/{alliedHouseholdId}": { "get": { "tags": [ "Integrations/Advizr" ], "summary": "Returns all Advizr Risk Tolerance Questionaire.", "operationId": "Advizr_GetRiskQuestionnaireAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "alliedHouseholdId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "advizrHouseholdId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Advizr/PersonalFinanceTemplates": { "get": { "tags": [ "Integrations/Advizr" ], "operationId": "Advizr_GetPersonalFinanceTemplatesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Advizr/ProbabilityOfSuccess": { "post": { "tags": [ "Integrations/Advizr" ], "operationId": "Advizr_ProbabilityOfSuccessAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "alClientIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Advizr/SendEmail": { "post": { "tags": [ "Integrations/Advizr" ], "summary": "\r\n This is only invoked from the FE if TOS is unchecked\r\n REF: advizrWizard.js\r\n vm.partnerApp.sendemail = vm.partnerApp.acceptedTOS === false;", "operationId": "Advizr_SendEmailtoLegalAsync", "consumes": [], "produces": [], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Akoya/App": { "post": { "tags": [ "Integrations/Akoya" ], "operationId": "AkoyaApp_RegisterApplicationAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Akoya/Configuration": { "get": { "tags": [ "Integrations/Akoya" ], "summary": "Retrieves Akoya Integration details.", "description": "Sample Request\r\n\tGET /Integrations/Akoya/GetConfiguration\r\n\t{\r\n\t}", "operationId": "Akoya_GetConfigurationAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.Akoya.DataModel.IntegrationConfig" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/Akoya" ], "summary": "Saves Akoya integration settings.", "description": " Sample Request\r\n\t\tPUT /Integrations/Configuration\r\n\t\t{\r\n \"secret\": \"string\",\r\n \"clientId\": \"string\"\r\n }", "operationId": "Akoya_UpdateConfigurationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "config", "in": "body", "description": "configuration values", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.Akoya.DataModel.IntegrationConfig" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.Akoya.DataModel.IntegrationConfig" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Akoya/DeleteAndRevokeTokens": { "post": { "tags": [ "Integrations/Akoya" ], "operationId": "Akoya_RevokeAndDeleteTokensAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "credentialIds", "in": "body", "required": true, "schema": { "items": { "type": "string" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Akoya/EditToken": { "get": { "tags": [ "Integrations/Akoya" ], "summary": "Edit Akoya Token", "description": "Sample Request\r\n\tGET /Integrations/Akoya/EditToken\r\n\t{\r\n\t\t\"akoyaTokenId\":5\r\n\t\t\"tokenname\":\"test\"\r\n\t}", "operationId": "Akoya_EditTokenAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "akoyaTokenId", "in": "query", "description": "akoya token id", "required": true, "type": "integer", "format": "int32" }, { "name": "tokenname", "in": "query", "description": "token name", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Akoya/GetAkoya": { "get": { "tags": [ "Integrations/Akoya" ], "summary": "Akoya - Financial Institution Dumb endpoint.", "description": " Sample Request\r\n\t\tGET /Integrations/Akoya/GetAkoya\r\n\t\t{\r\n\t\t}", "operationId": "Akoya_GetAkoyaAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Akoya/GetAkoyaImage": { "get": { "tags": [ "Integrations/Akoya" ], "summary": "Call this with financialInstitution\r\ncurrently supported are these three mikomo,transamerica, fidelity", "description": "Sample Request\r\n\tGET /Integrations/Akoya/GetAkoyaImageAsync?financialInstitution=mikomo\r\n\t{\r\n\t}", "operationId": "Akoya_GetAkoyaImageAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "financialInstitution", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string", "format": "byte" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Akoya/GetAkoyaLinkedAccounts": { "get": { "tags": [ "Integrations/Akoya" ], "summary": "Get Akoya Linked Accounts pass in get settings", "description": "Sample Request\r\n\tGET /Integrations/Akoya/GetAkoyaLinkedAccounts\r\n\t{\r\n\t}", "operationId": "Akoya_GetAkoyaLinkedAccountsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "description": "Cancel Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.Settings.CustomSettingDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Akoya/GetAkoyaToken": { "get": { "tags": [ "Integrations/Akoya" ], "summary": "Get Akoya Token", "description": "Sample Request\r\n\tGET /Integrations/Akoya/GetAkoyaToken\r\n\t{\r\n\t \"householdid\":5\r\n\t}", "operationId": "Akoya_GetAkoyaTokenAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "householdid", "in": "query", "description": "householdID", "required": false, "type": "integer", "format": "int32" }, { "name": "credentialId", "in": "query", "required": false, "type": "string" }, { "name": "tokenId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.Akoya.AkoyaUserDetail" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Akoya/GetToken": { "get": { "tags": [ "Integrations/Akoya" ], "summary": "Used to get token from Akoya.", "description": "Sample Request\r\n\tGET /Integrations/Akoya/GetToken\r\n\t{\r\n\t\t\"code\":\"test\",\r\n\t\t\"connector\":\"mikomo\"\r\n\t}", "operationId": "Akoya_GetTokenAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "code", "in": "query", "description": "Code param", "required": true, "type": "string" }, { "name": "connector", "in": "query", "required": true, "type": "string" }, { "name": "opToken", "in": "query", "required": false, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integration.AkoyaUserDtl" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Akoya/Institution": { "put": { "tags": [ "Integrations/Akoya" ], "summary": "Updates the institution and options asynchronous.", "description": "Sample Request\r\nPUT /Integrations/Akoya/Institution\r\n{\r\n \"id\": 1,\r\n \"fiName\": \"Fidelity\",\r\n \"fiId\": \"fidelity\",\r\n \"isExcluded\": 0,\r\n \"alClientList\": ''\r\n}", "operationId": "Akoya_UpdateInstitutionAndOptionsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "The dto.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.AkoyaInstitutionDto" } }, { "name": "ct", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.AkoyaInstitutionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Akoya/Institution/AlClient/Ids": { "get": { "tags": [ "Integrations/Akoya" ], "summary": "Gets available databases by comma separatedList query string param", "description": "Sample Request\r\n\tGET /Integrations/Akoya/Institution/AlClient/Ids?alClientIds=1,2,3,4\r\n\t{\r\n\t}", "operationId": "Akoya_GetDatabasesByCommaSeparatedListAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "alClientIds", "in": "query", "description": "a comma separated list of alclient ids.", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Authorization.ALClientDto" }, "xml": { "name": "ALClientDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Akoya/Institution/AlClient/Search": { "get": { "tags": [ "Integrations/Akoya" ], "summary": "Gets available databases by search text", "description": "Sample Request\r\n\tGET /Integrations/Akoya/Institution/AlClient/Search?searchText=abc\r\n\t{\r\n\t}", "operationId": "Akoya_GetDatabasesBySearchTextAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "searchText", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Authorization.ALClientDto" }, "xml": { "name": "ALClientDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Akoya/Institutions": { "get": { "tags": [ "Integrations/Akoya" ], "summary": "Get list of all the institutions", "description": "Sample Request\r\n\tGET /Integrations/Akoya/Institutions\r\n\t{\r\n\t}", "operationId": "Akoya_GetInstitutionsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.AkoyaInstitutionDto" }, "xml": { "name": "AkoyaInstitutionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Akoya/Legacy/Institution": { "get": { "tags": [ "Integrations/Akoya" ], "summary": "Returns all institutions with Image", "description": "GET\r\n/Integrations/Akoya/Legacy/Institution", "operationId": "Akoya_GetAkoyaInstitutionsForLegacyClientPortalAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "description": "Cancellation token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Akoya/Redirect": { "get": { "tags": [ "Integrations/Akoya" ], "summary": "Redirects the caller to a URL to authenticate with Akoya.", "description": "Sample Request\r\n\tGET /Integrations/Akoya/GetRedirectUrl\r\n\t{\r\n\t\t\"Authorization\":\"ABCDE1223\",\r\n\t\t\"t\",\"2324432232\",\r\n\t\t\"connector\":\"mikomo\"\r\n\t}", "operationId": "Akoya_GetRedirectUrlAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "Authorization", "in": "query", "description": "The Orion access token for the user making the redirection request.", "required": true, "type": "string" }, { "name": "t", "in": "query", "description": "The Orion access token for the user making the redirection request.", "required": true, "type": "string" }, { "name": "connector", "in": "query", "description": "connector value to pass in", "required": true, "type": "string" }, { "name": "opToken", "in": "query", "required": false, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Akoya/RefreshAkoyaToken": { "get": { "tags": [ "Integrations/Akoya" ], "summary": "Refresh Akoya Token", "description": "Sample Request\r\n\tGET /Integrations/Akoya/RefreshAkoyaToken\r\n\t{\r\n\t\t\"AkoyaTokenID\":5\r\n\t}", "operationId": "Akoya_AkoyaAccessRefreshtokenAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "AkoyaTokenId", "in": "query", "description": "akoya token ID", "required": true, "type": "integer", "format": "int32" }, { "name": "householdid", "in": "query", "description": "householdID", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.Akoya.AkoyaUser" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Akoya/Revoke": { "get": { "tags": [ "Integrations/Akoya" ], "summary": "Revoke Token", "description": "Sample Request\r\n\tGET /Integrations/Akoya/Revoke\r\n\t{\r\n\t\t\"householdid\":5\r\n\t}", "operationId": "Akoya_RevokeTokenAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "householdid", "in": "query", "description": "householdID", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Akoya/Revoke/{institution}": { "get": { "tags": [ "Integrations/Akoya" ], "summary": "Revoke Akoya Refresh Token.", "description": "Sample Request\r\n\tGET /Integrations/Akoya/Revoke/5\r\n\t{\r\n\t\t\"akoyaTokenId\":5\r\n\t}", "operationId": "Akoya_GetV1IntegrationsAkoyaRevokeByInstitution", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "akoyaTokenId", "in": "query", "description": "akoya token id", "required": true, "type": "integer", "format": "int32" }, { "name": "householdid", "in": "query", "description": "householdID", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "ct", "in": "header", "required": false }, { "name": "institution", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Akoya/SetAkoyaLinkedAccounts": { "put": { "tags": [ "Integrations/Akoya" ], "summary": "Set Akoya Linked Accounts pass in set settings", "description": " Sample Request\r\n\t\tPut /Integrations/Akoya/SetAkoyaLinkedAccounts\r\n\t\t{\r\n\t\t {\r\n \"value\": \"[{\\\"id\\\":\\\"fidelity\\\",\\\"name\\\":\\\"Fidelity\\\",\\\"image\\\":\\\"sss.jpg\\\"},\r\n {\\\"id\\\":\\\"mikomo\\\",\\\"name\\\":\\\"Mikomo\\\",\\\"image\\\":\\\"ttt.jpg\\\"},\r\n {\\\"id\\\":\\\"transamerica\\\",\\\"name\\\":\\\"Transamerica\\\",\\\"image\\\":\\\"abcdef.jpg\\\"}]\"\r\n\r\n\t\t}", "operationId": "Akoya_SetAkoyaLinkedAccountAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Settings.CustomSettingDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.Settings.CustomSettingDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Akoya/Token/Household": { "put": { "tags": [ "Integrations/Akoya" ], "summary": "Updates the ClientId/HouseholdId on an akoya token", "description": "Sample Request\r\n\tPUT /Integrations/Akoya/Token/Household\r\n\t{\r\n\t \"householdid\":5,\r\n \"credentialId\": \"\",\r\n \"token\": \"BearerTokenValue\"\r\n\t}", "operationId": "Akoya_UpdateAkoyaTokenHouseholdAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "description": "The request object seen above", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.AkoyaHouseholdUpdateRequestDto" } }, { "name": "ct", "in": "header", "description": "CancellationToken", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAT.Integrations.Akoya.AkoyaUser" }, "xml": { "name": "AkoyaUser", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Apex/Account": { "get": { "tags": [ "Integrations/Apex" ], "operationId": "Apex_AccountsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Apex/Account/{id}": { "get": { "tags": [ "Integrations/Apex" ], "operationId": "Apex_AccountAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Apex/AccountsDisposition": { "get": { "tags": [ "Integrations/Apex" ], "operationId": "Apex_AccountsDispositionAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Apex/ACHRelationship/{id}/{type}/{direction}": { "get": { "tags": [ "Integrations/Apex" ], "operationId": "Apex_ACHRelationshipAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "type", "in": "path", "required": true, "type": "string" }, { "name": "direction", "in": "path", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Apex/AutomatedAccount": { "get": { "tags": [ "Integrations/Apex" ], "operationId": "Apex_GetSamplePostRequestAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/Apex" ], "operationId": "Apex_PostApexAccountAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountOpeningDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Integrations.Apex.DTOs.ApexAccountOpeningDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Apex/Download/{snapId}": { "get": { "tags": [ "Integrations/Apex" ], "operationId": "Apex_DownloadAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "snapId", "in": "path", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Apex/File/{apexAccountNumber}": { "get": { "tags": [ "Integrations/Apex" ], "operationId": "Apex_GetFilesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "apexAccountNumber", "in": "path", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Apex/Investigation": { "post": { "tags": [ "Integrations/Apex" ], "operationId": "Apex_PostInvestigationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Integrations.Apex.DTOs.ApexFileUploadDto" } }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Apex/Investigation/{accountRequestId}": { "get": { "tags": [ "Integrations/Apex" ], "operationId": "Apex_GetInvestigationAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountRequestId", "in": "path", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Apex/Investigation/{sketchId}": { "delete": { "tags": [ "Integrations/Apex" ], "operationId": "Apex_DeleteInvestigationAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "sketchId", "in": "path", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Apex/Mapping": { "get": { "tags": [ "Integrations/Apex" ], "operationId": "Apex_GetMappingsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Apex/Mapping/{id}/{accountName}": { "post": { "tags": [ "Integrations/Apex" ], "operationId": "Apex_PostMappingsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "accountName", "in": "path", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Apex/Message/{apexAccountNumber}": { "get": { "tags": [ "Integrations/Apex" ], "operationId": "Apex_GetMessagessAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "apexAccountNumber", "in": "path", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Apex/NewMessages/{apexAccountNumber}": { "get": { "tags": [ "Integrations/Apex" ], "operationId": "Apex_GetNewMessageAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "apexAccountNumber", "in": "path", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Apex/RepBranchCode": { "get": { "tags": [ "Integrations/Apex" ], "operationId": "Apex_GetRepBranchMappingAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/Apex" ], "operationId": "Apex_PostRepBranchAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "repBranch", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Integrations.Apex.Code.RepBranchDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Apex/RepBranchCode/Client/{clientId}": { "get": { "tags": [ "Integrations/Apex" ], "operationId": "Apex_GetRepBranchCodeAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Apex/Setup/Firm": { "get": { "tags": [ "Integrations/Apex" ], "operationId": "ApexSetup_GetAllApexIntegrationFirmsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/Apex" ], "operationId": "ApexSetup_CreateFirmForApexAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "apexFirm", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Integrations.Apex.Code.ApexFirmDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Apex/Setup/Firm/{alClientId}": { "delete": { "tags": [ "Integrations/Apex" ], "operationId": "ApexSetup_DeleteFirmAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "alClientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Apex/Setup/HighWatermark/{alClientId}": { "get": { "tags": [ "Integrations/Apex" ], "operationId": "ApexSetup_GetApexFirmHighWatermarksAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "alClientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/Apex" ], "operationId": "ApexSetup_UpsertHighWatermarksAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "alClientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "highWatermarks", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataProcess.Integrations.Apex.DTOs.ApexHighWaterMark" }, "xml": { "name": "ApexHighWaterMark", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/Apex" ], "operationId": "ApexSetup_PostV1IntegrationsApexSetupHighWatermarkByAlClientId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "alClientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "highWatermarks", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataProcess.Integrations.Apex.DTOs.ApexHighWaterMark" }, "xml": { "name": "ApexHighWaterMark", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Apex/Setup/SystemConfig/{alClientId}": { "get": { "tags": [ "Integrations/Apex" ], "operationId": "ApexSetup_GetApexSystemConfigAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "alClientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/Apex" ], "operationId": "ApexSetup_UpsertSystemConfigAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "alClientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "apexSystemConfig", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Integrations.Apex.DTOs.ApexDocumentSystemConfiguration" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/Apex" ], "operationId": "ApexSetup_PostV1IntegrationsApexSetupSystemConfigByAlClientId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "alClientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "apexSystemConfig", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Integrations.Apex.DTOs.ApexDocumentSystemConfiguration" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Apex/Setup/TestSettings": { "get": { "tags": [ "Integrations/Apex" ], "operationId": "ApexSetup_TestSettingsForApexByIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/Apex" ], "operationId": "ApexSetup_TestSettingsForApexAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "apexFirm", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Integrations.Apex.Code.ApexFirmDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Apex/Setup/UserConfig/{alClientId}": { "get": { "tags": [ "Integrations/Apex" ], "operationId": "ApexSetup_GetApexUserConfigAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "alClientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/Apex" ], "operationId": "ApexSetup_UpsertUserConfigAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "alClientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "apexUser", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.Apex.DTOs.ApexUserToken" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/Apex" ], "operationId": "ApexSetup_PostV1IntegrationsApexSetupUserConfigByAlClientId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "alClientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "apexUser", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.Apex.DTOs.ApexUserToken" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Apex/Transaction": { "get": { "tags": [ "Integrations/Apex" ], "operationId": "Apex_TransactionsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Apex/Transaction/{accountId}": { "get": { "tags": [ "Integrations/Apex" ], "operationId": "Apex_TransactionsByIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "take", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 10 }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Apex/TransactionDisposition": { "get": { "tags": [ "Integrations/Apex" ], "operationId": "Apex_TransactionDispositionAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Apps/Management/PartnerApps": { "get": { "tags": [ "Integrations/Apps" ], "operationId": "AppManagement_GetPartnerAppsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Apps/Management/PartnerApps/{partnerAppId}": { "get": { "tags": [ "Integrations/Apps" ], "operationId": "AppManagement_GetPartnerAppByIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "partnerAppId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Apps/Management/PartnerApps/{partnerAppId}/Whitelist": { "get": { "tags": [ "Integrations/Apps" ], "operationId": "AppManagement_GetWhitelistedUrlsByIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "partnerAppId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/Apps" ], "operationId": "AppManagement_UpdateWhitelistedUrlAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "urlWhitelistEntry", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Security.PartnerAppUrlWhitelist" } }, { "name": "ct", "in": "header", "required": true }, { "name": "partnerAppId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/Apps" ], "operationId": "AppManagement_CreateWhitelistUrlAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "urlWhitelistEntry", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Security.PartnerAppUrlWhitelist" } }, { "name": "ct", "in": "header", "required": true }, { "name": "partnerAppId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Apps/Management/PartnerApps/{partnerAppId}/Whitelist/{whitelistEntryId}": { "delete": { "tags": [ "Integrations/Apps" ], "operationId": "AppManagement_DeleteWhitelistedUrlAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "partnerAppId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "whitelistEntryId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Ascent/Redirect": { "get": { "tags": [ "Integrations/Ascent" ], "summary": "Return the URL to the Ascent page, with an authorization token.", "operationId": "Ascent_GetRedirectUrlAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AssetMap/Actions/Remove": { "post": { "tags": [ "Integrations/AssetMap" ], "summary": "Removes the AssetMap integration for the current firm.", "description": "The user must have the necessary privileges to remove the integration.", "operationId": "AssetMap_RemoveServiceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AssetMap/Actions/Setup": { "post": { "tags": [ "Integrations/AssetMap" ], "summary": "Adds the AssetMap integration for the current firm.", "operationId": "AssetMap_SetupServiceAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "setupRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.IntegrationSetupRequestDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.BasicIntegrationConfigDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AssetMap/GetConfigurations": { "get": { "tags": [ "Integrations/AssetMap" ], "operationId": "AssetMap_GetConfigurationsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Integrations.AssetMapController.Configurations" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AssetMap/GetLoginToken": { "get": { "tags": [ "Integrations/AssetMap" ], "summary": "Gets a login token from Asset-Map.", "operationId": "AssetMap_GetLoginTokenAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AssetMap/GetToken": { "get": { "tags": [ "Integrations/AssetMap" ], "summary": "Gets an authentication token from Asset-Map.", "operationId": "AssetMap_GetTokenAsync", "consumes": [], "produces": [], "parameters": [ { "name": "code", "in": "query", "required": true, "type": "string" }, { "name": "authorization", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AssetMap/OAuth2Login": { "get": { "tags": [ "Integrations/AssetMap" ], "summary": "Proxies the OAuth2 login request to Asset-Map API to avoid CORS issues.", "operationId": "AssetMap_OAuth2LoginAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accessToken", "in": "query", "description": "The Asset-Map access token", "required": true, "type": "string" }, { "name": "ct", "in": "header", "description": "Cancellation token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AssetMap/Redirect": { "get": { "tags": [ "Integrations/AssetMap" ], "summary": "Gets the redirect URL for the user to authenticate with Asset-Map.", "operationId": "AssetMap_GetRedirectUrlAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/AssetMap/SaveToken": { "get": { "tags": [ "Integrations/AssetMap" ], "summary": "Used to get token from Fidelity.", "operationId": "AssetMap_SaveTokenAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "code", "in": "query", "required": true, "type": "string" }, { "name": "authorization", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Astro/Account/{accountId}/InvestmentStrategySetting": { "get": { "tags": [ "Integrations/Astro" ], "summary": "", "operationId": "IntegrationsAstro_GetInvestStrategySettingAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "string" }, { "name": "strategyName", "in": "query", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.Astro.RestServices.InvestorPreferencesSettings" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Astro/Account/{accountId}/InvestorPreference": { "post": { "tags": [ "Integrations/Astro" ], "summary": "", "operationId": "IntegrationsAstro_SaveInvestorPreferenceAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "string" }, { "name": "setting", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Integrations.Astro.RestServices.InvestorPreferencesSettingSaveRequest" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Astro/Accounts/{accountId}": { "get": { "tags": [ "Integrations/Astro" ], "operationId": "IntegrationsAstro_GetHoldingsByAccount", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.Integrations.Astro.Models.HoldingSimple" }, "xml": { "name": "HoldingSimple", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/Astro" ], "operationId": "IntegrationsAstro_SyncAccountToMars", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Astro/Accounts/{accountId}/Accounts": { "get": { "tags": [ "Integrations/Astro" ], "operationId": "IntegrationsAstro_GetAccountsByAccountId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Integration.Astro.AstroAccountData" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Astro/Accounts/{accountId}/Holdings": { "post": { "tags": [ "Integrations/Astro" ], "operationId": "IntegrationsAstro_SyncHoldingsToMars", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "string" }, { "name": "holdings", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Integration.Astro.AstroHolding" }, "xml": { "name": "AstroHolding", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Astro/Accounts/{accountId}/Optimizer": { "post": { "tags": [ "Integrations/Astro" ], "summary": "", "operationId": "IntegrationsAstro_RunOptimizerForAccount", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "string" }, { "name": "optimizerSettings", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Integrations.Astro.Models.OptimizerSettings" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.Astro.Models.OptimizationSummary" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Astro/Accounts/{accountId}/Optimizer/Enable/{enable}": { "post": { "tags": [ "Integrations/Astro" ], "operationId": "IntegrationsAstro_EnableOptimizerForAccount", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "enable", "in": "path", "required": true, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Astro/Accounts/{accountId}/Template": { "get": { "tags": [ "Integrations/Astro" ], "operationId": "IntegrationsAstro_GetTemplateByNameAndAccountId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.Astro.Models.Template" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Astro/AssetRestrictions": { "post": { "tags": [ "Integrations/Astro" ], "operationId": "IntegrationsAstro_SaveAstroAssetRestrictions", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "assets", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Integration.Astro.AstroAsset" }, "xml": { "name": "AstroAsset", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Integration.Astro.AstroAsset" }, "xml": { "name": "AstroAsset", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Astro/AstroSyncAfterTaxReport": { "post": { "tags": [ "Integrations/Astro" ], "summary": "Get Astro after Tax Reporting Metrics", "operationId": "IntegrationsAstro_GetAstroSyncAfterTaxReportingAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "firmIds", "in": "body", "description": "List of comma separated alClient Id's", "required": true, "schema": { "items": { "type": "string" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.AstroSyncAfterTaxReportingDto" }, "xml": { "name": "AstroSyncAfterTaxReportingDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Astro/BenchmarkDetail": { "get": { "tags": [ "Integrations/Astro" ], "summary": "Returns benchmark detail per template or accountId", "operationId": "IntegrationsAstro_GetBenchmarkDetail", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "query", "description": "Id of the account for which the report will be run.", "required": true, "type": "string" }, { "name": "templateId", "in": "query", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.BenchmarkDetailDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Astro/Benchmarks": { "get": { "tags": [ "Integrations/Astro" ], "operationId": "IntegrationsAstro_GetBenchmarks", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.Integrations.Astro.Models.Benchmark" }, "xml": { "name": "Benchmark", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Astro/Benchmarks/{benchmarkId}/Templates": { "get": { "tags": [ "Integrations/Astro" ], "operationId": "IntegrationsAstro_GetTemplatesForBenchmark", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "benchmarkId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.Integrations.Astro.Models.TemplateName" }, "xml": { "name": "TemplateName", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Astro/Clients/{clientId}/Accounts": { "get": { "tags": [ "Integrations/Astro" ], "operationId": "IntegrationsAstro_GetAccountsByHouseholdId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Integration.Astro.AstroAccountData" }, "xml": { "name": "AstroAccountData", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Astro/CreateOrders": { "post": { "tags": [ "Integrations/Astro" ], "summary": "Accept a list of orders, validate the orders and then create the orders based on an entity option in either eclipse or tom.", "operationId": "IntegrationsAstro_CreateOrders", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "tradeDef", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Remote.Trading.TradeDefinition" } }, { "name": "ct", "in": "header", "description": "CancellationToken", "required": true }, { "name": "sendNow", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "wait", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Astro/ESG/Restriction/Securities": { "get": { "tags": [ "Integrations/Astro" ], "summary": "", "operationId": "IntegrationsAstro_GetEsgSecurities", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "category", "in": "query", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.EsgSecurityRestrictionDto" }, "xml": { "name": "EsgSecurityRestrictionDto", "wrapped": true }, "type": "array" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Astro/HoldingRestriction/ValidateImport": { "post": { "tags": [ "Integrations/Astro" ], "summary": "", "operationId": "IntegrationsAstro_ValidateImportAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "import", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.HoldingRestrictionValidationResultDto" }, "xml": { "name": "HoldingRestrictionValidationResultDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Astro/Prospect/Holdings": { "post": { "tags": [ "Integrations/Astro" ], "operationId": "IntegrationsAstro_GetHoldingsForProspectHoldingsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "prospectAstroHoldings", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Integration.Astro.AstroHolding" }, "xml": { "name": "AstroHolding", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "prospectName", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Integration.Astro.AstroHolding" }, "xml": { "name": "AstroHolding", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Astro/Prospect/Holdings/Validate": { "post": { "tags": [ "Integrations/Astro" ], "operationId": "IntegrationsAstro_ValidateHoldingsForProspectHoldings", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "prospectAstroHoldings", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Integration.Astro.AstroHolding" }, "xml": { "name": "AstroHolding", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Integration.Astro.AstroHoldingError" }, "xml": { "name": "AstroHoldingError", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Astro/Prospect/UpdateHoldings/{accountId}": { "post": { "tags": [ "Integrations/Astro" ], "operationId": "IntegrationsAstro_UpdateHoldingsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "prospectAstroHoldings", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Integration.Astro.AstroHolding" }, "xml": { "name": "AstroHolding", "wrapped": true }, "type": "array" } }, { "name": "accountId", "in": "path", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Astro/Registrations/{regId}/Accounts": { "get": { "tags": [ "Integrations/Astro" ], "operationId": "IntegrationsAstro_GetAccountsByRegistrationId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "regId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Integration.Astro.AstroAccountData" }, "xml": { "name": "AstroAccountData", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Astro/SubmitOptimization/{accountId}": { "post": { "tags": [ "Integrations/Astro" ], "operationId": "IntegrationsAstro_SubmitOptimization", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Astro/SubReport/{accountId}": { "get": { "tags": [ "Integrations/Astro" ], "summary": "Returns the summary, gain/loss, top ten, and sector percentage data for the Astro subReport.", "operationId": "IntegrationsAstro_SubReportAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "description": "Id of the account for which the report will be run.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.AstroSubReportDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Astro/TaxSchedules/{accountId}": { "get": { "tags": [ "Integrations/Astro" ], "operationId": "IntegrationsAstro_GetTaxSchedules", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.AstroAccountTaxSchedulesDto" }, "xml": { "name": "AstroAccountTaxSchedulesDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Astro/TaxSchedules/Year/{year}": { "get": { "tags": [ "Integrations/Astro" ], "operationId": "IntegrationsAstro_GetTaxSchedulesByYear", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "year", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.AstroAccountTaxSchedulesDto" }, "xml": { "name": "AstroAccountTaxSchedulesDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Astro/Templates/Simple": { "get": { "tags": [ "Integrations/Astro" ], "operationId": "IntegrationsAstro_GetTemplatesSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.Integrations.Astro.Models.TemplateSimple" }, "xml": { "name": "TemplateSimple", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Axos/GetToken": { "put": { "tags": [ "Integrations/Axos" ], "summary": "", "operationId": "Axos_PutV1IntegrationsAxosGetToken", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "axosCreds", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Integrations.Axos.Models.AxosCreds" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.Axos.Models.AxosToken" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/Axos" ], "summary": "", "operationId": "Axos_GetTokenAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "axosCreds", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Integrations.Axos.Models.AxosCreds" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.Axos.Models.AxosToken" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Axos/RefreshToken": { "get": { "tags": [ "Integrations/Axos" ], "summary": "", "operationId": "Axos_RefreshTokenAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.Axos.Models.AxosToken" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Axos/Statement/Download": { "get": { "tags": [ "Integrations/Axos" ], "summary": "", "operationId": "Axos_DownloadStatementAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "documentid", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Axos/Statements": { "get": { "tags": [ "Integrations/Axos" ], "summary": "", "operationId": "Axos_GetStatementsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountNumber", "in": "query", "required": true, "type": "string" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Axos/TaxForm/Download": { "get": { "tags": [ "Integrations/Axos" ], "summary": "", "operationId": "Axos_DownloadTaxFormsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "documentid", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Axos/TaxForms": { "get": { "tags": [ "Integrations/Axos" ], "summary": "", "operationId": "Axos_GetTaxFormsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountNumber", "in": "query", "required": true, "type": "string" }, { "name": "startYear", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "endYear", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/BasisCode/Action/SAML": { "get": { "tags": [ "Integrations/BasisCode" ], "operationId": "BasisCode_StartSSOAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/BizEquity/Action/SAML": { "get": { "tags": [ "Integrations/BizEquity" ], "operationId": "BizEquity_StartSSOAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "query", "required": false, "type": "string", "default": 4, "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/BizEquity/Actions/Remove": { "post": { "tags": [ "Integrations/BizEquity" ], "summary": "Removes the AssetMap integration for the current firm.", "description": "The user must have the necessary privileges to remove the integration.", "operationId": "BizEquity_RemoveServiceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/BizEquity/Actions/Setup": { "post": { "tags": [ "Integrations/BizEquity" ], "summary": "Adds the AssetMap integration for the current firm.", "operationId": "BizEquity_SetupService", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "setupRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.IntegrationSetupRequestDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.BasicIntegrationConfigDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/BizEquity/BizUser": { "get": { "tags": [ "Integrations/BizEquity" ], "operationId": "BizEquity_GetV1IntegrationsBizEquityBizUser", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Integration.BizEquity.BizEquitySubDomain" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/BizEquity" ], "operationId": "BizEquity_BizUser", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "bizuser", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Integration.BizEquity.BizEquitySubDomain" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Integration.BizEquity.BizEquitySubDomain" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/BizEquity/Redirect": { "get": { "tags": [ "Integrations/BizEquity" ], "operationId": "BizEquity_GetRedirectUrl", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/BlackRock/Actions/Remove": { "post": { "tags": [ "Integrations/BlackRock" ], "summary": "Removes the AssetMap integration for the current firm.", "description": "The user must have the necessary privileges to remove the integration.", "operationId": "BlackRock_RemoveServiceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/BlackRock/Actions/Setup": { "post": { "tags": [ "Integrations/BlackRock" ], "summary": "Adds the AssetMap integration for the current firm.", "operationId": "BlackRock_SetupServiceAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "setupRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.IntegrationSetupRequestDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.BasicIntegrationConfigDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/BlackRock/Analyzer/{modelId}": { "get": { "tags": [ "Integrations/BlackRock" ], "operationId": "BlackRock_BlackRockAnalyzerRedirectAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "modelId", "in": "path", "required": true, "type": "string" }, { "name": "token", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/BlackRock/AssignModel": { "post": { "tags": [ "Integrations/BlackRock" ], "summary": "Evaluate the ids and assign the community model to the appropriate record.", "operationId": "BlackRock_AssignModelAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "brModel", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.BlackRock.Models.ModelAssignment" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/BlackRock/CoriIncome": { "post": { "tags": [ "Integrations/BlackRock" ], "summary": "Gets the income from BlackRock iRetire based on inputs. if the inputs are left null, then defaults will be used.", "operationId": "BlackRock_GetCoriIncomeAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "coriIncome", "in": "body", "description": "Parameters used to calculate retirement income.", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.BlackRock.Models.BlackRockCoriIncome" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.BlackRock.Models.BlackRockCoriIncomeDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/BlackRock/iRetireSSO": { "get": { "tags": [ "Integrations/BlackRock" ], "operationId": "BlackRock_iRetireSSOAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "testEnvironment", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "portfolioId", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "taxestimator", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/BlackRock/ModelName": { "post": { "tags": [ "Integrations/BlackRock" ], "summary": "Sets the modelName on the passed in portfolioId", "operationId": "BlackRock_SetModelName", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "portfolioId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "modelName", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/BlackRock/Redirect": { "get": { "tags": [ "Integrations/BlackRock" ], "operationId": "BlackRock_RedirectToBlackrockAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "testEnvironment", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "portfolioId", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "entity", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Blaze/Configuration": { "get": { "tags": [ "Integrations/Blaze" ], "summary": "Gets the configuration data for Blaze for the current user.", "operationId": "Blaze_GetConfigurationAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.PartnerAppConfigurationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Blaze/Remove": { "post": { "tags": [ "Integrations/Blaze" ], "summary": "Removes the Blaze integration for the current user.", "description": "The user must have the necessary privileges to setup the integration.", "operationId": "Blaze_RemoveServiceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Blaze/RescheduleJob": { "post": { "tags": [ "Integrations/Blaze" ], "summary": "Update a job schedule for Blaze for the current user.", "operationId": "Blaze_ChangeJobScheduleRunTimeAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "description": "A {OAS.WebApi.DTO.Scheduler.JobScheduleUpdateRequest} containing the time of day the job should run. \r\n The date portion of the run time parameter is ignored.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Scheduler.JobScheduleUpdateRequest" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.PartnerAppConfigurationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Blaze/RunJobNow": { "post": { "tags": [ "Integrations/Blaze" ], "summary": "Runs the job schedule for Blaze for the current user.", "operationId": "Blaze_RunJobScheduleNowAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "jobScheduleId", "in": "query", "description": "The ID of an existing Job Schedule.", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.PartnerAppConfigurationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Blaze/ScheduleJob": { "post": { "tags": [ "Integrations/Blaze" ], "summary": "Schedules a job schedule for Blaze for the current user.", "operationId": "Blaze_CreateNewJobScheduleAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "config", "in": "body", "description": "A {OAS.WebApi.DTO.Integrations.PartnerAppConfigurationDto} with the job schedule's desired run time and weekendsOnly values set.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.PartnerAppConfigurationDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Blaze/Setup": { "post": { "tags": [ "Integrations/Blaze" ], "summary": "Sets up Blaze integration for the current user.", "description": "The user must have the necessary privileges to setup the integration.", "operationId": "Blaze_SetupServiceAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "description": "A {OAS.WebApi.DTO.Integrations.PartnerAppConfigurationDto} containing the properties of the integration.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.IntegrationSetupRequestDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.PartnerAppConfigurationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Blaze/UnscheduleJob": { "post": { "tags": [ "Integrations/Blaze" ], "summary": "Removes the job schedule for Blaze for the current user.", "operationId": "Blaze_RemoveJobScheduleAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "jobScheduleId", "in": "query", "description": "The ID of an existing Job Schedule.", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.PartnerAppConfigurationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/BluePay/{key}": { "delete": { "tags": [ "Integrations/BluePay" ], "summary": "Used to save Credit Card information to Blue Pay", "operationId": "BluePay_DeleteCreditCard", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The ClientId", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/BluePay/{key}/StoreACHInfo": { "post": { "tags": [ "Integrations/BluePay" ], "summary": "Used to save ACH information to Blue Pay", "operationId": "BluePay_StoreACHInfo", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The ClientId", "required": true, "type": "integer", "format": "int32" }, { "name": "ach", "in": "body", "description": "ACH information that will be saved to BluePay.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.BluePay.BluePayBillingInfoDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.BluePay.BluePayBillingInfoDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/BluePay/{key}/StoreCreditCard": { "post": { "tags": [ "Integrations/BluePay" ], "summary": "Used to save Credit Card information to Blue Pay", "operationId": "BluePay_StoreCreditCard", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The ClientId", "required": true, "type": "integer", "format": "int32" }, { "name": "creditCard", "in": "body", "description": "Credit Card information that will be saved to BluePay.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.BluePay.BluePayBillingInfoDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.BluePay.BluePayBillingInfoDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/BluePay/Configuration": { "get": { "tags": [ "Integrations/BluePay" ], "summary": "Retrieves Bluepay Integration details.", "operationId": "BluePay_GetConfiguration", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.BluePay.IntegrationConfig" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/BluePay" ], "summary": "Saves BluePay integration settings.", "operationId": "BluePay_UpdateConfiguration", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "config", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.BluePay.IntegrationConfig" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.BluePay.IntegrationConfig" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/BluePay/Notify": { "post": { "tags": [ "Integrations/BluePay" ], "summary": "Notification from Bluepay that data has been processed", "description": "Sample Request\r\n\tGET /Notify", "operationId": "BluePay_ProcessBluePayBatchResponseAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/BluePay/NotifyTest": { "post": { "tags": [ "Integrations/BluePay" ], "summary": "Notification for testing fake BluePay messages", "description": "Sample Request\r\n\tGET /NotifyTest", "operationId": "BluePay_ProcessBluePayBatchResponseTestAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "bluePayBatchResponse", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.BluePay.BluePayBatchResponseDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/ByAllAccounts/Configuration": { "get": { "tags": [ "Integrations/ByAllAccounts" ], "summary": "Retrieves ByAllAccounts Integration details.", "operationId": "ByAllAccounts_GetConfiguration", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "firm", "in": "query", "required": true, "type": "boolean" }, { "name": "balanceOnly", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.IntegrationConfig" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/ByAllAccounts" ], "summary": "Saves ByAllAccounts integration settings.", "operationId": "ByAllAccounts_UpdateConfiguration", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "integrationConfig", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.IntegrationConfig" } }, { "name": "firm", "in": "query", "required": true, "type": "boolean" }, { "name": "balanceOnly", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.IntegrationConfig" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/ByAllAccounts/CreateAdvisorCreds": { "get": { "tags": [ "Integrations/ByAllAccounts" ], "summary": "Creates new advisor level creds", "description": " Sample Request\r\n GET /Integrations/ByAllAccounts/CreateAdvisorCreds\r\n\t\t{\r\n\t\t baaFirmId=1\r\n\t\t}", "operationId": "ByAllAccounts_CreateAdvisorCreds", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "baaFirmID", "in": "query", "description": "the baa firmID", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/ByAllAccounts/CreateInvestorCreds": { "get": { "tags": [ "Integrations/ByAllAccounts" ], "summary": "Creates new investor level creds", "description": " Sample Request\r\n GET /Integrations/ByAllAccounts/CreateInvestorCreds\r\n\t\t{\r\n\t\t baaFirmId=1\r\n\t\t}", "operationId": "ByAllAccounts_CreateInvestorCreds", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "baaFirmID", "in": "query", "description": "the baa firmID", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/ByAllAccounts/Delete/{baaId}/Account/{baaAccountId}": { "delete": { "tags": [ "Integrations/ByAllAccounts" ], "summary": "Delete Account from the UI without using the IFrame.", "operationId": "ByAllAccounts_DeleteAccount", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "baaId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "baaAccountId", "in": "path", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.DeleteAccountResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/ByAllAccounts/GetAccountsAndHoldings": { "get": { "tags": [ "Integrations/ByAllAccounts" ], "summary": "Get the Account and Holdings for the User.", "operationId": "ByAllAccounts_GetAccountsAndHoldings", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.DataGetResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/ByAllAccounts/GetAggregatedAccountData": { "get": { "tags": [ "Integrations/ByAllAccounts" ], "summary": "Get the Account and Holdings for the User.", "operationId": "ByAllAccounts_GetAggregatedAccountData", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.ByAllAggregatedAccountDto" }, "xml": { "name": "ByAllAggregatedAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/ByAllAccounts/Holding/Investor/{key}": { "get": { "tags": [ "Integrations/ByAllAccounts" ], "operationId": "ByAllAccounts_GetHoldingForInvestor", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/ByAllAccounts/SSO": { "get": { "tags": [ "Integrations/ByAllAccounts" ], "operationId": "ByAllAccounts_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "balanceOnly", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/ByAllAccounts/SSOToken": { "get": { "tags": [ "Integrations/ByAllAccounts" ], "summary": "Get the SSO Token. Do not create advisor or investor creds", "description": "Sample Request\r\nGET /Integrations/ByAllAccounts/GetSSOToken\r\n\t{\r\n\t baaFirmId=1\r\n\t}", "operationId": "ByAllAccounts_GetSSOToken", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "baaFirmID", "in": "query", "description": "the baa firmID", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.SSOResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CAIS/InsightUrl": { "get": { "tags": [ "Integrations/CAIS" ], "operationId": "Cais_InsightUrl", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "testEnvironment", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CapitalNetwork/SSO": { "get": { "tags": [ "Integrations/CapitalNetwork" ], "operationId": "CapitalNetwork_iCapitalSAMLAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "relayState", "in": "query", "required": false, "type": "string", "default": "" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Cetera/CRDBD": { "get": { "tags": [ "Integrations/Cetera" ], "operationId": "Cetera_GetCRDBDAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Cetera/SFCase": { "get": { "tags": [ "Integrations/Cetera" ], "operationId": "Cetera_GetCeteraSalesforceCaseAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/Cetera" ], "operationId": "Cetera_PostCeteraSalesforceCaseAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.Cetera.CeteraSFCaseDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Cheetah/Configuration": { "get": { "tags": [ "Integrations/Cheetah" ], "summary": "Retrieves Cheetah Integration details.", "operationId": "Cheetah_GetConfiguration", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.Confirmation.Services.Cheetah.IntegrationConfig" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/Cheetah" ], "summary": "Saves Cheetah integration settings.", "operationId": "Cheetah_UpdateConfiguration", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "config", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Confirmation.Services.Cheetah.IntegrationConfig" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.Confirmation.Services.Cheetah.IntegrationConfig" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/ChicagoClearing/Configuration": { "get": { "tags": [ "Integrations/ChicagoClearing" ], "summary": "Gets the configuration data for ChicagoClearing for the current user.", "operationId": "ChicagoClearing_GetConfigurationAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.PartnerAppConfigurationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/ChicagoClearing/Remove": { "post": { "tags": [ "Integrations/ChicagoClearing" ], "summary": "Removes the ChicagoClearing integration for the current user.", "description": "The user must have the necessary privileges to setup the integration.", "operationId": "ChicagoClearing_RemoveServiceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/ChicagoClearing/RescheduleJob": { "post": { "tags": [ "Integrations/ChicagoClearing" ], "summary": "Update a job schedule for ChicagoClearing for the current user.", "operationId": "ChicagoClearing_ChangeJobScheduleRunTimeAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "description": "A {OAS.WebApi.DTO.Scheduler.JobScheduleUpdateRequest} containing the time of day the job should run. \r\n The date portion of the run time parameter is ignored.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Scheduler.JobScheduleUpdateRequest" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.PartnerAppConfigurationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/ChicagoClearing/RunJobNow": { "post": { "tags": [ "Integrations/ChicagoClearing" ], "summary": "Runs the job schedule for ChicagoClearing for the current user.", "operationId": "ChicagoClearing_RunJobScheduleNowAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "jobScheduleId", "in": "query", "description": "The ID of an existing Job Schedule.", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.PartnerAppConfigurationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/ChicagoClearing/ScheduleJob": { "post": { "tags": [ "Integrations/ChicagoClearing" ], "summary": "Schedules a job schedule for ChicagoClearing for the current user.", "operationId": "ChicagoClearing_CreateNewJobScheduleAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "config", "in": "body", "description": "A {OAS.WebApi.DTO.Integrations.PartnerAppConfigurationDto} with the job schedule's \r\n desired run time and weekendsOnly values set.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.PartnerAppConfigurationDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/ChicagoClearing/Setup": { "post": { "tags": [ "Integrations/ChicagoClearing" ], "summary": "Set up ChicagoClearing integration for the current user.", "description": "The user must have the necessary privileges to setup the integration.", "operationId": "ChicagoClearing_SetupServiceAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "description": "A {OAS.WebApi.DTO.Integrations.PartnerAppConfigurationDto} containing the properties of the integration.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.IntegrationSetupRequestDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.PartnerAppConfigurationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/ChicagoClearing/UnscheduleJob": { "post": { "tags": [ "Integrations/ChicagoClearing" ], "summary": "Removes the job schedule for ChicagoClearing for the current user.", "operationId": "ChicagoClearing_RemoveJobScheduleAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "jobScheduleId", "in": "query", "description": "The ID of an existing Job Schedule.", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.PartnerAppConfigurationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CleverDome/Configuration": { "get": { "tags": [ "Integrations/CleverDome" ], "summary": "Retrieves CleverDome Integration details.", "operationId": "CleverDome_GetConfiguration", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Integrations.CleverDomeController.IntegrationConfigDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/CleverDome" ], "summary": "Saves CleverDome integration settings.", "operationId": "CleverDome_UpdateConfiguration", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "config", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Integrations.CleverDomeController.IntegrationConfigDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Integrations.CleverDomeController.IntegrationConfigDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CleverDome/Configuration/Test": { "get": { "tags": [ "Integrations/CleverDome" ], "summary": "Checks to see if CleverDome integration has been setup for this database.", "operationId": "CleverDome_CheckConfiguration", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/ClientBoxFolder": { "put": { "tags": [ "Integrations/ClientBoxFolder" ], "summary": "Set or clear Box folder ID for a client. Empty boxFolderId clears the configuration.\r\nValidates folder exists in Box before saving.", "operationId": "ClientBoxFolder_SetClientBoxFolderAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "description": "Client ID and Box folder ID", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.ClientBoxFolderSetRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/ClientBoxFolder/{clientId}": { "get": { "tags": [ "Integrations/ClientBoxFolder" ], "summary": "Get Box folder ID configuration for a client", "operationId": "ClientBoxFolder_GetClientBoxFolderAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "description": "Client ID", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/ClientBoxFolder/Bulk": { "post": { "tags": [ "Integrations/ClientBoxFolder" ], "summary": "Bulk import Box folder IDs for multiple clients", "operationId": "ClientBoxFolder_BulkSetClientBoxFoldersAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "description": "Array of client ID and Box folder ID pairs", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.ClientBoxFolderSetRequest" }, "xml": { "name": "ClientBoxFolderSetRequest", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/ClientBoxFolder/Validate": { "post": { "tags": [ "Integrations/ClientBoxFolder" ], "summary": "Validate a Box folder ID and return its path or error", "operationId": "ClientBoxFolder_ValidateBoxFolderAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "description": "Box folder ID to validate", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.ClientBoxFolderValidateRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CloudStorage/{provider}/Action/Share/{filepath}": { "post": { "tags": [ "Integrations/CloudStorage" ], "summary": "Used to generate a share link to a file in cloud storage.", "operationId": "IntegrationsCloudStorage_ShareCloudStorageAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "provider", "in": "path", "required": true, "type": "string", "enum": [ "AdvisorShared", "Box", "Dropbox", "Egnyte", "ShareFile", "NetDocuments" ] }, { "name": "filepath", "in": "path", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CloudStorage/{provider}/Browse/{filepath}": { "get": { "tags": [ "Integrations/CloudStorage" ], "summary": "Used to browse folders and view file meta data from cloud storage.", "operationId": "IntegrationsCloudStorage_BrowseCloudStorageAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "provider", "in": "path", "required": true, "type": "string", "enum": [ "AdvisorShared", "Box", "Dropbox", "Egnyte", "ShareFile", "NetDocuments" ] }, { "name": "filepath", "in": "path", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CloudStorage/{provider}/Credentials": { "put": { "tags": [ "Integrations/CloudStorage" ], "summary": "Used to save cloud storage credentials. Each provider has a different representation of credentials that must be posted as json in the message body.", "operationId": "IntegrationsCloudStorage_PutV1IntegrationsCloudStorageByProviderCredentials", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "provider", "in": "path", "required": true, "type": "string", "enum": [ "AdvisorShared", "Box", "Dropbox", "Egnyte", "ShareFile", "NetDocuments" ] }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/CloudStorage" ], "summary": "Used to save cloud storage credentials. Each provider has a different representation of credentials that must be posted as json in the message body.", "operationId": "IntegrationsCloudStorage_SaveCredentialsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "provider", "in": "path", "required": true, "type": "string", "enum": [ "AdvisorShared", "Box", "Dropbox", "Egnyte", "ShareFile", "NetDocuments" ] }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Integrations/CloudStorage" ], "summary": "Used to remove previously saved cloud storage credentials.", "operationId": "IntegrationsCloudStorage_DeleteCredentialsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "provider", "in": "path", "required": true, "type": "string", "enum": [ "AdvisorShared", "Box", "Dropbox", "Egnyte", "ShareFile", "NetDocuments" ] }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CloudStorage/{provider}/Data/{filepath}": { "get": { "tags": [ "Integrations/CloudStorage" ], "summary": "Used to download a file from cloud storage.", "operationId": "IntegrationsCloudStorage_DownloadCloudStorageAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "provider", "in": "path", "required": true, "type": "string", "enum": [ "AdvisorShared", "Box", "Dropbox", "Egnyte", "ShareFile", "NetDocuments" ] }, { "name": "filepath", "in": "path", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/CloudStorage" ], "summary": "Used to upload a file to cloud storage.", "operationId": "IntegrationsCloudStorage_UploadCloudStorageAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "provider", "in": "path", "required": true, "type": "string", "enum": [ "AdvisorShared", "Box", "Dropbox", "Egnyte", "ShareFile", "NetDocuments" ] }, { "name": "filepath", "in": "path", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Integrations/CloudStorage" ], "summary": "Used to delete a file from cloud storage.", "operationId": "IntegrationsCloudStorage_DeleteCloudStorageAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "provider", "in": "path", "required": true, "type": "string", "enum": [ "AdvisorShared", "Box", "Dropbox", "Egnyte", "ShareFile", "NetDocuments" ] }, { "name": "filepath", "in": "path", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CloudStorage/{provider}/FileById/{itemId}": { "get": { "tags": [ "Integrations/CloudStorage" ], "summary": "Used to download a file from cloud storage.", "operationId": "IntegrationsCloudStorage_DownloadCloudStorageByIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "provider", "in": "path", "required": true, "type": "string", "enum": [ "AdvisorShared", "Box", "Dropbox", "Egnyte", "ShareFile", "NetDocuments" ] }, { "name": "itemId", "in": "path", "description": "The unique ID of the item in cloud storage.", "required": true, "type": "string" }, { "name": "fileName", "in": "query", "description": "The name of the file to be downloaded.", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CloudStorage/{provider}/Redirect": { "get": { "tags": [ "Integrations/CloudStorage" ], "summary": "Used to automatically redirect the user's browser to the appropriate cloud storage provider's oauth page.", "operationId": "IntegrationsCloudStorage_GetRedirectUrlAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "provider", "in": "path", "required": true, "type": "string", "enum": [ "AdvisorShared", "Box", "Dropbox", "Egnyte", "ShareFile", "NetDocuments" ] }, { "name": "url", "in": "query", "description": "Absolute Url", "required": true, "type": "string" }, { "name": "domain", "in": "query", "required": false, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CloudStorage/List": { "get": { "tags": [ "Integrations/CloudStorage" ], "summary": "Used to get list of configured cloud storage providers.", "operationId": "IntegrationsCloudStorage_ListCloudStorageProvidersAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "checkCredentialsValid", "in": "query", "description": "Optional. Default: True. Will validate that the provider is valid before returning it. If false, any provider with credentials saved will be returned.", "required": false, "type": "boolean", "default": true }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "object" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Communities/Custodians/List": { "get": { "tags": [ "Integrations/Communities" ], "summary": "", "operationId": "Communities_GetAllCommunitiesCustodiansAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Communities/DailySyncLogDetails/{key}": { "get": { "tags": [ "Integrations/Communities" ], "summary": "Get daily sync log by processLogId for Communities", "operationId": "Communities_GetDailySyncLogDetails", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string", "format": "byte" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Communities/DailySyncLogs": { "get": { "tags": [ "Integrations/Communities" ], "summary": "Get daily sync logs for Communities", "operationId": "Communities_GetDailySyncLogs", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string", "format": "byte" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Communities/ManagerFactSheet/{modelId}": { "get": { "tags": [ "Integrations/Communities" ], "summary": "Get the model fact sheet from v2 communities", "operationId": "Communities_ManagerFactSheetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "modelId", "in": "path", "description": "key for the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true }, { "name": "requestEntity", "in": "query", "description": "optional parameter to specify the type of entity id passed in. default model with optional modelAgg", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Communities/ModelAllocationHistory/{id}": { "get": { "tags": [ "Integrations/Communities" ], "summary": "Get Model Allocation History by model Id", "operationId": "Communities_GetModelAllocationHistoryAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string", "format": "byte" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Communities/Models": { "get": { "tags": [ "Integrations/Communities" ], "summary": "Gets community models.", "operationId": "Communities_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "strategistId", "in": "query", "description": "Optional. Default: null. When there is value, only the community models for that strategistId will be returned.", "required": false, "type": "integer", "format": "int32" }, { "name": "lastRebalanceDate", "in": "query", "description": "Optional. Default: null. When there is value, only the community models with a LastRebalanceDate > than the date entered will be returned.", "required": false, "type": "string", "format": "date-time" }, { "name": "dateRebalanceRequested", "in": "query", "description": "Optional. Default: null. When true, only the community models with a DateRebalanceRequested > than the date entered will be returned.", "required": false, "type": "string", "format": "date-time" }, { "name": "needsRebalance", "in": "query", "description": "Optional. Default: null. When true, only the community models that have a lastRebalanceDate geater than dateRebalanceRequested will be returned \r\n \t\t\t\t\t\t\t\t\t\t\t\tand when false, only the community models that have a lastRebalanceDate less than dateRebalanceRequested will be returned .", "required": false, "type": "boolean" }, { "name": "managerId", "in": "query", "description": "Optional. Default: null. When there is value, only the community models for that managerId will be returned.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Communities.CommunityModelDto" }, "xml": { "name": "CommunityModelDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Communities/Models/{key}": { "get": { "tags": [ "Integrations/Communities" ], "summary": "Returns the Community model that has the given {key}. If the specified model does not\r\nexist, or isn't accessible to the logged in user, an HTTP 404 status code is returned.", "operationId": "Communities_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Communities.CommunityModelWithDetailsDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/Communities" ], "summary": "Updates the community model that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Communities_UpdateCommunityModelAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Communities.CommunityModelWithDetailsDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Communities.CommunityModelWithDetailsDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Communities/Models/AssignedToAccounts/Validate": { "post": { "tags": [ "Integrations/Communities" ], "operationId": "Communities_CheckCommunityModelsAssignedToAccountsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "communityModelIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "deleteSwitch", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Communities/Models/CountModelsNeedingRebalance": { "get": { "tags": [ "Integrations/Communities" ], "summary": "Gets community models.", "operationId": "Communities_CountModelsNeedingRebalance", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Communities/Models/List": { "post": { "tags": [ "Integrations/Communities" ], "summary": "Returns the models that have the given {keys}.", "operationId": "Communities_GetListByIdAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Communities.CommunityModelWithDetailsDto" }, "xml": { "name": "CommunityModelWithDetailsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Communities/Models/OutsourceModelInfo": { "post": { "tags": [ "Integrations/Communities" ], "operationId": "Communities_CommunityOutSourceModelInfoAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "accountIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Communities/Models/Simple": { "get": { "tags": [ "Integrations/Communities" ], "summary": "Gets community models.", "operationId": "Communities_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "strategistId", "in": "query", "description": "Optional. Default: null. When there is value, only the community models for that strategistId will be returned.", "required": false, "type": "integer", "format": "int32" }, { "name": "lastRebalanceDate", "in": "query", "description": "Optional. Default: null. When there is value, only the community models with a LastRebalanceDate > than the date entered will be returned.", "required": false, "type": "string", "format": "date-time" }, { "name": "dateRebalanceRequested", "in": "query", "description": "Optional. Default: null. When true, only the community models with a DateRebalanceRequested > than the date entered will be returned.", "required": false, "type": "string", "format": "date-time" }, { "name": "needsRebalance", "in": "query", "description": "Optional. Default: null. When true, only the community models that have a lastRebalanceDate geater than dateRebalanceRequested will be returned \r\n \t\t\t\t\t\t\t\t\t\t\t\tand when false, only the community models that have a lastRebalanceDate less than dateRebalanceRequested will be returned .", "required": false, "type": "boolean" }, { "name": "managerId", "in": "query", "description": "Optional. Default: null. When there is value, only the community models for that managerId will be returned.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Integration.Communities.SimpleCommunityModel" }, "xml": { "name": "SimpleCommunityModel", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Communities/Models/SimpleList": { "post": { "tags": [ "Integrations/Communities" ], "summary": "Get Model information by Community Model Id's", "operationId": "Communities_GetSimpleListByCommunityModelIds", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int64" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Communities.CommunityModelSimpleDto" }, "xml": { "name": "CommunityModelSimpleDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Communities/ModelUpdate": { "post": { "tags": [ "Integrations/Communities" ], "summary": "Create, Update, Delete sync of Models from Communities to Orion Connect.", "operationId": "Communities_ModelUpdateFromCommunitiesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "Model data", "required": true, "schema": { "$ref": "#/definitions/OAS.Eclipse.Lambda.Model.CommunitySyncMessageListOfOAS.Eclipse.Lambda.Model.CommunityModel" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Communities/Performance/{modelId}": { "get": { "tags": [ "Integrations/Communities" ], "summary": "Community Model Performance", "operationId": "Communities_CommunityModelPerformanceById", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "modelId", "in": "path", "description": "Community Model Id", "required": true, "type": "integer", "format": "int32" }, { "name": "months", "in": "query", "description": "Number of months for performance", "required": true, "type": "integer", "format": "int32" }, { "name": "rate", "in": "query", "description": "Rate of Return", "required": true, "type": "number", "format": "double" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Communities/Personal/GetPersonalDataForSync": { "post": { "tags": [ "Integrations/Communities" ], "operationId": "Communities_GetPersonalDataForSyncAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "personalIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Communities/ProductExclusions/Sync": { "get": { "tags": [ "Integrations/Communities" ], "operationId": "Communities_GetProductExclusionsForSyncAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Communities/Products/Sync": { "get": { "tags": [ "Integrations/Communities" ], "operationId": "Communities_GetProductsForSyncAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Communities/RemoveRebalanceRequestedDate/{key}": { "put": { "tags": [ "Integrations/Communities" ], "summary": "Removes the rebalance requested date from the community model", "operationId": "Communities_RemoveRebalanceRequestedDateAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Communities/Reports/StrategistAumReport": { "post": { "tags": [ "Integrations/Communities" ], "operationId": "CommunitiesReports_ProcessStrategistAumReport", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integration.Communities.CommunitiesStrategistAumReportRequestDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Communities/Reports/StrategistFlowReport": { "post": { "tags": [ "Integrations/Communities" ], "operationId": "CommunitiesReports_ProcessStrategistFlowReport", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integration.Communities.CommunitiesStrategistFlowReportRequestDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Communities/StrategistTiers": { "get": { "tags": [ "Integrations/Communities" ], "operationId": "Communities_GetStrategistTiersAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Communities/UpdateRebalanceExecutionRequestedDate": { "put": { "tags": [ "Integrations/Communities" ], "summary": "", "operationId": "Communities_UpdateRebalanceExecutionRequestedDateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Communities.CommunitiesRebalanceRequestExecutionDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Configuration/{app}/Client": { "get": { "tags": [ "Integrations/Configuration" ], "summary": "Returns the integration information for the specified ClientId.", "operationId": "Configuration_Client", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "app", "in": "path", "required": true, "type": "string" }, { "name": "clientId", "in": "query", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.IntegrationConfigurationDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/Configuration" ], "operationId": "Configuration_UpdateClientConfig", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "app", "in": "path", "required": true, "type": "string" }, { "name": "config", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.IntegrationConfigurationDto" } }, { "name": "clientId", "in": "query", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.IntegrationConfigurationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Configuration/{app}/Firm": { "get": { "tags": [ "Integrations/Configuration" ], "summary": "Returns the integration information for the current Firm the user is logged into.\r\nThis is helpful for saving firm specific integration information.", "operationId": "Configuration_Firm", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "app", "in": "path", "description": "App Code, supplied by Orion", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.IntegrationConfigurationDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/Configuration" ], "summary": "Updates the Firm level integration Information.", "operationId": "Configuration_UpdateFirmConfig", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "app", "in": "path", "required": true, "type": "string" }, { "name": "config", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.IntegrationConfigurationDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.IntegrationConfigurationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Configuration/{app}/Profile": { "get": { "tags": [ "Integrations/Configuration" ], "summary": "Returns the integraton information for the Profile.\r\nA profile is a User / Firm combination. Some users have access to more than one firm.", "operationId": "Configuration_Profile", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "app", "in": "path", "description": "App Code, supplied by Orion", "required": true, "type": "string" }, { "name": "userDetailId", "in": "query", "description": "Optional. When omitted, the currently logged in profile (userDetailId) is used.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.IntegrationConfigurationDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/Configuration" ], "operationId": "Configuration_UpdateProfileConfig", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "app", "in": "path", "required": true, "type": "string" }, { "name": "config", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.IntegrationConfigurationDto" } }, { "name": "userDetailId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.IntegrationConfigurationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Configuration/{app}/System": { "get": { "tags": [ "Integrations/Configuration" ], "summary": "Returns integration information at a System Level (system level = all orion firms and databases).\r\nThis is helpful for and Orion Id, or a URL that would not change from one firm to another.", "operationId": "Configuration_System", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "app", "in": "path", "description": "App Code, supplied by Orion", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.IntegrationConfigurationDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/Configuration" ], "summary": "Updates the config information for the System Level", "operationId": "Configuration_UpdateSystemConfig", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "app", "in": "path", "description": "App Code, supplied by Orion", "required": true, "type": "string" }, { "name": "config", "in": "body", "description": "Configuration object", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.IntegrationConfigurationDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.IntegrationConfigurationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Configuration/{app}/User": { "get": { "tags": [ "Integrations/Configuration" ], "summary": "Returns integration information for the currently logged in user (if userId=null) or the supplied userid.", "operationId": "Configuration_GetUser", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "app", "in": "path", "description": "App Code, supplied by Orion", "required": true, "type": "string" }, { "name": "userId", "in": "query", "description": "Optional. When used, the integration information is returned for this userId, When omitted, the currently logged in user is used.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.IntegrationConfigurationDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/Configuration" ], "summary": "Updates the integration information for the User.", "operationId": "Configuration_UpdateUserConfig", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "app", "in": "path", "required": true, "type": "string" }, { "name": "config", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.IntegrationConfigurationDto" } }, { "name": "userId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.IntegrationConfigurationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Configuration/Maintenance/BackfillExternalIds": { "post": { "tags": [ "Integrations/Configuration" ], "summary": "Admin-only maintenance endpoint to backfill encryption for existing {OAS.DataModel.Integrations.AppLinkDetail.ExternalId} values.\r\nEncryption is applied only when the oc-integrations-enable-externalid-encryption feature flag is enabled for the firm.", "operationId": "Configuration_BackfillExternalIds", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.ExternalIdEncryptionBackfillRequestDto" } }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/AkoyaAccounts": { "get": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Get all AkoyaAccounts.", "operationId": "AkoyaAccounts_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.AkoyaAccountDto" }, "xml": { "name": "AkoyaAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/AkoyaAccounts/{key}": { "get": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Gets the AkoyaAccount that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "AkoyaAccounts_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.AkoyaAccountDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Updates the AkoyaAccount that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "AkoyaAccounts_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired update object.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "AkoyaAccount object to update", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.AkoyaAccountDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.AkoyaAccountDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/AkoyaAccounts/Logs": { "get": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Gets Account Logs from the database.\r\n{\r\n akoyaAccountId=123ABC\r\n startDate=10-19-2023\r\n endDate=10-29-2023\r\n}", "operationId": "AkoyaAccounts_GetLogs", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "akoyaAccountId", "in": "query", "description": "the akoya Account id", "required": false, "type": "string" }, { "name": "startDate", "in": "query", "description": "start date to use for filtering start date range", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "end date to use for filter end date range", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.AkoyaLogDto" }, "xml": { "name": "AkoyaLogDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/AkoyaAccounts/Simple": { "get": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Gets Akoya Accounts simple object", "operationId": "AkoyaAccounts_GetSimpleEntities", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "query", "description": "House Hold ID", "required": false, "type": "integer", "format": "int32" }, { "name": "isLinked", "in": "query", "description": "determines whether to return unlinked akoya accounts", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleStringKeyEntity" }, "xml": { "name": "SimpleStringKeyEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/AkoyaGlobalSymbols": { "get": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Get all AkoyaGlobalSymbols.", "operationId": "AkoyaGlobalSymbol_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.AkoyaGlobalSymbolDto" }, "xml": { "name": "AkoyaGlobalSymbolDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/CustodialIntegrator" ], "operationId": "AkoyaGlobalSymbol_UpsertAkoyaGlobalSymbolsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "akoyaGlobalDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.AkoyaGlobalSymbolDto" } }, { "name": "token", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.AkoyaGlobalSymbolDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/AkoyaGlobalSymbols/Delete": { "post": { "tags": [ "Integrations/CustodialIntegrator" ], "operationId": "AkoyaGlobalSymbol_DeleteAkoyaGlobalSymbolsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "globalSymbolDtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.AkoyaGlobalSymbolDto" }, "xml": { "name": "AkoyaGlobalSymbolDto", "wrapped": true }, "type": "array" } }, { "name": "token", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.AkoyaGlobalSymbolDto" }, "xml": { "name": "AkoyaGlobalSymbolDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/AkoyaGlobalSymbols/Institutions": { "get": { "tags": [ "Integrations/CustodialIntegrator" ], "operationId": "AkoyaGlobalSymbol_GetAllInstitutions", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Integration.CustodialIntegrator.AkoyaInstitution" }, "xml": { "name": "AkoyaInstitution", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/ByAllAccounts": { "get": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Get all ByAllAccounts.", "operationId": "CustodialIntegratorByAllAccounts_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllAccountDto" }, "xml": { "name": "ByAllAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Adds a new ByAllAccount to the database.", "operationId": "CustodialIntegratorByAllAccounts_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "ByAllAccount object to update", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllAccountDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllAccountDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/ByAllAccounts/{key}": { "get": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Gets the ByAllAccount that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "CustodialIntegratorByAllAccounts_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllAccountDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Updates the ByAllAccount that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "CustodialIntegratorByAllAccounts_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired update object.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "ByAllAccount object to update", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllAccountDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllAccountDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/ByAllAccounts/Action/Backdate": { "put": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Backdates a list of ByAllAccounts to the specified date.", "operationId": "CustodialIntegratorByAllAccounts_ActionBackdateAccounts", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "backdateDetails", "in": "body", "description": "Composed of a list of ByAllAccount objects to backdate and a start date.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CustodialIntegrator.BackdateByAllAccountDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllAccountDto" }, "xml": { "name": "ByAllAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/ByAllAccounts/Action/Delete": { "put": { "tags": [ "Integrations/CustodialIntegrator" ], "operationId": "CustodialIntegratorByAllAccounts_ActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/ByAllGlobalSymbols": { "get": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Get all ByAllGlobalSymbols.", "operationId": "ByAllGlobalSymbols_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllGlobalSymbolDto" }, "xml": { "name": "ByAllGlobalSymbolDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Adds a new ByAllGlobalSymbol to the database.", "operationId": "ByAllGlobalSymbols_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "ByAllGlobalSymbol object to update", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllGlobalSymbolDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllGlobalSymbolDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/ByAllGlobalSymbols/{key}": { "get": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Gets the ByAllGlobalSymbol that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ByAllGlobalSymbols_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllGlobalSymbolDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Updates the ByAllGlobalSymbol that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ByAllGlobalSymbols_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired update object.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "ByAllGlobalSymbol object to update", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllGlobalSymbolDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllGlobalSymbolDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/ByAllGlobalSymbols/Action/Delete": { "put": { "tags": [ "Integrations/CustodialIntegrator" ], "operationId": "ByAllGlobalSymbols_ActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/ByAllLocalSymbols": { "get": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Get all ByAllLocalSymbols.", "operationId": "ByAllLocalSymbols_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllLocalSymbolDto" }, "xml": { "name": "ByAllLocalSymbolDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Adds a new ByAllLocalSymbol to the database.", "operationId": "ByAllLocalSymbols_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "ByAllLocalSymbol object to update", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllLocalSymbolDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllLocalSymbolDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/ByAllLocalSymbols/{key}": { "get": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Gets the ByAllLocalSymbol that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ByAllLocalSymbols_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllLocalSymbolDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Updates the ByAllLocalSymbol that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ByAllLocalSymbols_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired update object.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "ByAllLocalSymbol object to update", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllLocalSymbolDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllLocalSymbolDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/ByAllLocalSymbols/Action/Delete": { "put": { "tags": [ "Integrations/CustodialIntegrator" ], "operationId": "ByAllLocalSymbols_ActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/ByAllNoteMappings": { "get": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Get all ByAllByAllNoteMappings.", "operationId": "ByAllNoteMappings_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllNoteMappingDto" }, "xml": { "name": "ByAllNoteMappingDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Adds a new ByAllNoteMapping to the database.", "operationId": "ByAllNoteMappings_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "ByAllNoteMapping object to update", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllNoteMappingDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllNoteMappingDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/ByAllNoteMappings/{key}": { "get": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Gets the ByAllNoteMapping that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ByAllNoteMappings_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllNoteMappingDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Updates the ByAllNoteMapping that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ByAllNoteMappings_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired update object.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "ByAllNoteMapping object to update", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllNoteMappingDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllNoteMappingDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/ByAllNoteMappings/Action/Delete": { "put": { "tags": [ "Integrations/CustodialIntegrator" ], "operationId": "ByAllNoteMappings_ActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/ByAllOffsetSymbol": { "get": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Get all Offset Symbols.", "operationId": "ByAllOffsetSymbol_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllOffsetSymbolDto" }, "xml": { "name": "ByAllOffsetSymbolDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Create new Offset Symbol", "operationId": "ByAllOffsetSymbol_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "ByAllOffsetSymbolMapping object ot update", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllOffsetSymbolDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllOffsetSymbolDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/ByAllOffsetSymbol/{key}": { "get": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Get Offset Symbol by key.", "operationId": "ByAllOffsetSymbol_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desir4ed return object", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllOffsetSymbolDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Update Offset Symbol by key", "operationId": "ByAllOffsetSymbol_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllOffsetSymbolDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllOffsetSymbolDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/ByAllOffsetSymbol/Action/Delete": { "put": { "tags": [ "Integrations/CustodialIntegrator" ], "operationId": "ByAllOffsetSymbol_ActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/ByAllTreatments": { "get": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Get all ByAllTreatments.", "operationId": "ByAllTreatments_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllTreatmentDto" }, "xml": { "name": "ByAllTreatmentDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Adds a new ByAllTreatment to the database.", "operationId": "ByAllTreatments_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "ByAllTreatment object to update", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllTreatmentDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllTreatmentDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/ByAllTreatments/{key}": { "get": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Gets the ByAllTreatment that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ByAllTreatments_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllTreatmentDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Updates the ByAllTreatment that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ByAllTreatments_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired update object.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "ByAllTreatment object to update", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllTreatmentDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllTreatmentDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/ByAllTreatments/Action/Delete": { "put": { "tags": [ "Integrations/CustodialIntegrator" ], "operationId": "ByAllTreatments_ActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/ByAllTreatmentTypes": { "get": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Get all ByAllTreatmentTypes.", "operationId": "ByAllTreatmentTypes_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllTreatmentTypeDto" }, "xml": { "name": "ByAllTreatmentTypeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/PlaidAccounts": { "get": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Gets all of the Plaid accounts.", "operationId": "PlaidAccount_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.PlaidAccountDto" }, "xml": { "name": "PlaidAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/PlaidAccounts/{key}": { "get": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Gets the PlaidAccount that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "PlaidAccount_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.PlaidAccountDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Updates the PlaidAccount that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "PlaidAccount_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired update object.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "PlaidAccount object to update", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.PlaidAccountDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.PlaidAccountDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/PlaidNoteMappings": { "get": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Get all PlaidNoteMappings.", "operationId": "PlaidNoteMappings_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.PlaidNoteMappingDto" }, "xml": { "name": "PlaidNoteMappingDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "", "operationId": "PlaidNoteMappings_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "PlaidNoteMapping to add to the database", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.PlaidNoteMappingDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.PlaidNoteMappingDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/PlaidNoteMappings/{key}": { "get": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Gets the PlaidNoteMapping that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "PlaidNoteMappings_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.PlaidNoteMappingDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Updates the PlaidNoteMapping that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "PlaidNoteMappings_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired update object.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "PlaidNoteMapping object to update", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.PlaidNoteMappingDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.PlaidNoteMappingDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/PlaidNoteMappings/Action/Delete": { "put": { "tags": [ "Integrations/CustodialIntegrator" ], "operationId": "PlaidNoteMappings_ActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/PlaidSecurityMappings": { "get": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Get all PlaidSecurityMappings.", "operationId": "PlaidSecurityMappings_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.PlaidSecurityMappingDto" }, "xml": { "name": "PlaidSecurityMappingDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "", "operationId": "PlaidSecurityMappings_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "PlaidSecurityMapping to add to the database", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.PlaidSecurityMappingDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.PlaidSecurityMappingDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/PlaidSecurityMappings/{key}": { "get": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Gets the PlaidSecurityMapping that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "PlaidSecurityMappings_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.PlaidSecurityMappingDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Updates the PlaidSecurityMapping that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "PlaidSecurityMappings_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired update object.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "PlaidSecurityMapping object to update", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.PlaidSecurityMappingDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.PlaidSecurityMappingDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/PlaidSecurityMappings/Action/Delete": { "put": { "tags": [ "Integrations/CustodialIntegrator" ], "operationId": "PlaidSecurityMappings_ActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/PlaidUnitBalanceOverrides": { "get": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Get all PlaidUnitBalanceOverrides.", "operationId": "PlaidUnitBalanceOverrides_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.PlaidUnitBalanceOverrideDto" }, "xml": { "name": "PlaidUnitBalanceOverrideDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "", "operationId": "PlaidUnitBalanceOverrides_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "PlaidUnitBalanceOverride to add to the database", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.PlaidUnitBalanceOverrideDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.PlaidUnitBalanceOverrideDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/PlaidUnitBalanceOverrides/{key}": { "get": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Gets the PlaidUnitBalanceOverride that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "PlaidUnitBalanceOverrides_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.PlaidUnitBalanceOverrideDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/CustodialIntegrator" ], "summary": "Updates the PlaidUnitBalanceOverride that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "PlaidUnitBalanceOverrides_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired update object.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "PlaidUnitBalanceOverride object to update", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.PlaidUnitBalanceOverrideDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.PlaidUnitBalanceOverrideDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodialIntegrator/PlaidUnitBalanceOverrides/Action/Delete": { "put": { "tags": [ "Integrations/CustodialIntegrator" ], "operationId": "PlaidUnitBalanceOverrides_ActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Custodian/Account/{accountId}": { "get": { "tags": [ "Integrations/Custodian" ], "operationId": "Custodian_GetCustodianForClientAccountAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellation", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Custodian/Account/{accountId}/FidelityType": { "get": { "tags": [ "Integrations/Custodian" ], "operationId": "Custodian_GetFidelityTypeForClientAccountAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellation", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Custodian/Client/{clientId}": { "get": { "tags": [ "Integrations/Custodian" ], "operationId": "Custodian_GetCustodianForClientAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellation", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Custodian/Document": { "get": { "tags": [ "Integrations/Custodian" ], "operationId": "Custodian_GetFolders", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Custodian/Document/{custodian}/{documentType}": { "get": { "tags": [ "Integrations/Custodian" ], "summary": "Returns the document.", "operationId": "Custodian_GetV1IntegrationsCustodianDocumentByCustodianByDocumentType", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "custodian", "in": "path", "required": true, "type": "string", "enum": [ "Pershing", "Apex", "TD", "Schwab", "Fidelity", "GoldmanSachs", "Axos", "Undefined", "Brinker_Fidelity", "Arch" ] }, { "name": "documentType", "in": "path", "required": true, "type": "string", "enum": [ "GENERAL_DOCUMENT", "STATEMENTS", "CONFIRMS", "TAX_STATEMENTS", "NOTIFICATIONS", "LETTERS", "CORRESPONDENCE", "TRADES", "THIRD_PARTY_REPORTS", "Tax1099", "Tax1099R", "Tax5489" ] }, { "name": "id", "in": "query", "required": true, "type": "string" }, { "name": "fileName", "in": "query", "required": false, "type": "string", "default": "" }, { "name": "custodianToken", "in": "query", "required": false, "type": "string" }, { "name": "accountNumber", "in": "query", "required": false, "type": "string", "default": "" }, { "name": "accountType", "in": "query", "required": false, "type": "string", "default": "" }, { "name": "taxDocType", "in": "query", "required": false, "type": "string", "default": "" }, { "name": "reportType", "in": "query", "required": false, "type": "string", "default": "" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Custodian/Document/{custodian}/{documentType}/{id}": { "get": { "tags": [ "Integrations/Custodian" ], "summary": "Returns the document.", "operationId": "Custodian_GetDocumentAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "custodian", "in": "path", "required": true, "type": "string", "enum": [ "Pershing", "Apex", "TD", "Schwab", "Fidelity", "GoldmanSachs", "Axos", "Undefined", "Brinker_Fidelity", "Arch" ] }, { "name": "documentType", "in": "path", "required": true, "type": "string", "enum": [ "GENERAL_DOCUMENT", "STATEMENTS", "CONFIRMS", "TAX_STATEMENTS", "NOTIFICATIONS", "LETTERS", "CORRESPONDENCE", "TRADES", "THIRD_PARTY_REPORTS", "Tax1099", "Tax1099R", "Tax5489" ] }, { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "fileName", "in": "query", "required": false, "type": "string", "default": "" }, { "name": "custodianToken", "in": "query", "required": false, "type": "string" }, { "name": "accountNumber", "in": "query", "required": false, "type": "string", "default": "" }, { "name": "accountType", "in": "query", "required": false, "type": "string", "default": "" }, { "name": "taxDocType", "in": "query", "required": false, "type": "string", "default": "" }, { "name": "reportType", "in": "query", "required": false, "type": "string", "default": "" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Custodian/Document/Client/{clientId}": { "get": { "tags": [ "Integrations/Custodian" ], "summary": "This is the starting point for getting Client Custodian Documents.", "operationId": "Custodian_GetSetUpCustodianForClientAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Custodian/Document/Client/BrinkerTest/{clientId}": { "get": { "tags": [ "Integrations/Custodian" ], "operationId": "Custodian_TestBrinkerAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Custodian/Document/Custodian/{custodian}/Client/{orionClientId}": { "get": { "tags": [ "Integrations/Custodian" ], "summary": "Get documents for by custodian and client Id", "operationId": "Custodian_GetDocumentsByClientAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "custodian", "in": "path", "description": "The custodian to use.", "required": true, "type": "string", "enum": [ "Pershing", "Apex", "TD", "Schwab", "Fidelity", "GoldmanSachs", "Axos", "Undefined", "Brinker_Fidelity", "Arch" ] }, { "name": "orionClientId", "in": "path", "description": "The Orion Client ID", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "description": "Optional starting date range. If null the last year will be returned.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional ending date range. If null the last year will be returned.", "required": false, "type": "string", "format": "date-time" }, { "name": "documentTypes", "in": "query", "description": "The types of documents you want back. If null all will be returned.", "required": false, "items": { "type": "string", "enum": [ "GENERAL_DOCUMENT", "STATEMENTS", "CONFIRMS", "TAX_STATEMENTS", "NOTIFICATIONS", "LETTERS", "CORRESPONDENCE", "TRADES", "THIRD_PARTY_REPORTS", "Tax1099", "Tax1099R", "Tax5489" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "custodianToken", "in": "query", "description": "A token to be passed to the custodian.", "required": false, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodianDashboard/Account/{accountId}": { "get": { "tags": [ "Integrations/CustodianDashboard" ], "operationId": "CustodianDashboard_GetInitAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodianDashboard/AccountBalance/Account/{accountId}": { "get": { "tags": [ "Integrations/CustodianDashboard" ], "operationId": "CustodianDashboard_GetAccountBalanceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodianDashboard/Alerts/Account/{accountId}": { "get": { "tags": [ "Integrations/CustodianDashboard" ], "operationId": "CustodianDashboard_GetAlertsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodianDashboard/Alerts/Account/{accountId}/{alertId}": { "get": { "tags": [ "Integrations/CustodianDashboard" ], "operationId": "CustodianDashboard_GetAlertDetailsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "alertId", "in": "path", "required": true, "type": "string" }, { "name": "masterAccountNumber", "in": "query", "required": false, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodianDashboard/Auth/Account/{accountId}": { "get": { "tags": [ "Integrations/CustodianDashboard" ], "operationId": "CustodianDashboard_GetAuthAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodianDashboard/costbasis/positions/Account/{accountId}": { "get": { "tags": [ "Integrations/CustodianDashboard" ], "operationId": "CustodianDashboard_GetCostbasisPositionAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodianDashboard/costbasis/transactions/Account/{accountId}": { "get": { "tags": [ "Integrations/CustodianDashboard" ], "operationId": "CustodianDashboard_GetCostbasisTransactionsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodianDashboard/Documents/Account/{accountId}": { "get": { "tags": [ "Integrations/CustodianDashboard" ], "operationId": "CustodianDashboard_GetDocumentsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodianDashboard/Documents/Account/{accountId}/DocumentType/{documentType}": { "get": { "tags": [ "Integrations/CustodianDashboard" ], "operationId": "CustodianDashboard_DownloadDocumentAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "documentType", "in": "path", "required": true, "type": "string" }, { "name": "documentId", "in": "query", "required": true, "type": "string" }, { "name": "documentName", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodianDashboard/Positions/Account/{accountId}": { "get": { "tags": [ "Integrations/CustodianDashboard" ], "operationId": "CustodianDashboard_GetPositionsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodianDashboard/RefreshToken": { "get": { "tags": [ "Integrations/CustodianDashboard" ], "operationId": "CustodianDashboard_RefreshTokenAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodianDashboard/SI/AccountId/{accountId}": { "get": { "tags": [ "Integrations/CustodianDashboard" ], "operationId": "CustodianDashboard_StandInstructAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "masterAccount", "in": "query", "required": false, "type": "string" }, { "name": "account", "in": "query", "required": false, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodianDashboard/SI/Details/AccountId/{accountId}": { "get": { "tags": [ "Integrations/CustodianDashboard" ], "operationId": "CustodianDashboard_StandInstructDetsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "masterAccount", "in": "query", "required": false, "type": "string" }, { "name": "account", "in": "query", "required": false, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodianDashboard/SI/Details/ByDetailId/{detailId}/master/{masterAccount}/account/{account}": { "get": { "tags": [ "Integrations/CustodianDashboard" ], "operationId": "CustodianDashboard_StandInstructByIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "detailId", "in": "path", "required": true, "type": "string" }, { "name": "masterAccount", "in": "path", "required": true, "type": "string" }, { "name": "account", "in": "path", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodianDashboard/Transactions/Account/{accountId}": { "get": { "tags": [ "Integrations/CustodianDashboard" ], "operationId": "CustodianDashboard_GetTransactionsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodianDocuments/Advisor/Account/{accountId}": { "get": { "tags": [ "Integrations/CustodianDocuments" ], "operationId": "CustodianDocumentsAdvisor_GetCustodianForAccountAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodianDocuments/Advisor/Client/{clientId}": { "get": { "tags": [ "Integrations/CustodianDocuments" ], "operationId": "CustodianDocumentsAdvisor_GetCustodianForClientAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodianDocuments/Advisor/Custodian/{custodian}/Account/{accountId}": { "get": { "tags": [ "Integrations/CustodianDocuments" ], "operationId": "CustodianDocumentsAdvisor_GetDocumentListForAccountAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "custodian", "in": "path", "required": true, "type": "string", "enum": [ "Pershing", "Apex", "TD", "Schwab", "Fidelity", "GoldmanSachs", "Axos", "Undefined", "Brinker_Fidelity", "Arch" ] }, { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodianDocuments/Advisor/Custodian/{custodian}/Client/{clientId}": { "get": { "tags": [ "Integrations/CustodianDocuments" ], "operationId": "CustodianDocumentsAdvisor_GetDocumentListForClientAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "custodian", "in": "path", "required": true, "type": "string", "enum": [ "Pershing", "Apex", "TD", "Schwab", "Fidelity", "GoldmanSachs", "Axos", "Undefined", "Brinker_Fidelity", "Arch" ] }, { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/CustodianDocuments/Advisor/Download/{custodian}/{documentType}/{id}": { "get": { "tags": [ "Integrations/CustodianDocuments" ], "operationId": "CustodianDocumentsAdvisor_AdvisorGetDocumentAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "custodian", "in": "path", "required": true, "type": "string", "enum": [ "Pershing", "Apex", "TD", "Schwab", "Fidelity", "GoldmanSachs", "Axos", "Undefined", "Brinker_Fidelity", "Arch" ] }, { "name": "documentType", "in": "path", "required": true, "type": "string", "enum": [ "GENERAL_DOCUMENT", "STATEMENTS", "CONFIRMS", "TAX_STATEMENTS", "NOTIFICATIONS", "LETTERS", "CORRESPONDENCE", "TRADES", "THIRD_PARTY_REPORTS", "Tax1099", "Tax1099R", "Tax5489" ] }, { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "fileName", "in": "query", "required": false, "type": "string", "default": "" }, { "name": "custodianToken", "in": "query", "required": false, "type": "string" }, { "name": "accountNumber", "in": "query", "required": false, "type": "string", "default": "" }, { "name": "accountType", "in": "query", "required": false, "type": "string", "default": "" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/DataTransmissionService/{vendorCode}/documents/{documentCategory}": { "get": { "tags": [ "Integrations/DataTransmissionService" ], "summary": "Gets a paged list of documents for a vendor.", "operationId": "DataTransmissionService_GetDocumentsPagedAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "vendorCode", "in": "path", "description": "Vendor code (e.g., Arch, GoldmanSachs)", "required": true, "type": "string" }, { "name": "documentCategory", "in": "path", "description": "Document category - possible values: Activity, Holding, TaxDocument", "required": true, "type": "string" }, { "name": "holdingId", "in": "query", "description": "Filter by holding ID (applicable for Activity category)", "required": false, "type": "integer", "format": "int32" }, { "name": "after", "in": "query", "description": "Filter activities after this date (applicable for Activity category)", "required": false, "type": "string", "format": "date-time" }, { "name": "before", "in": "query", "description": "Filter activities before this date (applicable for Activity category)", "required": false, "type": "string", "format": "date-time" }, { "name": "afterStatementDate", "in": "query", "description": "Filter activities after statement date (applicable for Arch Activity category)", "required": false, "type": "string", "format": "date-time" }, { "name": "beforeStatementDate", "in": "query", "description": "Filter activities before statement date (applicable for Arch Activity category)", "required": false, "type": "string", "format": "date-time" }, { "name": "accountIds", "in": "query", "description": "Comma-separated account IDs (applicable for Arch Activity category)", "required": false, "type": "string" }, { "name": "types", "in": "query", "description": "Comma-separated activity types (applicable for Arch Activity category)", "required": false, "type": "string" }, { "name": "year", "in": "query", "description": "Filter by tax year (applicable for TaxDocument category)", "required": false, "type": "integer", "format": "int32" }, { "name": "limit", "in": "query", "description": "Page size (default: 25)", "required": false, "type": "integer", "format": "int32", "default": 25 }, { "name": "offset", "in": "query", "description": "Page offset (default: 0)", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "ct", "in": "header", "description": "Cancellation token", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/DataTransmissionService/{vendorCode}/documents/{documentCategory}/{entityId}/Files": { "get": { "tags": [ "Integrations/DataTransmissionService" ], "summary": "Gets files for a specific document entity.", "operationId": "DataTransmissionService_GetDocumentFilesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "vendorCode", "in": "path", "description": "Vendor code (e.g., Arch, GoldmanSachs)", "required": true, "type": "string" }, { "name": "documentCategory", "in": "path", "description": "Document category - possible values: Activity, Holding, TaxDocument", "required": true, "type": "string" }, { "name": "entityId", "in": "path", "description": "Entity ID", "required": true, "type": "string" }, { "name": "ct", "in": "header", "description": "Cancellation token", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/DataTransmissionService/{vendorCode}/documents/{documentCategory}/{entityId}/Files/{fileId}/Download": { "get": { "tags": [ "Integrations/DataTransmissionService" ], "summary": "Downloads a file for a specific document entity.", "operationId": "DataTransmissionService_DownloadDocumentFileAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "vendorCode", "in": "path", "description": "Vendor code (e.g., Arch, GoldmanSachs)", "required": true, "type": "string" }, { "name": "documentCategory", "in": "path", "description": "Document category - possible values: Activity, Holding, TaxDocument", "required": true, "type": "string" }, { "name": "entityId", "in": "path", "description": "Entity ID", "required": true, "type": "string" }, { "name": "fileId", "in": "path", "description": "File ID", "required": true, "type": "string" }, { "name": "ct", "in": "header", "description": "Cancellation token", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/DataTransmissionService/CurrentUser": { "get": { "tags": [ "Integrations/DataTransmissionService" ], "operationId": "DataTransmissionService_GetCurrentUserAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/DataTransmissionService/FirmVendor/{vendorCode}": { "get": { "tags": [ "Integrations/DataTransmissionService" ], "summary": "Gets firm vendor configuration for the specified vendor code.", "operationId": "DataTransmissionServiceFirmVendor_GetFirmVendorAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "vendorCode", "in": "path", "description": "The vendor code (e.g., \"GoldmanSachs\")", "required": true, "type": "string" }, { "name": "ct", "in": "header", "description": "Cancellation token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Integrations/DataTransmissionService" ], "summary": "Deletes firm vendor configuration for the specified vendor.", "operationId": "DataTransmissionServiceFirmVendor_DeleteFirmVendorAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "vendorCode", "in": "path", "description": "The vendor code (e.g., \"GoldmanSachs\")", "required": true, "type": "string" }, { "name": "ct", "in": "header", "description": "Cancellation token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/DataTransmissionService/FirmVendor/{vendorCode}/credentials": { "post": { "tags": [ "Integrations/DataTransmissionService" ], "summary": "Creates or updates firm vendor credentials for the specified vendor.", "operationId": "DataTransmissionServiceFirmVendor_CreateOrUpdateFirmVendorCredentialsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "vendorCode", "in": "path", "description": "The vendor code (e.g., \"GoldmanSachs\")", "required": true, "type": "string" }, { "name": "firmVendorDto", "in": "body", "description": "The firm vendor credentials", "required": true, "schema": { "$ref": "#/definitions/OAS.Integrations.DataTransmissionService.DTOs.FirmVendorInputDto" } }, { "name": "ct", "in": "header", "description": "Cancellation token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/DataTransmissionService/FirmVendor/{vendorCode}/established": { "get": { "tags": [ "Integrations/DataTransmissionService" ], "summary": "Checks if firm vendor credentials are established for the specified vendor.", "operationId": "DataTransmissionServiceFirmVendor_GetFirmVendorIsEstablishedAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "vendorCode", "in": "path", "description": "The vendor code (e.g., \"GoldmanSachs\")", "required": true, "type": "string" }, { "name": "ct", "in": "header", "description": "Cancellation token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/DataTransmissionService/GoldmanSachs/Beneficiaries": { "get": { "tags": [ "Integrations/DataTransmissionService" ], "operationId": "DataTransmissionService_GetBeneficiariesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/DataTransmissionService/GoldmanSachs/RMD": { "get": { "tags": [ "Integrations/DataTransmissionService" ], "operationId": "DataTransmissionService_GetRmdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/DataTransmissionService/GoldmanSachs/SsoSignInUrl": { "get": { "tags": [ "Integrations/DataTransmissionService" ], "summary": "Gets the vendor sign-in URL for Inbound SSO (Part B). Use after Part A authorization to open vendor portal in new tab.", "operationId": "DataTransmissionService_GetGoldmanSachsSsoSignInUrlAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "landingPage", "in": "query", "description": "Optional landing page for deep links", "required": false, "type": "string", "enum": [ "None", "Home", "Accounts", "AccountOpening", "AwaitingClientAction", "ClientOverview", "AccountPositions", "ActivityAndOrders", "LinkedBankAccounts", "AccountProfile" ] }, { "name": "ct", "in": "header", "required": false }, { "name": "context.memberId", "in": "query", "required": false, "type": "string" }, { "name": "context.accountId", "in": "query", "required": false, "type": "string" }, { "name": "context.accountNumber", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/DataTransmissionService/GoldmanSachs/SsoUrl": { "get": { "tags": [ "Integrations/DataTransmissionService" ], "summary": "Gets the URL to initiate Goldman Sachs SSO (Part A - Authorize). Redirect user to this URL to start OAuth.", "operationId": "DataTransmissionService_GetGoldmanSachsSsoUrlAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "landingPage", "in": "query", "description": "Landing page after auth. Defaults to Home. Use None for Ok(\"Success!\") response.", "required": false, "type": "string", "default": 1, "enum": [ "None", "Home", "Accounts", "AccountOpening", "AwaitingClientAction", "ClientOverview", "AccountPositions", "ActivityAndOrders", "LinkedBankAccounts", "AccountProfile" ] }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/DataTransmissionService/GoldmanSachs/TokenEstablished": { "get": { "tags": [ "Integrations/DataTransmissionService" ], "summary": "Checks if the current user has completed Goldman Sachs OAuth and has a token established.", "operationId": "DataTransmissionService_IsGoldmanSachsTokenEstablishedAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Dimensional/Action/SAML": { "get": { "tags": [ "Integrations/Dimensional" ], "operationId": "Dimensional_StartSSOAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Docusign/DeleteDocusignLogin": { "delete": { "tags": [ "Integrations/Docusign" ], "summary": "Uses callback code to get IntegrationInfo for DocuSign.", "operationId": "Docusign_Delete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "appLinkDtlId", "in": "query", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Docusign/GetEnvelope": { "get": { "tags": [ "Integrations/Docusign" ], "summary": "Get Account information.", "operationId": "Docusign_GetEnvelope", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "query", "required": true, "type": "string" }, { "name": "envelopeId", "in": "query", "required": true, "type": "string" }, { "name": "base_uri", "in": "query", "required": true, "type": "string" }, { "name": "appLinkDtlId", "in": "query", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.DocuSign.Models.Envelope" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Docusign/GetToken": { "get": { "tags": [ "Integrations/Docusign" ], "summary": "Uses callback code to get IntegrationInfo for DocuSign.", "operationId": "Docusign_GetToken", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "code", "in": "query", "required": true, "type": "string" }, { "name": "name", "in": "query", "required": false, "type": "string" }, { "name": "appLinkDtl", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "level", "in": "query", "required": false, "type": "string", "enum": [ "System", "Firm", "User", "UserProfile", "Client", "Custodian", "Rep" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Docusign.DocusignAppLinkDtlDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Docusign/GetUserInfo": { "get": { "tags": [ "Integrations/Docusign" ], "summary": "Exchanges refresh token for new access token.", "operationId": "Docusign_GetUserInfo", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "appLinkDtlId", "in": "query", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.DocuSign.Models.LoginAccountContainer" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Docusign/Logins": { "get": { "tags": [ "Integrations/Docusign" ], "summary": "Get the Account logins for the user.", "operationId": "Docusign_GetLogins", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Docusign.DocusignAppLinkDtlDto" }, "xml": { "name": "DocusignAppLinkDtlDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Docusign/Redirect": { "get": { "tags": [ "Integrations/Docusign" ], "summary": "Uses DocuSign to add new account.", "operationId": "Docusign_GetRedirectUrl", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "authorization", "in": "query", "required": true, "type": "string" }, { "name": "state", "in": "query", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Docusign/RefreshToken": { "get": { "tags": [ "Integrations/Docusign" ], "summary": "Exchanges refresh token for new access token.", "operationId": "Docusign_UseRefreshToken", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "appLinkDtlId", "in": "query", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Docusign.DocusignAppLinkDtlDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Docusign/SaveEnvelope": { "post": { "tags": [ "Integrations/Docusign" ], "summary": "Uses callback code to get IntegrationInfo for DocuSign.", "operationId": "Docusign_SaveEnvelope", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "envelope", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Integration.Docusign.DocusignEnvelope" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Docusign/SaveIntegrationInfo": { "put": { "tags": [ "Integrations/Docusign" ], "summary": "Uses callback code to get IntegrationInfo for DocuSign.", "operationId": "Docusign_SaveIntegrationInfo", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "info", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.DocuSign.Models.IntegrationInfo" } }, { "name": "level", "in": "query", "required": true, "type": "string", "enum": [ "System", "Firm", "User", "UserProfile", "Client", "Custodian", "Rep" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.DocuSign.Models.IntegrationInfo" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Docusign/Sign/Selfservice": { "post": { "tags": [ "Integrations/Docusign" ], "operationId": "Docusign_SelfServiceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "query", "required": true, "type": "string" }, { "name": "baseUri", "in": "query", "required": true, "type": "string" }, { "name": "appLinkDtlId", "in": "query", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.DocuSign.Models.EnvelopeResult" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/DPL/AcceptTos": { "post": { "tags": [ "Integrations/DPL" ], "operationId": "Dpl_UpdateTosStatusAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/DPL/IsEnabled": { "get": { "tags": [ "Integrations/DPL" ], "operationId": "Dpl_IsDplEnabledAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/DPL/TosStatus": { "get": { "tags": [ "Integrations/DPL" ], "operationId": "Dpl_GetTosStatusAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/DPL/WidgetConfig": { "get": { "tags": [ "Integrations/DPL" ], "operationId": "Dpl_GetWidgetConfigAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/Accounts/{accountId}/Holdings": { "get": { "tags": [ "Integrations/Eclipse" ], "summary": "", "operationId": "IntegrationsEclipse_GetHoldingsByAccount", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseHolding" }, "xml": { "name": "EclipseHolding", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/Accounts/External/{externalAccountId}": { "get": { "tags": [ "Integrations/Eclipse" ], "summary": "Return the Eclipse account based on OC account and firm ids", "operationId": "IntegrationsEclipse_GetEclipseAccountByExternalId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "externalAccountId", "in": "path", "description": "Orion Connect Account ID", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.Eclipse.EclipseAccountResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/Actions/InitiateV2ImportOnEclipse": { "post": { "tags": [ "Integrations/Eclipse" ], "summary": "Initiates the Import Process on EclipseV2", "operationId": "IntegrationsEclipse_InitiateV2ImportOnEclipse", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "importRequest", "in": "body", "description": "Object containing the Eclipse Firm ID and a boolean representing whether the extract type is \"Full\". The Correlation ID will be auto-generated.", "required": true, "schema": { "$ref": "#/definitions/OAS.Integrations.Eclipse.EclipseInitV2ImportOnEclipseRequest" } }, { "name": "ct", "in": "header", "description": "CancellationToken", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/Actions/StartExtract": { "post": { "tags": [ "Integrations/Eclipse" ], "summary": "This was the endpoint for starting the V1 Import process.\r\nIt has been deprecated and will most likely be completely removed in a future update.\r\nFor now, it will return '400-BadRequest' with appropriate messaging to indicate future intent.", "operationId": "IntegrationsEclipse_StartExtract", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/Actions/StartExtractV2": { "post": { "tags": [ "Integrations/Eclipse" ], "summary": "Starts the Eclipse extract, which notifies eclipse the extract is starting, loads the file into S3, then notifies eclipse the extract is complete.", "operationId": "IntegrationsEclipse_StartExtractV2", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "request", "in": "body", "description": "Object containing the eclipse FirmID to run the extract for (ex 1000), a uri for the destination, and session key if initiated by eclipse.", "required": true, "schema": { "$ref": "#/definitions/OAS.Integrations.Eclipse.EclipseExtractRequestV2" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/Actions/UpdateSleevePortfolio/{regId}/{firmId}": { "put": { "tags": [ "Integrations/Eclipse" ], "summary": "Sync sleeve changes from Orion to Eclipse.", "operationId": "IntegrationsEclipse_UpdateSleevePortfolio", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "regId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "firmId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.Eclipse.SleevedAccounts" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/ClientPortal/{accountId}/CashInfo": { "get": { "tags": [ "Integrations/Eclipse" ], "summary": "Get cash info for an account from eclipse given an orion account id", "operationId": "EclipseClientPortal_GetCashInfoForAccount", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "description": "orion account id", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "description": "CancellationToken", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Eclipse.EclipseAccountTradeInfoDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/ClientPortal/Account/{accountId}/TradedToday": { "get": { "tags": [ "Integrations/Eclipse" ], "summary": "Get all the current trade orders from eclipse", "operationId": "EclipseClientPortal_GetAccountHasTradesForToday", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "description": "account id from orion connect", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "description": "CancellationToken", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/ClientPortal/Allocations/{accountId}/{modelAggId}": { "get": { "tags": [ "Integrations/Eclipse" ], "summary": "Get model allocations", "operationId": "EclipseClientPortal_GetModelAllocations", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "description": "int", "required": true, "type": "integer", "format": "int32" }, { "name": "modelAggId", "in": "path", "description": "int", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "description": "CancellationToken", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.CurrentAccountModelDto" }, "xml": { "name": "CurrentAccountModelDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/ClientPortal/DeleteTradeInstance": { "put": { "tags": [ "Integrations/Eclipse" ], "summary": "Client portal originally used TradeRequestInstancesController, ActionDisable(). \r\nNot really supposed to delete it, just disable apparently. Not sure that's an option.\r\ni know this looks bad, i'm not on trading.", "operationId": "EclipseClientPortal_DisableTradeInstances", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "tradeInstanceIdList", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/ClientPortal/GenerateTrades": { "post": { "tags": [ "Integrations/Eclipse" ], "summary": "Generates trades of any type based on the instructions in the tradeDefinition provided in the request body.\r\nThis needs some cleaning up based on swagger api", "operationId": "EclipseClientPortal_GenerateClientPortalTrades", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "trades", "in": "body", "description": "list of eclipsetrade objects", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseTrade" }, "xml": { "name": "EclipseTrade", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "description": "CancellationToken", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseTradeOrder" }, "xml": { "name": "EclipseTradeOrder", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/ClientPortal/Rebalance/{portfolioId}": { "post": { "tags": [ "Integrations/Eclipse" ], "summary": "Rebalance the portfolio. With TOM, it rebalances by account thru client portal", "operationId": "EclipseClientPortal_RebalanceAccount", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "description": "CancellationToken", "required": true }, { "name": "portfolioId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/ClientPortal/ValidateTrades": { "post": { "tags": [ "Integrations/Eclipse" ], "summary": "Validate trades against eclipse v2 /api/v2/TradeOrder/Trades/Action/Validate", "operationId": "EclipseClientPortal_ValidateTrades", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "orders", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateOrderDto" }, "xml": { "name": "ValidateOrderDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "description": "CancellationToken", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseTradeValidateResponse" }, "xml": { "name": "EclipseTradeValidateResponse", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/CreateOrders": { "post": { "tags": [ "Integrations/Eclipse" ], "summary": "", "operationId": "IntegrationsEclipse_CreateOrdersFromEclipse", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Eclipse.Lambda.Model.EclipseSyncMessageListOfOAS.Eclipse.Lambda.Model.Trades" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/CreatePendingTransactions": { "post": { "tags": [ "Integrations/Eclipse" ], "summary": "Create pending transactions from orders that were created in Eclipse", "operationId": "IntegrationsEclipse_CreatePendingTransactionsFromEclipse", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "Order data", "required": true, "schema": { "$ref": "#/definitions/OAS.Eclipse.Lambda.Model.EclipseSyncMessageListOfOAS.Eclipse.Lambda.Model.PendingTransactions" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/DeleteTransactions": { "post": { "tags": [ "Integrations/Eclipse" ], "summary": "Delete transactions that are linked to orders deleted in Eclipse", "operationId": "IntegrationsEclipse_DeleteTransactionsFromEclipse", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "dto", "in": "body", "description": "Order data", "required": true, "schema": { "$ref": "#/definitions/OAS.Eclipse.Lambda.Model.EclipseSyncMessageListOfSystem.Int32" } }, { "name": "ct", "in": "header", "description": "CancellationToken", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/Firms": { "get": { "tags": [ "Integrations/Eclipse" ], "summary": "Returns all the Eclipse firms in AdviosrLynx", "operationId": "IntegrationsEclipse_GetFirmsFromEclipse", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Eclipse.EclipseFirmDto" }, "xml": { "name": "EclipseFirmDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/Eclipse" ], "summary": "Creates new Eclipse Firm in the OAS Database", "operationId": "IntegrationsEclipse_CreateEclipseFirm", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Eclipse.EclipseFirmWithAlClientDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Eclipse.EclipseFirmWithAlClientDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/Firms/{key}": { "get": { "tags": [ "Integrations/Eclipse" ], "summary": "Returns all the Eclipse Firm AlClient information in AdviosrLynx", "operationId": "IntegrationsEclipse_GetFirmsAlClient", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Eclipse.EclipseFirmWithAlClientDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/Eclipse" ], "summary": "Edit Eclipse Firm and Eclipse Firm AlClient", "operationId": "IntegrationsEclipse_UpdateEclipseFirmAlClient", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Eclipse.EclipseFirmWithAlClientDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Eclipse.EclipseFirmWithAlClientDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Integrations/Eclipse" ], "summary": "Deletes the existing Sleeve Strategy", "operationId": "IntegrationsEclipse_Delete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/Firms/ByAlClientId/{key}": { "get": { "tags": [ "Integrations/Eclipse" ], "summary": "Returns all the Eclipse Firm AlClient information in AdviosrLynx", "operationId": "IntegrationsEclipse_GetFirmsByAlClientId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Interface.IEclipseFirmWithAlClients" }, "xml": { "name": "IEclipseFirmWithAlClients", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/Firms/DefaultByAlClientId/{key}": { "get": { "tags": [ "Integrations/Eclipse" ], "operationId": "IntegrationsEclipse_GetDefaultEclipseFirmByAlClientId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/Firms/SetDefaultEclipseFirmForAlClient": { "post": { "tags": [ "Integrations/Eclipse" ], "operationId": "IntegrationsEclipse_SetDefaultEclipseFirmForAlClientAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "eclipseSetupDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Eclipse.MyEclipseSetupDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/Households/{clientId}/Portfolios": { "get": { "tags": [ "Integrations/Eclipse" ], "summary": "", "operationId": "IntegrationsEclipse_GetPorfoliosByClientId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipsePortfolio" }, "xml": { "name": "EclipsePortfolio", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/Households/{clientId}/TradeOrder/Instances": { "get": { "tags": [ "Integrations/Eclipse" ], "summary": "", "operationId": "IntegrationsEclipse_GetTradeOrderInstancesForHousehold", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/Instances/{instanceId}/UpdateStatus": { "post": { "tags": [ "Integrations/Eclipse" ], "summary": "", "operationId": "IntegrationsEclipse_UpdateInstanceStatus", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "instanceId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "isEnabled", "in": "query", "required": true, "type": "boolean" }, { "name": "ct", "in": "header", "required": true }, { "name": "isDeleted", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseTradeOrder" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/ModelAssignment": { "post": { "tags": [ "Integrations/Eclipse" ], "summary": "Update model assignment for accounts, and sets/update portfolio allocation information.", "operationId": "IntegrationsEclipse_ModelAssignmentFromEclipse", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "Model assignment data.", "required": true, "schema": { "$ref": "#/definitions/OAS.Eclipse.Lambda.Model.EclipseSyncMessageListOfOAS.Eclipse.Lambda.Model.ModelAssignment" } }, { "name": "ct", "in": "header", "description": "CancellationToken for async", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/Models/{modelId}": { "get": { "tags": [ "Integrations/Eclipse" ], "summary": "", "operationId": "IntegrationsEclipse_GetModel", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "modelId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseModel" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/Models/{modelId}/Allocations": { "get": { "tags": [ "Integrations/Eclipse" ], "summary": "", "operationId": "IntegrationsEclipse_GetAllocationsForModel", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "modelId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseModelAllocation" }, "xml": { "name": "EclipseModelAllocation", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/Models/{modelId}/Portfolios/{portfolioId}": { "post": { "tags": [ "Integrations/Eclipse" ], "operationId": "IntegrationsEclipse_AssignModelToPortfolio", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "modelId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "portfolioId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Integrations/Eclipse" ], "summary": "", "operationId": "IntegrationsEclipse_UnAssignModelFromPortfolio", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "modelId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "portfolioId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/Models/Search": { "get": { "tags": [ "Integrations/Eclipse" ], "summary": "", "operationId": "IntegrationsEclipse_GetModels", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseModel" }, "xml": { "name": "EclipseModel", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/ModelUpdate": { "post": { "tags": [ "Integrations/Eclipse" ], "summary": "Create, Update, Delete sync of Models from Eclipse to Orion", "operationId": "IntegrationsEclipse_ModelUpdateFromEclipse", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "dto", "in": "body", "description": "Model data", "required": true, "schema": { "$ref": "#/definitions/OAS.Eclipse.Lambda.Model.EclipseSyncMessageListOfOAS.Eclipse.Lambda.Model.ModelEdit" } }, { "name": "ct", "in": "header", "description": "CancellationToken", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/Portfolio/CustodialInformation": { "get": { "tags": [ "Integrations/Eclipse" ], "summary": "Returns information about the accounts and or sleeves associated to the account. LastRebance, PendingModelChange, TradingInProcess ect.", "operationId": "IntegrationsEclipse_GetCustodialInformation", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountNumber", "in": "query", "description": "The custodial account number.", "required": true, "type": "string" }, { "name": "ct", "in": "header", "description": "CancellationToken", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseCustodianInfo" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/Portfolio/Portfolios/Update": { "put": { "tags": [ "Integrations/Eclipse" ], "summary": "Updates the portfolio trade blocked field.", "operationId": "IntegrationsEclipse_UpdatePortfolioAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "update", "in": "body", "description": "The object passed containing accountId and tradeBlocked. AccountId passed to find the portfolio. True or false whether the portfolio is trade blocked.", "required": true, "schema": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseAccountToUpdatePortfolio" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/PortfolioAssignment": { "post": { "tags": [ "Integrations/Eclipse" ], "operationId": "IntegrationsEclipse_PortfolioAssignmentFromEclipse", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Eclipse.Lambda.Model.EclipseSyncMessageListOfOAS.Eclipse.Lambda.Model.PortfolioAssignment" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/PortfolioAssignment/InitiateSync": { "post": { "tags": [ "Integrations/Eclipse" ], "operationId": "IntegrationsEclipse_InitiatePortfolioAssignmentSync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "eclipseFirmId", "in": "query", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/Portfolios": { "post": { "tags": [ "Integrations/Eclipse" ], "operationId": "EclipsePortfolios_GetEclipsePortfolioIdAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true }, { "name": "useServiceAccount", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/Portfolios/{entity}/{entityId}": { "get": { "tags": [ "Integrations/Eclipse" ], "operationId": "EclipsePortfolios_GetEclipsePortfoliosByEntityAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/Portfolios/{portfolioId}": { "get": { "tags": [ "Integrations/Eclipse" ], "summary": "", "operationId": "IntegrationsEclipse_GetPorfolioById", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "portfolioId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipsePortfolio" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/Portfolios/{portfolioId}/Allocations": { "get": { "tags": [ "Integrations/Eclipse" ], "summary": "", "operationId": "IntegrationsEclipse_GetAllocationsForPortfolio", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "portfolioId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipsePortfolioAllocation" }, "xml": { "name": "EclipsePortfolioAllocation", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/Portfolios/{portfolioId}/Holdings": { "get": { "tags": [ "Integrations/Eclipse" ], "summary": "", "operationId": "IntegrationsEclipse_GetHoldingsByPortfolio", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "portfolioId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseHolding" }, "xml": { "name": "EclipseHolding", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/Portfolios/{portfolioId}/Pending/Model": { "get": { "tags": [ "Integrations/Eclipse" ], "summary": "", "operationId": "IntegrationsEclipse_GetPendingModelForPortfolio", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "portfolioId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipsePendingModel" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/Portfolios/{portfolioId}/Rebalance": { "post": { "tags": [ "Integrations/Eclipse" ], "summary": "", "operationId": "IntegrationsEclipse_RebalancePortfolio", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "portfolioId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "eclipseSettings", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseSettings" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/Portfolios/{portfolioId}/V2Allocations": { "get": { "tags": [ "Integrations/Eclipse" ], "summary": "", "operationId": "IntegrationsEclipse_GetAllocationsForPortfolioV2", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "portfolioId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Models.EclipseV2PortfolioAllocationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/Portfolios/ByOrionAccount/Rebalance": { "post": { "tags": [ "Integrations/Eclipse" ], "summary": "", "operationId": "IntegrationsEclipse_RebalanceByOrionAccounts", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountList", "in": "body", "description": "A list of Orion Account Ids to run rebalances on", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true }, { "name": "eclipseFirmId", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseTradeOrder" }, "xml": { "name": "EclipseTradeOrder", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/Privileges": { "get": { "tags": [ "Integrations/Eclipse" ], "summary": "", "operationId": "IntegrationsEclipse_GetPrivileges", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipsePrivilege" }, "xml": { "name": "EclipsePrivilege", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/Securities/Search": { "get": { "tags": [ "Integrations/Eclipse" ], "summary": "", "operationId": "IntegrationsEclipse_GetSecurities", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseSecurity" }, "xml": { "name": "EclipseSecurity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/Securities/Search/{resultsCount}": { "get": { "tags": [ "Integrations/Eclipse" ], "summary": "", "operationId": "IntegrationsEclipse_GetV1IntegrationsEclipseSecuritiesSearchByResultsCount", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "resultsCount", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseSecurity" }, "xml": { "name": "EclipseSecurity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/TradeAnalysisReports": { "post": { "tags": [ "Integrations/Eclipse" ], "operationId": "IntegrationsEclipse_ReverseSyncTradeAnalysisReports", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "syncMessage", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Eclipse.Lambda.Model.EclipseSyncMessageListOfOAS.Eclipse.Lambda.Model.TradeAnalysisReport" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/TradeOrder/Distributions": { "post": { "tags": [ "Integrations/Eclipse" ], "summary": "", "operationId": "IntegrationsEclipse_GenerateDistributionTrade", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "distributionTrade", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseDistributionTrade" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseTradeOrder" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/TradeOrder/Instances/{tradeOrderInstanceId}/Trades": { "get": { "tags": [ "Integrations/Eclipse" ], "summary": "", "operationId": "IntegrationsEclipse_GetTradesForTradeOrderInstance", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "tradeOrderInstanceId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseTradeOrderObject" }, "xml": { "name": "EclipseTradeOrderObject", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/TradeOrder/Trades": { "post": { "tags": [ "Integrations/Eclipse" ], "summary": "", "operationId": "IntegrationsEclipse_GenerateTrades", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "eclipseTrades", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseTrade" }, "xml": { "name": "EclipseTrade", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseTradeOrder" }, "xml": { "name": "EclipseTradeOrder", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/TradeOrder/Trades/Validate": { "post": { "tags": [ "Integrations/Eclipse" ], "summary": "", "operationId": "IntegrationsEclipse_ValidateTrades", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "eclipseTrades", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseTrade" }, "xml": { "name": "EclipseTrade", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseTradeValidateResponse" }, "xml": { "name": "EclipseTradeValidateResponse", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/TradeOrders/Instances/{tradeOrderInstanceId}": { "delete": { "tags": [ "Integrations/Eclipse" ], "summary": "", "operationId": "IntegrationsEclipse_DeleteTradeOrderInstance", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "tradeOrderInstanceId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/Trading/RaiseCash/Methods": { "get": { "tags": [ "Integrations/Eclipse" ], "summary": "", "operationId": "IntegrationsEclipse_GetRaiseCashTradeMethods", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseTradeMethod" }, "xml": { "name": "EclipseTradeMethod", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/Trading/SpendCash/Methods": { "get": { "tags": [ "Integrations/Eclipse" ], "summary": "", "operationId": "IntegrationsEclipse_GetSpendCashTradeMethods", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseTradeMethod" }, "xml": { "name": "EclipseTradeMethod", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/UpdateDoNotTrade": { "post": { "tags": [ "Integrations/Eclipse" ], "summary": "With the release of the Multi-Trade Block Feature, this endpoint will no longer be used.", "operationId": "IntegrationsEclipse_ReverseSyncUpdateDoNotTradeByListAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Eclipse.Lambda.Model.EclipseSyncMessageListOfOAS.Eclipse.Lambda.Model.UpdateDoNotTrade" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/UpdateSma": { "post": { "tags": [ "Integrations/Eclipse" ], "operationId": "IntegrationsEclipse_ReverseSyncUpdateAccountSmaByListAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Eclipse.Lambda.Model.EclipseSyncMessageListOfOAS.Eclipse.Lambda.Model.UpdateAccountSma" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Eclipse/User/Privileges": { "get": { "tags": [ "Integrations/Eclipse" ], "summary": "", "operationId": "IntegrationsEclipse_GetUserPrivileges", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseUserPrivilege" }, "xml": { "name": "EclipseUserPrivilege", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Element/AccountId/{accountId}": { "get": { "tags": [ "Integrations/Element" ], "operationId": "Element_GetAccountIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Element/household/{householdId}/workflows": { "get": { "tags": [ "Integrations/Element" ], "operationId": "Element_GetHouseholdWorkflowsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "householdId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "workflowCode", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Element/RiskToleranceQuestionnaire/email/{clientId}/{registrationId}": { "get": { "tags": [ "Integrations/Element" ], "operationId": "Element_GetRtqEmailAddressAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "registrationId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellation", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Element/RiskToleranceQuestionnaire/Retake": { "post": { "tags": [ "Integrations/Element" ], "operationId": "Element_RetakeRiskToleranceQuestionnaireAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Integrations.Element.Interfaces.RiskToleranceQuestionnaireRetakeDto" } }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Element/SSO/BrinkerInstance": { "get": { "tags": [ "Integrations/Element" ], "operationId": "Element_SSO_Brinker_InstanceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellation", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Element/SSO/OPSInstance": { "get": { "tags": [ "Integrations/Element" ], "operationId": "Element_SSO_OPS_InstanceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellation", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Element/SSO/Prospects": { "get": { "tags": [ "Integrations/Element" ], "operationId": "Element_SSOProspectsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellation", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Element/SSO/TownsquareInstance": { "get": { "tags": [ "Integrations/Element" ], "operationId": "Element_SSO_Townsquare_InstanceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellation", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Element/UseSFCommunities": { "get": { "tags": [ "Integrations/Element" ], "operationId": "Element_UseSFCommunitiesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellation", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/ElementTrading/Accounts/Sleeve/Rebalance": { "post": { "tags": [ "Integrations/ElementTrading" ], "operationId": "ElementTrading_RebalanceAccount", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true }, { "name": "regLevel", "in": "query", "required": true, "type": "boolean" }, { "name": "rebalanceType", "in": "query", "required": false, "type": "string", "default": 1, "enum": [ "Portfolio", "Sleeve", "Model" ] }, { "name": "eclipseFirmId", "in": "query", "required": false, "type": "string" }, { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/ElementTrading/Eclipse/Firm/{firmId}/Models": { "get": { "tags": [ "Integrations/ElementTrading" ], "summary": "Gets a list of all eclipse models associated with a rep", "operationId": "ElementTrading_GetAllModelList", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "firmId", "in": "path", "required": true, "type": "string" }, { "name": "searchTerm", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true }, { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "includeSelfDirected", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/ElementTrading/Eclipse/Firm/Cache": { "get": { "tags": [ "Integrations/ElementTrading" ], "operationId": "ElementTrading_UpdateEclipseClientCache", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "eclipseFirmId", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true }, { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/ElementTrading/Eclipse/Registrations/{registrationId}/Account": { "get": { "tags": [ "Integrations/ElementTrading" ], "operationId": "ElementTrading_GetEclipseAccountFromRegistration", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "registrationId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true }, { "name": "eclipseFirmId", "in": "query", "required": false, "type": "string" }, { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.Eclipse.EclipseAccountResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/ElementTrading/Entity/{entityType}/{entityId}/RiskScoreModel": { "get": { "tags": [ "Integrations/ElementTrading" ], "operationId": "ElementTrading_GetRiskScoreModel", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entityType", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Rep", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Beneficiary", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QPEDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "Banking", "RMD", "Systematic", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "AdditionalRep", "DownloadSource", "DownloadRecord", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Element.RiskScoreModelDto" }, "xml": { "name": "RiskScoreModelDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/ElementTrading/Registrations/{registrationId}/EclipsePreferences": { "get": { "tags": [ "Integrations/ElementTrading" ], "summary": "See Domains -> RepExpTrading -> TradingPreferencesController", "operationId": "ElementTrading_GetRegistrationEclipsePreferences", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "registrationId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true }, { "name": "eclipseFirmId", "in": "query", "required": false, "type": "string" }, { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Models.EclipsePreferenceResponse" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/ElementTrading" ], "summary": "See Domains -> Trading -> RepExpTrading -> TradingPreferencesController", "operationId": "ElementTrading_UpdateRegistrationEclipsePreferences", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "registrationId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "securityPreference", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Models.EclipsePreferenceRequest" } }, { "name": "ct", "in": "header", "required": true }, { "name": "eclipseFirmId", "in": "query", "required": false, "type": "string" }, { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Models.EclipsePreferenceResponse" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/ElementTrading/Reps/{repId}/ModelAggs/Minimal": { "get": { "tags": [ "Integrations/ElementTrading" ], "operationId": "ElementTrading_GetRepModelAggsSimpleAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "repId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "filterSelfDirected", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "subAdvisorModels", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "useFullRestrictions", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "custodianId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "registrationTypeId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.Domains.Integrations.Element.ModelAggMinimal" }, "xml": { "name": "ModelAggMinimal", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/ElementTrading/Tickers/NonExisting/Search": { "post": { "tags": [ "Integrations/ElementTrading" ], "operationId": "ElementTrading_GetNonExistingSecurities", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "tickers", "in": "body", "required": true, "schema": { "items": { "type": "string" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/eMoney/Client/{clientId}/AssetHoldings/{resourceId}": { "get": { "tags": [ "Integrations/eMoney" ], "summary": "Gets holding information for a specific product for a specific client from eMoney.", "operationId": "eMoney_GetClientsAssetHoldingsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "description": "Cancellation token for the request", "required": true }, { "name": "clientId", "in": "path", "required": true, "type": "string" }, { "name": "resourceId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/eMoney/Client/{clientId}/plans/{planId}/goals": { "get": { "tags": [ "Integrations/eMoney" ], "summary": "Gets the goals for a specific plan for a client from eMoney.", "operationId": "eMoney_GetClientsPlanGoalAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "description": "Cancellation token for the request", "required": true }, { "name": "clientId", "in": "path", "required": true, "type": "string" }, { "name": "planId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/eMoney/Client/{clientId}/plans/{planId}/projection/goalfunding/{goalId}": { "get": { "tags": [ "Integrations/eMoney" ], "summary": "Gets goal funding for a specific clients plan from eMoney.", "operationId": "eMoney_GetClientsPlanGoalFundingAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "description": "Cancellation token for the request", "required": true }, { "name": "clientId", "in": "path", "required": true, "type": "string" }, { "name": "planId", "in": "path", "required": true, "type": "string" }, { "name": "goalId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/eMoney/Client/NetWorth": { "get": { "tags": [ "Integrations/eMoney" ], "summary": "Gets specific client's Networth from eMoney.", "operationId": "eMoney_GetClientsNetWorthAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "description": "Cancellation token for the request", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/eMoney/Client/Plan/Assets": { "get": { "tags": [ "Integrations/eMoney" ], "summary": "Gets a specific plan's assets for a client from eMoney.", "operationId": "eMoney_GetClientsPlanAssetsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "description": "Cancellation token for the request", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/eMoney/GetClients": { "get": { "tags": [ "Integrations/eMoney" ], "operationId": "eMoney_GetClientsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "page", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "pageSize", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/eMoney/SSO": { "get": { "tags": [ "Integrations/eMoney" ], "operationId": "eMoney_SSOAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.eMoney.EmoneyUser" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/eMoney/SSO/Client/{clientId}": { "get": { "tags": [ "Integrations/eMoney" ], "operationId": "eMoney_SsoAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/eMoney/SSO/ClientPortal/{clientId}": { "get": { "tags": [ "Integrations/eMoney" ], "operationId": "eMoney_ClientPortalSSOAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/FCS/Action/FocusSAML": { "get": { "tags": [ "Integrations/FCS" ], "operationId": "FocusClientSolutions_StartFocusSSOAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "location", "in": "query", "required": false, "type": "string", "default": "home" }, { "name": "houseHoldId", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/FCS/CheckSettings": { "get": { "tags": [ "Integrations/FCS" ], "operationId": "FocusClientSolutions_GetSettings", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/FCS/FocusUser": { "get": { "tags": [ "Integrations/FCS" ], "operationId": "FocusClientSolutions_GetFocusUser", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Integration.Practifi.FocusUser" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/FCS" ], "operationId": "FocusClientSolutions_FocusUser", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "Userid", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "isSignedUp", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Integration.Practifi.FocusUser" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/FCS/GetLoanRequest": { "get": { "tags": [ "Integrations/FCS" ], "operationId": "FocusClientSolutions_GetLoanRequest", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "status", "in": "query", "required": false, "type": "string" }, { "name": "excludeClosedLoans", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Fidelity/AccountPositions": { "get": { "tags": [ "Integrations/Fidelity" ], "summary": "", "operationId": "Fidelity_AccountPositionsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.Fidelity.Classes.AccountPositionsResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Fidelity/AccountTrxHistory": { "get": { "tags": [ "Integrations/Fidelity" ], "summary": "", "operationId": "Fidelity_AccountTrxHistoryAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "required": true, "type": "string" }, { "name": "endDate", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.Fidelity.Classes.AccountHistoryResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Fidelity/AcctBalance": { "get": { "tags": [ "Integrations/Fidelity" ], "summary": "quoteCode can have three values\r\n\tR - Real-time Price - Price obtained at the time of the request.\r\n\tD - Delayed Price - Price refreshed between 15-30 minutes; depending on the type of security/exchange.\r\n\tC - Closing Price - Price as of the prior days close. (Looks like you need permission to run this for Closing)\r\nInd - \r\n\tintra - Return \"\"Intraday\"\" values in the response.\r\n\trecent - Return best available \"\"Recent\"\" values in the response.\r\n\tclose - Return \"\"Close\"\" values in the response. (Looks like you need permission to run this for Closing)", "operationId": "Fidelity_AcctBalanceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "quoteCode", "in": "query", "required": false, "type": "string", "default": "R" }, { "name": "ind", "in": "query", "required": false, "type": "string", "default": "intra" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.Fidelity.Classes.AccountBalanceResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Fidelity/ClientDocuments/Traceroute/{clientId}": { "get": { "tags": [ "Integrations/Fidelity" ], "operationId": "Fidelity_ClientDocuemtnsTracerouteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Fidelity/ClientDocumentToken/Client/{clientId}": { "get": { "tags": [ "Integrations/Fidelity" ], "summary": "A list of all the Clients Tokens for this Client", "operationId": "Fidelity_GetClientDocumentTokensAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/Fidelity" ], "summary": "Adds a new Client to Fidelity Documents", "description": "This end-point will not double save. It is safe to post to this end-point multiple times.", "operationId": "Fidelity_CreateClientDocumentTokenAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Integrations.FidelityDocuments.FidelityDocumentTokenInputDto" } }, { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Fidelity/ClientDocumentToken/Client/{clientId}/{opaqueId}": { "delete": { "tags": [ "Integrations/Fidelity" ], "summary": "Deletes opaqueId for this client with this ID.", "operationId": "Fidelity_DeleteClientDocumentTokensAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "opaqueId", "in": "path", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Fidelity/ClientDocumentToken/Refresh/Client/{clientId}": { "get": { "tags": [ "Integrations/Fidelity" ], "operationId": "Fidelity_RefreshClientDocumentTokensAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Fidelity/Echotest": { "get": { "tags": [ "Integrations/Fidelity" ], "operationId": "Fidelity_EchoTestAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EchoTest.EchoResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Fidelity/GetInvestorAlertMessages": { "get": { "tags": [ "Integrations/Fidelity" ], "operationId": "Fidelity_GetInvestorAlertMessagesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": true, "type": "string" }, { "name": "endDate", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.Fidelity.Classes.ResultListOfOAT.Integrations.Fidelity.Classes.CurrentInvestorAlertsMessagesTypeDTO" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Fidelity/GetSubscriberAlertMessagesCount": { "get": { "tags": [ "Integrations/Fidelity" ], "operationId": "Fidelity_GetSubscriberAlertMessagesCountAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": true, "type": "string" }, { "name": "endDate", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.Fidelity.Classes.ResultListOfOAT.Integrations.Fidelity.Classes.SubscriberAlertMessagesCountDetailsTypeDTO" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Fidelity/GetSubscriberAlertsMessages": { "get": { "tags": [ "Integrations/Fidelity" ], "operationId": "Fidelity_GetSubscriberAlertsMessagesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "required": true, "type": "string" }, { "name": "endDate", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.Fidelity.Classes.ResultListOfOAT.Integrations.Fidelity.Classes.CurrentAlertsMessagesTypeDTO" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Fidelity/GetUserAlertMessagesCount": { "get": { "tags": [ "Integrations/Fidelity" ], "operationId": "Fidelity_GetUserAlertMessagesCountAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": true, "type": "string" }, { "name": "endDate", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.Fidelity.Classes.ResultItemOfOAT.Integrations.Fidelity.Classes.MessageCountDetailsDTO" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Fidelity/NewPortfolio/Pending": { "post": { "tags": [ "Integrations/Fidelity" ], "summary": "Gets pending accounts from Akoya for the specified client.", "operationId": "Fidelity_RefreshAccountsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Fidelity/PreGen": { "post": { "tags": [ "Integrations/Fidelity" ], "operationId": "Fidelity_PregenAccountsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.Code.Integrations.FidelityPreGenInDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Fidelity/Streetscape/Redirect": { "get": { "tags": [ "Integrations/Fidelity" ], "summary": "", "operationId": "Fidelity_GetStreetscapeRedirectUrlAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Fidelity/Streetscape/SSO": { "get": { "tags": [ "Integrations/Fidelity" ], "summary": "Connects through a single-sign-on (SSO) to Streetscape.", "operationId": "Fidelity_StreetscapeSsoAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "relayState", "in": "query", "required": false, "type": "string", "default": "" }, { "name": "accountNumber", "in": "query", "required": false, "type": "string", "default": "" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Fidelity/Streetscape/Token": { "get": { "tags": [ "Integrations/Fidelity" ], "summary": "", "operationId": "Fidelity_GetStreetscapeTokenAsync", "consumes": [], "produces": [], "parameters": [ { "name": "code", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Fidelity/Wealthscape/Redirect": { "get": { "tags": [ "Integrations/Fidelity" ], "summary": "", "operationId": "Fidelity_GetWealthScapeRedirectUrlAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Fidelity/Wealthscape/SSO": { "get": { "tags": [ "Integrations/Fidelity" ], "summary": "Connects through a single-sign-on (SSO) to Wealthscape.", "operationId": "Fidelity_WealthscapeSsoAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "relayState", "in": "query", "required": false, "type": "string", "default": "" }, { "name": "accountNumber", "in": "query", "required": false, "type": "string", "default": "" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Fidelity/Wealthscape/Token": { "get": { "tags": [ "Integrations/Fidelity" ], "summary": "", "operationId": "Fidelity_GetWealthscapeTokenAsync", "consumes": [], "produces": [], "parameters": [ { "name": "code", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/FinaMetrica/SSO": { "get": { "tags": [ "Integrations/FinaMetrica" ], "operationId": "FinaMetrica_GetSSO", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "query", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/FinMason/Actions/Remove": { "post": { "tags": [ "Integrations/FinMason" ], "summary": "Removes the Fin Mason integration for the current firm.", "description": "The user must have the necessary privileges to remove the integration.", "operationId": "FinMason_RemoveServiceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/FinMason/Actions/Setup": { "post": { "tags": [ "Integrations/FinMason" ], "summary": "Adds the Fin Mason integration for the current firm.", "operationId": "FinMason_SetupServiceAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "setupRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.IntegrationSetupRequestDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.BasicIntegrationConfigDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/FinMason/MonteCarloInput": { "get": { "tags": [ "Integrations/FinMason" ], "summary": "Get the data for a FinMason MonteCarlo chart for a client.", "operationId": "FinMason_GetMonteCarloInputAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "query", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "RunForClient", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.FinMason.MonteCarloInput" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/FinMason/ProxyPerformance/{asOfDate}": { "post": { "tags": [ "Integrations/FinMason" ], "operationId": "FinMason_CalculateProxyPerformanceAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "asOfDate", "in": "path", "required": true, "type": "string", "format": "date-time" }, { "name": "modelAggIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int64" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Flourish/CreateUser": { "post": { "tags": [ "Integrations/Flourish" ], "summary": "Creates a Client Household along with one or two Client Users as members. Each Household member is sent an invitation to join Flourish as soon as they are created.\r\n\r\nThis creates and sends an Invite (Stauts = INVITED), and is the only endpoint that AUTOMATICALLY INVITES (other flows require Advisor intervention)\r\n", "operationId": "Flourish_PostuserAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Integrations.Flourish.Models.CreateUserRequest" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Flourish/GetMenuValues": { "get": { "tags": [ "Integrations/Flourish" ], "summary": "", "operationId": "Flourish_GetMenuValuesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Flourish/GetToken": { "get": { "tags": [ "Integrations/Flourish" ], "summary": "This is the second part of the Oauth process. The redirect Url we give to Flourish will call this endpoint with the given Authorization Code given to use by Flourish. An Access and Refresh token is given in return. Access token has a lifetime of 15 mins and the refresh token lives for 90 days. \r\nWe save the json object in the app link detail table under the users profile.\r\n\r\n Invoked from flourish-credentials.html \r\n", "operationId": "Flourish_GetTokenAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "code", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Flourish/Invite/{userId}": { "post": { "tags": [ "Integrations/Flourish" ], "summary": "Resends the email invitation for a Client User that is NOT yet ACTIVE> (i.e. the Client User has not yet signed up with Flourish", "operationId": "Flourish_ReInviteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Flourish/Invite-and-Apply": { "post": { "tags": [ "Integrations/Flourish" ], "summary": "Creates a Client Household along with one or two Client Users as members.\r\nThe response includes a Flourish URL that should be opened for the advisor to prefill information about the Cash account on behalf of the client.\r\nEach Household member will be sent an invitation to join Flourish after the application prefill is completed.\r\n\r\nThis requries Advisor action to complete the process. Status CREATED until the advisor completes the process and transitions to INVITED", "operationId": "Flourish_InviteApplyAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Integrations.Flourish.Models.InviteAndApplyRequest" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Flourish/InviteClient/{clientId}": { "get": { "tags": [ "Integrations/Flourish" ], "summary": "Resends the email invitation for a Client User that is NOT yet ACTIVE> (i.e. the Client User has not yet signed up with Flourish\r\nA Flourish User must have already been CREATED or INVITED to \"RESEND* an INVITE", "operationId": "Flourish_InviteClientAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Flourish/InviteContact": { "post": { "tags": [ "Integrations/Flourish" ], "summary": "Creates a contact that can be invited to Flourish at a later time.This fully delegates the invite experience to Flourish\r\n\r\nThis DOES NOT AUTOMATICALLY CREATE a USER. This flow requires advisor action. UserId and State are conditional\r\n - UserId and Status are returned if the email already exists in Flourish\r\n - otherwise both are null\r\n", "operationId": "Flourish_PostContactAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Integrations.Flourish.Models.ContactRequest" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Flourish/Rates": { "get": { "tags": [ "Integrations/Flourish" ], "summary": "Returns the current interest rates paid by Flourish Cash along with their effective dates.\r\nReturns the default Flourish cash rates if the request is unauthenticated.If the request is authenticated to an advisor, returns the advisor's firm custom rates if applicable (or default).\r\nBy default, there is one interest rate tier for each schedule type (single, joint, institutional). For firms with custom rates, \r\nrates can be broken into multiple tiers with different rates, with the interest rate paid for a Flourish Cash account \r\nbeing determined by which tier range the account balance falls in.", "operationId": "Flourish_GetRatesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.Flourish.Models.Rates" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Flourish/Redirect": { "get": { "tags": [ "Integrations/Flourish" ], "summary": "Starts the Oauth process to Flourish, will need a Username and Password for a user on their system, plus a provided secret from Flourish to use with an OTP provider.", "operationId": "Flourish_GetRedirectUrl", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Flourish/RefreshToken": { "get": { "tags": [ "Integrations/Flourish" ], "summary": "This process can be manually fired off before an of the api call to Flourish or the process can be referenced to make sure. The users access token is valid. When using the refresh token, the system is given back a new Access and Refresh token. \r\nWe save the json object in the app link detail table under the users profile.", "operationId": "Flourish_RefreshTokenAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.Flourish.Models.FlourishToken" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Flourish/SearchbyEmails": { "post": { "tags": [ "Integrations/Flourish" ], "summary": "Search by email for users associated with this advisor.", "operationId": "Flourish_SearchByEmailAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "emails", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Integrations.Flourish.Models.EmailSearchRequest" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Flourish/SearchbyUserids": { "post": { "tags": [ "Integrations/Flourish" ], "summary": "the request payload for userIds defines array of string...but they're actually integers.....", "operationId": "Flourish_SearchByUserIdAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "userIds", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Integrations.Flourish.Models.UserIdSearchRequest" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Flourish/UpdateTosStatus": { "post": { "tags": [ "Integrations/Flourish" ], "summary": "", "operationId": "Flourish_UpdateTosStatusAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "flourishTosDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Integrations.Flourish.Models.FlourishTosDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Flourish/UserInfo/{userid}": { "get": { "tags": [ "Integrations/Flourish" ], "summary": "Returns a user's personal information and account information.", "operationId": "Flourish_GetUserByUserIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "userid", "in": "path", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Flourish/Users": { "get": { "tags": [ "Integrations/Flourish" ], "summary": "Lists the users associated with the advisor. The API is paginated and will return a maximum of 1000 records.\r\nYou can get results from the next page by passing the last ID previously returned on the previous page.", "operationId": "Flourish_GetuserAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "inviteAfter", "in": "query", "description": "The date and time the user was last sent an invitation e.g. \"2025-01-29T13:53:51.0547252-06:00\"", "required": false, "type": "string" }, { "name": "count", "in": "query", "description": "Default and max is 1000", "required": false, "type": "integer", "format": "int32" }, { "name": "previousId", "in": "query", "description": "When paging the last id previously returned", "required": false, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/FPAlpha/GetToken": { "get": { "tags": [ "Integrations/FPAlpha" ], "summary": "This is called from fp-alpha-credentials.html after initial OAuth redirect from FP Alpha with {code}\r\n and the original state from {!:GetRedirectUrl}", "operationId": "FPAlpha_GetTokenAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "code", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.FPAlpha.FPAlphaToken" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/FPAlpha/Redirect": { "get": { "tags": [ "Integrations/FPAlpha" ], "operationId": "FPAlpha_GetRedirectUrlAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/FPAlpha/RefreshToken": { "get": { "tags": [ "Integrations/FPAlpha" ], "operationId": "FPAlpha_RefreshTokenAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.FPAlpha.FPAlphaToken" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/FPAlpha/SyncClient/{clientId}": { "get": { "tags": [ "Integrations/FPAlpha" ], "summary": "Add FPAlpha Client\r\n\r\n FP Alpha hanldes update or add process\r\n", "operationId": "FPAlpha_UpdateOrCreateClientAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/FPAlpha/UserToken": { "get": { "tags": [ "Integrations/FPAlpha" ], "operationId": "FPAlpha_UserTokenAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.FPAlpha.FPAlphaToken" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/HiddenLevers/Astro/RepManaged": { "post": { "tags": [ "Integrations/HiddenLevers" ], "operationId": "OrionRiskIntelligence_AstroRepManagedPortfolioAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.Portfolio_Rep_Managed.RepManagedRequest" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/HiddenLevers/Client": { "post": { "tags": [ "Integrations/HiddenLevers" ], "operationId": "OrionRiskIntelligence_PostV1IntegrationsHiddenLeversClient", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "newItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Integrations.HiddenLeversClientDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Integrations.HiddenLeversClientDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/HiddenLevers/Client/{key}": { "put": { "tags": [ "Integrations/HiddenLevers" ], "operationId": "OrionRiskIntelligence_UpdateClientAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Integrations.HiddenLeversClientDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Integrations.HiddenLeversClientDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/HiddenLevers/ClientRiskScore/{key}": { "put": { "tags": [ "Integrations/HiddenLevers" ], "summary": "Update the clients Risk Score In client Suitability.", "operationId": "OrionRiskIntelligence_UpdateClientRiskScore", "consumes": [], "produces": [], "parameters": [ { "name": "key", "in": "path", "description": "The ID of the Orion Client.", "required": true, "type": "integer", "format": "int32" }, { "name": "riskscore", "in": "query", "description": "Clients risk score", "required": true, "type": "number", "format": "double" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/HiddenLevers/CreateClient": { "put": { "tags": [ "Integrations/HiddenLevers" ], "operationId": "OrionRiskIntelligence_CreateClientAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.CreateClient.CreateClientRequest" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/HiddenLevers/ElementNewHousehold": { "post": { "tags": [ "Integrations/HiddenLevers" ], "operationId": "OrionRiskIntelligence_HiddenLeversInsertElementProposalAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "hiddenLeversNewProposal", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Integrations.HiddenLeversNewProposal" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/HiddenLevers/GetSurveyResults": { "get": { "tags": [ "Integrations/HiddenLevers" ], "operationId": "OrionRiskIntelligence_GetSurveyResultsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/HiddenLevers/Iframe/RiskProfile": { "get": { "tags": [ "Integrations/HiddenLevers" ], "operationId": "OrionRiskIntelligence_GetRiskProfileURL", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "accountid", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/HiddenLevers/Iframe/StressTest": { "get": { "tags": [ "Integrations/HiddenLevers" ], "operationId": "OrionRiskIntelligence_GetStressTestURL", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "accountid", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/HiddenLevers/ProposalPayload": { "get": { "tags": [ "Integrations/HiddenLevers" ], "operationId": "OrionRiskIntelligence_GetProposalPayloadAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/HiddenLevers/RiskProfile": { "post": { "tags": [ "Integrations/HiddenLevers" ], "operationId": "OrionRiskIntelligence_GetRiskProfileAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.RiskProfileV3Request" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.RiskProfileV3Response" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/HiddenLevers/RiskRewardScores": { "get": { "tags": [ "Integrations/HiddenLevers" ], "operationId": "OrionRiskIntelligence_GetRiskRewardScoresAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Integrations.RiskRewardScoresDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/HiddenLevers/SSOPayload": { "get": { "tags": [ "Integrations/HiddenLevers" ], "operationId": "OrionRiskIntelligence_GetSSOPayloadAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "redtailUserKey", "in": "query", "required": false, "type": "string" }, { "name": "isStandaloneFirm", "in": "query", "required": false, "type": "boolean" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/HiddenLevers/StressTest": { "post": { "tags": [ "Integrations/HiddenLevers" ], "operationId": "OrionRiskIntelligence_StressTestAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.StressTest.StressTestV3Request" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/HiddenLevers/StressTest/Account/{accountId}": { "get": { "tags": [ "Integrations/HiddenLevers" ], "operationId": "OrionRiskIntelligence_StressTestByAccountIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/HiddenLevers/StressTest/Client/{clientId}": { "get": { "tags": [ "Integrations/HiddenLevers" ], "operationId": "OrionRiskIntelligence_StressTestByClientIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/HiddenLevers/SyncData/Portfolios": { "get": { "tags": [ "Integrations/HiddenLevers" ], "summary": "Gets a simple list of assets, with specific data for the HiddenLevers data sync, for portfolios portfolio.", "operationId": "OrionRiskIntelligence_GetSimpleAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return assets that have value (true).", "required": false, "type": "boolean" }, { "name": "registrationId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Integration.HiddenLevers.PortfolioSyncAssetDto" }, "xml": { "name": "PortfolioSyncAssetDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Instream/Clients/{key}/Plans": { "get": { "tags": [ "Integrations/Instream" ], "operationId": "Instream_GetPlansAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamPlanDto" }, "xml": { "name": "InstreamPlanDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Instream/Clients/{key}/Plans/{planId}": { "get": { "tags": [ "Integrations/Instream" ], "operationId": "Instream_GetPlanDetailAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "planId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamPlanDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Instream/Clients/{key}/Plans/{planId}/MatrixSummary": { "get": { "tags": [ "Integrations/Instream" ], "operationId": "Instream_GetMatrixSummaryAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "planId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamPlanMatrixDto" }, "xml": { "name": "InstreamPlanMatrixDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Instream/Clients/{key}/Plans/Primary": { "get": { "tags": [ "Integrations/Instream" ], "operationId": "Instream_GetPrimaryPlanAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamPlanDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Instream/Clients/{key}/Plans/StaticContent": { "get": { "tags": [ "Integrations/Instream" ], "operationId": "Instream_GetStaticContentAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamStaticContentDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Instream/Clients/{key}/Plans/Summary": { "get": { "tags": [ "Integrations/Instream" ], "operationId": "Instream_GetPlanSummaryAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "planId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamClientReportOverviewDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Instream/Clients/{key}/Profile": { "get": { "tags": [ "Integrations/Instream" ], "operationId": "Instream_GetProfileAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamProfileDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Instream/Clients/{key}/Token": { "get": { "tags": [ "Integrations/Instream" ], "operationId": "Instream_GetClientTokenAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "resetcache", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.Instream.InstreamAuthenticationTokenDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/IntegrationSync": { "get": { "tags": [ "Integrations/IntegrationSync" ], "operationId": "IntegrationSync_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "status", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" }, { "name": "syncType", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 2 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.IntegrationSyncDto" }, "xml": { "name": "IntegrationSyncDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Intuit/Enrollments": { "get": { "tags": [ "Integrations/Intuit" ], "summary": "Get all enrollments currently setup in Intuit", "operationId": "Intuit_GetEnrollments", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/iRebal": { "get": { "tags": [ "Integrations/iRebal" ], "summary": "Get iRebal export files information", "operationId": "iRebal_GetAllIRebalExports", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/iRebal/Action/Schedule": { "put": { "tags": [ "Integrations/iRebal" ], "summary": "Schedule iRebal Export", "operationId": "iRebal_ScheduleExportAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/iRebal/Configuration": { "get": { "tags": [ "Integrations/iRebal" ], "summary": "Gets the configuration data for iRebal for the current user.", "operationId": "iRebal_GetConfigurationAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.iRebal.IntegrationConfigDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/iRebal/Download": { "get": { "tags": [ "Integrations/iRebal" ], "summary": "Download iRebal Export files as one Zip file.", "operationId": "iRebal_GetFilesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/iRebal/Remove": { "post": { "tags": [ "Integrations/iRebal" ], "summary": "Removes the iRebal integration for the current user.", "description": "The user must have the necessary privileges to setup the integration.", "operationId": "iRebal_RemoveServiceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/iRebal/RescheduleJob": { "post": { "tags": [ "Integrations/iRebal" ], "summary": "Update a job schedule for iRebal for the current user.", "operationId": "iRebal_ChangeJobScheduleRunTimeAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "description": "A {OAS.WebApi.DTO.Scheduler.JobScheduleUpdateRequest} containing the time of day the job should run. \r\n The date portion of the run time parameter is ignored.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Scheduler.JobScheduleUpdateRequest" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.iRebal.IntegrationConfigDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/iRebal/RunJobNow": { "post": { "tags": [ "Integrations/iRebal" ], "summary": "Runs the job schedule for iRebal for the current user.", "operationId": "iRebal_RunJobScheduleNowAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "jobScheduleId", "in": "query", "description": "The ID of an existing Job Schedule.", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.iRebal.IntegrationConfigDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/iRebal/ScheduleJob": { "post": { "tags": [ "Integrations/iRebal" ], "summary": "Schedules an job schedule for iRebal for the current user.", "operationId": "iRebal_CreateNewJobScheduleAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "config", "in": "body", "description": "A {OAS.WebApi.DTO.Integrations.PartnerAppConfigurationDto} with the job schedule's desired run time and weekendsOnly values set.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.PartnerAppConfigurationDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/iRebal/Setup": { "post": { "tags": [ "Integrations/iRebal" ], "summary": "Sets up iRebal integration for the current user.", "description": "The user must have the necessary privileges to setup the integration.", "operationId": "iRebal_SetupServiceAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "description": "An {OAS.WebApi.DTO.Integrations.iRebal.IntegrationConfigDto} containing the properties of the integration.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.IntegrationSetupRequestDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.iRebal.IntegrationConfigDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/iRebal/Status": { "get": { "tags": [ "Integrations/iRebal" ], "summary": "Get iRebal export status", "operationId": "iRebal_GetStatus", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/iRebal/UnscheduleJob": { "post": { "tags": [ "Integrations/iRebal" ], "summary": "Removes the job schedule for iRebal for the current user.", "operationId": "iRebal_RemoveJobScheduleAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "jobScheduleId", "in": "query", "description": "The ID of an existing Job Schedule.", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.iRebal.IntegrationConfigDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Junxure/SSO": { "get": { "tags": [ "Integrations/Junxure" ], "operationId": "Junxure_SsoAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/LaserApp/Accounts/{accountId}/Forms": { "get": { "tags": [ "Integrations/LaserApp" ], "summary": "Returns a list of forms available for the specified criteria.", "operationId": "LaserApp_GetFormsForAccount", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "description": "The id of the account to returns forms for.", "required": true, "type": "integer", "format": "int32" }, { "name": "sourceOfFunds", "in": "query", "description": "The source of funds related to the account.", "required": false, "type": "string", "enum": [ "Rollover", "Transfer", "ACHWIRE", "CashCheck" ] }, { "name": "formType", "in": "query", "description": "Form types for the selected account: 1 = New Account, 2 = Distribution", "required": false, "type": "string", "enum": [ "NewAccount", "Distribution" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.Paperwork.FormRecordDto" }, "xml": { "name": "FormRecordDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/LaserApp/Accounts/{accountId}/Submit": { "post": { "tags": [ "Integrations/LaserApp" ], "summary": "", "operationId": "LaserApp_SubmitFormsForAccount", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "description": "Account id to pass to LaserApp", "required": true, "type": "integer", "format": "int32" }, { "name": "formList", "in": "body", "description": "An array of FormRecord objects that will be populated in LaserApp", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.Paperwork.FormRecordDto" }, "xml": { "name": "FormRecordDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/LaserApp/Configuration": { "get": { "tags": [ "Integrations/LaserApp" ], "summary": "Retrieves LaserApp Integration details.", "operationId": "LaserApp_GetConfiguration", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "custodianId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.LaserApp.IntegrationConfig" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/LaserApp" ], "summary": "Saves laserapp integration settings.", "operationId": "LaserApp_UpdateConfiguration", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "config", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.LaserApp.IntegrationConfig" } }, { "name": "custodianId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.LaserApp.IntegrationConfig" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/LaserApp/Configuration/Test": { "get": { "tags": [ "Integrations/LaserApp" ], "summary": "Checks to see if laserapp integration has been setup for this database.", "operationId": "LaserApp_CheckConfiguration", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/LaserApp/Forms": { "get": { "tags": [ "Integrations/LaserApp" ], "summary": "Returns a list of forms available from LaserApp.", "operationId": "LaserApp_GetForms", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "resetCache", "in": "query", "description": "Optional. Default: false. If true the list of forms will be refreshed from LaserApp. If false, the list will only be updated if it has been 10 hours since the last time it was updated.", "required": false, "type": "boolean", "default": false }, { "name": "custodianId", "in": "query", "description": "Optional. Return all forms that have this paperwork assignment.", "required": false, "type": "integer", "format": "int32" }, { "name": "brokerDealerId", "in": "query", "description": "Optional. Return all forms that have this paperwork assignment.", "required": false, "type": "integer", "format": "int32" }, { "name": "managementStyleId", "in": "query", "description": "Optional. Return all forms that have this paperwork assignment.", "required": false, "type": "integer", "format": "int32" }, { "name": "fundFamilyId", "in": "query", "description": "Optional. Return all forms that have this paperwork assignment.", "required": false, "type": "integer", "format": "int32" }, { "name": "accountTypeId", "in": "query", "description": "Obsolete. Will be removed after August 2016. Replaced with registrationTypeId.", "required": false, "type": "integer", "format": "int32" }, { "name": "registrationTypeId", "in": "query", "description": "Optional. Return all forms that have this paperwork assignment.", "required": false, "type": "integer", "format": "int32" }, { "name": "representativeId", "in": "query", "description": "Optional. Return all forms that have this paperwork assignment.", "required": false, "type": "integer", "format": "int32" }, { "name": "subadvisorId", "in": "query", "description": "Optional. Return all forms that have this paperwork assignment.", "required": false, "type": "integer", "format": "int32" }, { "name": "sourceOfFunds", "in": "query", "required": false, "type": "string", "enum": [ "Rollover", "Transfer", "ACHWIRE", "CashCheck" ] }, { "name": "formType", "in": "query", "required": false, "type": "string", "enum": [ "NewAccount", "Distribution" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.Paperwork.FormRecordDto" }, "xml": { "name": "FormRecordDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/LaserApp/Forms/{key}": { "get": { "tags": [ "Integrations/LaserApp" ], "summary": "Gets the form that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "LaserApp_GetFormByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.Paperwork.FormRecordFullDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/LaserApp" ], "operationId": "LaserApp_UpdateForm", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.Paperwork.FormRecordFullDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.Paperwork.FormRecordFullDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/LaserApp/Forms/Search": { "get": { "tags": [ "Integrations/LaserApp" ], "operationId": "LaserApp_GetLaserAppFormSearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.Paperwork.FormRecordDto" }, "xml": { "name": "FormRecordDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/LaserApp/Forms/Search/{search}": { "get": { "tags": [ "Integrations/LaserApp" ], "operationId": "LaserApp_GetV1IntegrationsLaserAppFormsSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.Paperwork.FormRecordDto" }, "xml": { "name": "FormRecordDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/LaserApp/PostBackFromLaserApp": { "post": { "tags": [ "Integrations/LaserApp" ], "summary": "This endpoint is called from the LaserApp application, to post the filled out PDF, and xml form data back for Orion to store in the Accounts Documents.", "operationId": "LaserApp_PostBackFromLaserAppAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "header", "required": true, "type": "object" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/LexisNexis/Actions/Approve": { "put": { "tags": [ "Integrations/LexisNexis" ], "summary": "Approves a list of Search Results matching a set of IDs, with the provided reason.", "operationId": "LexisNexis_ApproveResultsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "approvalCommand", "in": "body", "description": "A list of search result ids to approve, and the approval reason.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.LexisNexis.ApprovalDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.LexisNexis.SearchResultDto" }, "xml": { "name": "SearchResultDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/LexisNexis/Actions/Remove": { "post": { "tags": [ "Integrations/LexisNexis" ], "summary": "Disconnects the integration for the firm.", "operationId": "LexisNexis_RemoveServiceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/LexisNexis/Actions/RunNow": { "post": { "tags": [ "Integrations/LexisNexis" ], "summary": "Runs an on-demand query of all active accounts and sends the data to the LexisNexis batch server.", "description": "This endpoint is limited to scanning all accounts, but it will use the SearchDetail defined in\r\n the SearchSchedule table row.\r\nThe firm will have only one record in the SearchSchedules table, which will be used to populate the \r\n LexisNexis configuration instance for the firm. Since the SearchSchedule properties in the configuration \r\n may not match what this endpoint does, the only configuration value used is the level of detail \r\n for the batch process(Basic or Premium / Strict ).The level of detail specifies how well false positives are\r\n screened out, and determines the per - account charges for the scans.\r\nLevels of detail can be viewed or defined in the LexisNexis Bridger web application by the Compliance team.", "operationId": "LexisNexis_RunNowAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.LexisNexis.IntegrationConfigDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/LexisNexis/Actions/Setup": { "post": { "tags": [ "Integrations/LexisNexis" ], "summary": "Connects the integration for the firm.", "operationId": "LexisNexis_SetupServiceAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "setupRequest", "in": "body", "description": "The parameters required to setup the partner app.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.IntegrationSetupRequestDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.LexisNexis.IntegrationConfigDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/LexisNexis/Configuration": { "get": { "tags": [ "Integrations/LexisNexis" ], "summary": "Get the configuration of the LexisNexis integration partner app.", "operationId": "LexisNexis_GetLexisNexisConfiguration", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.LexisNexis.IntegrationConfigDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/LexisNexis" ], "operationId": "LexisNexis_UpdateLexisNexisConfigurationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "config", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.LexisNexis.IntegrationConfigDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.LexisNexis.IntegrationConfigDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/LexisNexis/Results": { "get": { "tags": [ "Integrations/LexisNexis" ], "summary": "Get all of the searches that the authorized user can read.", "operationId": "LexisNexis_GetAllSearchResultsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "complianceFilterDtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.ComplianceFilterDto" }, "xml": { "name": "ComplianceFilterDto", "wrapped": true }, "type": "array" } }, { "name": "open", "in": "query", "required": false, "type": "boolean" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.LexisNexis.SearchResultDto" }, "xml": { "name": "SearchResultDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/LexisNexis/Results/Details/{searchResultId}": { "get": { "tags": [ "Integrations/LexisNexis" ], "operationId": "LexisNexis_GetResultDetailsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "searchResultId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integration.LexisNexis.SearchResultDetailsDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/LexisNexis/Searches": { "get": { "tags": [ "Integrations/LexisNexis" ], "summary": "Get all of the search results that the authorized user can read. Can filter by a specific search result by passing the searchId as a query parameter.", "operationId": "LexisNexis_GetAllSearchesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "searchId", "in": "query", "description": "The search result unique id.", "required": false, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.LexisNexis.SearchScheduleDto" }, "xml": { "name": "SearchScheduleDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Marketor/SSO": { "get": { "tags": [ "Integrations/Marketor" ], "operationId": "Marketor_Get_SSO_UrlAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/MFE/ModelSearch": { "get": { "tags": [ "Integrations/MFE" ], "operationId": "ModelSearch_GetModelAggsByNameAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/MFE/ModelSearch/Compare": { "post": { "tags": [ "Integrations/MFE" ], "operationId": "ModelSearch_GetModelAggCompareDataAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/MFE/ModelSearch/Compare/Stats": { "post": { "tags": [ "Integrations/MFE" ], "operationId": "ModelSearch_GetModelAggCompareStatDataAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Integrations.MFE.ModelSearch.Dtos.CompareModelRiskMetricsRequestDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/MFE/ModelSearch/GridData": { "get": { "tags": [ "Integrations/MFE" ], "operationId": "ModelSearch_GetGridDataAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Mindflash/Redirect": { "get": { "tags": [ "Integrations/Mindflash" ], "summary": "Find custom URL for Mindflash/Ascent app and use it for redirect if it exists, otherwise use generic.", "operationId": "Mindflash_RedirectAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/MindTouchCls/Redirect": { "get": { "tags": [ "Integrations/MindTouchCls" ], "operationId": "MindTouch_Redirect", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/MoneyGuidePro/Configuration": { "get": { "tags": [ "Integrations/MoneyGuidePro" ], "summary": "Retrieves MoneyGuidePro Integration details.", "operationId": "MoneyGuidePro_GetConfigurationAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.IntegrationConfig" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/MoneyGuidePro" ], "summary": "Saves MoneyGuidePro integration settings.", "operationId": "MoneyGuidePro_UpdateConfiguration", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "integrationConfig", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.IntegrationConfig" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.IntegrationConfig" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/MoneyGuidePro/Configuration/Client": { "get": { "tags": [ "Integrations/MoneyGuidePro" ], "summary": "Retrieves MoneyGuidePro Integration details.", "operationId": "MoneyGuidePro_GetClientConfigurationAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.ClientIntegrationConfig" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/MoneyGuidePro" ], "summary": "Saves MoneyGuidePro Client-level integration settings.", "operationId": "MoneyGuidePro_PutV1IntegrationsMoneyGuideProConfigurationClient", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "userDetailId", "in": "query", "description": "The User Detail ID of the {OAS.DataModel.Portfolio.Client} user whose configuration is to be updated.", "required": true, "type": "integer", "format": "int32" }, { "name": "integrationConfig", "in": "body", "description": "A {OAS.Integrations.MoneyGuidePro.ClientIntegrationConfig} object with the values to store for the {OAS.DataModel.Portfolio.Client}.", "required": true, "schema": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.ClientIntegrationConfig" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.ClientIntegrationConfig" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/MoneyGuidePro" ], "summary": "Saves MoneyGuidePro Client-level integration settings.", "operationId": "MoneyGuidePro_UpdateClientConfigurationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "userDetailId", "in": "query", "description": "The User Detail ID of the {OAS.DataModel.Portfolio.Client} user whose configuration is to be updated.", "required": true, "type": "integer", "format": "int32" }, { "name": "integrationConfig", "in": "body", "description": "A {OAS.Integrations.MoneyGuidePro.ClientIntegrationConfig} object with the values to store for the {OAS.DataModel.Portfolio.Client}.", "required": true, "schema": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.ClientIntegrationConfig" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.ClientIntegrationConfig" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/MoneyGuidePro/Household/{clientId}": { "get": { "tags": [ "Integrations/MoneyGuidePro" ], "summary": "Get the household data for the specified client ID, and return it as an MGPHouseholdInfo object.\r\n\r\nRep level calls may throw SQL timeouts. See {useAltRepQuery} for alternative.\r\n", "operationId": "MoneyGuidePro_GetPortfolioDataAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellation", "in": "header", "required": false }, { "name": "useAltRepQuery", "in": "query", "description": "Optional. Default: null. Use alternate process for Rep level api calls. Otherwise, checks SplitIO for setting.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.DTO.MGPHouseholdInfo" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/MoneyGuidePro/InsurancePolicies/Client/{clientId}": { "get": { "tags": [ "Integrations/MoneyGuidePro" ], "summary": "Used to download the MoneyGuidePro Insurance Policies", "operationId": "MoneyGuidePro_DownloadInsurancePoliciesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "forceRefresh", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.InsurancePoliciesResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/MoneyGuidePro/MonteCarloMeter/Client/{clientId}": { "get": { "tags": [ "Integrations/MoneyGuidePro" ], "summary": "Used to download the MoneyGuidePro Monte Carlo Dial.", "operationId": "MoneyGuidePro_DownloadMonteCarloImageAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "forceRefresh", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "includeImage", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "imageWidth", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 150 }, { "name": "imageHeight", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 75 }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.MonteCarloMeterResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/MoneyGuidePro/Networth/Client/{clientId}": { "get": { "tags": [ "Integrations/MoneyGuidePro" ], "summary": "Used to download the MoneyGuidePro Networth", "operationId": "MoneyGuidePro_DownloadNetworthAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "forceRefresh", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.NetworthResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/MoneyGuidePro/PlanSummary/Client/{clientId}": { "get": { "tags": [ "Integrations/MoneyGuidePro" ], "summary": "Used to download the MoneyGuidePro Plan Summary", "operationId": "MoneyGuidePro_DownloadPlanSummaryAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "forceRefresh", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "includeImage", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "imageWidth", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 150 }, { "name": "imageHeight", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 75 }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Integration.MoneyGuidePro.MPGPlanSummary" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/MoneyGuidePro" ], "operationId": "MoneyGuidePro_PostV1IntegrationsMoneyGuideProPlanSummaryClientByClientId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ps", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.PlanSummaryResponse" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Integration.MoneyGuidePro.MPGPlanSummary" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/MoneyGuidePro/Remove": { "post": { "tags": [ "Integrations/MoneyGuidePro" ], "summary": "Sets up MoneyGuidePro integration for the current user.", "description": "The user must have the necessary privileges to setup the integration.", "operationId": "MoneyGuidePro_RemoveServiceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/MoneyGuidePro/Settings": { "get": { "tags": [ "Integrations/MoneyGuidePro" ], "operationId": "MoneyGuidePro_GetSettingsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.MoneyGuidePro.MoneyGuideProSettingsDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/MoneyGuidePro" ], "operationId": "MoneyGuidePro_UpdateSettingsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updatedSettings", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.MoneyGuidePro.MoneyGuideProSettingsDto" } }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.MoneyGuidePro.MoneyGuideProSettingsDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/MoneyGuidePro/Setup": { "post": { "tags": [ "Integrations/MoneyGuidePro" ], "summary": "Sets up MoneyGuidePro integration for the current user.", "description": "The user must have the necessary privileges to setup the integration.", "operationId": "MoneyGuidePro_SetupServiceAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "description": "An object containing the parameters to set up the service.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.IntegrationSetupRequestDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.IntegrationConfig" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/MoneyGuidePro/SSO/AccessPlan/{clientId}": { "get": { "tags": [ "Integrations/MoneyGuidePro" ], "operationId": "MoneyGuidePro_AccessPlanSAMLAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/MoneyGuidePro/SSO/Client/{clientId}": { "get": { "tags": [ "Integrations/MoneyGuidePro" ], "operationId": "MoneyGuidePro_SsoAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/NewAccount": { "post": { "tags": [ "Integrations/NewAccount" ], "operationId": "NewAccount_CustodianNewAccountAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountGlobalId", "in": "query", "required": true, "type": "string", "format": "uuid" }, { "name": "householdGlobalId", "in": "query", "required": false, "type": "string", "format": "uuid" }, { "name": "workflowGlobalId", "in": "query", "required": false, "type": "string", "format": "uuid" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/NewAccount/{accountId}/StreetScape": { "get": { "tags": [ "Integrations/NewAccount" ], "operationId": "NewAccount_StreetScapeNewAccountAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/NewAccount/{accountId}/WealthScape": { "get": { "tags": [ "Integrations/NewAccount" ], "operationId": "NewAccount_WealthScapeNewAccountAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/NewAccount/Custodians/{custodianGuid}/UploadDocuments": { "post": { "tags": [ "Integrations/NewAccount" ], "operationId": "NewAccount_UploadDocumentsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "custodianGuid", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "formSessionUploads", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.Integrations.Element.DTOs.FormSessionUpload" }, "xml": { "name": "FormSessionUpload", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/NewAccount/DocumentTypes": { "get": { "tags": [ "Integrations/NewAccount" ], "operationId": "NewAccount_GetDocumentTypesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/NewAccount/Fidelity/{accountId}/{location}": { "get": { "tags": [ "Integrations/NewAccount" ], "operationId": "NewAccount_FidelityNewAccountAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "location", "in": "path", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/System.ValueTupleOfSystem.StringAndSystem.Boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/NewAccount/FormsData": { "post": { "tags": [ "Integrations/NewAccount" ], "operationId": "NewAccount_SubmitWorkflowDataAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "workflowData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Integrations.Element.DTOs.WorkflowDataDto" } }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/NewAccount/FormsData/{accountGlobalId}": { "get": { "tags": [ "Integrations/NewAccount" ], "operationId": "NewAccount_GetFlattenFormsDataAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountGlobalId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "householdGlobalId", "in": "query", "required": false, "type": "string", "format": "uuid" }, { "name": "workflowGlobalId", "in": "query", "required": false, "type": "string", "format": "uuid" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/NewAccount/Pershing/{accountNumber}": { "get": { "tags": [ "Integrations/NewAccount" ], "operationId": "NewAccount_GetAccountAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountNumber", "in": "path", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/NewAccount/Schwab": { "post": { "tags": [ "Integrations/NewAccount" ], "operationId": "NewAccount_SchwabNewAccountAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/NewAccount/UploadPershingDocuments": { "post": { "tags": [ "Integrations/NewAccount" ], "operationId": "NewAccount_UploadPershingDocumentsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "formSessionUploads", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.Integrations.Element.DTOs.FormSessionUpload" }, "xml": { "name": "FormSessionUpload", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Notifications/Action/UpdateStatus": { "put": { "tags": [ "Integrations/Notifications" ], "operationId": "Notification_UpdateStatusAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "notificationIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "status", "in": "query", "required": true, "type": "string", "enum": [ "Unread", "Read", "Deleted" ] }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Fuse.NotificationDto" }, "xml": { "name": "NotificationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Onboarding/ConversionSources": { "get": { "tags": [ "Integrations/Onboarding" ], "summary": "Get all ConversionSources.", "operationId": "ConversionSources_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Onboarding.ConversionSourceDto" }, "xml": { "name": "ConversionSourceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/Onboarding" ], "summary": "Adds a new ConversionSource to the database.", "operationId": "ConversionSources_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "ConversionSource object to create", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Onboarding.ConversionSourceDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Onboarding.ConversionSourceDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Onboarding/ConversionSources/{key}": { "get": { "tags": [ "Integrations/Onboarding" ], "summary": "Gets the ConversionSource that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ConversionSources_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Onboarding.ConversionSourceDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/Onboarding" ], "summary": "Updates the ConversionSource that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ConversionSources_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired update object.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "ConversionSource object to update", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Onboarding.ConversionSourceDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Onboarding.ConversionSourceDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Onboarding/ConversionSources/checkprogress": { "post": { "tags": [ "Integrations/Onboarding" ], "operationId": "ConversionSources_checkProgress", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "file", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Onboarding.FileDataDTO" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int64" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Onboarding/ConversionSources/chunkCreate": { "post": { "tags": [ "Integrations/Onboarding" ], "operationId": "ConversionSources_mergeFilesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "fileChunk", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Onboarding.ChunkDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Onboarding.ConversionSourceDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Onboarding/ConversionSources/Types": { "get": { "tags": [ "Integrations/Onboarding" ], "summary": "Get all ConversionTypes.", "operationId": "ConversionSources_GetAllConversionTypes", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Onboarding.ConversionTypeDto" }, "xml": { "name": "ConversionTypeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/integrations/openai/chat/completions": { "post": { "tags": [ "integrations/openai" ], "operationId": "OpenAI_GetChatCompletionAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "messages", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OpenAI_API.Chat.ChatMessage" }, "xml": { "name": "ChatMessage", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/integrations/openai/portfolioview/{clientId}/meetingagenda": { "post": { "tags": [ "integrations/openai" ], "operationId": "OpenAI_CreateMeetingAgendaAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "report", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.EnvisionReportDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/OrionElement/AssetFactSheet/{modelId}": { "get": { "tags": [ "Integrations/OrionElement" ], "summary": "Get the manager fact sheet from v2 communities", "operationId": "OrionElement_AssetFactSheetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "modelId", "in": "path", "description": "key for the desired model aggregate fact sheet.", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/OrionElement/BlendedAssetFactSheet/{id}": { "get": { "tags": [ "Integrations/OrionElement" ], "summary": "Get the manager fact sheet from v2 communities", "operationId": "OrionElement_BlendedAssetFactSheetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "description": "key for the desired strategy fact sheet.", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/OutboxSync/Accounts": { "post": { "tags": [ "Integrations/OutboxSync" ], "summary": "Re-queues account-context outbox data for the supplied {accountIds}.\r\nAn empty or null list is a no-op and returns 200. Account ids that don't resolve to a real account\r\nproduce no events for that id (the downstream producers filter on the live account) and do not fail\r\nthe batch.", "description": "Sample Request:\r\nPOST v1/Integrations/OutboxSync/Accounts\r\n[ 100, 200, 300 ]", "operationId": "OutboxSync_SyncAccountsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Paperwork/Accounts/{accountId}/Forms": { "get": { "tags": [ "Integrations/Paperwork" ], "summary": "Returns a list of forms available for the specified account. Paperwork is mapped to the Accounts Custodian, BD, MgmtStyle, AccountType, Rep, and Subadvisor.", "operationId": "Paperwork_GetFormsForAccount", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "description": "The id of the account to returns forms for the specified account.", "required": true, "type": "integer", "format": "int32" }, { "name": "paperworkSource", "in": "query", "required": false, "type": "string", "enum": [ "LaserApp", "AdvisoryWorld", "Firm", "Quik" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.Paperwork.FormRecordDto" }, "xml": { "name": "FormRecordDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Paperwork/Forms/{key}": { "get": { "tags": [ "Integrations/Paperwork" ], "summary": "Gets the form that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Paperwork_GetFormByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.Paperwork.FormRecordFullDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/Paperwork" ], "operationId": "Paperwork_UpdateForm", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.Paperwork.FormRecordFullDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.Paperwork.FormRecordFullDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Paperwork/Forms/Mapped": { "get": { "tags": [ "Integrations/Paperwork" ], "summary": "Returns a list of forms available for the specified criteria. Paperwork is mapped to the Accounts Custodian, BD, MgmtStyle (Platform), AccountType, Rep, and Subadvisor.", "operationId": "Paperwork_GetFormsMapped", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "custodianId", "in": "query", "description": "Optional. When included, returns forms assigned to this custodian.", "required": false, "type": "integer", "format": "int32" }, { "name": "brokerDealerId", "in": "query", "description": "Optional. When included, returns forms assigned to this broker dealer.", "required": false, "type": "integer", "format": "int32" }, { "name": "platformId", "in": "query", "description": "Optional. When included, returns forms assigned to this mgmt style (platform).", "required": false, "type": "integer", "format": "int32" }, { "name": "fundFamilyId", "in": "query", "description": "Optional. When included, returns forms assigned to this fund family.", "required": false, "type": "integer", "format": "int32" }, { "name": "regTypeId", "in": "query", "description": "Optional. When included, returns forms assigned to this reg type (Account Type).", "required": false, "type": "integer", "format": "int32" }, { "name": "repId", "in": "query", "description": "Optional. When included, returns forms assigned to this Representative.", "required": false, "type": "integer", "format": "int32" }, { "name": "subAdvisorId", "in": "query", "description": "Optional. When included, returns forms assigned to this Sub Advisor.", "required": false, "type": "integer", "format": "int32" }, { "name": "fundSource", "in": "query", "description": "Optional. When included, returns forms assigned to this Fund Source. (For example, Rollover, transfer, wire, check)", "required": false, "type": "string", "enum": [ "Rollover", "Transfer", "ACHWIRE", "CashCheck" ] }, { "name": "formType", "in": "query", "description": "Optional. When included, returns forms assigned to this formType {OAS.DataModel.Integrations.FormType}.", "required": false, "type": "string", "enum": [ "NewAccount", "Distribution" ] }, { "name": "paperworkSource", "in": "query", "description": "Optional. When included, returns forms related to the specified source..", "required": false, "type": "string", "enum": [ "LaserApp", "AdvisoryWorld", "Firm", "Quik" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.Paperwork.FormRecordDto" }, "xml": { "name": "FormRecordDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Paperwork/Forms/Search": { "get": { "tags": [ "Integrations/Paperwork" ], "summary": "Searches the forms libarary for documents titled with the specified text.", "operationId": "Paperwork_GetFormSearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "Search String", "required": true, "type": "string" }, { "name": "paperworkSource", "in": "query", "description": "Paperwork Source", "required": false, "type": "string", "enum": [ "LaserApp", "AdvisoryWorld", "Firm", "Quik" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.Paperwork.FormRecordDto" }, "xml": { "name": "FormRecordDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Paperwork/Forms/Search/{search}": { "get": { "tags": [ "Integrations/Paperwork" ], "summary": "Searches the forms libarary for documents titled with the specified text.", "operationId": "Paperwork_GetV1IntegrationsPaperworkFormsSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "Search String", "required": true, "type": "string" }, { "name": "paperworkSource", "in": "query", "description": "Paperwork Source", "required": false, "type": "string", "enum": [ "LaserApp", "AdvisoryWorld", "Firm", "Quik" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.Paperwork.FormRecordDto" }, "xml": { "name": "FormRecordDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Pershing/Action/SAML": { "get": { "tags": [ "Integrations/Pershing" ], "operationId": "Pershing_StartSSOAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "deepLink", "in": "query", "required": false, "type": "string", "enum": [ "None", "Alerts", "Balances", "AccountServices", "OrderStatus", "AccountSummary", "ReportCenter" ] }, { "name": "accountNumber", "in": "query", "required": false, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Pershing/HistoricalActivities": { "get": { "tags": [ "Integrations/Pershing" ], "operationId": "Pershing_GetHistoricalActivitiesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "dto.activityTypeName", "in": "query", "required": false, "type": "string" }, { "name": "dto.securityIdentifierTypeCode", "in": "query", "required": false, "type": "string" }, { "name": "dto.securityIdentifier", "in": "query", "required": false, "type": "string" }, { "name": "dto.asOfDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "dto.endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "dto.recordReturnCount", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "dto.scrollKey", "in": "query", "required": false, "type": "string" }, { "name": "dto.accountIdentifier", "in": "query", "required": false, "type": "string" }, { "name": "dto.multiTenantAuthenticationClientIdentifier", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Pershing/IntradayActivities": { "get": { "tags": [ "Integrations/Pershing" ], "operationId": "Pershing_GetIntradayActivitiesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "dto.activityTypeName", "in": "query", "required": false, "type": "string", "enum": [ "ALL", "TRADE_ONLY", "DIVIDEND_INTEREST", "CASH_WITHDRAWAL_OR_DEPOSIT", "COMMON_STOCK", "PREFERRED_STOCK", "OPTION", "MUTUAL_FUND", "BOND", "CD", "OTHER", "ACH_TRANSACTIONS", "JOURNAL_TRANSACTIONS", "CHECK_TRANSACTIONS" ] }, { "name": "dto.securityIdentifierTypeCode", "in": "query", "required": false, "type": "string", "enum": [ "ALL", "CUSIP", "SYMBOL", "ISIN", "SEDOL" ] }, { "name": "dto.securityIdentifier", "in": "query", "required": false, "type": "string" }, { "name": "dto.recordReturnCount", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "dto.scrollKey", "in": "query", "required": false, "type": "string" }, { "name": "dto.accountIdentifier", "in": "query", "required": false, "type": "string" }, { "name": "dto.multiTenantAuthenticationClientIdentifier", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Pershing/IntradayHoldings": { "get": { "tags": [ "Integrations/Pershing" ], "operationId": "Pershing_GetIntradayHoldingsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "dto.viewingCurrency", "in": "query", "required": false, "type": "string" }, { "name": "dto.requestIdentifier", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "dto.recordReturnCount", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "dto.scrollKey", "in": "query", "required": false, "type": "string" }, { "name": "dto.accountIdentifier", "in": "query", "required": false, "type": "string" }, { "name": "dto.multiTenantAuthenticationClientIdentifier", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Pershing/NetX360User": { "get": { "tags": [ "Integrations/Pershing" ], "operationId": "Pershing_GetV1IntegrationsPershingNetX360User", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Integration.Pershing.netXuser" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/Pershing" ], "operationId": "Pershing_NetX360UserAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "user", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Integration.Pershing.netXuser" } }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Integration.Pershing.netXuser" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Pershing/PershingClientPortalDocuments": { "get": { "tags": [ "Integrations/Pershing" ], "operationId": "Pershing_CheckForPershingClientPortalDocumentsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Pershing/PriorDayBalances": { "get": { "tags": [ "Integrations/Pershing" ], "operationId": "Pershing_GetPriorDayBalancesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "dto.viewingCurrency", "in": "query", "required": false, "type": "string" }, { "name": "dto.accountIdentifier", "in": "query", "required": false, "type": "string" }, { "name": "dto.multiTenantAuthenticationClientIdentifier", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Pershing/PriorDayHoldings": { "get": { "tags": [ "Integrations/Pershing" ], "operationId": "Pershing_GetPriorDayHoldingsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "dto.viewingCurrency", "in": "query", "required": false, "type": "string" }, { "name": "dto.recordReturnCount", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "dto.scrollKey", "in": "query", "required": false, "type": "string" }, { "name": "dto.accountIdentifier", "in": "query", "required": false, "type": "string" }, { "name": "dto.multiTenantAuthenticationClientIdentifier", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Pershing/RegistrationTypes": { "get": { "tags": [ "Integrations/Pershing" ], "operationId": "Pershing_GetRegistrationTypes", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Pershing/TransferableHoldings": { "get": { "tags": [ "Integrations/Pershing" ], "operationId": "Pershing_GetTransferableHoldingsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "dto.holdingsRequestTypeCode", "in": "query", "required": false, "type": "string" }, { "name": "dto.journalAccountProcessingTypeCode", "in": "query", "required": false, "type": "string" }, { "name": "dto.scrollDirectionCode", "in": "query", "required": false, "type": "string" }, { "name": "dto.scrollKey", "in": "query", "required": false, "type": "string" }, { "name": "dto.accountTransferAssetTypeFilter", "in": "query", "required": false, "type": "string" }, { "name": "dto.recordReturnCount", "in": "query", "required": false, "type": "integer", "format": "int64" }, { "name": "dto.symbols", "in": "query", "required": false, "items": {}, "collectionFormat": "multi", "type": "array" }, { "name": "dto.accountIdentifier", "in": "query", "required": false, "type": "string" }, { "name": "dto.multiTenantAuthenticationClientIdentifier", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Pershing/UploadPDFDocument": { "post": { "tags": [ "Integrations/Pershing" ], "summary": "This operation uploads a document to Pershing NetX360 or to Albridge Document Management and Workflows.\r\nIf you are uploading multiple documents, you must initiate a separate request for each document.\r\nThis operation uses a multi-part request to send metadata along with the uploaded document.\r\n\r\nRequest Data Required.\r\n{\r\n \"authToken\": \"\",\r\n \"userId\": \"\",\r\n \"busFuncCode\": \"\",\r\n \"busFuncDocType\": \"\",\r\n \"accountNumber\": \"\",\r\n \"documentName\": \"\"\r\n}\r\nA single request file is required.", "operationId": "Pershing_UploadDocumentAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Plaid/Accounts": { "get": { "tags": [ "Integrations/Plaid" ], "summary": "Get Accounts for an item", "description": "Sample Request\r\n\tGET /Integrations/Plaid/Accounts\r\n\t{\r\n\t\t\"itemID\":\"ABCD74M35rbR1fEKaElMr3bswmEQeAZVGuvRwbLR\"\r\n\t}", "operationId": "Plaid_AccountsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "itemID", "in": "query", "description": "The item you want to get accounts of", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Plaid/Accounts/{clientId}": { "get": { "tags": [ "Integrations/Plaid" ], "summary": "Get Plaid Accounts that are not assigned an Account Number. For use with UI", "description": "Sample Request\r\n\tGET /Integrations/Plaid/Accounts/3", "operationId": "Plaid_GetPlaidAccountByUser", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleStringKeyEntity" }, "xml": { "name": "SimpleStringKeyEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Plaid/AccountsBalance": { "get": { "tags": [ "Integrations/Plaid" ], "summary": "Get Accounts Balance", "description": "Sample Request\r\n\tGET /Integrations/Plaid/AccountsBalance\r\n\t{\r\n\t\t\"itemID\":\"ABCD74M35rbR1fEKaElMr3bswmEQeAZVGuvRwbLR\"\r\n\t}", "operationId": "Plaid_AccountsBalanceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "itemID", "in": "query", "description": "the itemID for which you want to get the accounts balance of", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Plaid/Auth": { "get": { "tags": [ "Integrations/Plaid" ], "summary": "Get Auth Status", "description": "Sample Request\r\n\tGET /Integrations/Plaid/Auth\r\n\t{\r\n\t\t\"itemID\":\"ABCD74M35rbR1fEKaElMr3bswmEQeAZVGuvRwbLR\"\r\n\t}", "operationId": "Plaid_Auth", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "itemID", "in": "query", "description": "The item you want to get authentication of", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Plaid/Configuration": { "get": { "tags": [ "Integrations/Plaid" ], "summary": "Retrieves Plaid Integration details.", "operationId": "Plaid_GetConfiguration", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.Plaid.IntegrationConfig" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/Plaid" ], "summary": "Saves Plaid integration settings.", "operationId": "Plaid_UpdateConfiguration", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "config", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.Plaid.IntegrationConfig" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.Plaid.IntegrationConfig" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Plaid/DeleteItem": { "delete": { "tags": [ "Integrations/Plaid" ], "summary": "Delete an Item given Plaid Item ID", "description": "Sample Request\r\n\tDELETE /Integrations/Plaid/DeleteItem\r\n\t{\r\n\t\t\"itemID\":\"ABCD74M35rbR1fEKaElMr3bswmEQeAZVGuvRwbLR\"\r\n\t}", "operationId": "Plaid_DeleteItem", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "itemID", "in": "query", "description": "the item you want to delete", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Plaid/GetAllCategories": { "get": { "tags": [ "Integrations/Plaid" ], "summary": "Get all Categories data from Plaid. This will return category_id, group, and hierarchy", "description": "Sample Request\r\n\tGET /Integrations/Plaid/GetAllCategories", "operationId": "Plaid_Categories", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Plaid/GetAllData": { "get": { "tags": [ "Integrations/Plaid" ], "summary": "Get all Items data for particular access token. This will returns transactions, investment transactions, and investments holding consolidate with one JSON response", "description": "Sample Request\r\n\tGET /Integrations/Plaid/GetAllData\r\n\t{\r\n\t\t\"itemID\":\"ABCD74M35rbR1fEKaElMr3bswmEQeAZVGuvRwbLR\"\r\n\t}\r\n\tor\r\n\tGET /Integrations/Plaid/GetAllData\r\n\t{\r\n\t\t\"itemID\":\"ABCD74M35rbR1fEKaElMr3bswmEQeAZVGuvRwbLR\",\r\n\t\t\"startDate\" :2020/09/01\r\n\t}", "operationId": "Plaid_GetAllDataAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "itemID", "in": "query", "description": "the item you want to get all data of", "required": true, "type": "string" }, { "name": "startDate", "in": "query", "description": "start data you want to begin with optional", "required": false, "type": "string", "format": "date-time" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Plaid/GetAllInstitutions": { "get": { "tags": [ "Integrations/Plaid" ], "summary": "Get All Institutions", "description": "Sample Request\r\n\tGET /Integrations/Plaid/GetAllInstitutions\r\n\tor\r\n\tGET /Integrations/Plaid/GetAllInstitutions?nameOnly=true", "operationId": "Plaid_GetAllInstitutionsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "nameOnly", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAT.Integrations.Plaid.Acklann.Plaid.Entity.Institution" }, "xml": { "name": "Institution", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Plaid/GetAllPlaidItemsForUser": { "get": { "tags": [ "Integrations/Plaid" ], "summary": "Get All Plaid Items user can see", "description": "Sample Request\r\n\tGET /Integrations/Plaid/GetAllPlaidItemsForUser\r\n\t{\r\n\t}\r\n\tor\r\n\tGET /Integrations/Plaid/GetAllPlaidItemsForUser?nameOnly=true", "operationId": "Plaid_GetAllPlaidItemsForUserAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "nameOnly", "in": "query", "description": "only return name", "required": false, "type": "boolean", "default": false }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAT.Integrations.Plaid.Classes.PlaidItemForUser" }, "xml": { "name": "PlaidItemForUser", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Plaid/GetInstitutionByID": { "get": { "tags": [ "Integrations/Plaid" ], "summary": "Get Institution By ID", "description": "Sample Request\r\n\tGET /Integrations/Plaid/GetInstitutionByID?institutionId=ins_1", "operationId": "Plaid_GetInstitutionByIDAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "institutionId", "in": "query", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAT.Integrations.Plaid.Acklann.Plaid.Entity.Institution" }, "xml": { "name": "Institution", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Plaid/GetInstitutionByName": { "get": { "tags": [ "Integrations/Plaid" ], "summary": "Get Institution By Name", "description": "Sample Request\r\n\tGET /Integrations/Plaid/GetInstitutionByName?institutionName=Bank of America", "operationId": "Plaid_GetInstitutionByNameAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "institutionName", "in": "query", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAT.Integrations.Plaid.Acklann.Plaid.Entity.Institution" }, "xml": { "name": "Institution", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Plaid/ItemRefresh": { "get": { "tags": [ "Integrations/Plaid" ], "summary": "Get Item Refresh", "description": "Sample Request\r\n\tGET /Integrations/Plaid/ItemRefresh\r\n\t{\r\n\t\t\"itemID\":\"ABCD74M35rbR1fEKaElMr3bswmEQeAZVGuvRwbLR\"\r\n\t}", "operationId": "Plaid_ItemRefreshAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "itemID", "in": "query", "description": "the item you want to refresh of", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Plaid/Items": { "get": { "tags": [ "Integrations/Plaid" ], "summary": "This is responsible for create a new item from a given public token", "description": "Sample Request\r\n\tGET /Integrations/Plaid/Items\r\n\t{\r\n\t\t\"publicToken\":\"public-sandbox-a9c421e4-de6c-4fce-ab89-82588e593c99\",\r\n\t\t\"isInform\":false\r\n\t}\r\n\tGET /Integrations/Plaid/Items\r\n\t{\r\n\t\t\"publicToken\":\"public-sandbox-a9c421e4-de6c-4fce-ab89-82588e593c99\",\r\n\t\t\"isInform\":false,\r\n\t\t\"OtherInfoJSON\":\"stored inform for Success\"\r\n\t}", "operationId": "Plaid_CreateNewItemAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "publicToken", "in": "query", "description": "the public token", "required": true, "type": "string" }, { "name": "isInform", "in": "query", "description": "is this used for inform or not", "required": true, "type": "boolean" }, { "name": "otherInfoJSON", "in": "query", "description": "other info JSON (optional)", "required": false, "type": "string", "default": "" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Plaid/LinkTokens": { "get": { "tags": [ "Integrations/Plaid" ], "summary": "This operation creates a link token for a new connection or updates an existing connection with plaid.\r\nIt takes four parameters appName (required), isInform(required), householdID optional(defaults to correlationID) and optional itemID for update", "description": "Sample Request\r\n\tGET /Integrations/Plaid/LinkTokens\r\n\t{\r\n\t\t\"appName\":\"Advizer\",\r\n\t\t\"isInform\":false\r\n\t}\r\n\tor\r\n \tGET /Integrations/Plaid/LinkTokens\r\n\t{\r\n\t\t\"appName\":\"Advizer\",\r\n\t\t\"isInform\":false,\r\n \"authOnly\":true,\r\n \"householdID\":\"op_householdID\"\r\n\t}\r\n\tor\r\n\tGET /Integrations/Plaid/LinkTokens\r\n\t{\r\n\t\t\"appName\":\"Advizer\",\r\n\t\t\"isInform\":false,\r\n\t\t\"itemID\":\"ABCD74M35rbR1fEKaElMr3bswmEQeAZVGuvRwbLR\",\r\n\t\t\"householdID\":\"op_householdID\"\r\n\t}\r\n\tor\r\n\tGET /Integrations/Plaid/LinkTokens\r\n\t{\r\n\t\t\"appName\":\"Advizer\",\r\n\t\t\"isInform\":false,\r\n\t\t\"householdID\":\"op_householdID\"\r\n\t}\r\n\tor\r\n\tGET /Integrations/Plaid/LinkTokens\r\n\t{\r\n\t\t\"appName\":\"Advizer\",\r\n\t\t\"isInform\":false,\r\n\t\t\"householdID\":\"op_householdID\",\r\n\t\t\"clientUserId\":\"12345\",\r\n \"dateOfBirth\":2020-01-01,\r\n \"emailAddress\":test%40orion.com,\r\n \"emailAddressVerifiedTime\":2020-01-01T00:00:00Z,\r\n \"legalName\":\"integrationTest\",\r\n \"phoneNumber\":%2B16175551212,\r\n \"phoneNumberVerifiedTime\":2020-01-01T00:00:00Z,\r\n \"ssn\":123-12-1234,\r\n \"languageCode\":en,\r\n \"countryCodes\":US,\r\n \"depositoryAccountFilter\":checking,\r\n \"creditAccountFilter\":credit card,\r\n \"loanAccountFilter\":auto,\r\n \"investmentAccountFilter\":all,\r\n \"otherAccountfilter\":\"unknown\"\r\n\t}", "operationId": "Plaid_CreateLinkTokenAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "appName", "in": "query", "description": "app name is your application name.", "required": true, "type": "string" }, { "name": "isInform", "in": "query", "description": "is this used for inform or not", "required": true, "type": "boolean" }, { "name": "itemID", "in": "query", "description": "optional itemID", "required": false, "type": "string", "default": "" }, { "name": "authOnly", "in": "query", "description": "optional authOnly (default to false)", "required": false, "type": "boolean", "default": false }, { "name": "householdID", "in": "query", "description": "The household id to be used to replace the default correlation id.", "required": false, "type": "string" }, { "name": "languageCode", "in": "query", "description": "optional Default en; Possibles: English en, French fr, Spanish es, Dutch nl, German de", "required": false, "type": "string" }, { "name": "redirectUri", "in": "query", "description": "optional", "required": false, "type": "string", "default": "" }, { "name": "cancellationToken", "in": "header", "required": false }, { "name": "user.clientUserId", "in": "query", "required": false, "type": "string" }, { "name": "user.legalName", "in": "query", "required": false, "type": "string" }, { "name": "user.phoneNumber", "in": "query", "required": false, "type": "string" }, { "name": "user.phoneNumberVerifiedTime", "in": "query", "required": false, "type": "string" }, { "name": "user.emailAddress", "in": "query", "required": false, "type": "string" }, { "name": "user.emailAddressVerifiedTime", "in": "query", "required": false, "type": "string" }, { "name": "user.ssn", "in": "query", "required": false, "type": "string" }, { "name": "user.dateOfBirth", "in": "query", "required": false, "type": "string" }, { "name": "accountFilters.countryCodes", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" }, { "name": "accountFilters.depositoryAccountFilter", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" }, { "name": "accountFilters.creditAccountFilter", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" }, { "name": "accountFilters.loanAccountFilter", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" }, { "name": "accountFilters.investmentAccountFilter", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" }, { "name": "accountFilters.otherAccountFilter", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Plaid/OtherInfo": { "get": { "tags": [ "Integrations/Plaid" ], "summary": "Get other info JSON", "description": "Sample Request\r\n\tGET /Integrations/Plaid/OtherInfo\r\n\t{\r\n\t\t\"itemID\":\"ABCD74M35rbR1fEKaElMr3bswmEQeAZVGuvRwbLR\"\r\n\t}", "operationId": "Plaid_GetOtherInfoAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "itemID", "in": "query", "description": "The itemID for which you want to get other information JSON", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/Plaid" ], "summary": "Store other info JSON", "description": "Sample Request\r\n\tPUT /Integrations/Plaid/OtherInfo\r\n\t{\r\n\t\t\"itemID\":\"ABCD74M35rbR1fEKaElMr3bswmEQeAZVGuvRwbLR\",\r\n\t\t\"otherInfoJSON\":{\r\n\t\t\t\t\t\tAppName:\"abcd\",\r\n\t\t\t\tRedirectURI:\"abfdfddfg\",\r\n\t\t\t\tItemID:\"asfv\"\r\n\t\t}", "operationId": "Plaid_StoreOtherInfoAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "itemID", "in": "query", "description": "The itemID for which you want to store the JSON", "required": true, "type": "string" }, { "name": "otherInfoJSON", "in": "body", "description": "The JSON object you want to store", "required": true, "schema": { "type": "object" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Plaid/Processor": { "get": { "tags": [ "Integrations/Plaid" ], "summary": "Used to create a token suitable for sending to one of Plaid's partners to enable integrations.\r\nPossible values for processor are Possible values: dwolla, galileo, modern_treasury, ocrolus, prime_trust, vesta, drivewealth, vopay, achq, check, \r\ncheckbook, circle, sila_money, rize, svb_api, unit, wyre, lithic, alpaca, astra, moov, treasury_prime, marqeta, checkout, solid, \r\nhighnote, apex_clearing, gusto", "description": "Sample Request\r\n\tGET /Integrations/Plaid/Processor\r\n\t{\r\n\t\t\"itemID\":\"ZN7ezPXewbT8kJWbXk3NSqzJNzWj7QigJPMzE\"\r\n\t\t\"accountID\":\"ZN7ezPXewbT8kJWbXk3NSqzJNzWj7QigJPMzE\"\r\n\t\t\"processor\":\"apex_clearing\"\r\n\t}", "operationId": "Plaid_GetProcessorTokenAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "itemID", "in": "query", "required": true, "type": "string" }, { "name": "accountID", "in": "query", "required": true, "type": "string" }, { "name": "processor", "in": "query", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Plaid/SaveItem": { "put": { "tags": [ "Integrations/Plaid" ], "summary": "Save Accounts accessToken for item", "description": "Sample Request\r\n\tPUT /Integrations/Plaid/SaveItem?itemID=ABCD74M35rbR1fEKaElMr3bswmEQeAZVGuvRwbLR accessToken=access-sandbox-a9c421e4-de6c-4fce-ab89-82588e593c99 isInform=false", "operationId": "Plaid_SaveItemAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "itemID", "in": "query", "description": "The item you save", "required": true, "type": "string" }, { "name": "accessToken", "in": "query", "description": "The access you save", "required": true, "type": "string" }, { "name": "isInform", "in": "query", "description": "is this used for inform or not", "required": true, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Plaid/Status": { "get": { "tags": [ "Integrations/Plaid" ], "summary": "Get Item Status", "description": "Sample Request\r\n\tGET /Integrations/Plaid/Status\r\n\t{\r\n\t\t\"itemID\":\"ABCD74M35rbR1fEKaElMr3bswmEQeAZVGuvRwbLR\"\r\n\t}", "operationId": "Plaid_ItemStatusAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "itemID", "in": "query", "description": "the item you want to status of", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Quantum/Jobs": { "get": { "tags": [ "Integrations/Quantum" ], "summary": "Retrieves list of quantum print jobs.", "operationId": "Quantum_GetJobs", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "currentDatabaseOnly", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Quantum.QuantumJobDto" }, "xml": { "name": "QuantumJobDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/Quantum" ], "operationId": "Quantum_UpdateCreateJobs", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updatedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Quantum.QuantumJobDto" }, "xml": { "name": "QuantumJobDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Quantum.QuantumJobDto" }, "xml": { "name": "QuantumJobDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/integrations/querysmith/columns/search": { "get": { "tags": [ "integrations/querysmith" ], "operationId": "QuerySmith_SearchColumnsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "searchTerm", "in": "query", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/integrations/querysmith/queries/{queryId}": { "get": { "tags": [ "integrations/querysmith" ], "operationId": "QuerySmith_GetQueryAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "queryId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/integrations/querysmith/queries/{queryId}/register": { "post": { "tags": [ "integrations/querysmith" ], "operationId": "QuerySmith_RegisterRecipeAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "queryId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/integrations/querysmith/queries/modify/interrupt": { "post": { "tags": [ "integrations/querysmith" ], "operationId": "QuerySmith_InterruptModifyQueryAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/integrations/querysmith/queries/modify/stream": { "post": { "tags": [ "integrations/querysmith" ], "operationId": "QuerySmith_StreamModifyQueryAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "modifyRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.QuerySmith.ModifyRequestDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Quik/Accounts/{accountId}/Forms/Viewer": { "post": { "tags": [ "Integrations/Quik" ], "summary": "Returns the HTML Forms Viewer Page", "operationId": "Quik_GetFormsViewer", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "formsList", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.Form" }, "xml": { "name": "Form", "wrapped": true }, "type": "array" } }, { "name": "docAcctId", "in": "query", "required": false, "type": "string" }, { "name": "docBaseUri", "in": "query", "required": false, "type": "string" }, { "name": "appLinkDtl", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "quikIntegrationId", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Quik/Advisors/{alClientId}/Accounts/{accountId}/Forms/Viewer/Submit": { "post": { "tags": [ "Integrations/Quik" ], "summary": "Accepts the Form Post from the Quik Viewer", "operationId": "Quik_SubmitCallbackFromViewer", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "alClientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "jToken", "in": "body", "required": true, "schema": { "type": "object" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Integrations.QuikController.QuikResponseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Quik/Advisors/{alClientId}/Entity/{entityId}/EntityEnum/{entityEnum}/Forms/Viewer/DocuSign": { "post": { "tags": [ "Integrations/Quik" ], "summary": "Accepts the Form Post from the Quik Viewer providing the DocuSign Envelope Id", "operationId": "Quik_DocuSignCallbackFromViewer", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "alClientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "entityEnum", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Integrations.QuikController.QuikResponseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Quik/Advisors/{alClientId}/Entity/{entityId}/EntityEnum/{entityEnum}/Forms/Viewer/Save": { "post": { "tags": [ "Integrations/Quik" ], "summary": "Accepts the Form Post from the Quik Viewer and saves the POST for later processing", "operationId": "Quik_SaveCallbackFromViewer", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "alClientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "entityEnum", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Quik/Configuration": { "get": { "tags": [ "Integrations/Quik" ], "summary": "Retrieves Quik Integration details.", "operationId": "Quik_GetConfiguration", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.IntegrationConfig" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/Quik" ], "summary": "Saves Quik integration settings.", "operationId": "Quik_SaveConfiguration", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "config", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.IntegrationConfig" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.IntegrationConfig" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/Quik" ], "summary": "Saves Quik integration settings.", "operationId": "Quik_PostV1IntegrationsQuikConfiguration", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "config", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.IntegrationConfig" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.IntegrationConfig" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Integrations/Quik" ], "summary": "Deletes Quik integration settings.", "operationId": "Quik_DeleteConfiguration", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.IntegrationConfig" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Quik/Configuration/Default": { "get": { "tags": [ "Integrations/Quik" ], "summary": "Retrieves Quik Integration details.", "operationId": "Quik_GetDefaultConfiguration", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.IntegrationConfig" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Quik/Configuration/Test": { "get": { "tags": [ "Integrations/Quik" ], "summary": "Checks to see if Quik integration has been setup for this database.", "operationId": "Quik_CheckConfiguration", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.IntegrationConfig" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Quik/Dealers": { "get": { "tags": [ "Integrations/Quik" ], "summary": "Returns a list of all dealers", "operationId": "Quik_GetDealers", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "assignedOnly", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.Dealer" }, "xml": { "name": "Dealer", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/Quik" ], "summary": "Saves a list of available form owners ( dealers ) for a customer", "operationId": "Quik_SaveDealers", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dealers", "in": "body", "description": "The list of available dealers to save, with chosen dealers marked Selected = true.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.Dealer" }, "xml": { "name": "Dealer", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.Dealer" }, "xml": { "name": "Dealer", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Quik/Dealers/Accounts/{accountId}": { "get": { "tags": [ "Integrations/Quik" ], "summary": "Returns a comma seperated list of dealers ( form owners ) for an account", "operationId": "Quik_GetDealerIdCsvForAccount", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Quik/DocuSign/Envelopes/Accounts/{accountId}": { "get": { "tags": [ "Integrations/Quik" ], "summary": "Returns a DocuSign envelopes for an acccount.", "operationId": "Quik_GetDocuSignEnvelopes", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Integrations.QuikIntegration" }, "xml": { "name": "QuikIntegration", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Quik/DocuSign/Envelopes/Entity/{entityId}/EntityEnum/{entityEnum}": { "get": { "tags": [ "Integrations/Quik" ], "summary": "Returns a DocuSign envelope with status for an entityId and EntityEnum.", "operationId": "Quik_GetDocuSignEnvelope", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "entityEnum", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.DocuSign.Models.Envelope" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Quik/DocuSign/Token": { "post": { "tags": [ "Integrations/Quik" ], "summary": "Returns a DocuSign OAuth Token", "operationId": "Quik_GetDocuSignOAuthToken", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "integrationConfig", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.IntegrationConfig" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Quik/FormData/{quikIntegrationId}/Accounts/{accountId}/Forms/Viewer": { "post": { "tags": [ "Integrations/Quik" ], "summary": "Returns the HTML Forms Viewer Page", "operationId": "Quik_PostV1IntegrationsQuikFormDataByQuikIntegrationIdAccountsByAccountIdFormsViewer", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "quikIntegrationId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "forms", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.Form" }, "xml": { "name": "Form", "wrapped": true }, "type": "array" } }, { "name": "docAcctId", "in": "query", "required": false, "type": "string" }, { "name": "docBaseUri", "in": "query", "required": false, "type": "string" }, { "name": "appLinkDtl", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Quik/FormData/Accounts/{accountId}": { "get": { "tags": [ "Integrations/Quik" ], "summary": "Returns a FormData for an acccount.", "operationId": "Quik_GetFormData", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Integrations.QuikIntegration" }, "xml": { "name": "QuikIntegration", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Quik/FormGroups": { "get": { "tags": [ "Integrations/Quik" ], "operationId": "Quik_GetFormGroups", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.FormGroup" }, "xml": { "name": "FormGroup", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/Quik" ], "operationId": "Quik_PostFormGroup", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "formGroup", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.FormGroup" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.FormGroup" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/Quik" ], "operationId": "Quik_PostV1IntegrationsQuikFormGroups", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "formGroup", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.FormGroup" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.FormGroup" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Quik/FormGroups/{formGroupId}": { "get": { "tags": [ "Integrations/Quik" ], "operationId": "Quik_GetFormGroup", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "formGroupId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.FormGroup" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Integrations/Quik" ], "operationId": "Quik_PostFormsToFormGroup", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "formGroupId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Quik/FormGroups/{formGroupId}/Entity/{entityId}/EntityEnum/{entityEnum}/Forms/Viewer": { "post": { "tags": [ "Integrations/Quik" ], "summary": "Returns the Url of the Viewer Page", "operationId": "Quik_GetFormsViewerUrl", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "formGroupId", "in": "path", "description": "FormGroupId", "required": true, "type": "integer", "format": "int32" }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "entityEnum", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dict", "in": "body", "required": true, "schema": { "additionalProperties": { "type": "string" }, "type": "object" } }, { "name": "docAcctId", "in": "query", "required": false, "type": "string" }, { "name": "docBaseUri", "in": "query", "required": false, "type": "string" }, { "name": "appLinkDtl", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Quik/FormGroups/{formGroupId}/Forms": { "post": { "tags": [ "Integrations/Quik" ], "operationId": "Quik_PostV1IntegrationsQuikFormGroupsByFormGroupIdForms", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "formGroupId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "forms", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.Form" }, "xml": { "name": "Form", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Quik/FormGroups/Accounts/{accountId}": { "get": { "tags": [ "Integrations/Quik" ], "operationId": "Quik_GetFormGroupsByAcccount", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.FormGroup" }, "xml": { "name": "FormGroup", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Quik/FormGroups/Name/{name}": { "get": { "tags": [ "Integrations/Quik" ], "operationId": "Quik_GetFormGroupByName", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "name", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.FormGroup" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Quik/FormGroups/Search": { "get": { "tags": [ "Integrations/Quik" ], "operationId": "Quik_GetFormGroupsSearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.FormGroup" }, "xml": { "name": "FormGroup", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Quik/Forms/Custodians/{custodianCode}": { "get": { "tags": [ "Integrations/Quik" ], "summary": "Returns a list of forms available from Quik for the passed in custodian.", "operationId": "Quik_GetFormsForCustodian", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "custodianCode", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.Form" }, "xml": { "name": "Form", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Quik/Forms/Dealers": { "get": { "tags": [ "Integrations/Quik" ], "summary": "Returns a list of forms available from Quik for the passed in custodian.", "operationId": "Quik_GetFormsForDealerCsv", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dealerIdCsv", "in": "query", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.Form" }, "xml": { "name": "Form", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Quik/Forms/FormData/{quikIntegrationId}": { "get": { "tags": [ "Integrations/Quik" ], "summary": "Returns a list of forms available from Quik for the passed in custodian.", "operationId": "Quik_GetFormsByIntegrationId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "quikIntegrationId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.Form" }, "xml": { "name": "Form", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Integrations/Quik" ], "operationId": "Quik_DeleteSavedForm", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "quikIntegrationId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Quik/Forms/PreviewUrl": { "post": { "tags": [ "Integrations/Quik" ], "summary": "Sets the preview link on the Form object.", "operationId": "Quik_SetFormPreviewUrl", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "form", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.Form" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.Form" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Quik/Forms/Search": { "get": { "tags": [ "Integrations/Quik" ], "summary": "Returns a list of forms available from Quik for the passed in search criterial and dealerIdCsv.", "operationId": "Quik_GetFormsSearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "dealerIdCsv", "in": "query", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.Form" }, "xml": { "name": "Form", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Quik/Reps/{repId}/NewAccounts": { "get": { "tags": [ "Integrations/Quik" ], "operationId": "Quik_GetNewAccountsWithStatusByRep", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "repId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.QuikNewAccount" }, "xml": { "name": "QuikNewAccount", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Quik/User": { "get": { "tags": [ "Integrations/Quik" ], "summary": "Returns the user for the logged in entity", "operationId": "Quik_GetUser", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.CustomerUser" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Quik/Users": { "get": { "tags": [ "Integrations/Quik" ], "summary": "Returns a list of users for the customer", "operationId": "Quik_GetUsers", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.CustomerUser" }, "xml": { "name": "CustomerUser", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/Quik" ], "summary": "Adds or Updates a list of users for the customer", "operationId": "Quik_SaveUsers", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "customerUsers", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.CustomerUser" }, "xml": { "name": "CustomerUser", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.CustomerUser" }, "xml": { "name": "CustomerUser", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Redtail/Action/ConnectUser": { "put": { "tags": [ "Integrations/Redtail" ], "summary": "Connects a Redtail user to an Orion user, enabling or disabling automatic 2-way sync.", "operationId": "Redtail_ConnectUserAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "userConfig", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.Redtail.UserConfig" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Redtail/Actions/Remove": { "post": { "tags": [ "Integrations/Redtail" ], "summary": "Disconnects the integration for the firm.", "operationId": "Redtail_RemoveServiceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Redtail/Actions/Setup": { "post": { "tags": [ "Integrations/Redtail" ], "summary": "Connects the integration for the firm.", "operationId": "Redtail_SetupServiceAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "setupRequest", "in": "body", "description": "The parameters required to setup the partner app.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.IntegrationSetupRequestDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integrations.Redtail.FirmConfig" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Redtail/Configuration": { "get": { "tags": [ "Integrations/Redtail" ], "summary": "Retrieves Redtail Integration details.", "description": "Note that the firm-level configuration for Redtail Integration is used to flag the firm\r\n database for automated data transfers, as well as storing data for the email template to assign reps\r\n to Redtail users.", "operationId": "Redtail_GetFirmConfigurationAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integrations.Redtail.FirmConfig" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/Redtail" ], "summary": "Saves Redtail integration settings.", "description": "Note that the firm-level configuration for Redtail Integration is used to flag the firm\r\n database for automated data transfers, as well as storing data for the email template to assign reps\r\n to Redtail users.", "operationId": "Redtail_UpdateFirmConfigurationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "integrationConfig", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integrations.Redtail.FirmConfig" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integrations.Redtail.FirmConfig" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Redtail/SSO": { "get": { "tags": [ "Integrations/Redtail" ], "operationId": "Redtail_SsoAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/RightCapital/SSO": { "get": { "tags": [ "Integrations/RightCapital" ], "operationId": "RightCapital_Get_SSO_UrlAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/RiskAlyze/Accounts/{key}": { "put": { "tags": [ "Integrations/RiskAlyze" ], "operationId": "RiskAlyze_AccountRiskScoreUpdate", "consumes": [], "produces": [], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "riskScore", "in": "query", "required": true, "type": "number", "format": "double" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/RiskAlyze/AccountUpsert": { "put": { "tags": [ "Integrations/RiskAlyze" ], "operationId": "RiskAlyze_AccountUpsertAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "upsertAccounts", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Dto.RiskAlyzeAccountUpsertDto" }, "xml": { "name": "RiskAlyzeAccountUpsertDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/RiskAlyze/Allocations": { "post": { "tags": [ "Integrations/RiskAlyze" ], "summary": "The endpoint is to get Nitrogen scores as the user is building out a model for a client.\r\nAs ticker and allocations are passed to the endpoint\r\nthe user will be updated with new scores.", "operationId": "RiskAlyze_GetScoreForAllocationsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "allocations", "in": "body", "description": "The combination of Ticker and Amount that will be used to determine the score.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Dto.TickerAllocationsDto" }, "xml": { "name": "TickerAllocationsDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/RiskAlyze/Clients": { "get": { "tags": [ "Integrations/RiskAlyze" ], "summary": "Gets all Clients from Nitrogen.", "operationId": "RiskAlyze_GetAllClientsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Classes.Client" }, "xml": { "name": "Client", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/RiskAlyze/Clients/{key}": { "get": { "tags": [ "Integrations/RiskAlyze" ], "summary": "Gets a Client from Nitrogen.", "operationId": "RiskAlyze_GetClientInfoAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "imageSize", "in": "query", "description": "Optional. Valid values are: 60, 90, 180, 360, or 1000", "required": false, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Classes.Client" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/RiskAlyze" ], "summary": "Updates the risk score for a Nitrogen Client.", "operationId": "RiskAlyze_ClientRiskScoreUpdateAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The unique ID of the Client.", "required": true, "type": "integer", "format": "int32" }, { "name": "riskScore", "in": "query", "description": "The risk score.", "required": true, "type": "number", "format": "double" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Classes.Client" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/RiskAlyze/Clients/{key}/Analysis": { "get": { "tags": [ "Integrations/RiskAlyze" ], "summary": "Gets a Client and associated analysis data from Nitrogen.", "operationId": "RiskAlyze_GetClientAnalysisAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "imageSize", "in": "query", "description": "Optional. Valid values are: 60, 90, 180, 360, or 1000", "required": false, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Dto.RiskalyzeAnalysisDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/RiskAlyze/Clients/{key}/Token": { "get": { "tags": [ "Integrations/RiskAlyze" ], "summary": "Gets the token for a Client from Nitrogen.", "operationId": "RiskAlyze_GetClientTokenAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/RiskAlyze/Clients/ImplementProposed": { "post": { "tags": [ "Integrations/RiskAlyze" ], "summary": "Calls out to Nitrogen with the currently logged in user sso, and\r\nImplements the Proposed portfolio for the specified client Id.\r\nThis can be called when a new client is created in the Orion System,\r\nto create a link into the Nitrogen system.", "operationId": "RiskAlyze_ImplementProposedAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "riskAlyzeClientId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/RiskAlyze/Clients/ProposalRedirect": { "get": { "tags": [ "Integrations/RiskAlyze" ], "summary": "Checks for an existing client based on integration mappings, and updates or creates a new Nitrogen client.", "operationId": "RiskAlyze_CreateOrUpdateClientAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "query", "description": "Orion AccountId to base the new Nitrogen client on.", "required": false, "type": "integer", "format": "int32" }, { "name": "clientId", "in": "query", "description": "Orion HHId to base the new Nitrogen client on.If Launched from HH level of Portfolio Audit", "required": false, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/RiskAlyze/Configuration": { "get": { "tags": [ "Integrations/RiskAlyze" ], "summary": "Returns configuration settings for Nitrogen integration.", "operationId": "RiskAlyze_GetConfigurationAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.IntegrationInfo" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/RiskAlyze" ], "summary": "Updates Nitrogen configuration information.", "operationId": "RiskAlyze_UpdateConfigurationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "integrationInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.IntegrationInfo" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.IntegrationInfo" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/RiskAlyze/GetToken": { "get": { "tags": [ "Integrations/RiskAlyze" ], "summary": "Used to get token from Nitrogen.", "operationId": "RiskAlyze_GetTokenAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "code", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/RiskAlyze/Redirect": { "get": { "tags": [ "Integrations/RiskAlyze" ], "summary": "Used to automatically redirect the user's browser to Nitrogen's OAuth page.", "operationId": "RiskAlyze_GetRedirectUrlAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/RiskAlyze/Remove": { "post": { "tags": [ "Integrations/RiskAlyze" ], "summary": "Removes Nitrogen integration from the current user's firm.", "description": "The user must have Admin or Advisor privileges to remove the integration.", "operationId": "RiskAlyze_RemoveServiceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/RiskAlyze/Representatives/{key}/DefaultSchedules": { "get": { "tags": [ "Integrations/RiskAlyze" ], "summary": "Get list of default fee schedules for the representative", "operationId": "RiskAlyze_GetDefaultSchedulesForRepAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "platformId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillScheduleDto" }, "xml": { "name": "BillScheduleDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/RiskAlyze/Response": { "post": { "tags": [ "Integrations/RiskAlyze" ], "operationId": "RiskAlyze_OAuthResponseAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "token", "in": "body", "required": true, "schema": { "type": "object" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/RiskAlyze/RetirementRedirect": { "get": { "tags": [ "Integrations/RiskAlyze" ], "operationId": "RiskAlyze_GetRetirementRedirectUrlAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/RiskAlyze/Setup": { "post": { "tags": [ "Integrations/RiskAlyze" ], "summary": "Sets up the Nitrogen integration for an advisory firm.", "description": "The user must have Admin or Advisor privileges to setup the integration.", "operationId": "RiskAlyze_SetupServiceAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "setupRequest", "in": "body", "description": "An {OAS.WebApi.DTO.Integrations.IntegrationSetupRequestDto} defining the integration.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.IntegrationSetupRequestDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.IntegrationInfo" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/RiskAlyze/StoredUserToken": { "get": { "tags": [ "Integrations/RiskAlyze" ], "summary": "Returns configuration settings for Nitrogen integration.", "operationId": "RiskAlyze_GetUserTokenAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Integration.RiskAlyze.RiskAlyzeUser" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/RiskAnalytics/RiskScores/PortfolioView": { "post": { "tags": [ "Integrations/RiskAnalytics" ], "operationId": "RiskAnalytics_GetRiskScoresAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Integrations.RiskAnalytics.PortfolioViewRiskScoreRequest" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/RiskScores/AddNewAccountScore": { "post": { "tags": [ "Integrations/RiskScores" ], "operationId": "GenericRiskScore_AddAccountScoreAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "payload", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Integration.RiskScoreGenericDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/RiskScores/AddNewAccountScores": { "post": { "tags": [ "Integrations/RiskScores" ], "operationId": "GenericRiskScore_AddAccountScoresAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "payloads", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Integration.RiskScoreGenericDto" }, "xml": { "name": "RiskScoreGenericDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/RiskScores/AddNewClientScore": { "post": { "tags": [ "Integrations/RiskScores" ], "summary": "Add new client score data", "operationId": "GenericRiskScore_AddClientScoreAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "payload", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Integration.RiskScoreGenericDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/RiskScores/AddNewClientScores": { "post": { "tags": [ "Integrations/RiskScores" ], "summary": "Add multiple client scores data", "operationId": "GenericRiskScore_AddClientScoresAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "payloads", "in": "body", "description": "{System.Collections.Generic.IList`1} representing new scores data", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Integration.RiskScoreGenericDto" }, "xml": { "name": "RiskScoreGenericDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/RiskScores/CurrentAccountScore/{accountId}": { "get": { "tags": [ "Integrations/RiskScores" ], "summary": "Need to configure new privilege to work with {OAS.WebApi.Code.Attributes.EndpointAuthorizeAttribute} for Read access...", "operationId": "GenericRiskScore_GetCurrentAccountScoreAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/RiskScores/CurrentClientScore/{clientId}": { "get": { "tags": [ "Integrations/RiskScores" ], "summary": "Need to configure new privilege to work with {OAS.WebApi.Code.Attributes.EndpointAuthorizeAttribute} for Read access...", "operationId": "GenericRiskScore_GetCurrentClientScoreAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/RiskScores/DeleteAccountScore/{accountId}": { "delete": { "tags": [ "Integrations/RiskScores" ], "operationId": "GenericRiskScore_DeleteAccountScoreAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/RiskScores/DeleteClientScore/{clientId}": { "delete": { "tags": [ "Integrations/RiskScores" ], "operationId": "GenericRiskScore_DeleteClientScoreAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/RiskScores/UpdateCurrentAccountScore": { "put": { "tags": [ "Integrations/RiskScores" ], "summary": "Update account score", "operationId": "GenericRiskScore_UpdateCurrentAccountScoreAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "payload", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Integration.RiskScoreGenericDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/RiskScores/UpdateCurrentClientScore": { "put": { "tags": [ "Integrations/RiskScores" ], "summary": "Update client (hh) score", "operationId": "GenericRiskScore_UpdateCurrentClientScoreAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "payload", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Integration.RiskScoreGenericDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SaleMove/Cobrowse/{externalId}/Launch": { "get": { "tags": [ "Integrations/SaleMove" ], "summary": "Method to redirect to Cobrowse session", "operationId": "SaleMove_GetCobrowseLaunchRedirectUrlAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "externalId", "in": "path", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SaleMove/Cobrowse/{externalId}/Online": { "get": { "tags": [ "Integrations/SaleMove" ], "operationId": "SaleMove_GetVisitorOnlineAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "externalId", "in": "path", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SaleMove/Cobrowse/HasPrivilege": { "get": { "tags": [ "Integrations/SaleMove" ], "operationId": "SaleMove_HasPrivilegeAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SaleMove/Cobrowse/Operator": { "get": { "tags": [ "Integrations/SaleMove" ], "operationId": "SaleMove_GetOperatorAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/SaleMove" ], "operationId": "SaleMove_CreateOperator", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.Glia.DTOs.OperatorPasswordDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SaleMove/Cobrowse/Rep": { "get": { "tags": [ "Integrations/SaleMove" ], "operationId": "SaleMove_HasRepPrivilegeAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SaleMove/Cobrowse/SiteId": { "get": { "tags": [ "Integrations/SaleMove" ], "operationId": "SaleMove_GetSiteIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SaleMove/GliaRepChatSupport": { "get": { "tags": [ "Integrations/SaleMove" ], "operationId": "SaleMove_GliaRepChatSupportAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SaleMove/GliaServiceTeam": { "get": { "tags": [ "Integrations/SaleMove" ], "operationId": "SaleMove_GetGliaService", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "serviceTeamId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SaleMove/GliaServiceTeam/Add": { "post": { "tags": [ "Integrations/SaleMove" ], "operationId": "SaleMove_GliaServiceTeamAddAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "gliaServiceDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.GliaServiceDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SaleMove/GliaServiceTeam/Delete/{serviceTeamId}": { "delete": { "tags": [ "Integrations/SaleMove" ], "operationId": "SaleMove_GliaServiceTeamDeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "serviceTeamId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SaleMove/GliaServiceTeam/Update/{serviceTeamId}": { "put": { "tags": [ "Integrations/SaleMove" ], "operationId": "SaleMove_GliaServiceTeamUpdateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "serviceTeamId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "gliaServiceDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.GliaServiceDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SaleMove/Operator/{userId}": { "get": { "tags": [ "Integrations/SaleMove" ], "operationId": "SaleMove_GetOperatorFromUserIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "alClientId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SaleMove/Operator/{userId}/Firm/{alClientId}": { "get": { "tags": [ "Integrations/SaleMove" ], "operationId": "SaleMove_GetOperatorFromUserIdAndAlClientIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "alClientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SaleMove/OrionSiteId": { "get": { "tags": [ "Integrations/SaleMove" ], "operationId": "SaleMove_GetOrionSiteIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SaleMove/Premier": { "get": { "tags": [ "Integrations/SaleMove" ], "operationId": "SaleMove_GetPremierStatusAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "alClientId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SaleMove/PremierQueues": { "get": { "tags": [ "Integrations/SaleMove" ], "operationId": "SaleMove_CheckPremierQueues", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SaleMove/Queues": { "get": { "tags": [ "Integrations/SaleMove" ], "operationId": "SaleMove_GetQueuesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SaleMove/SiteId/{alClientId}": { "get": { "tags": [ "Integrations/SaleMove" ], "operationId": "SaleMove_GetSiteIdByAlClientIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "alClientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/SaleMove" ], "operationId": "SaleMove_NewIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "alClientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/Action/CommunitySAML": { "get": { "tags": [ "Integrations/Salesforce" ], "summary": "our Orion Support App SSO poorly named endpoint.", "operationId": "SalesforceOrionConnect_StartCommunitySSOAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "householdId", "in": "query", "required": false, "type": "string", "default": "" }, { "name": "ssoStartPage", "in": "query", "required": false, "type": "string", "default": "" }, { "name": "logOutUrl", "in": "query", "required": false, "type": "string", "default": "" }, { "name": "relayState", "in": "query", "required": false, "type": "string", "default": "" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/Action/ElementSAML": { "get": { "tags": [ "Integrations/Salesforce" ], "summary": "our support App SSO for Element", "operationId": "SalesforceOrionConnect_StartCommunitySSOForElementAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "householdId", "in": "query", "required": false, "type": "string", "default": "" }, { "name": "ssoStartPage", "in": "query", "required": false, "type": "string", "default": "" }, { "name": "logOutUrl", "in": "query", "required": false, "type": "string", "default": "" }, { "name": "relayState", "in": "query", "required": false, "type": "string", "default": "" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/Action/InvoiceSso": { "get": { "tags": [ "Integrations/Salesforce" ], "summary": "SSO SF Orion Invoicing Experience", "operationId": "SalesforceOrionConnect_StartInvoiceSsoAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ssoStartPage", "in": "query", "description": "Optional start page", "required": false, "type": "string", "default": "" }, { "name": "logOutUrl", "in": "query", "description": "Optional Logout", "required": false, "type": "string", "default": "" }, { "name": "relayState", "in": "query", "required": false, "type": "string", "default": "" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/Action/SAML": { "get": { "tags": [ "Integrations/Salesforce" ], "summary": "Our Custom SSO to other org Salesforce", "operationId": "SalesforceOrionConnect_StartSSOAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "householdId", "in": "query", "required": false, "type": "string", "default": "" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/ChatContext": { "get": { "tags": [ "Integrations/Salesforce" ], "operationId": "SalesforceOrionConnect_ChatContextForOrionSalesforceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cleanResponse", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "state", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/Compare": { "get": { "tags": [ "Integrations/Salesforce" ], "summary": "Looks up a record in salesforce, and orion, and returns the values for that record from both systems.", "operationId": "SalesforceOrionConnect_CompareRecordAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "query", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "orgId", "in": "query", "description": "Optional.", "required": false, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.Salesforce.CompareRecordDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/Salesforce" ], "summary": "Syncs Orion with the salesforce values.", "operationId": "SalesforceOrionConnect_UpdateCompareRecordAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "compare", "in": "body", "description": "The comparison object from the Get endpoint.", "required": true, "schema": { "$ref": "#/definitions/OAS.Integrations.Salesforce.CompareRecordDto" } }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.Salesforce.CompareRecordDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/Config": { "get": { "tags": [ "Integrations/Salesforce" ], "operationId": "SalesforceOrionConnect_GetConfigAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "alClientId", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Salesforce.CustomCommunitiesSamlConfig" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/Salesforce" ], "operationId": "SalesforceOrionConnect_PutV1IntegrationsSalesforceOrionConnectConfig", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "Config", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Salesforce.CustomCommunitiesSamlConfig" } }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Salesforce.CustomCommunitiesSamlConfig" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/Salesforce" ], "operationId": "SalesforceOrionConnect_UpdateConfigAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "Config", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Salesforce.CustomCommunitiesSamlConfig" } }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Salesforce.CustomCommunitiesSamlConfig" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/DataSync/Settings/{alClientId}/{repIds}": { "get": { "tags": [ "Integrations/Salesforce" ], "operationId": "SalesforceOrionConnect_GetSyncAndFieldMappingSettingsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "alClientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "repIds", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/DeltaSync/{entity}/{key}": { "post": { "tags": [ "Integrations/Salesforce" ], "summary": "Triggers delta sync", "operationId": "SalesforceOrionConnect_DeltaSyncAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/GetUpdatedUsersSync/{daysPriorToday}": { "get": { "tags": [ "Integrations/Salesforce" ], "summary": "Gets users with updated details given `daysPriorToday` days prior to today", "operationId": "SalesforceOrionConnect_GetUpdatedUsersDataAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "daysPriorToday", "in": "path", "description": "Days prior to today. Default 1, Max 365", "required": true, "type": "integer", "format": "int32", "default": 1 }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 120 } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/GetUpdatedUsersSync/{editedDate}": { "get": { "tags": [ "Integrations/Salesforce" ], "summary": "Gets users with details updated on the specified calendar date.", "operationId": "SalesforceOrionConnect_GetV1IntegrationsSalesforceOrionConnectGetUpdatedUsersSyncByEditedDate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "editedDate", "in": "path", "description": "Date to retrieve (e.g. 2026-07-14). Must be between today and 365 days ago, inclusive.", "required": true, "type": "string", "format": "date-time" }, { "name": "timeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 120 } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/ImplementationSummary": { "get": { "tags": [ "Integrations/Salesforce" ], "summary": "Calls to salesforce to pull back implementation information to feed the implementation Gantt chart and page.", "operationId": "SalesforceOrionConnect_GetImplementationSummaryAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/Namespace": { "get": { "tags": [ "Integrations/Salesforce" ], "operationId": "SalesforceOrionConnect_GetNamespaceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/PassThrough/{path}": { "get": { "tags": [ "Integrations/Salesforce" ], "operationId": "SalesforceOrionConnect_PassGetToSalesforceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "path", "in": "path", "required": true, "type": "string" }, { "name": "cleanResponse", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/Salesforce" ], "operationId": "SalesforceOrionConnect_PassPostToSalesforceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "path", "in": "path", "required": true, "type": "string" }, { "name": "cleanResponse", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/Projects": { "get": { "tags": [ "Integrations/Salesforce" ], "summary": "Calls to salesforce to pull back implementation information to feed the implementation Gantt chart and page.", "operationId": "SalesforceOrionConnect_GetOrionProjectsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.Salesforce.OrionConnect.ProjectItemsDto" }, "xml": { "name": "ProjectItemsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/Projects/{projectId}": { "get": { "tags": [ "Integrations/Salesforce" ], "summary": "Calls to salesforce to pull back implementation information to feed the implementation Gantt chart and page.", "operationId": "SalesforceOrionConnect_GetProjectSummaryAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/Redirect": { "post": { "tags": [ "Integrations/Salesforce" ], "summary": "Return redirect url.", "operationId": "SalesforceOrionConnect_SaleForceRedirectAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "p", "in": "query", "required": true, "type": "string" }, { "name": "m", "in": "query", "required": true, "type": "string" }, { "name": "dbId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/SetIdentity": { "post": { "tags": [ "Integrations/Salesforce" ], "operationId": "SalesforceOrionConnect_SetIdentityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.Code.Integrations.SalesforceSetIdentityDto" } }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/SetupIntegration": { "get": { "tags": [ "Integrations/Salesforce" ], "operationId": "SalesforceOrionConnect_SetupIntegrationByAlClientIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/Salesforce" ], "operationId": "SalesforceOrionConnect_SetupIntegrationPostAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "setup", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Integration.OrionConnect.SalesforceUser" } }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/SetupIntegration/{id}": { "get": { "tags": [ "Integrations/Salesforce" ], "operationId": "SalesforceOrionConnect_SetupIntegrationGetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/Salesforce" ], "operationId": "SalesforceOrionConnect_SetupIntegrationPatchAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "setup", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Integration.OrionConnect.SalesforceUser" } }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Integrations/Salesforce" ], "operationId": "SalesforceOrionConnect_SetupIntegrationDeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/SetupIntegration/OrgId/{orgId}": { "get": { "tags": [ "Integrations/Salesforce" ], "operationId": "SalesforceOrionConnect_SetupIntegrationGetWithOrgIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "orgId", "in": "path", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/SocialAPI/Cases": { "get": { "tags": [ "Integrations/Salesforce" ], "operationId": "SalesforceOrionConnect_SocialAPI_Cases_GetListAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "filter", "in": "query", "required": false, "type": "string", "default": "waitingonorion" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/Salesforce" ], "operationId": "SalesforceOrionConnect_SocialAPI_Cases_CreateAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/SocialAPI/Cases/{caseNumber}": { "get": { "tags": [ "Integrations/Salesforce" ], "operationId": "SalesforceOrionConnect_SocialAPI_Cases_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "caseNumber", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Integrations/Salesforce" ], "operationId": "SalesforceOrionConnect_SocialAPI_Cases_DeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "caseNumber", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "patch": { "tags": [ "Integrations/Salesforce" ], "summary": "updates case objects to salesforce tied to the specified case number.", "operationId": "SalesforceOrionConnect_SocialAPI_Cases_PatchAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "caseNumber", "in": "path", "description": "Salesforce Case ID", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/SocialAPI/Cases/{caseNumber}/Attachments": { "get": { "tags": [ "Integrations/Salesforce" ], "operationId": "SalesforceOrionConnect_SocialAPI_Cases_GetAttachmentAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "caseNumber", "in": "path", "required": true, "type": "string" }, { "name": "fileName", "in": "query", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/SocialAPI/Cases/{caseNumber}/Attachments/{fileName}": { "post": { "tags": [ "Integrations/Salesforce" ], "operationId": "SalesforceOrionConnect_SocialAPI_Cases_AttachFileAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "caseNumber", "in": "path", "required": true, "type": "string" }, { "name": "fileName", "in": "path", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/SocialAPI/Cases/{caseNumber}/Messages": { "get": { "tags": [ "Integrations/Salesforce" ], "summary": "Gets message objects back from salesforce tied to the specified case number.", "operationId": "SalesforceOrionConnect_SocialAPI_Cases_GetMessagesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "caseNumber", "in": "path", "description": "Salesforce Case ID", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/Salesforce" ], "operationId": "SalesforceOrionConnect_SocialAPI_Cases_CreateMessageAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "caseNumber", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/SocialAPI/Cases/Export": { "post": { "tags": [ "Integrations/Salesforce" ], "operationId": "SalesforceOrionConnect_SocialAPI_Cases_ExportAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "caseIds", "in": "body", "required": true, "schema": { "items": { "type": "string" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/SocialAPI/Cases/Picklists": { "get": { "tags": [ "Integrations/Salesforce" ], "operationId": "SalesforceOrionConnect_SocialAPI_Cases_GetPicklistsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/SocialAPI/Cases/Search": { "get": { "tags": [ "Integrations/Salesforce" ], "operationId": "SalesforceOrionConnect_SocialAPI_Cases_SearchAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "DateFrom", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "DateTo", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "Limit", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "MaxDesc", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 255 } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/SocialAPI/Contact/{email}": { "get": { "tags": [ "Integrations/Salesforce" ], "operationId": "SalesforceOrionConnect_SocialAPI_Contact_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "email", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/SocialAPI/Contacts": { "get": { "tags": [ "Integrations/Salesforce" ], "summary": "Gets authorized contacts with access to Orion Support back from salesforce tied to the advisor.", "operationId": "SalesforceOrionConnect_SocialAPI_Contact_GetAuthorizedContactsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/SocialAPI/Projects": { "get": { "tags": [ "Integrations/Salesforce" ], "summary": "Get a list of projects for the current advisornumber.", "operationId": "SalesforceOrionConnect_SocialAPI_Projects_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "description": "Projects created on or after this date.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Projects created on or before this date.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/SocialAPI/Projects/{projectId}/Attachments/{fileName}": { "post": { "tags": [ "Integrations/Salesforce" ], "operationId": "SalesforceOrionConnect_SocialAPI_Projects_AttachFileAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "type": "string" }, { "name": "fileName", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/SSOSessionId": { "get": { "tags": [ "Integrations/Salesforce" ], "summary": "Logs user into salesforce to the specified page.", "operationId": "SalesforceOrionConnect_SSOSessionIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/Sync": { "post": { "tags": [ "Integrations/Salesforce" ], "summary": "Triggers full sync", "operationId": "SalesforceOrionConnect_SyncAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/SyncFromOrion/{alClientId}/{firmOrgId}": { "get": { "tags": [ "Integrations/Salesforce" ], "summary": "Triggers a sync job in Hangfire, passing parameters in the URI instead of a body.\r\nMay not be used after initial testing from Salesforce.", "operationId": "SalesforceOrionConnect_RunSyncJobAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "alClientId", "in": "path", "description": "The Orion Firm ID.", "required": true, "type": "integer", "format": "int32" }, { "name": "firmOrgId", "in": "path", "description": "The Salesforce Org ID.", "required": true, "type": "string" }, { "name": "syncType", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 1 }, { "name": "repIds", "in": "query", "required": false, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/SyncFromOrion/TestRep": { "get": { "tags": [ "Integrations/Salesforce" ], "operationId": "SalesforceOrionConnect_TestRepAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/SyncHistory": { "get": { "tags": [ "Integrations/Salesforce" ], "summary": "Returns recent Salesforce sync history within the specified date range.\r\nBy default returns only sync history summary without child objects for optimal performance.\r\nReturns a wrapper object containing the total count and a paginated list of sync history entries.", "operationId": "SalesforceOrionConnect_GetSyncHistoryAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "description": "Start of the time period for which sync history is returned (required)", "required": true, "type": "string", "format": "date-time" }, { "name": "limit", "in": "query", "description": "Number of records to return (required, max 10000)", "required": true, "type": "integer", "format": "int32" }, { "name": "endDate", "in": "query", "description": "End of the time period for which sync history is returned (optional, defaults to current time)", "required": false, "type": "string", "format": "date-time" }, { "name": "skip", "in": "query", "description": "Number of records to skip for pagination (default 0)", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "syncType", "in": "query", "description": "Optional sync type filter (0=all, 1=Full, etc.)", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "includeObjects", "in": "query", "description": "Whether to include child objects in the response (default false for better performance)", "required": false, "type": "boolean", "default": false }, { "name": "ct", "in": "header", "description": "Cancellation token", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/SyncJobState/{jobId}": { "get": { "tags": [ "Integrations/Salesforce" ], "summary": "Gets the {Hangfire.Storage.StateData} of the Hangfire job matching the provided ID.", "operationId": "SalesforceOrionConnect_GetJobStateData", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "jobId", "in": "path", "description": "The ID of the Hangfire job to check.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Hangfire.Storage.StateData" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/SyncJobStatus/{jobId}": { "get": { "tags": [ "Integrations/Salesforce" ], "summary": "", "operationId": "SalesforceOrionConnect_GetSyncJobStatus", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "jobId", "in": "path", "description": "The Hangfire Job ID of the Salesforce sync.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integration.Salesforce.SyncJobStatus" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/SyncPerformance": { "get": { "tags": [ "Integrations/Salesforce" ], "summary": "Returns performance metrics for full syncs within the specified timeframe.\r\nReturns main sync metrics with nested object-level metrics. Calculates averages or max values \r\noptionally grouped by time period (day/week/month/year) for completed full syncs only.", "operationId": "SalesforceOrionConnect_GetSyncPerformanceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "fromDate", "in": "query", "description": "Optional specific start date", "required": false, "type": "string", "format": "date-time" }, { "name": "daysBack", "in": "query", "description": "Optional number of days to look back (default 30, max 365)", "required": false, "type": "integer", "format": "int32" }, { "name": "syncType", "in": "query", "description": "Sync type (default 1=Full sync)", "required": false, "type": "integer", "format": "int32", "default": 1 }, { "name": "groupBy", "in": "query", "description": "Optional grouping period: Day (0), Week (1), Month (2), or Year (3). If null, no period grouping is applied.", "required": false, "type": "string", "enum": [ "Day", "Week", "Month", "Year" ] }, { "name": "lastNumberOfSync", "in": "query", "description": "Optional number of most recent syncs to analyze. If null, uses all syncs in date range.", "required": false, "type": "integer", "format": "int32" }, { "name": "typeOfPerformance", "in": "query", "description": "Performance calculation type: Average (0, default) or Max (1)", "required": false, "type": "string", "default": 0, "enum": [ "Average", "Max" ] }, { "name": "ct", "in": "header", "description": "Cancellation token", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/SyncStatus": { "get": { "tags": [ "Integrations/Salesforce" ], "summary": "Returns the most recent Salesforce sync entry with child objects.\r\nThis endpoint is optimized for fast performance and frequent polling to monitor current sync status.", "operationId": "SalesforceOrionConnect_GetSyncStatusAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "syncType", "in": "query", "description": "Optional sync type filter (0=all, 1=Full, etc.)", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "ct", "in": "header", "description": "Cancellation token", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Salesforce/OrionConnect/TestChatter": { "get": { "tags": [ "Integrations/Salesforce" ], "summary": "Calls to salesforce to pull back implementation information to feed the implementation Gantt chart and page.", "operationId": "SalesforceOrionConnect_TestChatterAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SalesforceSync/Setup": { "get": { "tags": [ "Integrations/SalesforceSync" ], "operationId": "SalesforceSync_GetSetupsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/SalesforceSync" ], "operationId": "SalesforceSync_PostSetupsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.Code.Integrations.SalesForce.SfSyncPostDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SalesforceSync/Setup/{id}": { "delete": { "tags": [ "Integrations/SalesforceSync" ], "operationId": "SalesforceSync_DeleteSetupsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SAML/CAIS": { "get": { "tags": [ "Integrations/SAML" ], "operationId": "IntegrationSaml_CAIS_SamlAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "relayState", "in": "query", "required": false, "type": "string" }, { "name": "isWealth", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SAML/CAISWM": { "get": { "tags": [ "Integrations/SAML" ], "operationId": "IntegrationSaml_CAISWealthManagement_SamlAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "relayState", "in": "query", "required": false, "type": "string" }, { "name": "isWealth", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SAML/DPL": { "get": { "tags": [ "Integrations/SAML" ], "operationId": "IntegrationSaml_DPL_SamlAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "relayState", "in": "query", "required": false, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SAML/iCapital": { "get": { "tags": [ "Integrations/SAML" ], "operationId": "IntegrationSaml_iCapital_SamlAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "relayState", "in": "query", "required": false, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SAML/SamlServices/AddOrUpdateSamlPartner": { "post": { "tags": [ "Integrations/SAML" ], "operationId": "IntegrationSaml_AddOrUpdateSamlPartnerInfoAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "payload", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Integrations.SamlServices.Models.PartnerInfoDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SAML/SamlServices/CheckSamlUpdatePrivilege": { "get": { "tags": [ "Integrations/SAML" ], "summary": "Check if user can perform SAML updates (certificates, etc)", "operationId": "IntegrationSaml_CheckSamlUpdatePrivilegeAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SAML/SamlServices/GetClientGlobalId/{houseHoldGlobalId}": { "get": { "tags": [ "Integrations/SAML" ], "summary": "", "operationId": "IntegrationSaml_GetClientGlobalIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "houseHoldGlobalId", "in": "path", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SAML/SamlServices/GetExpiringCertificates/{interval}/{duration}": { "get": { "tags": [ "Integrations/SAML" ], "operationId": "IntegrationSaml_GetExpiringCertificatesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "interval", "in": "path", "required": true, "type": "string" }, { "name": "duration", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SAML/SamlServices/GetMappedUser": { "get": { "tags": [ "Integrations/SAML" ], "summary": "", "operationId": "IntegrationSaml_GetMappedUserAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "applink", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "external", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SAML/SamlServices/GetPartnerDatabases": { "get": { "tags": [ "Integrations/SAML" ], "summary": "", "operationId": "IntegrationSaml_GetPartnerDatabasesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "partnerid", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SAML/SamlServices/GetPartnerInfo": { "get": { "tags": [ "Integrations/SAML" ], "summary": "Step 1: After SamlResponse is received and parsed, obtain PartnerInfo from Saml.Issuer.NameIdentifier", "operationId": "IntegrationSaml_GetPartnerInfoAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "issuer", "in": "query", "description": "Saml Issuer from Assertion", "required": true, "type": "string" }, { "name": "partnerAppId", "in": "query", "description": "Saml Partner Id from Assertion", "required": false, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SAML/SamlServices/GetSamlConfig": { "get": { "tags": [ "Integrations/SAML" ], "operationId": "IntegrationSaml_GetSamlConfigAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "samlIssuer", "in": "query", "required": true, "type": "string" }, { "name": "partnerAppId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "certSerialNumber", "in": "query", "required": false, "type": "string", "default": "" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SAML/SamlServices/GetSamlConfigByCertSerial": { "get": { "tags": [ "Integrations/SAML" ], "operationId": "IntegrationSaml_GetSamlConfigByCertSerialNoAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "serialNumber", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SAML/SamlServices/GetSamlConfigByCertThumbprint": { "get": { "tags": [ "Integrations/SAML" ], "operationId": "IntegrationSaml_GetSamlConfigByCertThumbprintAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "thumbprint", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SAML/SamlServices/GetSamlConfigByIssuer": { "get": { "tags": [ "Integrations/SAML" ], "operationId": "IntegrationSaml_GetSamlConfigByIssuerAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "samlIssuer", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SAML/SamlServices/GetSamlConfigByPartnerId": { "get": { "tags": [ "Integrations/SAML" ], "operationId": "IntegrationSaml_GetV1IntegrationsSAMLSamlServicesGetSamlConfigByPartnerId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "partnerId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SAML/SamlServices/GetServiceCredentials": { "get": { "tags": [ "Integrations/SAML" ], "summary": "", "operationId": "IntegrationSaml_GetServiceCredentialsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "partnerid", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "firmid", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "issuer", "in": "query", "description": "Saml Issuer from Assertion", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SAML/SamlServices/GetUserProfiles": { "get": { "tags": [ "Integrations/SAML" ], "summary": "", "operationId": "IntegrationSaml_GetUserProfilesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "userId", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SAML/SamlServices/SaveMappedUser": { "post": { "tags": [ "Integrations/SAML" ], "summary": "", "operationId": "IntegrationSaml_SaveMappedUserAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "userId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "applink", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "external", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SAML/SamlServices/Test": { "get": { "tags": [ "Integrations/SAML" ], "operationId": "IntegrationSaml_HelloWorld", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabAlliance/Action/SAML": { "get": { "tags": [ "Integrations/SchwabAlliance" ], "operationId": "SchwabAlliance_StartSSOAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "landingpage", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabAlliance/GetAccountBlockNumbers": { "get": { "tags": [ "Integrations/SchwabAlliance" ], "operationId": "SchwabAlliance_GetAccountBlockNumbersAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.SchwabAlliance.Models.AccountBlockNumbersRetrieveResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabAlliance/GetToken": { "get": { "tags": [ "Integrations/SchwabAlliance" ], "operationId": "SchwabAlliance_GetTokenAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "code", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.SchwabAlliance.SchwabAllianceToken" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabAlliance/IntegratedFirms/{firmId}/Users": { "get": { "tags": [ "Integrations/SchwabAlliance" ], "summary": "Gets Schwab-integrated users for a specific firm. Requires admin entity and IntegrationsSetup privilege.", "operationId": "SchwabAlliance_GetIntegratedFirmUsersAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "firmId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabAlliance/IntegratedFirms/Summary": { "get": { "tags": [ "Integrations/SchwabAlliance" ], "summary": "Gets all Schwab-integrated firms with user counts. Requires admin entity and IntegrationsSetup privilege.", "operationId": "SchwabAlliance_GetIntegratedFirmsSummaryAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabAlliance/IntegratedUsers/{userId}/{userDetailId}": { "delete": { "tags": [ "Integrations/SchwabAlliance" ], "summary": "Clears the Schwab Alliance connection for a specific user. Requires admin entity and IntegrationsSetup privilege.", "operationId": "SchwabAlliance_ClearUserConnectionAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "userDetailId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabAlliance/IntegratedUsers/Firm": { "get": { "tags": [ "Integrations/SchwabAlliance" ], "summary": "Gets Schwab-integrated users for the current user's firm. Requires admin entity and IntegrationsSetup privilege.", "operationId": "SchwabAlliance_GetFirmIntegratedUsersAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabAlliance/Redirect": { "get": { "tags": [ "Integrations/SchwabAlliance" ], "operationId": "SchwabAlliance_GetRedirectUrlAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabAlliance/RefreshToken": { "get": { "tags": [ "Integrations/SchwabAlliance" ], "operationId": "SchwabAlliance_RefreshTokenAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.SchwabAlliance.SchwabAllianceToken" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabAlliance/ReserveAccountBlockNumbers": { "post": { "tags": [ "Integrations/SchwabAlliance" ], "operationId": "SchwabAlliance_ReserveAccountBlockNumbersAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "numberOfAccounts", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.SchwabAlliance.Models.AccountBlockNumbersRetrieveResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabAlliance/ServiceAccount": { "get": { "tags": [ "Integrations/SchwabAlliance" ], "operationId": "SchwabAlliance_GetServiceAccountAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/SchwabAlliance" ], "operationId": "SchwabAlliance_PostServiceAccountAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Integrations.SchwabV2.Shared.SchwabSAPostDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabAlliance/ServiceAccount/AllTokens": { "get": { "tags": [ "Integrations/SchwabAlliance" ], "operationId": "SchwabAlliance_ServiceAccountAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabAlliance/ServiceAccount/Delete": { "post": { "tags": [ "Integrations/SchwabAlliance" ], "operationId": "SchwabAlliance_DeleteServiceAccountAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Integrations.SchwabV2.Shared.SchwabSAPostDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabAlliance/UserToken": { "get": { "tags": [ "Integrations/SchwabAlliance" ], "operationId": "SchwabAlliance_UserTokenAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.SchwabAlliance.SchwabAllianceToken" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabBatch/Beneficiaries": { "get": { "tags": [ "Integrations/SchwabBatch" ], "operationId": "SchwabBatch_GetBeneficiariesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "batchId", "in": "query", "required": false, "type": "string", "default": "" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabBatch/GetRmdEnrollment": { "get": { "tags": [ "Integrations/SchwabBatch" ], "operationId": "SchwabBatch_GetRmdEnrollmentAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabBatch/RMD": { "get": { "tags": [ "Integrations/SchwabBatch" ], "operationId": "SchwabBatch_GetRMDAsucnAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "batchId", "in": "query", "required": false, "type": "string", "default": "" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabBatch/RmdEnroll": { "get": { "tags": [ "Integrations/SchwabBatch" ], "operationId": "SchwabBatch_RmdEnrollAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabBatch/RmdUnEnroll": { "get": { "tags": [ "Integrations/SchwabBatch" ], "operationId": "SchwabBatch_RmdUnEnrollAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabServiceRequest/{householdId}/UpdateAddress": { "post": { "tags": [ "Integrations/SchwabServiceRequest" ], "summary": "Method to update address in Schwab", "operationId": "SchwabServiceRequest_UpdateAddressAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "householdId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabServiceRequest/Create": { "post": { "tags": [ "Integrations/SchwabServiceRequest" ], "summary": "Method send a request to Schwab Request Center.", "operationId": "SchwabServiceRequest_CreateRequestCenterTicketAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.ServiceRequestData" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Integration.ResultItemOfOAT.Integrations.Schwab.SII.Dto.SchwabServiceResponseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabServiceRequest/CreateV2": { "post": { "tags": [ "Integrations/SchwabServiceRequest" ], "operationId": "SchwabServiceRequest_CreateSchwabServiceRequestAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Integrations.SchwabV2.ServiceRequest.Models.SchwabCreateServiceRequestRequestDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabServiceRequest/test": { "get": { "tags": [ "Integrations/SchwabServiceRequest" ], "operationId": "SchwabServiceRequest_TestGetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabServiceRequest/Topics": { "get": { "tags": [ "Integrations/SchwabServiceRequest" ], "summary": "Method to request center topics picklist", "operationId": "SchwabServiceRequest_GetSchwabRequestCenterTopicsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "otp", "in": "query", "required": false, "type": "string", "default": "" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.SchwabRequestCenterDTO" }, "xml": { "name": "SchwabRequestCenterDTO", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabServiceRequest/TopicsV2": { "get": { "tags": [ "Integrations/SchwabServiceRequest" ], "operationId": "SchwabServiceRequest_GetSchwabRequestCenterTopicsV2Async", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabSII/Accounts/{accountId}/Preferences/CostBasis": { "get": { "tags": [ "Integrations/SchwabSII" ], "summary": "Method to retrieve Account CostBasis Preferences from Schwab SII", "operationId": "SchwabSii_GetCostBasisPreferencesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "otp", "in": "query", "description": "One-Time Password", "required": false, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.SchwabSIICostBasicPreferencesResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabSII/Accounts/{accountId}/RealizedGainLoss": { "get": { "tags": [ "Integrations/SchwabSII" ], "summary": "Method to retrieve Account Realized Gain Loss information from Schwab Rest API", "operationId": "SchwabSii_GetRestAccountRealizedGainLossAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "required": true, "type": "string" }, { "name": "endDate", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.SchwabRestRealizedGainLossResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabSII/Accounts/{accountId}/Report/PDF": { "post": { "tags": [ "Integrations/SchwabSII" ], "summary": "Method to retrieve Account Report PDF from Schwab Rest API", "operationId": "SchwabSii_GetRestAccountReportsPdfAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.SchwabRestReportRequest" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabSII/Accounts/{accountId}/Report/PDF/{sessionId}": { "get": { "tags": [ "Integrations/SchwabSII" ], "summary": "Method to retrieve Account Report PDF from Schwab Rest API", "operationId": "SchwabSii_GetV1IntegrationsSchwabSIIAccountsByAccountIdReportPDFBySessionId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "sessionId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabSII/Accounts/{accountId}/Reports": { "get": { "tags": [ "Integrations/SchwabSII" ], "summary": "Method to retrieve Account Reports from Schwab Rest API", "operationId": "SchwabSii_GetRestAccountReportsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "endDate", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "reportType", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.SchwabRestReportResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabSII/Accounts/{accountId}/TransactionDetail": { "get": { "tags": [ "Integrations/SchwabSII" ], "summary": "Method to retrieve Account Profile from Schwab Rest API", "operationId": "SchwabSii_GetRestAccountTransactionDetailAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "execDate", "in": "query", "description": "Execution date from Transaction requested", "required": true, "type": "string" }, { "name": "publishTimeStamp", "in": "query", "description": "Execution date from Transaction requested", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.SchwabRestTransDetailResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabSII/Accounts/{accountId}/Transactions": { "get": { "tags": [ "Integrations/SchwabSII" ], "summary": "Method to retrieve Account Profile from Schwab Rest API", "operationId": "SchwabSii_GetRestAccountTransactionsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "required": true, "type": "string" }, { "name": "endDate", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.SchwabRestTransactionResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabSII/Accounts/{accountId}/UnrealizedGainLoss": { "get": { "tags": [ "Integrations/SchwabSII" ], "summary": "Method to retrieve Account Unrealized Gain Loss Information from Schwab Rest API", "operationId": "SchwabSii_GetRestAccountUnrealizedGainLossAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.SchwabRestUnrealizedGainLossDetailResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabSII/Accounts/{accountId}/UnrealizedGainLoss/{positionId}/Lots": { "get": { "tags": [ "Integrations/SchwabSII" ], "summary": "Method to retrieve Account Unrealized Gain Loss Lot Information from Schwab Rest API", "operationId": "SchwabSii_GetRestAccountUnrealizedGainLossLotDetailAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "positionId", "in": "path", "required": true, "type": "string" }, { "name": "cacheId", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.UnRealizedPositionLotDetailResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabSII/Actions/Remove": { "post": { "tags": [ "Integrations/SchwabSII" ], "summary": "Removes the Schwab integration for the current user.", "description": "The user must have the necessary privileges to remove the integration.", "operationId": "SchwabSii_RemoveServiceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabSII/Actions/Setup": { "post": { "tags": [ "Integrations/SchwabSII" ], "operationId": "SchwabSii_SetupServiceAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "setupRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.IntegrationSetupRequestDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.BasicIntegrationConfigDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabSII/EnrollmentStatus": { "get": { "tags": [ "Integrations/SchwabSII" ], "summary": "Method to retrieve Enrollment Status with Schwab SII", "operationId": "SchwabSii_GetEnrollmentStatus", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.SchwabSIIEnrollmentStatusDto" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabSII/Rest/Accounts/{accountId}/Alerts": { "get": { "tags": [ "Integrations/SchwabSII" ], "summary": "Method to retrieve Account Alerts from Schwab Rest API", "operationId": "SchwabSii_GetRestAccountAlertsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "required": false, "type": "string" }, { "name": "endDate", "in": "query", "required": false, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.SchwabSIIAccountAlertsInquiryDtoRest" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabSII/Rest/Accounts/{accountId}/Balances": { "get": { "tags": [ "Integrations/SchwabSII" ], "summary": "Method to retrieve Account Balances from Schwab Rest API", "operationId": "SchwabSii_GetRestAccountBalancesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "otp", "in": "query", "required": false, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.SchwabRestBalance" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabSII/Rest/Accounts/{accountId}/Positions": { "get": { "tags": [ "Integrations/SchwabSII" ], "summary": "Method to retrieve Account Positions from Schwab Rest API", "operationId": "SchwabSii_GetRestAccountPositionsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.SchwabRestPostionsDetail" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabSII/Rest/Accounts/{accountId}/Profile": { "get": { "tags": [ "Integrations/SchwabSII" ], "summary": "Method to retrieve Account Profile from Schwab Rest API", "operationId": "SchwabSii_GetRestAccountProfileAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.SchwabRestProfilesResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabSII/Rest/GetSACToken": { "get": { "tags": [ "Integrations/SchwabSII" ], "summary": "Method to retrieve SAC token for SSO", "operationId": "SchwabSii_GetSACTokenAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabSII/SSO": { "get": { "tags": [ "Integrations/SchwabSII" ], "summary": "New implementations should call Ssov2Connection", "operationId": "SchwabSii_SSOAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "otp", "in": "query", "required": false, "type": "string" }, { "name": "pageId", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "symbol", "in": "query", "required": false, "type": "string" }, { "name": "accountId", "in": "query", "required": false, "type": "string" }, { "name": "actionId", "in": "query", "required": false, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabSII/SsoV2/{landingPage}": { "get": { "tags": [ "Integrations/SchwabSII" ], "summary": "Modernized SSO v2 Flow", "description": "In the existing REST SSO, the user identifier is UserGuid and is used as the SAML SUBJECT for consistency only. Theoritically, it's any unique user identifier and has\r\nNO RELATIONSHIP to existing REST SSO.\r\n REF: {M:OAT.Integrations.Schwab.SII.SchwabRESTService.SingleSignOnAsync(OAT.Integrations.Schwab.SII.SchwabSiiUser,System.String)}httpRequestMessage.Headers.Add(\"Authorization\", \"Basic \" + Convert.ToBase64String(Encoding.UTF8.GetBytes(user.UserGuid)));", "operationId": "SchwabSii_Ssov2ConnectionAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "landingPage", "in": "path", "description": "Optional: landing page sanc. If not provided, wrong code, default SAC home page.", "required": true, "type": "integer", "format": "int32", "default": 0 }, { "name": "cancellationToken", "in": "header", "required": false }, { "name": "context.subaccount", "in": "query", "required": false, "type": "string" }, { "name": "context.masteraccount", "in": "query", "required": false, "type": "string" }, { "name": "context.accountNumber", "in": "query", "required": false, "type": "string" }, { "name": "context.alertid", "in": "query", "required": false, "type": "string" }, { "name": "context.hidenavigation", "in": "query", "required": false, "type": "string" }, { "name": "context.trackingid", "in": "query", "required": false, "type": "string" }, { "name": "context.symbol", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabSII/TestConnection": { "get": { "tags": [ "Integrations/SchwabSII" ], "summary": "Method to test the connectivity with Schwab SII", "operationId": "SchwabSii_TestConnection", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabSII/Unenroll": { "get": { "tags": [ "Integrations/SchwabSII" ], "summary": "Method to retrieve Enrollment Status with Schwab SII", "operationId": "SchwabSii_UnenrollAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.SchwabSIIUnenrollDTO" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabSII/UserAuthorization": { "get": { "tags": [ "Integrations/SchwabSII" ], "summary": "Method to retrieve User Authorization from Schwab. Uses latest OAuth", "operationId": "SchwabSii_UserAuthorizationGetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "otp", "in": "query", "description": "One-Time Password", "required": false, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.SchwabV2.User_Authorizations.SchwabUserAuthorizationsResponseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabSII/UserAuthorization/Action/LogOut": { "get": { "tags": [ "Integrations/SchwabSII" ], "summary": "Method to retrieve LogOut User Authorization from Schwab SII", "operationId": "SchwabSii_UserAuthorizationLogOutAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "SSOCorrelatorId", "in": "query", "required": true, "type": "string" }, { "name": "otp", "in": "query", "description": "One-Time Password", "required": false, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabSII/UserAuthorization/Token": { "get": { "tags": [ "Integrations/SchwabSII" ], "summary": "Method to retrieve User Authorization Token from Schwab SII", "operationId": "SchwabSii_UserAuthorizationGetTokenAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "otp", "in": "query", "description": "One-Time Password", "required": false, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.SchwabSIIUserAuthorizationTokenDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabStatus/AlertsV2": { "get": { "tags": [ "Integrations/SchwabStatus" ], "operationId": "SchwabStatus_GetV2AlertsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "accountNumber", "in": "query", "required": false, "type": "string" }, { "name": "nextCursor", "in": "query", "required": false, "type": "string" }, { "name": "overrideToken", "in": "query", "required": false, "type": "string" }, { "name": "filterType", "in": "query", "required": false, "type": "string" }, { "name": "status", "in": "query", "required": false, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabStatus/AlertsV2/Details": { "post": { "tags": [ "Integrations/SchwabStatus" ], "operationId": "SchwabStatus_PostV2AlertsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Integrations.SchwabV2.Alerts.SchwabAlertsV2DetailDto" } }, { "name": "overrideToken", "in": "query", "required": false, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabStatus/AlertsV2/Details/{detailId}": { "get": { "tags": [ "Integrations/SchwabStatus" ], "operationId": "SchwabStatus_GetV1IntegrationsSchwabStatusAlertsV2DetailsByDetailId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "detailId", "in": "path", "required": true, "type": "string" }, { "name": "overrideToken", "in": "query", "required": false, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabStatus/AlertsV2/ForceRefresh": { "get": { "tags": [ "Integrations/SchwabStatus" ], "operationId": "SchwabStatus_ForceRefreshAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "userId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "userDetailId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabStatus/Limit/{limit}/Skip/{skip}": { "get": { "tags": [ "Integrations/SchwabStatus" ], "operationId": "SchwabStatus_AccountsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "limit", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "skip", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabStatus/OPS/Limit/{limit}/Skip/{skip}": { "get": { "tags": [ "Integrations/SchwabStatus" ], "summary": "Note: Timeouts will occur if requested dataset is too large. Take note of {startDate}, {endDate}, and {firstPageOnly}", "operationId": "SchwabStatus_OPSAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "limit", "in": "path", "description": "Internal. Opaque to Schwab API", "required": true, "type": "integer", "format": "int32" }, { "name": "skip", "in": "path", "description": "Internal. Opaque to Schwab API", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "description": "Default: 1 day ago", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Default: Current UTC time", "required": false, "type": "string", "format": "date-time" }, { "name": "firstPageOnly", "in": "query", "description": "Default: True", "required": false, "type": "boolean", "default": true }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabStatus/OTP": { "post": { "tags": [ "Integrations/SchwabStatus" ], "operationId": "SchwabStatus_OtpAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "otp", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabStatus/StatusV2/OPS": { "get": { "tags": [ "Integrations/SchwabStatus" ], "summary": "This is v2 of the current implementation of the AS Status API.\r\n While the current endpoint accepts ski/take, it is not actually implemented.\r\n A separate end endpoint is being created to support pagination {M:OAS.WebApi.Domains.Integrations.SchwabStatusController.GetPagedStatusV2OpsAsync(System.Int32,System.Int32,System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.Boolean,System.Boolean,System.String,System.Threading.CancellationToken)}", "operationId": "SchwabStatus_GetStatusV2OpsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "firstPageOnly", "in": "query", "description": "Default: true", "required": false, "type": "boolean", "default": true }, { "name": "maskAcct", "in": "query", "description": "Mask account numbers. Default: false", "required": false, "type": "boolean", "default": false }, { "name": "statusFilter", "in": "query", "description": "Comma separated list of filters. Default: empty string (unfiltered)\r\n Action NeededCanceledIn ProcessNewResolved", "required": false, "type": "string", "default": "" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabStatus/StatusV2/OPS/Events": { "get": { "tags": [ "Integrations/SchwabStatus" ], "operationId": "SchwabStatus_GetStatusV2EventsOpsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "feedId", "in": "query", "required": true, "type": "string" }, { "name": "statusObjectId", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabStatus/StatusV2/OPS/Limit/{limit}/Skip/{skip}": { "get": { "tags": [ "Integrations/SchwabStatus" ], "summary": "Proxy for AS Status POST: /stat-feed/status-objects", "operationId": "SchwabStatus_GetPagedStatusV2OpsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "limit", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "skip", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "description": "Note: Schwab API is based on EST. The earliest and default date supported is 90 days prior", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Note: Schwab API is based on EST", "required": false, "type": "string", "format": "date-time" }, { "name": "firstPageOnly", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "maskAcct", "in": "query", "description": "Mask account numbers. Default: false", "required": false, "type": "boolean", "default": false }, { "name": "statusFilter", "in": "query", "description": "Comma separated list of filters. Default: empty string (unfiltered)\r\n Action NeededCanceledIn ProcessNewResolved", "required": false, "type": "string", "default": "" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SchwabStatus/TestCert": { "get": { "tags": [ "Integrations/SchwabStatus" ], "operationId": "SchwabStatus_TestCertAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "limit", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/ShareFile/Configuration": { "get": { "tags": [ "Integrations/ShareFile" ], "summary": "Gets the configuration data for ShareFile for the current user.", "operationId": "ShareFile_GetConfiguration", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.BasicIntegrationConfigDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/ShareFile/Remove": { "post": { "tags": [ "Integrations/ShareFile" ], "summary": "Sets up ShareFile integration for the current user.", "description": "The user must have the necessary privileges to setup the integration.", "operationId": "ShareFile_RemoveServiceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/ShareFile/Setup": { "post": { "tags": [ "Integrations/ShareFile" ], "summary": "Sets up ShareFile integration for the current user.", "description": "The user must have the necessary privileges to setup the integration.", "operationId": "ShareFile_SetupServiceAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "description": "An {OAS.WebApi.DTO.Integrations.PartnerAppConfigurationDto} containing the parameters for the ShareFile setup.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.IntegrationSetupRequestDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Fuse.IntegrationDto" }, "xml": { "name": "IntegrationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SmartIQ/SSO": { "get": { "tags": [ "Integrations/SmartIQ" ], "operationId": "SmartIQ_SmartIqSamlAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "isproduce", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "relaystate", "in": "query", "required": false, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SmartIQ/UserSync": { "get": { "tags": [ "Integrations/SmartIQ" ], "operationId": "SmartIQ_GetUserInfoByPrivilegeAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entityid", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "isactive", "in": "query", "required": false, "type": "boolean" }, { "name": "entityenum", "in": "query", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "firstname", "in": "query", "required": false, "type": "string" }, { "name": "lastname", "in": "query", "required": false, "type": "string" }, { "name": "page", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 1 }, { "name": "pagesize", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Integrations.SmartIQController.SmartIqSync" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Support/IpRestrictions": { "put": { "tags": [ "Integrations/Support" ], "operationId": "Support_UpsertIPRestriction", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ipRanges", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Security.AlClientIpRange" }, "xml": { "name": "AlClientIpRange", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/Support" ], "operationId": "Support_PostV1IntegrationsSupportIpRestrictions", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ipRanges", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Security.AlClientIpRange" }, "xml": { "name": "AlClientIpRange", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Support/IpRestrictions/{AlClient}": { "get": { "tags": [ "Integrations/Support" ], "operationId": "Support_GetIPRestrictionAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "AlClient", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Support/IpRestrictions/{alClientId}": { "delete": { "tags": [ "Integrations/Support" ], "operationId": "Support_DeleteIPRestriction", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "alClientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Support/IsContactUsV2Enabled": { "get": { "tags": [ "Integrations/Support" ], "operationId": "Support_IsContactUsV2EnabledAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Support/PartnerApp": { "put": { "tags": [ "Integrations/Support" ], "operationId": "Support_CreatePartnerapp", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "partnerApp", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Security.PartnerApp" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Security.PartnerApp" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Integrations/Support" ], "operationId": "Support_PostV1IntegrationsSupportPartnerApp", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "partnerApp", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Security.PartnerApp" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Security.PartnerApp" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Support/PartnerApp/{partnerappId}": { "get": { "tags": [ "Integrations/Support" ], "operationId": "Support_GetPartnerapp", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "partnerappId", "in": "path", "required": true, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Security.PartnerApp" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Integrations/Support" ], "operationId": "Support_DeletePartnerapp", "consumes": [], "produces": [], "parameters": [ { "name": "partnerappId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/SyncHistory": { "get": { "tags": [ "Integrations/SyncHistory" ], "operationId": "IntegrationSyncHistory_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "status", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" }, { "name": "syncType", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.IntegrationSyncHistoryDto" }, "xml": { "name": "IntegrationSyncHistoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/TDAmeritrade/Accounts": { "get": { "tags": [ "Integrations/TDAmeritrade" ], "summary": "Method to retrive Account data for all Accounts linked to the user", "operationId": "TDAmeritrade_GetAccounts", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.TD.Dto.TDAccountsDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/TDAmeritrade/Accounts/{accountId}": { "get": { "tags": [ "Integrations/TDAmeritrade" ], "summary": "Method to retrive Account data for the Account", "operationId": "TDAmeritrade_GetV1IntegrationsTDAmeritradeAccountsByAccountId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.TD.Dto.TDAccountsDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/TDAmeritrade/Accounts/{accountId}/Alerts": { "get": { "tags": [ "Integrations/TDAmeritrade" ], "summary": "Method to retrive Account Alerts from TD Ameritrade", "operationId": "TDAmeritrade_GetAccountAlerts", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "required": true, "type": "string" }, { "name": "endDate", "in": "query", "required": true, "type": "string" }, { "name": "alertType", "in": "query", "description": "Flag Enum; Account = 1, Trading = 2, CashManagement = 4", "required": true, "type": "string", "enum": [ "Account", "Trading", "CashManagement" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.TD.Dto.TDAlertsReturnDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/TDAmeritrade/Accounts/{accountId}/Balances": { "get": { "tags": [ "Integrations/TDAmeritrade" ], "summary": "Method to retrive Account Balances from TD Ameritrade", "operationId": "TDAmeritrade_GetAccountBalances", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.TD.Dto.TDBalancesDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/TDAmeritrade/Accounts/{accountId}/Extended": { "get": { "tags": [ "Integrations/TDAmeritrade" ], "summary": "Method to retrive Account data for the Account", "operationId": "TDAmeritrade_GetAccountExtendeds", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "includeBalances", "in": "query", "description": "Optional. Default is false.", "required": false, "type": "boolean", "default": false }, { "name": "includePositions", "in": "query", "description": "Optional. Default is false.", "required": false, "type": "boolean", "default": false }, { "name": "includeTransactions", "in": "query", "description": "Optional. Default is false. If true, default date range is 7 days from today", "required": false, "type": "boolean", "default": false }, { "name": "startDate", "in": "query", "description": "Optional, used for Transactions. Default is null. Required field if endDate is present.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional, used for Transactions. Default is null. Required field if startDate is present.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.TD.Dto.TDAccountsExtendedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/TDAmeritrade/Accounts/{accountId}/Positions": { "get": { "tags": [ "Integrations/TDAmeritrade" ], "summary": "Method to retrive Account Positions from TD Ameritrade", "operationId": "TDAmeritrade_GetAccountPositions", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.TD.Dto.TDPositionsDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/TDAmeritrade/Accounts/{accountId}/Transactions": { "get": { "tags": [ "Integrations/TDAmeritrade" ], "summary": "Method to retrive Account Transactions from TD Ameritrade", "operationId": "TDAmeritrade_GetAccountTransactions", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "required": true, "type": "string" }, { "name": "endDate", "in": "query", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.TD.Dto.TDTransactionsDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/TDAmeritrade/Action/StartSSO": { "get": { "tags": [ "Integrations/TDAmeritrade" ], "summary": "", "operationId": "TDAmeritrade_StartSSOAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "referenceId", "in": "query", "required": false, "type": "string" }, { "name": "tdaContext", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/TDAmeritrade/AdvancedAlerts/Configuration": { "get": { "tags": [ "Integrations/TDAmeritrade" ], "summary": "Returns configuration settings for Advanced Alerts integration.", "operationId": "TDAmeritrade_GetAdvancedAlertsConfiguration", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Integrations.TDAmeritradeController.AdvancedAlertsIntegrationConfig" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/TDAmeritrade" ], "summary": "Updates Advanced Alerts configuration information.", "operationId": "TDAmeritrade_UpdateAdvancedAlertsConfiguration", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "integrationInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Integrations.TDAmeritradeController.AdvancedAlertsIntegrationConfig" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Integrations.TDAmeritradeController.AdvancedAlertsIntegrationConfig" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/TDAmeritrade/CheckUser": { "get": { "tags": [ "Integrations/TDAmeritrade" ], "summary": "Method to check user", "operationId": "TDAmeritrade_CheckUser", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.TD.Dto.TDUsersInfoDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/TDAmeritrade/User": { "post": { "tags": [ "Integrations/TDAmeritrade" ], "summary": "Method to save user's credentials", "operationId": "TDAmeritrade_SaveUserAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "user", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.TD.Dto.TDUserDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/TDAmeritrade/VeoOneUser": { "get": { "tags": [ "Integrations/TDAmeritrade" ], "summary": "Method to check user", "operationId": "TDAmeritrade_VeoOneUser", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.TD.Dto.TDUserDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/TDAmeritrade" ], "summary": "Method to save user's credentials", "operationId": "TDAmeritrade_VeoOneUserAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "user", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.TD.Dto.TDUserDto" } }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.TD.Dto.TDUserDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Tolerisk/GetToken": { "get": { "tags": [ "Integrations/Tolerisk" ], "summary": "Used to get token from Fidelity.", "operationId": "Tolerisk_GetTokenAsync", "consumes": [], "produces": [], "parameters": [ { "name": "code", "in": "query", "required": true, "type": "string" }, { "name": "authorization", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Tolerisk/Redirect": { "get": { "tags": [ "Integrations/Tolerisk" ], "operationId": "Tolerisk_GetRedirectUrlAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Tolerisk/SaveOrionToken": { "get": { "tags": [ "Integrations/Tolerisk" ], "operationId": "Tolerisk_CallSaveOrionTokenAsync", "consumes": [], "produces": [], "parameters": [ { "name": "OrionId", "in": "query", "required": true, "type": "string" }, { "name": "authorization", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/TRX/Action/Schedule": { "put": { "tags": [ "Integrations/TRX" ], "summary": "Schedule TRX Export", "operationId": "Trx_ScheduleTrxExportAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/TRX/Configuration": { "get": { "tags": [ "Integrations/TRX" ], "summary": "Retrieves trx Integration details.", "operationId": "Trx_GetConfiguration", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Integrations.TRXIntegrationConfigDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/TRX" ], "summary": "Saves trx integration settings.", "operationId": "Trx_UpdateConfiguration", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "config", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Integrations.TRXIntegrationConfigDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Integrations.TRXIntegrationConfigDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/TRX/Configuration/Test": { "get": { "tags": [ "Integrations/TRX" ], "summary": "Checks to see if trx integration has been setup for this database.", "operationId": "Trx_CheckConfiguration", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/TRX/ModelComplianceClass/{key}": { "get": { "tags": [ "Integrations/TRX" ], "summary": "Get asset category from TRX", "operationId": "Trx_GetModelComplianceClass", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.Domains.Integrations.TrxController.TrxHouseholdGroupDto" }, "xml": { "name": "TrxHouseholdGroupDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/TRX/ModelComplianceSubClass/{key}": { "get": { "tags": [ "Integrations/TRX" ], "summary": "Get asset class from TRX", "operationId": "Trx_GetModelComplianceSubClass", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.Domains.Integrations.TrxController.TrxHouseholdGroupDto" }, "xml": { "name": "TrxHouseholdGroupDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Vanilla/Action/SAML": { "get": { "tags": [ "Integrations/Vanilla" ], "operationId": "Vanilla_StartSSOAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Vanilla/GetToken": { "get": { "tags": [ "Integrations/Vanilla" ], "operationId": "Vanilla_GetTokenAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "code", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.Vanilla.VanillaToken" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Vanilla/Redirect": { "get": { "tags": [ "Integrations/Vanilla" ], "operationId": "Vanilla_GetRedirectUrlAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "Authorization", "in": "query", "required": true, "type": "string" }, { "name": "t", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Vanilla/RefreshToken": { "get": { "tags": [ "Integrations/Vanilla" ], "operationId": "Vanilla_RefreshTokenAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAT.Integrations.Vanilla.VanillaToken" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Vision/Health": { "get": { "tags": [ "Integrations/Vision" ], "operationId": "Vision_HealthAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Vision/SourceDestination": { "get": { "tags": [ "Integrations/Vision" ], "operationId": "Vision_TransactionSourceDestinationAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Vision.VisionSourceDestinationDto" }, "xml": { "name": "VisionSourceDestinationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/Vision/SSO": { "get": { "tags": [ "Integrations/Vision" ], "operationId": "Vision_SSOAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "showIncomplete", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/WealthAccess/{clientId}/IFrame/Url": { "get": { "tags": [ "Integrations/WealthAccess" ], "operationId": "WealthAccess_GetWealthAccessRedirectUrlAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/WealthAccess/Configuration": { "get": { "tags": [ "Integrations/WealthAccess" ], "operationId": "WealthAccess_GetConfiguration", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.WealthAccess.IntegrationConfigDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Integrations/WealthAccess" ], "operationId": "WealthAccess_UpdateConfiguration", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "config", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Integration.WealthAccess.IntegrationConfig" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.WealthAccess.IntegrationConfigDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/WealthAccess/Remove": { "post": { "tags": [ "Integrations/WealthAccess" ], "operationId": "WealthAccess_RemoveServiceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/WealthAccess/Setup": { "post": { "tags": [ "Integrations/WealthAccess" ], "operationId": "WealthAccess_SetupServiceAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "setupRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.IntegrationSetupRequestDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.WealthAccess.IntegrationConfigDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/WealthSite/Allocation/ByManager/Account/{accountId}": { "post": { "tags": [ "Integrations/WealthSite" ], "summary": "", "operationId": "WealthSite_GetAllocationByManagerForAccountAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "requestData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteRequestDataDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteAllocationByManagerDto" }, "xml": { "name": "WealthSiteAllocationByManagerDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/WealthSite/Allocation/ByManager/Client/{clientId}": { "post": { "tags": [ "Integrations/WealthSite" ], "summary": "", "operationId": "WealthSite_GetAllocationByManagerForClientAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "requestData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteRequestDataWithAccountsDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteAllocationByManagerDto" }, "xml": { "name": "WealthSiteAllocationByManagerDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/WealthSite/Allocation/ByManager/Registration/{registrationId}": { "post": { "tags": [ "Integrations/WealthSite" ], "summary": "", "operationId": "WealthSite_GetAllocationByManagerForRegistrationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "registrationId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "requestData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteRequestDataWithAccountsDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteAllocationByManagerDto" }, "xml": { "name": "WealthSiteAllocationByManagerDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/WealthSite/Allocation/ByPropertyType/Account/{accountId}": { "post": { "tags": [ "Integrations/WealthSite" ], "summary": "", "operationId": "WealthSite_GetAllocationByPropertyTypeForAccountAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "requestData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteRequestDataDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteAllocationByPropertyTypeDto" }, "xml": { "name": "WealthSiteAllocationByPropertyTypeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/WealthSite/Allocation/ByPropertyType/Client/{clientId}": { "post": { "tags": [ "Integrations/WealthSite" ], "summary": "", "operationId": "WealthSite_GetAllocationByPropertyTypeForClientAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "requestData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteRequestDataWithAccountsDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteAllocationByPropertyTypeDto" }, "xml": { "name": "WealthSiteAllocationByPropertyTypeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/WealthSite/Allocation/ByPropertyType/Registration/{registrationId}": { "post": { "tags": [ "Integrations/WealthSite" ], "summary": "", "operationId": "WealthSite_GetAllocationByPropertyTypeForRegistrationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "registrationId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "requestData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteRequestDataWithAccountsDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteAllocationByPropertyTypeDto" }, "xml": { "name": "WealthSiteAllocationByPropertyTypeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/WealthSite/Allocation/ByRegion/Account/{accountId}": { "post": { "tags": [ "Integrations/WealthSite" ], "summary": "", "operationId": "WealthSite_GetAllocationByRegionForAccountAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "requestData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteRequestDataDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteAllocationByRegionDto" }, "xml": { "name": "WealthSiteAllocationByRegionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/WealthSite/Allocation/ByRegion/Client/{clientId}": { "post": { "tags": [ "Integrations/WealthSite" ], "summary": "", "operationId": "WealthSite_GetAllocationByRegionForClientAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "requestData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteRequestDataWithAccountsDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteAllocationByRegionDto" }, "xml": { "name": "WealthSiteAllocationByRegionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/WealthSite/Allocation/ByRegion/Registration/{registrationId}": { "post": { "tags": [ "Integrations/WealthSite" ], "summary": "", "operationId": "WealthSite_GetAllocationByRegionForRegistrationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "registrationId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "requestData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteRequestDataWithAccountsDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteAllocationByRegionDto" }, "xml": { "name": "WealthSiteAllocationByRegionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/WealthSite/Allocation/ByRisk/Account/{accountId}": { "post": { "tags": [ "Integrations/WealthSite" ], "summary": "", "operationId": "WealthSite_GetAllocationByRiskForAccountAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "requestData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteRequestDataDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteAllocationByRiskDto" }, "xml": { "name": "WealthSiteAllocationByRiskDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/WealthSite/Allocation/ByRisk/Client/{clientId}": { "post": { "tags": [ "Integrations/WealthSite" ], "summary": "", "operationId": "WealthSite_GetAllocationByRiskForClientAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "requestData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteRequestDataWithAccountsDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteAllocationByRiskDto" }, "xml": { "name": "WealthSiteAllocationByRiskDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/WealthSite/Allocation/ByRisk/Registration/{registrationId}": { "post": { "tags": [ "Integrations/WealthSite" ], "summary": "", "operationId": "WealthSite_GetAllocationByRiskForRegistrationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "registrationId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "requestData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteRequestDataWithAccountsDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteAllocationByRiskDto" }, "xml": { "name": "WealthSiteAllocationByRiskDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/WealthSite/Allocation/ByYear/Account/{accountId}": { "post": { "tags": [ "Integrations/WealthSite" ], "summary": "", "operationId": "WealthSite_GetAllocationByYearForAccountAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "requestData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteRequestDataDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteAllocationByYearDto" }, "xml": { "name": "WealthSiteAllocationByYearDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/WealthSite/Allocation/ByYear/Client/{clientId}": { "post": { "tags": [ "Integrations/WealthSite" ], "summary": "", "operationId": "WealthSite_GetAllocationByYearForClientAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "requestData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteRequestDataWithAccountsDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteAllocationByYearDto" }, "xml": { "name": "WealthSiteAllocationByYearDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/WealthSite/Allocation/ByYear/Registration/{registrationId}": { "post": { "tags": [ "Integrations/WealthSite" ], "summary": "", "operationId": "WealthSite_GetAllocationByYearForRegistrationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "registrationId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "requestData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteRequestDataWithAccountsDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteAllocationByYearDto" }, "xml": { "name": "WealthSiteAllocationByYearDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/WealthSite/Allocation/Summary/Account/{accountId}": { "post": { "tags": [ "Integrations/WealthSite" ], "summary": "", "operationId": "WealthSite_GetAllocationSummaryForAccountAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "requestData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteRequestDataDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteAllocationSummaryDto" }, "xml": { "name": "WealthSiteAllocationSummaryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/WealthSite/Allocation/Summary/Client/{clientId}": { "post": { "tags": [ "Integrations/WealthSite" ], "summary": "", "operationId": "WealthSite_GetAllocationSummaryForClientAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "requestData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteRequestDataWithAccountsDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteAllocationSummaryDto" }, "xml": { "name": "WealthSiteAllocationSummaryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/WealthSite/Allocation/Summary/Registration/{registrationId}": { "post": { "tags": [ "Integrations/WealthSite" ], "summary": "", "operationId": "WealthSite_GetAllocationSummaryForRegistrationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "registrationId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "requestData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteRequestDataWithAccountsDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteAllocationSummaryDto" }, "xml": { "name": "WealthSiteAllocationSummaryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/WealthSite/PrivateAssetSummary/Account/{accountId}": { "post": { "tags": [ "Integrations/WealthSite" ], "summary": "", "operationId": "WealthSite_GetPrivateAssetSummaryForAccountAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "requestData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteRequestDataDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSitePrivateAssetSummaryDto" }, "xml": { "name": "WealthSitePrivateAssetSummaryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/WealthSite/PrivateAssetSummary/Client/{clientId}": { "post": { "tags": [ "Integrations/WealthSite" ], "summary": "", "operationId": "WealthSite_GetPrivateAssetSummaryForClientAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "requestData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteRequestDataWithAccountsDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSitePrivateAssetSummaryDto" }, "xml": { "name": "WealthSitePrivateAssetSummaryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/WealthSite/PrivateAssetSummary/Registration/{registrationId}": { "post": { "tags": [ "Integrations/WealthSite" ], "summary": "", "operationId": "WealthSite_GetPrivateAssetSummaryForRegistrationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "registrationId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "requestData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteRequestDataWithAccountsDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSitePrivateAssetSummaryDto" }, "xml": { "name": "WealthSitePrivateAssetSummaryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/WealthSite/PrivateInvestmentPerformance/Account/{accountId}": { "post": { "tags": [ "Integrations/WealthSite" ], "summary": "", "operationId": "WealthSite_GetPrivateInvestmentPerformanceForAccountAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "requestData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteRequestDataDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSitePrivateInvestmentPerformanceDto" }, "xml": { "name": "WealthSitePrivateInvestmentPerformanceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/WealthSite/PrivateInvestmentPerformance/Client/{clientId}": { "post": { "tags": [ "Integrations/WealthSite" ], "summary": "", "operationId": "WealthSite_GetPrivateInvestmentPerformanceForClientAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "requestData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteRequestDataWithAccountsDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSitePrivateInvestmentPerformanceDto" }, "xml": { "name": "WealthSitePrivateInvestmentPerformanceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/WealthSite/PrivateInvestmentPerformance/Registration/{registrationId}": { "post": { "tags": [ "Integrations/WealthSite" ], "summary": "", "operationId": "WealthSite_GetPrivateInvestmentPerformanceForRegistrationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "registrationId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "requestData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSiteRequestDataWithAccountsDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAT.Integrations.WealthSite.Dto.WealthSitePrivateInvestmentPerformanceDto" }, "xml": { "name": "WealthSitePrivateInvestmentPerformanceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/YahooFinance/Options/{ticker}": { "get": { "tags": [ "Integrations/YahooFinance" ], "operationId": "IntegrationsYahooFinance_GetTickerOptionsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ticker", "in": "path", "required": true, "type": "string" }, { "name": "straddle", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "expiredate", "in": "query", "required": false, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Integrations.CoveredCallOptionsDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Integrations/YahooFinance/Quote/{contractSymbol}": { "get": { "tags": [ "Integrations/YahooFinance" ], "operationId": "IntegrationsYahooFinance_GetTickerQuoteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "contractSymbol", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Integrations.CoveredCallOptionsDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/MarketProperties/BullBearDates": { "get": { "tags": [ "MarketProperties/BullBearDates" ], "summary": "Get a list of Bull Bear Dates that the logged in user has access to see.\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "BullBearDates_GetAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "marketType", "in": "query", "required": false, "type": "string", "enum": [ "Bull", "Bear" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.MarketProperties.BullBearDateDto" }, "xml": { "name": "BullBearDateDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/MarketProperties/BullBearDates/{key}": { "get": { "tags": [ "MarketProperties/BullBearDates" ], "summary": "Gets the Bull Bear Dates that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "BullBearDates_GetById", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.MarketProperties.BullBearDateDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Mobile/Clients/{key}/Accounts/Menu": { "post": { "tags": [ "Mobile/Clients" ], "summary": "Gets the account menu for the specified if one exists. If none exists a 404 will be thrown.", "operationId": "MobileClients_GetAccountsMenuAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "settings", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Mobile.AccountsMenuSettingsDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Mobile.AccountsMenuReturnDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Mobile/Clients/{key}/Allocation": { "get": { "tags": [ "Mobile/Clients" ], "summary": "Gets the allocation groups of the client with the specified key. The allocation grouping is defined by the mobile setting \"MobileValueViewTypeAccount\".", "operationId": "MobileClients_GetAllocation", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the client that the account belongs to.", "required": true, "type": "integer", "format": "int32" }, { "name": "asOfDate", "in": "query", "description": "Optional. Default: today. Defines the date that the values should reflect.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Mobile.PortfolioGroupValuesDto" }, "xml": { "name": "PortfolioGroupValuesDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Mobile/Clients/{key}/AumOverTime": { "get": { "tags": [ "Mobile/Clients" ], "summary": "Gets a list of Aum data representative of the last year for the client with the specified key.", "operationId": "MobileClients_GetAumOverTimeAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "description": "Optional. Default: 1 year ago. Defines the first date that should be returned.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default: today. Defines the last date that should be returned.", "required": false, "type": "string", "format": "date-time" }, { "name": "interval", "in": "query", "description": "Optional. Default: \"A\" Automatic. Options are:\r\n \"A\" Automatic\r\n \"M\" Monthly\r\n \"W\" Weekly\r\n \"D\" Daily", "required": false, "type": "string", "default": "A" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Mobile.PortfolioGroupValuesDto" }, "xml": { "name": "PortfolioGroupValuesDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Mobile/Clients/{key}/Rep": { "get": { "tags": [ "Mobile/Clients" ], "summary": "Gets a the representative assigned to the client with the specified key, which the logged in user has access to.", "operationId": "MobileClients_GetRepByClientId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Mobile.RepresentativeDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Mobile/Clients/{key}/Rep/Photo": { "get": { "tags": [ "Mobile/Clients" ], "summary": "Gets the representative's photo if one exists. If none exists a 404 will be thrown.", "operationId": "MobileClients_GetRepPhotoByClientId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Mobile/Clients/{key}/Representative": { "get": { "tags": [ "Mobile/Clients" ], "summary": "Gets a the representative assigned to the client with the specified key, which the logged in user has access to.", "operationId": "MobileClients_GetV1MobileClientsByKeyRepresentative", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Mobile.RepresentativeDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Mobile/Clients/{key}/Representative/Photo": { "get": { "tags": [ "Mobile/Clients" ], "summary": "Gets the representative's photo if one exists. If none exists a 404 will be thrown.", "operationId": "MobileClients_GetV1MobileClientsByKeyRepresentativePhoto", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Mobile/Clients/{key}/Snapshot": { "get": { "tags": [ "Mobile/Clients" ], "summary": "Gets a list of accounts that fall below the client with the specified key, which the logged in user has access to. The list includes additional accounts. The value provided is for today.", "operationId": "MobileClients_GetSnapshotClient", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the client that the accounts belong to.", "required": true, "type": "integer", "format": "int32" }, { "name": "asOfDate", "in": "query", "description": "Optional. Default: today. Defines the date that the values should reflect.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Mobile.PortfolioGroupValuesDto" }, "xml": { "name": "PortfolioGroupValuesDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Mobile/Clients/{key}/Snapshot/{groupId}/Assets": { "get": { "tags": [ "Mobile/Clients" ], "summary": "Gets a list of assets that fall within the account with the specified key, which the logged in user has access to.", "operationId": "MobileClients_GetSnapshotClientAssetsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the client that the account belongs to.", "required": true, "type": "integer", "format": "int32" }, { "name": "groupId", "in": "path", "description": "Key of the account which assets will be returned from.", "required": true, "type": "integer", "format": "int32" }, { "name": "showZeroValueAssets", "in": "query", "description": "If true all assets applicable assets are shown. If false, only asset with value are shown.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Mobile.PortfolioGroupValuesDto" }, "xml": { "name": "PortfolioGroupValuesDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Mobile/Clients/First": { "get": { "tags": [ "Mobile/Clients" ], "summary": "Gets the first client that the logged in user has access to that has value ordered by last name.", "operationId": "MobileClients_GetClientFirst", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleClient" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Mobile/Clients/Search": { "get": { "tags": [ "Mobile/Clients" ], "summary": "Gets a simple list of clients that are active and have value that the logged in user has access to where the clients first name, lastname, or entityname begins with the search string.", "operationId": "MobileClients_GetClientSearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "Partial client name to search for.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleClient" }, "xml": { "name": "SimpleClient", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Mobile/Clients/Search/{search}": { "get": { "tags": [ "Mobile/Clients" ], "summary": "Gets a simple list of clients that are active and have value that the logged in user has access to where the clients first name, lastname, or entityname begins with the search string.", "operationId": "MobileClients_GetV1MobileClientsSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "Partial client name to search for.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleClient" }, "xml": { "name": "SimpleClient", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Mobile/Register/PushNotification": { "post": { "tags": [ "Mobile/Register" ], "summary": "Used to create mobile tokens for push notifications. If token already exists, a 200 Ok will be returned else 201 Created will be returned.", "operationId": "Mobile_RegisterPushNotification", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Mobile.PushNotificationDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Monitor": { "get": { "tags": [ "Monitor" ], "operationId": "Monitor_Echo", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "echo", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/OrionStored/Compare": { "post": { "tags": [ "OrionStored/Compare" ], "summary": "Run an Orion Stored Cost Basis compare process for a list of assets.", "operationId": "OrionStoredCostBasisCompare_PostCompareAssetsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "Object containing the asset ID(s) for which to run the compare process and processing options.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.OrionStoredCompareBatchDto" } }, { "name": "cancellationToken", "in": "header", "description": "A token to cancel the current request process.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.OrionStored.OrionStoredCostBasisCompareResult" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/OrionStored/Compare/{key}": { "get": { "tags": [ "OrionStored/Compare" ], "summary": "Get the results of an asynchronous Orion Stored Cost Basis compare process for a list of assets.", "operationId": "OrionStoredCostBasisCompare_GetCompareAssetsResultAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Hangfire ID of the compare process.", "required": true, "type": "string" }, { "name": "returnDifferencesOnly", "in": "query", "description": "Flag to only return data results that are different from old (stored) to new calculated data.", "required": true, "type": "boolean" }, { "name": "cancellationToken", "in": "header", "description": "A token to cancel the current request process.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.OrionStored.OrionStoredCostBasisCompareResult" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/OrionStored/Compare/Start": { "post": { "tags": [ "OrionStored/Compare" ], "summary": "Starts an asynchronous Orion Stored Cost Basis compare process for a list of assets.", "operationId": "OrionStoredCostBasisCompare_StartCompareAssetsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "Object containing the asset ID(s) for which to run the compare process and processing options.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.OrionStoredCompareBatchDto" } }, { "name": "cancellationToken", "in": "header", "description": "A token to cancel the current request process.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/OrionStored/RunAsset/{assetID}": { "post": { "tags": [ "OrionStored/RunAsset" ], "operationId": "OrionStoredCostBasis_RunAssetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "assetID", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "CutoffDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/AttributionAssignment/EntityLevel/{entityLevel}": { "get": { "tags": [ "Performance/AttributionAssignment" ], "summary": "Gets a list of attribution assignments that the logged in user has access to.", "operationId": "AttributionAssignment_GetAttributionAssignmentsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "entityLevel", "in": "path", "required": true, "type": "string", "enum": [ "RiskCategories", "BrokerDealers", "Representatives", "AssetClasses", "AssetCategories", "Platforms", "Models", "AggregateModels", "IndexBlends", "FundFamilies", "Database", "Custodians", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Product", "PortfolioGroups", "SleeveStrategyAggregates", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.AttributionAssignmentDto" }, "xml": { "name": "AttributionAssignmentDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Performance/AttributionAssignment" ], "summary": "Update assigned attributions by entity level", "operationId": "AttributionAssignment_UpdateAssignmentsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "entityLevel", "in": "path", "required": true, "type": "string", "enum": [ "RiskCategories", "BrokerDealers", "Representatives", "AssetClasses", "AssetCategories", "Platforms", "Models", "AggregateModels", "IndexBlends", "FundFamilies", "Database", "Custodians", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Product", "PortfolioGroups", "SleeveStrategyAggregates", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10" ] }, { "name": "assignments", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.AttributionAssignmentDto" }, "xml": { "name": "AttributionAssignmentDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.AttributionAssignmentDto" }, "xml": { "name": "AttributionAssignmentDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/AttributionDetails": { "get": { "tags": [ "Performance/AttributionDetails" ], "summary": "Gets a list of attribution details that the logged in user has access to.", "operationId": "AttributionDetails_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.AttributionDetailDto" }, "xml": { "name": "AttributionDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Performance/AttributionDetails" ], "summary": "Used to create a new attribution detail.", "operationId": "AttributionDetails_CreateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.AttributionDetailFullDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.AttributionDetailFullDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/AttributionDetails/{key}": { "get": { "tags": [ "Performance/AttributionDetails" ], "summary": "Gets the attribution detail that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "AttributionDetails_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.AttributionDetailFullDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Performance/AttributionDetails" ], "summary": "Used to update an existing attribution detail. Upon successful modification a 200 will be returned.", "operationId": "AttributionDetails_UpdateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.AttributionDetailFullDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.AttributionDetailFullDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Performance/AttributionDetails" ], "summary": "Used to delete an existing attribution detail. Upon successful deletion a 204 will be returned.", "operationId": "AttributionDetails_DeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/AttributionDetails/Benchmark/{key}": { "get": { "tags": [ "Performance/AttributionDetails" ], "summary": "Gets the attribution detail that has the provided benchmark key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "AttributionDetails_GetByBenchmarkKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/AttributionDetails/New": { "get": { "tags": [ "Performance/AttributionDetails" ], "summary": "Gets the attribution detail that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "AttributionDetails_GetNewVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.AttributionDetailFullDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/AttributionDetails/Simple": { "get": { "tags": [ "Performance/AttributionDetails" ], "summary": "Gets a simple list of attribution details that the logged in user has access to.", "operationId": "AttributionDetails_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Batch": { "get": { "tags": [ "Performance/Batch" ], "summary": "Gets a list of performance Batches that the logged in user has access to.", "operationId": "PerformanceBatch_GetAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.PerformanceBatchDto" }, "xml": { "name": "PerformanceBatchDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Batch/{key}": { "get": { "tags": [ "Performance/Batch" ], "summary": "Gets the performance Batches with the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "PerformanceBatch_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.PerformanceBatchDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Performance/Batch" ], "summary": "Deletes a performance Batch.", "operationId": "PerformanceBatch_DeletePerformanceBatch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Batch/{performanceBatchId}/Details": { "post": { "tags": [ "Performance/Batch" ], "summary": "Gets a list of details for the provided performance batch id that the logged in user has access to pivotted based on the timeframe.", "operationId": "PerformanceBatchEntities_GetAllPivottedByTimeframeAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "performanceBatchId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "entityIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.PerformanceBatchEntityDetailDto" }, "xml": { "name": "PerformanceBatchEntityDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Batch/{performanceBatchId}/Details/ByEntities": { "post": { "tags": [ "Performance/Batch" ], "summary": "Gets a list of details for the provided performance batch id that the logged in user has access to pivotted based on the entities.", "operationId": "PerformanceBatchEntities_GetDetailsByEntitiesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "performanceBatchId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "entityIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.PerformanceBatchEntityDetailPivotDto" }, "xml": { "name": "PerformanceBatchEntityDetailPivotDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Batch/{performanceBatchId}/Entities": { "get": { "tags": [ "Performance/Batch" ], "summary": "Gets a list of entities for the provided performance batch id that the logged in user has access to.", "operationId": "PerformanceBatchEntities_GetAllAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "performanceBatchId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.PerformanceBatchEntityDto" }, "xml": { "name": "PerformanceBatchEntityDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Batch/{performanceBatchId}/Entities/Action/Generate": { "post": { "tags": [ "Performance/Batch" ], "summary": "Used generate the performance data of the batch.", "operationId": "PerformanceBatchEntities_GenerateComparisonsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "performanceBatchId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ids", "in": "body", "description": "Optional. If provided only the items included will be updated. If omitted all items in the batch will be updated.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Performance/Batch" ], "summary": "Used to stop batch generation.", "operationId": "PerformanceBatchEntities_CancelGenerateComparisonsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "performanceBatchId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Batch/{performanceBatchId}/Entities/Action/Reset": { "post": { "tags": [ "Performance/Batch" ], "summary": "Used to reset some of the entities in the performance batch.", "operationId": "PerformanceBatchEntities_ResetEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "performanceBatchId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ids", "in": "body", "description": "Only the items included will be reset. If omitted an error will be returned.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Batch/{sourcePerformanceBatchId}/Details/Compare": { "post": { "tags": [ "Performance/Batch" ], "summary": "Compare Two Batches", "operationId": "PerformanceBatchEntities_CompareBatchesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "sourcePerformanceBatchId", "in": "path", "description": "Source Batch ID to base comparison off of", "required": true, "type": "integer", "format": "int32" }, { "name": "comparePerformanceBatchId", "in": "body", "description": "Batch ID for compare batch", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/System.ValueTupleOfOAS.WebApi.DTO.Performance.PerformanceBatchEntityDetailPivotDataAndOAS.WebApi.DTO.Performance.PerformanceBatchEntityDetailPivotData" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Batch/Action/ConcurrentEntityExecutionInfo": { "get": { "tags": [ "Performance/Batch" ], "operationId": "PerformanceBatch_GetConcurrentEntityExecutionInfo", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clear", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Caching.IDistributedSemaphoreInfo" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Batch/Action/RefreshConcurrentEntityExecutionLimit": { "post": { "tags": [ "Performance/Batch" ], "operationId": "PerformanceBatch_RefreshConcurrentEntityExecutionLimit", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Batch/Verbose": { "get": { "tags": [ "Performance/Batch" ], "operationId": "PerformanceBatchVerbose_GetVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "General", "Options", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.PerformanceBatchVerboseDto" }, "xml": { "name": "PerformanceBatchVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Performance/Batch" ], "summary": "Create new Performance Batch", "operationId": "PerformanceBatchVerbose_CreateVerboseBatchAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.PerformanceBatchVerboseDto" } }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "beginGeneration", "in": "query", "description": "Default: false. When true the batch generation will be started after batch has been successfully created. Generation will not be started if batch was not successfully created.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.PerformanceBatchVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Batch/Verbose/{key}": { "get": { "tags": [ "Performance/Batch" ], "operationId": "PerformanceBatchVerbose_GetVerboseByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "General", "Options", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.PerformanceBatchVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Batch/Verbose/{key}/Description": { "put": { "tags": [ "Performance/Batch" ], "summary": "Batch Description for Performance Batch.", "description": "", "operationId": "PerformanceBatchVerbose_UpdateBatchDescriptionAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "description": "The Performance Batch id", "required": true, "type": "integer", "format": "int32" }, { "name": "description", "in": "body", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Batch/Verbose/{performanceBatchId}/Copy": { "post": { "tags": [ "Performance/Batch" ], "summary": "Create a Copy of a Performance Batch for Compare Purposes", "operationId": "PerformanceBatchVerbose_CopyPerformanceBatchAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "performanceBatchId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Batch/Verbose/GroupingOptions": { "get": { "tags": [ "Performance/Batch" ], "summary": "Linked security classification groupings for Batch Performance (same data as Envision security classification slice).", "operationId": "PerformanceBatchVerbose_GetSecurityClassificationGroupingOptionsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataAccess.Domains.Reporting.Envision.CalculationGroupingOption" }, "xml": { "name": "CalculationGroupingOption", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Batch/Verbose/New": { "get": { "tags": [ "Performance/Batch" ], "operationId": "PerformanceBatchVerbose_GetNewVerboseAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.PerformanceBatchVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Compare": { "get": { "tags": [ "Performance/Compare" ], "summary": "Gets a list of performance compares that the logged in user has access to.", "operationId": "PerformanceCompare_GetAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.PerformanceCompareDto" }, "xml": { "name": "PerformanceCompareDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Performance/Compare" ], "summary": "Used to create a new performance compare. Must include details of items to be compared.", "operationId": "PerformanceCompare_CreateNewCompareAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.PerformanceCompareFullDto" } }, { "name": "beginGeneration", "in": "query", "description": "Default: false. When true the compare generation will be started after compare has been successfully created. Generation will not be started if compare was not successfully created.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.PerformanceCompareDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Compare/{key}": { "get": { "tags": [ "Performance/Compare" ], "summary": "Gets the performance compares with the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "PerformanceCompare_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.PerformanceCompareDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Performance/Compare" ], "summary": "Deletes a performance compare.", "operationId": "PerformanceCompare_DeletePerformanceCompare", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Compare/{performanceCompareId}/Details": { "get": { "tags": [ "Performance/Compare" ], "operationId": "PerformanceCompareDetails_GetAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "performanceCompareId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "calculationStatus", "in": "query", "required": false, "items": { "type": "string", "enum": [ "NotCalculated", "Errored", "Calculated", "PendingCalculation", "WillNotBeCalculated" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "entityId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.PerformanceCompareDetailFullDto" }, "xml": { "name": "PerformanceCompareDetailFullDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Compare/{performanceCompareId}/Details/{key}": { "get": { "tags": [ "Performance/Compare" ], "summary": "Gets the performance compare detail with the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "PerformanceCompareDetails_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "performanceCompareId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.PerformanceCompareDetailFullDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Compare/{performanceCompareId}/Details/Action/ChangeActionStatus": { "post": { "tags": [ "Performance/Compare" ], "summary": "Used to change the action status of the details in the performance comparison.", "operationId": "PerformanceCompareDetails_ChangeActionStatus", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "performanceCompareId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ids", "in": "body", "description": "Only the items included will be updated. If omitted an error will be returned.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "actionStatus", "in": "query", "required": false, "type": "string", "enum": [ "NotComplete", "Complete", "AdvisorResearch", "OrionResearch", "NoAction", "Addressed" ] }, { "name": "note", "in": "query", "description": "Optional. If provided the note will be associated to all items provided as an admin only note.", "required": false, "type": "string" }, { "name": "advisorNote", "in": "query", "description": "Optional. If provided the note will be associated to all items provided as an advisor visible note.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Compare/{performanceCompareId}/Details/Action/Generate": { "post": { "tags": [ "Performance/Compare" ], "summary": "Used to update the system generate info for some or all of the details. Details that already have a data generated will be ignored.", "operationId": "PerformanceCompareDetails_GenerateComparisonsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "performanceCompareId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ids", "in": "body", "description": "Optional. If provided only the items included will be updated. If omitted all items in the compare will be updated.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Performance/Compare" ], "summary": "Used to stop comparison generation.", "operationId": "PerformanceCompareDetails_CancelGenerateComparisonsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "performanceCompareId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Compare/{performanceCompareId}/Details/Action/Reset": { "post": { "tags": [ "Performance/Compare" ], "summary": "Used to reset some of the details in the performance comparison.", "operationId": "PerformanceCompareDetails_ResetEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "performanceCompareId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ids", "in": "body", "description": "Only the items included will be reset. If omitted an error will be returned.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Compare/{performanceCompareId}/Details/Notes": { "post": { "tags": [ "Performance/Compare" ], "summary": "Gets the notes for the performance compare detail records provided.", "operationId": "PerformanceCompareDetails_GetNotes", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "performanceCompareId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.PerformanceCompareNoteDto" }, "xml": { "name": "PerformanceCompareNoteDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Compare/{performanceCompareId}/Details/Timeframe": { "get": { "tags": [ "Performance/Compare" ], "operationId": "PerformanceCompareDetails_GetAllPivottedByTimeframe", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "performanceCompareId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "calculationStatus", "in": "query", "required": false, "items": { "type": "string", "enum": [ "NotCalculated", "Errored", "Calculated", "PendingCalculation", "WillNotBeCalculated" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.PerformanceCompareDetailPivotDto" }, "xml": { "name": "PerformanceCompareDetailPivotDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Compare/ValidateImport/Details": { "post": { "tags": [ "Performance/Compare" ], "summary": "Takes an xlsx, xls, or csv file as multipart content. The file needs either an account id column (named \"account id\", \"accountid\", \"pkaccount\", \"acct id\", or \"acctid\")\r\nor an account number column (named \"account number\", or \"acct number\"). The file will be processed and returned as a list signifying the id or number provided. If the account \r\nvalid, the \"isValid\" property will be true. If it is invalid, the \"isValid\" property will be false and a message about why it is invalid will be provided.", "operationId": "PerformanceCompareValidateDetails_PostAsMultipartStreamAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } }, { "name": "daysAddedToStartDate", "in": "query", "description": "Optional. Default: 0. The value provided will be added to the start date of the provided data.", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "performanceCompareId", "in": "query", "description": "Optional. Default: null. If provided instead of the valid data being returned it will be automatically added to the performance comparison provided. Invalid records will be returned.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.ValidatePerformanceCompareDetailDto" }, "xml": { "name": "ValidatePerformanceCompareDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Compare/ValidateImport/Details/Templates/Csv": { "get": { "tags": [ "Performance/Compare" ], "operationId": "PerformanceCompareValidateDetails_GetCsvTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Compare/ValidateImport/Details/Templates/Xls": { "get": { "tags": [ "Performance/Compare" ], "operationId": "PerformanceCompareValidateDetails_GetXlsTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Compare/ValidateImport/Details/Templates/Xlsx": { "get": { "tags": [ "Performance/Compare" ], "operationId": "PerformanceCompareValidateDetails_GetXlsxTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Maintenance/CompositePortfolioGroupAutomation/Action/Run": { "post": { "tags": [ "Performance/Maintenance" ], "operationId": "Maintenance_RunCompositePortfolioGroupAutomationJob", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Maintenance/EclipseInfo/Action/Run": { "post": { "tags": [ "Performance/Maintenance" ], "operationId": "Maintenance_RunEclipseInfoJob", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Maintenance/InvalidAssetValueChangeCheck/Action/Run": { "post": { "tags": [ "Performance/Maintenance" ], "operationId": "Maintenance_RunInvalidAssetValueChangeCheck", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Maintenance/ModelAggBenchmarkProxyMaintain/Blends": { "delete": { "tags": [ "Performance/Maintenance" ], "operationId": "Maintenance_DeleteProxyBenchmarksAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Maintenance/PriceDifferenceCheck/Action/Run": { "post": { "tags": [ "Performance/Maintenance" ], "operationId": "Maintenance_RunPriceDifferenceCheckJob", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Maintenance/Status": { "post": { "tags": [ "Performance/Maintenance" ], "operationId": "Maintenance_RunMaintenanceStatusJob", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Overview": { "get": { "tags": [ "Performance/Overview" ], "operationId": "PerformanceOverview_GetOverviewPerformanceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "query", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "grouping", "in": "query", "required": true, "type": "string", "enum": [ "Undefined", "Representative", "Client", "Registration", "Account", "Asset", "AssetClass", "ProductType", "Platform", "RiskCategory", "Product", "IndexBlend", "AssetCategory", "AssetLevelStrategy", "AggregateModel", "AccountType", "PortfolioGroup" ] }, { "name": "annualize", "in": "query", "required": true, "type": "boolean" }, { "name": "includeBenchmarks", "in": "query", "required": true, "type": "boolean" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.Performance.Overview.PerformanceWithDateRangeInfoDto" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Performance/Overview" ], "summary": "Returns Overview Performance. Overview performance is \"stored\" performance. It is updated once per day with pre-defined periods and settings.", "operationId": "PerformanceOverview_PostV1PerformanceOverview", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Performance.Overview.OverviewPerformanceRequestParameters" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.Performance.Overview.PerformanceWithDateRangeInfoDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Overview/Action/Run": { "post": { "tags": [ "Performance/Overview" ], "operationId": "PerformanceOverview_RunPerformanceOverview", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "force", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/Overview/Multiple/Action/Run": { "post": { "tags": [ "Performance/Overview" ], "operationId": "PerformanceOverview_PostV1PerformanceOverviewMultipleActionRun", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dbIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/StoredPerformanceImport": { "get": { "tags": [ "Performance/StoredPerformanceImport" ], "operationId": "StoredPerformanceImports_GetStoredPerformanceImportsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.StoredPerformance.StoredPerformanceImportVerboseDto" }, "xml": { "name": "StoredPerformanceImportVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Performance/StoredPerformanceImport" ], "operationId": "StoredPerformanceImports_CreateStoredPerformanceImportAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.StoredPerformance.StoredPerformanceImportVerboseDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/StoredPerformanceImport/{key}": { "get": { "tags": [ "Performance/StoredPerformanceImport" ], "operationId": "StoredPerformanceImports_GetStoredPerformanceImportAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.StoredPerformance.StoredPerformanceImportVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Performance/StoredPerformanceImport" ], "operationId": "StoredPerformanceImports_UpdateStoredPerformanceImportAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.StoredPerformance.StoredPerformanceImportVerboseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.StoredPerformance.StoredPerformanceImportVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Performance/StoredPerformanceImport" ], "operationId": "StoredPerformanceImports_DeleteStoredPerformanceImportAsync", "consumes": [], "produces": [], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/StoredPerformanceImport/Entities": { "put": { "tags": [ "Performance/StoredPerformanceImport" ], "operationId": "StoredPerformanceImportEntity_UpdateStoredPerformanceImportEntitiesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Performance.StoredPerformanceImportEntity" }, "xml": { "name": "StoredPerformanceImportEntity", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Performance.StoredPerformanceImportEntity" }, "xml": { "name": "StoredPerformanceImportEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/StoredPerformanceImport/Entities/Actions/GenerationStatus/Reset": { "post": { "tags": [ "Performance/StoredPerformanceImport" ], "operationId": "StoredPerformanceImportEntity_ResetGenerationStatusAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/StoredPerformanceImport/Entities/Actions/GenerationStatus/Reset/All/{storedPerformanceImportId}": { "post": { "tags": [ "Performance/StoredPerformanceImport" ], "operationId": "StoredPerformanceImportEntity_PostV1PerformanceStoredPerformanceImportEntitiesActionsGenerationStatusResetAllByStoredPerformanceImportId", "consumes": [], "produces": [], "parameters": [ { "name": "storedPerformanceImportId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/StoredPerformanceImport/Entities/Actions/Notes/Update": { "post": { "tags": [ "Performance/StoredPerformanceImport" ], "operationId": "StoredPerformanceImportEntity_UpdateNotesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "notes", "in": "query", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/StoredPerformanceImport/Entities/ByStoredPerformanceImportEntityID/{storedPerformanceImportEntityId}": { "get": { "tags": [ "Performance/StoredPerformanceImport" ], "operationId": "StoredPerformanceImportEntity_GetStoredPerformanceImportEntityAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "storedPerformanceImportEntityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Performance.StoredPerformanceImportEntity" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/StoredPerformanceImport/Entities/ByStoredPerformanceImportID/{storedPerformanceImportId}": { "get": { "tags": [ "Performance/StoredPerformanceImport" ], "operationId": "StoredPerformanceImportEntity_GetStoredPerformanceImportEntitiesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "storedPerformanceImportId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Performance.StoredPerformanceImportEntity" }, "xml": { "name": "StoredPerformanceImportEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/StoredPerformanceImport/GetDataTable": { "post": { "tags": [ "Performance/StoredPerformanceImport" ], "operationId": "StoredPerformanceImports_GetImportFileAsDataTableAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.StoredPerformance.StoredPerformanceImportVerboseDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Performance/StoredPerformanceImport/Upload": { "post": { "tags": [ "Performance/StoredPerformanceImport" ], "operationId": "StoredPerformanceImports_UploadStoredPerformanceImportFileAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.StoredPerformance.StoredPerformanceImportFileDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/AccountCancellationSubjects": { "get": { "tags": [ "Portfolio/AccountCancellationSubjects" ], "summary": "Gets a simple list of account cancellation types that the logged in user has access to.", "operationId": "AccountCancellationSubjects_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountCancellationSubjectsDto" }, "xml": { "name": "AccountCancellationSubjectsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/AccountCancellationSubjects" ], "summary": "Used to create a new account cancellation type. Upon successful creation a 201 will be returned with the location of the nearly created account cancellation type.", "operationId": "AccountCancellationSubjects_Create", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountCancellationSubjectsDto" }, "xml": { "name": "AccountCancellationSubjectsDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AccountCancellationSubjects" }, "xml": { "name": "AccountCancellationSubjects", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/AccountCustodialInfo": { "get": { "tags": [ "Portfolio/AccountCustodialInfo" ], "summary": "Gets the records of changes between the received Custodian Name File information and the Orion system, based on the provided filter options. \r\n\r\nThis can include records in any of the change states, including declined or approved records.", "operationId": "AccountCustodialInfo_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "accountId", "in": "query", "description": "Optional. Default: null. If provided returns only the records associated with the provided account id", "required": false, "type": "integer", "format": "int32" }, { "name": "householdId", "in": "query", "description": "Optional. Default: null. If provided returns only the records associated with the provided household id", "required": false, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "description": "Optional. Default: null. If provided returns only the records that have been acted on after the provided date", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default: null. If provided returns only the records that have been acted on before the provided date", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountCustodialInfoChangeDto" }, "xml": { "name": "AccountCustodialInfoChangeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/AccountCustodialInfo" ], "summary": "Apply changes based on the ChangeStatus for the AccountId and FieldName for the change record, as well as applicable Registration/Household records.", "operationId": "AccountCustodialInfo_UpdateEntitiesToStateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "json", "in": "body", "description": "List of the Changes to be processed", "required": true, "schema": { "type": "object" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/AccountCustodialInfo/Active": { "get": { "tags": [ "Portfolio/AccountCustodialInfo" ], "summary": "Gets the records of changes between the received Custodian Name File information and the Orion system. It will only return records that are in the pending state or records that have been modified today", "operationId": "AccountCustodialInfo_GetActive", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountCustodialInfoChangeDto" }, "xml": { "name": "AccountCustodialInfoChangeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts": { "get": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_GetAccountsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "top", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "isActive", "in": "query", "required": false, "type": "boolean" }, { "name": "IsDiscretionary", "in": "query", "required": false, "type": "boolean" }, { "name": "isManaged", "in": "query", "required": false, "type": "boolean" }, { "name": "createdDateStart", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "newAccountFilter", "in": "query", "required": false, "type": "string" }, { "name": "accountFilter", "in": "query", "required": false, "type": "string", "enum": [ "MissingInformation", "ActiveAccountsWithZeroBalance", "InactiveAccountsNotZero", "AcctsWithMultAcctNumbersPerAcctId", "SameAcctNumberInMultAccounts", "MissingMgmtStyle", "LinkedToHistoryAccountWithValue", "LinkedWithRecursiveLink", "LinkedInDifferentRegistrations", "LinkedWithNoTransactions", "StrewnAcrossMultipleAccounts", "FundFamilyVsCustodianComparison", "NotPartOfSleeveStrategy", "ModelAccountAssignment", "ModelCustodialAccountAssignment", "ModelAccountAssignmentWithoutCustodial", "ModelCustodialAccountAssignmentWithoutSleeves", "SleeveCustodialAccountsWithBalance", "SleeveAccountsWithNegBalance" ] }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "Audit", "AccountAssignment", "AccountAssignmentModelAgg" ] }, { "name": "clientId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "registrationId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "accountId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "asOfDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "hasValue", "in": "query", "required": false, "type": "boolean" }, { "name": "editedStartDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "editedEndDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "pageQueryId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "includeAdditionalAccounts", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "fundFamilyId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "representativeId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "portfolioGroupId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "sleeveId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "entitySessionId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountBaseDto" }, "xml": { "name": "AccountBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{accountId}/Changes/Action/Delete": { "post": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_DeleteAccountChanges", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{accountId}/DailyAnnuityValue/{asOfDate}": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Get latest annuity value for all accounts that has annuity value.", "operationId": "Accounts_GetDailyAnnuityValue", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "asOfDate", "in": "path", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{accountId}/ModelAgg/{modelAggId}": { "patch": { "tags": [ "Portfolio/Accounts" ], "summary": "Assign a model aggregate to an account.", "operationId": "Accounts_AssignAggregateModelToAccountAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "modelAggId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{accountId}/ModelTolerance": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Returns a comparison of an Account to its Assigned Model Targets.", "operationId": "Accounts_ModelTolerance", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "includeCash", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "grouping", "in": "query", "required": false, "type": "string", "default": 9, "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "includePendingValue", "in": "query", "required": false, "type": "string", "default": 2, "enum": [ "UseDefault", "Current", "PendingTransactions", "PendingTransactionsAndOrders" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelToleranceDto" }, "xml": { "name": "ModelToleranceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{accountId}/Systematics/{systematicId}/BeneficiarySSN": { "put": { "tags": [ "Portfolio/Accounts" ], "summary": "Retrieve or update beneficiary SSN for a systematic on an account.", "operationId": "Accounts_UpdateSystematicBeneficiarySSN", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "systematicId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updateInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.UpdateSsnDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{accountId}/TaxLot": { "get": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_GetTaxLotExportByAccount", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TaxLotExportDto" }, "xml": { "name": "TaxLotExportDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{accountNumber}": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets the account that has the provided Custodial Account Number. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Accounts_GetEntityByAccountNumberAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "manipulator", "in": "header", "required": true }, { "name": "accountNumber", "in": "path", "description": "Custodial Account Number of the desired return account object.", "required": true, "type": "string" }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "Audit", "AccountAssignment", "AccountAssignmentModelAgg" ] }, { "name": "lookupBasis", "in": "query", "required": false, "type": "string", "default": 7, "enum": [ "Account", "Asset" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountBaseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{key}": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets the account that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Accounts_GetEntityByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "Audit", "AccountAssignment", "AccountAssignmentModelAgg" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountBaseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Accounts" ], "summary": "Simple dto update", "operationId": "Accounts_UpdateAccountAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{key}/Action/MoveToRegistration/{registrationId}": { "put": { "tags": [ "Portfolio/Accounts" ], "summary": "Move account from one registration to another", "operationId": "Accounts_MoveAccountAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "registrationId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountBaseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{key}/Action/UndoConversion": { "delete": { "tags": [ "Portfolio/Accounts" ], "summary": "Undo Account Conversion by key\r\nSample Request\r\nPOST\r\n/Portfolio/Accounts/:key/Action/UndoConversion", "operationId": "Accounts_UndoAccountConversionAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Account Id", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{key}/Assets": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a list of assets that fall within the account with the specified key, which the logged in user has access to.", "operationId": "Accounts_GetAssetsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "includeCostBasis", "in": "query", "description": "Optional bool. Default is false. When true, the Cost Basis property will be populated. This requires extra calculation which will reduce performance when true.", "required": false, "type": "boolean", "default": false }, { "name": "isSweepAsset", "in": "query", "description": "Optional bool. Default is false. When true, only the sweep asset information will be returned.", "required": false, "type": "boolean", "default": false }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetDto" }, "xml": { "name": "AssetDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{key}/Assets/{asOfDate}": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a list of assets that fall within the account with the specified key, which the logged in user has access to.", "operationId": "Accounts_GetAssetsAsOfDateAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "asOfDate", "in": "path", "description": "The asset value returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "includeCostBasis", "in": "query", "description": "Optional bool. Default is false. When true, the Cost Basis property will be populated. This requires extra calculation which will reduce performance when true.", "required": false, "type": "boolean", "default": false }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetDto" }, "xml": { "name": "AssetDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{key}/Assets/Value": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of assets (including aum for today) that fall within the account with the specified key, which the logged in user has access to.", "operationId": "Accounts_GetAssetsValue", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return accounts that have value (true) or don't have value (false).", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAssetWithValue" }, "xml": { "name": "SimpleAssetWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{key}/Assets/Value/{asOfDate}": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of assets (including aum for the end of the date specified) that fall within the account with the specified key, which the logged in user has access to.", "operationId": "Accounts_GetAssetsValueAsOfDate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return accounts that have value (true) or don't have value (false).", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAssetWithValue" }, "xml": { "name": "SimpleAssetWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{key}/Audits": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a list of account Audit items", "operationId": "Accounts_GetAuditsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Account Id", "required": true, "type": "integer", "format": "int32" }, { "name": "token", "in": "header", "description": "Cancellation token", "required": true }, { "name": "startDate", "in": "query", "description": "Optional. Start date. Filter on EditedDate.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. End date. Filter on EditedDate.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "Returns a list of account audit data.", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountAuditDto" }, "xml": { "name": "AccountAuditDto", "wrapped": true }, "type": "array" } }, "404": { "description": "The specified account ID was not found." } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{key}/AumOverTime": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a list of Aum data representative of the range provided for the account with the specified key.", "operationId": "Accounts_GetAumOverTimeAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "description": "Optional. Default: inception date. The start of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default: yesterday. The end of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "interval", "in": "query", "description": "Optional. Default: \"A\" Automatic. Options are:\r\n\"A\" Automatic\r\n\"M\" Monthly\r\n\"W\" Weekly\r\n\"D\" Daily", "required": false, "type": "string", "default": "A" }, { "name": "cancellationToken", "in": "header", "required": false }, { "name": "clientPerformanceInclude", "in": "query", "description": "Optional. Default: Default. When set only accounts/registrations that have value/are active will be returned.", "required": false, "type": "string", "default": -1, "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, { "name": "unmangedInclusionOverride", "in": "query", "description": "Optional. Default: no override. Used to override the unmanaged setting. To include all unmanaged assets set this parameter to \"ActivitySummary\".", "required": false, "type": "string", "enum": [ "Unmanaged", "Performance", "ActivitySummary", "Allocation", "PortfolioDetail", "TaxDetail" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AumOverTimeDto" }, "xml": { "name": "AumOverTimeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{key}/AumOverTime/Simple": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Same as AumOverTime, except it is faster (simpler) because it does not support all the report options, it simply returns a sum of all assets with value over a time period.", "operationId": "Accounts_GetAumOverTimeSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "description": "Optional. Default: inception date. The start of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default: yesterday. The end of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "interval", "in": "query", "description": "Optional. Default: \"A\" Automatic. Options are:\r\n\"A\" Automatic\r\n\"M\" Monthly\r\n\"W\" Weekly\r\n\"D\" Daily", "required": false, "type": "string", "default": "A" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Activity.AumOverTimeSimple" }, "xml": { "name": "AumOverTimeSimple", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{key}/Calculate/InceptionDate": { "post": { "tags": [ "Portfolio/Accounts" ], "summary": "Used to calculate the appropriate inception date for the provided account.", "operationId": "Accounts_CalculateInceptionDate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "endDate", "in": "query", "description": "Optional. Default: Today. The end date of the reporting period.", "required": false, "type": "string", "format": "date-time" }, { "name": "inclusionOption", "in": "query", "description": "Optional. Default: Database default. Indicates which accounts/registrations to include.", "required": false, "type": "string", "default": -1, "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, { "name": "unmanagedInclusionOption", "in": "query", "description": "Optional. Default: Database default. Indicates how unmanaged assets are handled.", "required": false, "type": "string", "enum": [ "Unmanaged", "Performance", "ActivitySummary", "Allocation", "PortfolioDetail", "TaxDetail" ] }, { "name": "reportCategory", "in": "query", "required": false, "type": "string", "enum": [ "Unmanaged", "Performance", "ActivitySummary", "Allocation", "PortfolioDetail", "TaxDetail" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RunReport.InceptionDateDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{key}/Changes": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a list of account changes for the account with the specified key, which the logged in user has access to.", "operationId": "Accounts_GetAccountChanges", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountChangeDto" }, "xml": { "name": "AccountChangeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{key}/Changes/New": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a template object for creating a new account change for the account with the specified key, which the logged in user has access to.", "operationId": "Accounts_GetNewAccountChange", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountChangeNewDto" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/Accounts" ], "summary": "Used to create new account change records.", "operationId": "Accounts_CreateNewAccountChange", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "An object describing the account changes to perform.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountChangeNewDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{key}/ClearCancelationDate": { "put": { "tags": [ "Portfolio/Accounts" ], "summary": "Clear account cancelation date", "operationId": "Accounts_UpdateAccountCancelationDateAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "description": "Token for cancellation.", "required": true }, { "name": "key", "in": "path", "description": "Account Identifier.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{key}/CustomIndex": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Get full set of Account's Custom Index data", "operationId": "Accounts_GetCustomIndexDataByAccountAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationCustomIndexDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{key}/Documents": { "get": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_GetBlobs", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "fileType", "in": "query", "required": false, "items": { "type": "string", "enum": [ "RPT_1099", "QuarterlyStatements", "YearEndStatements", "CrmDocuments", "Payable", "InsightPresentations", "PortfolioViewDashboards" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" }, "xml": { "name": "BlobBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_CreateBlobAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "file", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountFileDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{key}/Documents/{fileId}": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a file for the account with the specified key and the file with the specified key.", "operationId": "Accounts_GetBlobDto", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "description": "Key of the file to be returned.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_UpdateBlobAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "file", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountFileDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_DeleteBlob", "consumes": [], "produces": [], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{key}/Documents/{fileId}/Download": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets the raw data of the specific file with the blobId provided which is associated to the account with the specified key.", "operationId": "Accounts_GetBlobFile", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "description": "Key of the file to be downloaded.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{key}/Documents/Action/MoveToAccount/{accountId}": { "put": { "tags": [ "Portfolio/Accounts" ], "summary": "Move documents to different account", "operationId": "Accounts_MoveDocumentsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "fileIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{key}/NetAmountInvested": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a list of Aum data representative of the range provided for all account with the specified key. Also returns a list of data to show the net amount invested overtime.", "operationId": "Accounts_GetAumOverTimeWithNetAmountInvestedAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "description": "Optional. Default: inception date. The start of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default: yesterday. The end of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "interval", "in": "query", "description": "Optional. Default: \"A\" Automatic. Options are:\r\n\"A\" Automatic\r\n\"M\" Monthly\r\n\"W\" Weekly\r\n\"D\" Daily", "required": false, "type": "string", "default": "A" }, { "name": "cancellationToken", "in": "header", "required": false }, { "name": "clientPerformanceInclude", "in": "query", "description": "Optional. Default: Default. When set only accounts/registrations that have value/are active will be returned.", "required": false, "type": "string", "default": -1, "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, { "name": "unmangedInclusionOverride", "in": "query", "description": "Optional. Default: no override. Used to override the unmanaged setting. To include all unmanaged assets set this parameter to \"ActivitySummary\".", "required": false, "type": "string", "enum": [ "Unmanaged", "Performance", "ActivitySummary", "Allocation", "PortfolioDetail", "TaxDetail" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AumOverTimeWithNetAmountInvestedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{key}/Performance": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Used to verbosely return performance. Has the ability to return account performance, benchmark performance, and statistical data for the account over a number of date ranges.", "operationId": "Accounts_GetPerformanceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the account that performance will be calculated for.", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "description": "Optional. The start of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default: Today. The end of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "cancellationToken", "in": "header", "required": false }, { "name": "clientPerformanceInclude", "in": "query", "description": "Optional. Default: Default. When set only accounts/registrations that have value/are active will be returned.", "required": false, "type": "string", "default": -1, "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, { "name": "returnStyle", "in": "query", "description": "Optional. Default: 3 PortfolioSummary & PortfolioDaily\r\n1 = Returns Portfolio Performance Summary\r\n2 = Returns Portfolio Daily Factors\r\n4 = Modifies return style 1 to include beginning and ending market value. Also includes accrued interest if performance was calculated including accrued interest.\r\n8 = Returns Benchmark Performance Summary\r\n16 = Returns Benchmark Daily Factors\r\n32 = **does nothing\r\n64 = Returns Statistical Summary", "required": false, "type": "string", "default": 3, "enum": [ "PortfolioSummary", "PortfolioDaily", "PortfolioDetailed", "BenchmarkSummary", "BenchmarkDaily", "AssetGroupAssignment", "StatisticSummary" ] }, { "name": "interval", "in": "query", "description": "Optional. Default: \"A\" Automatic. Options are:\r\n\"A\" Automatic\r\n\"M\" Monthly\r\n\"W\" Weekly\r\n\"D\" Daily", "required": false, "type": "string", "default": "A" }, { "name": "periods", "in": "query", "description": "Optional. Bitwise parameter for requesting commonly used date ranges.\r\n1 = MTD\r\n2 = QTD\r\n4 = YTD\r\n8 = 1yr\r\n16 = 3yr\r\n32 = 5yr\r\n64 = 10yr\r\n128 = inception\r\n256 = day", "required": false, "type": "string", "default": 0, "enum": [ "None", "Day", "MTD", "QTD", "YTD", "OneYear", "ThreeYear", "FiveYear", "TenYear", "Inception", "AllDates" ] }, { "name": "calendarYears", "in": "query", "description": "Optional. Comma delimited list of calendar years for which performance should be calculated.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Performance.PerformancePortfolio" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{key}/Performance/{grouping}": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Used to verbosely return performance. Has the ability to return grouped account performance, benchmark performance, and statistical data for the account over a number of date ranges.", "operationId": "Accounts_GetV1PortfolioAccountsByKeyPerformanceByGrouping", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the account that performance will be calculated for.", "required": true, "type": "integer", "format": "int32" }, { "name": "grouping", "in": "path", "description": "Defines how the account is grouped for the performance return. Can be set to any of the follow:\r\n Account, Asset, AssetClass, ProductType, MgmntStyle, RiskCategory, AssetCategory, or AssetLevelStrategy.", "required": true, "type": "string", "enum": [ "Undefined", "Representative", "Client", "Registration", "Account", "Asset", "AssetClass", "ProductType", "Platform", "RiskCategory", "Product", "IndexBlend", "AssetCategory", "AssetLevelStrategy", "AggregateModel", "AccountType", "PortfolioGroup" ] }, { "name": "startDate", "in": "query", "description": "Optional. The start of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default: Today. The end of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "cancellationToken", "in": "header", "required": false }, { "name": "clientPerformanceInclude", "in": "query", "description": "Optional. Default: Default. When set only accounts/registrations that have value/are active will be returned.", "required": false, "type": "string", "default": -1, "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, { "name": "returnStyle", "in": "query", "description": "Optional. Default: 3 Portfolio Summary & Portfolio Daily\r\n1 = Returns Portfolio Performance Summary\r\n2 = Returns Portfolio Daily Factors\r\n4 = Modifies return style 1 to include beginning and ending market value. Also includes accrued interest if performance was calculated including accrued interest.\r\n8 = Returns Benchmark Performance Summary\r\n16 = Returns Benchmark Daily Factors\r\n32 = **does nothing\r\n64 = Returns Statistical Summary", "required": false, "type": "string", "default": 3, "enum": [ "PortfolioSummary", "PortfolioDaily", "PortfolioDetailed", "BenchmarkSummary", "BenchmarkDaily", "AssetGroupAssignment", "StatisticSummary" ] }, { "name": "interval", "in": "query", "description": "Optional. Default: \"A\" Automatic. Options are:\r\n\"A\" Automatic\r\n\"M\" Monthly\r\n\"W\" Weekly\r\n\"D\" Daily", "required": false, "type": "string", "default": "A" }, { "name": "periods", "in": "query", "description": "Optional. Bitwise parameter for requesting commonly used date ranges.\r\n1 = MTD\r\n2 = QTD\r\n4 = YTD\r\n8 = 1yr\r\n16 = 3yr\r\n32 = 5yr\r\n64 = 10yr\r\n128 = inception\r\n256 = day", "required": false, "type": "string", "default": 0, "enum": [ "None", "Day", "MTD", "QTD", "YTD", "OneYear", "ThreeYear", "FiveYear", "TenYear", "Inception", "AllDates" ] }, { "name": "calendarYears", "in": "query", "description": "Optional. Comma delimited list of calendar years for which performance should be calculated.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Performance.PerformancePortfolio" }, "xml": { "name": "PerformancePortfolio", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{key}/Performance/Interval": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Used to return interval performance. Has the ability to return account performance in sequential intervals over a number the date range specified.", "operationId": "Accounts_GetPerformanceIntervalAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the account that performance will be calculated for.", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "description": "Optional. The start of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default: Today. The end of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "interval", "in": "query", "description": "Optional. Default: \"A\" Automatic. Options are:\r\n\"A\" Automatic\r\n\"M\" Monthly\r\n\"W\" Weekly\r\n\"D\" Daily", "required": false, "type": "string", "default": "A" }, { "name": "cancellationToken", "in": "header", "required": false }, { "name": "clientPerformanceInclude", "in": "query", "description": "Optional. Default: Default. When set only accounts/registrations that have value/are active will be returned.", "required": false, "type": "string", "default": -1, "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Reporting.PerformancePortfolioDetailDto" }, "xml": { "name": "PerformancePortfolioDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{key}/Performance/Interval/{grouping}": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Used to return interval performance. Has the ability to return grouped account performance in sequential intervals over a number the date range specified.", "operationId": "Accounts_GetV1PortfolioAccountsByKeyPerformanceIntervalByGrouping", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the account that performance will be calculated for.", "required": true, "type": "integer", "format": "int32" }, { "name": "grouping", "in": "path", "description": "Defines how the account is grouped for the performance return. Can be set to any of the follow:\r\n Account, Asset, AssetClass, ProductType, MgmntStyle, RiskCategory, AssetCategory, or AssetLevelStrategy.", "required": true, "type": "string", "enum": [ "Undefined", "Representative", "Client", "Registration", "Account", "Asset", "AssetClass", "ProductType", "Platform", "RiskCategory", "Product", "IndexBlend", "AssetCategory", "AssetLevelStrategy", "AggregateModel", "AccountType", "PortfolioGroup" ] }, { "name": "startDate", "in": "query", "description": "Optional. The start of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default: Today. The end of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "interval", "in": "query", "description": "Optional. Default: \"A\" Automatic. Options are:\r\n\"A\" Automatic\r\n\"M\" Monthly\r\n\"W\" Weekly\r\n\"D\" Daily", "required": false, "type": "string", "default": "A" }, { "name": "cancellationToken", "in": "header", "required": false }, { "name": "clientPerformanceInclude", "in": "query", "description": "Optional. Default: Default. When set only accounts/registrations that have value/are active will be returned.", "required": false, "type": "string", "default": -1, "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Reporting.PerformancePortfolioDetailDto" }, "xml": { "name": "PerformancePortfolioDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{key}/Performance/Summary": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Used to return summary performance. Has the ability to return performance for the account over a number of date ranges.", "operationId": "Accounts_GetPerformanceSummaryAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the account that performance will be calculated for.", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "description": "Optional. The start of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default: Today. The end of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "cancellationToken", "in": "header", "required": false }, { "name": "clientPerformanceInclude", "in": "query", "description": "Optional. Default: Default. When set only accounts/registrations that have value/are active will be returned.", "required": false, "type": "string", "default": -1, "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, { "name": "periods", "in": "query", "description": "Optional. Bitwise parameter for requesting commonly used date ranges.\r\n1 = MTD\r\n2 = QTD\r\n4 = YTD\r\n8 = 1yr\r\n16 = 3yr\r\n32 = 5yr\r\n64 = 10yr\r\n128 = inception\r\n256 = day", "required": false, "type": "string", "default": 0, "enum": [ "None", "Day", "MTD", "QTD", "YTD", "OneYear", "ThreeYear", "FiveYear", "TenYear", "Inception", "AllDates" ] }, { "name": "calendarYears", "in": "query", "description": "Optional. Comma delimited list of calendar years for which performance should be calculated.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.PerformancePortfolioSummaryDto" }, "xml": { "name": "PerformancePortfolioSummaryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{key}/Performance/Summary/{grouping}": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Used to return summary performance. Has the ability to return grouped account performance for the account over a number of date ranges.", "operationId": "Accounts_GetV1PortfolioAccountsByKeyPerformanceSummaryByGrouping", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the account that performance will be calculated for.", "required": true, "type": "integer", "format": "int32" }, { "name": "grouping", "in": "path", "description": "Defines how the account is grouped for the performance return. Can be set to any of the follow:\r\n Account, Asset, AssetClass, ProductType, MgmntStyle, RiskCategory, AssetCategory, or AssetLevelStrategy.", "required": true, "type": "string", "enum": [ "Undefined", "Representative", "Client", "Registration", "Account", "Asset", "AssetClass", "ProductType", "Platform", "RiskCategory", "Product", "IndexBlend", "AssetCategory", "AssetLevelStrategy", "AggregateModel", "AccountType", "PortfolioGroup" ] }, { "name": "startDate", "in": "query", "description": "Optional. The start of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default: Today. The end of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "cancellationToken", "in": "header", "required": false }, { "name": "clientPerformanceInclude", "in": "query", "description": "Optional. Default: Default. When set only accounts/registrations that have value/are active will be returned.", "required": false, "type": "string", "default": -1, "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, { "name": "periods", "in": "query", "description": "Optional. Bitwise parameter for requesting commonly used date ranges.\r\n1 = MTD\r\n2 = QTD\r\n4 = YTD\r\n8 = 1yr\r\n16 = 3yr\r\n32 = 5yr\r\n64 = 10yr\r\n128 = inception\r\n256 = day", "required": false, "type": "string", "default": 0, "enum": [ "None", "Day", "MTD", "QTD", "YTD", "OneYear", "ThreeYear", "FiveYear", "TenYear", "Inception", "AllDates" ] }, { "name": "calendarYears", "in": "query", "description": "Optional. Comma delimited list of calendar years for which performance should be calculated.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.PerformancePortfolioSummaryDto" }, "xml": { "name": "PerformancePortfolioSummaryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{key}/RmdCalculation": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Method to get RMD calculation for the account", "operationId": "Accounts_GetRmdCalculationsForAccountAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 1, "enum": [ "Standard", "Full" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RmdDashboardBaseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Accounts" ], "summary": "Update items associated with RMD dashboard for the account", "operationId": "Accounts_UpdateRmdCalculationsForAccountAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RmdDashboardFullDto" } }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 1, "enum": [ "Standard", "Full" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RmdDashboardBaseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{key}/Simple": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets the simple account that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Accounts_GetSimpleByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{key}/Transactions": { "get": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_GetTransactions", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "transTypeId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TradingTransactionDto" }, "xml": { "name": "TradingTransactionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{key}/UpdateEclipseSMA": { "put": { "tags": [ "Portfolio/Accounts" ], "summary": "Used when Astro Enabled is changed on the Eclipse side for non-sleeved accounts.", "operationId": "Accounts_UpdateEclipseSMAAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the account that will have an updated EclipseSMA.", "required": true, "type": "integer", "format": "int32" }, { "name": "eclipseSMA", "in": "query", "required": true, "type": "boolean" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{key}/UserDefinedFields": { "get": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_GetUserDefinedFieldsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "entities", "in": "query", "required": false, "items": { "type": "string", "enum": [ "BrokerDealers", "Wholesalers", "Representatives", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Products", "FundFamilies", "ModelRanges", "PortfolioGroups" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{key}/Value": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets the simple account (including aum for the end of today) that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Accounts_GetValueByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "includeCash", "in": "query", "description": "Optional. Default: false. When true the cash value will be returned along with the account value.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/{key}/Value/{asOfDate}": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets the simple account (including aum for the end of the date specified) that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Accounts_GetValueAsOfDateByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "includeCash", "in": "query", "description": "Optional. Default: false. When true the cash value will be returned along with the account value.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/AccountInformation/Banking": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Collects the banking information for the logged in user's active accounts\r\nThis information is provided by the recon process that pulls this\r\ninformation from the tenants", "operationId": "Accounts_GetBankingAccountInformationForUser", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BankingAccountDto" }, "xml": { "name": "BankingAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/AccountInformation/Banking/{repId}": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Collects the banking information for a given Reps active accounts\r\nThis information is provided by the recon process that pulls this\r\ninformation from the tenants", "operationId": "Accounts_GetBankingAccountInformationByRepId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "repId", "in": "path", "description": "Required: Orion rep id to get the banking information for their active accounts", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BankingAccountDto" }, "xml": { "name": "BankingAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/AccountInformation/Beneficiaries": { "post": { "tags": [ "Portfolio/Accounts" ], "summary": "Collects the beneificiary information for a given Reps accounts\r\nThis information is provided by the recon process that pulls this\r\ninformation from the tenants", "operationId": "Accounts_GetBeneficiariesRepIdList", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "repIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BeneficiaryAccountDto" }, "xml": { "name": "BeneficiaryAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/AccountInformation/Beneficiaries/{repId}": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Collects the beneificiary information for a given Reps accounts\r\nThis information is provided by the recon process that pulls this\r\ninformation from the tenants", "operationId": "Accounts_GetBeneficiariesRepId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "repId", "in": "path", "description": "Required: Orion rep id to get the beneficiary information for their active accounts", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BeneficiaryAccountDto" }, "xml": { "name": "BeneficiaryAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/AccountInformation/Rmd": { "post": { "tags": [ "Portfolio/Accounts" ], "summary": "Retrieves RMD information for the accounts tied to a given rep id.", "operationId": "Accounts_GetRmdsByRepIdList", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "repIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RmdDto" }, "xml": { "name": "RmdDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/AccountInformation/Rmd/{repId}": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Retrieves RMD information for the accounts tied to a given rep id.", "operationId": "Accounts_GetRmds", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "repId", "in": "path", "description": "Required: Orion rep id to get the RMD information for their accounts", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RmdDto" }, "xml": { "name": "RmdDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/AccountInformation/Systematics/{repId}": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Collects the systematics information for a given Reps accounts\r\nThis information is provided by the recon process that pulls this\r\ninformation from the tenants", "operationId": "Accounts_GetSystematicsRepId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "repId", "in": "path", "description": "Required: Orion rep id to get the systematics information for their active accounts", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SystematicAccountDto" }, "xml": { "name": "SystematicAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/AccountManagers": { "get": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_GetAccountManagersAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountManagerDto" }, "xml": { "name": "AccountManagerDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/AccountsForConvertAccount": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets accounts for convert account feature\r\nSample Request\r\n GET /Portfolio/Accounts/AccountsForConvertAccount?clientId=123&accountId=456\r\nSample Response \r\n[\r\n {\r\n \"id\": 123,\r\n \"fundName\": \"Test\",\r\n \"acctCode\": \"Testcode\"\r\n }\r\n]", "operationId": "Accounts_GetAccountsForConvertAccountAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "query", "description": "Client ID to filter accounts to", "required": true, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "query", "description": "Account ID to exclude", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountForConvertAccountDto" }, "xml": { "name": "AccountForConvertAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Action/AssignToSelfDirected": { "post": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_AssignAccoutsToSelfDirectedAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "accountIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "copyAllocation", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "suppressTrade", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Action/ConvertAccount": { "post": { "tags": [ "Portfolio/Accounts" ], "summary": "Converts an account\r\nSample Request\r\nPOST\r\n/Portfolio/Accounts/Action/ConvertAccount\r\n{\r\n \"convertDate\": \"2024-11-04\",\r\n \"copyAssets\": true,\r\n \"copyBillingInst\": true,\r\n \"copySwp\": true,\r\n \"copyTrans\": true,\r\n \"fromAccountId\": 123,\r\n \"oldAcctActive\": false,\r\n \"overwriteAcctNum\": 1\r\n}", "operationId": "Accounts_ConvertAccountAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "convertAccountDto", "in": "body", "description": "Convert account data", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ConvertAccountDto" } }, { "name": "ct", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountBaseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Action/Delete": { "put": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_ActionDeleteAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Action/Merge": { "put": { "tags": [ "Portfolio/Accounts" ], "summary": "Takes a list of old and new account ids and merges the old account into the new account. The old account is then deleted.", "operationId": "Accounts_MergeAccountsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "mergeList", "in": "body", "description": "List of old and new account ids", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AccountMerge" }, "xml": { "name": "AccountMerge", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Action/Restore": { "post": { "tags": [ "Portfolio/Accounts" ], "summary": "Restores account[s].", "operationId": "Accounts_RestoreAccountsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountNumbers", "in": "body", "required": true, "schema": { "items": { "type": "string" }, "type": "array" } }, { "name": "effectiveDate", "in": "query", "description": "DateTime. Required.", "required": true, "type": "string", "format": "date-time" }, { "name": "downloadSource", "in": "query", "description": "Int. Default All. UID of Download Source.", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "isReturnAllPositions", "in": "query", "description": "Boolean. Default `false`.", "required": false, "type": "boolean", "default": false }, { "name": "createStartingValueTrans", "in": "query", "description": "Boolean. Default `true`.", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RestoreAccountsDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Action/UndoCancel/{key}/{restore}": { "put": { "tags": [ "Portfolio/Accounts" ], "summary": "Undo a cancelation of an account.", "operationId": "Accounts_UndoCanceledAccountAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "restore", "in": "path", "required": true, "type": "boolean" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.UndoCancelDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Action/UpdateCashModelForFees": { "post": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_UpdateCashModelForFeesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "emailRecepients", "in": "body", "required": true, "schema": { "type": "string" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/action/updateDoNotTrade": { "put": { "tags": [ "Portfolio/Accounts" ], "summary": "Update Account DoNotTrade settings from Eclipse", "operationId": "Accounts_UpdateDoNotTradeByListAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accounts", "in": "body", "description": "Collection of the accounts and their doNotTrade setting that need to be updated.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.AccountDoNotTradeDto" }, "xml": { "name": "AccountDoNotTradeDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Changes/New": { "post": { "tags": [ "Portfolio/Accounts" ], "summary": "Used to create new account change records across a number of accounts.", "operationId": "Accounts_PostV1PortfolioAccountsChangesNew", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "An object describing the account changes to perform.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.NumerousAccountChangeNewDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Count": { "get": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_GetAccountsListCountAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "isActive", "in": "query", "required": false, "type": "boolean" }, { "name": "IsDiscretionary", "in": "query", "required": false, "type": "boolean" }, { "name": "isManaged", "in": "query", "required": false, "type": "boolean" }, { "name": "createdDateStart", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "newAccountFilter", "in": "query", "required": false, "type": "string" }, { "name": "accountFilter", "in": "query", "required": false, "type": "string", "enum": [ "MissingInformation", "ActiveAccountsWithZeroBalance", "InactiveAccountsNotZero", "AcctsWithMultAcctNumbersPerAcctId", "SameAcctNumberInMultAccounts", "MissingMgmtStyle", "LinkedToHistoryAccountWithValue", "LinkedWithRecursiveLink", "LinkedInDifferentRegistrations", "LinkedWithNoTransactions", "StrewnAcrossMultipleAccounts", "FundFamilyVsCustodianComparison", "NotPartOfSleeveStrategy", "ModelAccountAssignment", "ModelCustodialAccountAssignment", "ModelAccountAssignmentWithoutCustodial", "ModelCustodialAccountAssignmentWithoutSleeves", "SleeveCustodialAccountsWithBalance", "SleeveAccountsWithNegBalance" ] }, { "name": "clientId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "registrationId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "accountId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "asOfDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "hasValue", "in": "query", "required": false, "type": "boolean" }, { "name": "editedStartDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "editedEndDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "pageQueryId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "includeAdditionalAccounts", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "fundFamilyId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "representativeId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "portfolioGroupId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "sleeveId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "entitySessionId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.ListCountDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Grid": { "get": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "manipulator", "in": "header", "required": true }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "top", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "isActive", "in": "query", "required": false, "type": "boolean" }, { "name": "isManaged", "in": "query", "required": false, "type": "boolean" }, { "name": "createdDateStart", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "newAccountFilter", "in": "query", "required": false, "type": "string" }, { "name": "accountFilter", "in": "query", "required": false, "type": "string", "enum": [ "MissingInformation", "ActiveAccountsWithZeroBalance", "InactiveAccountsNotZero", "AcctsWithMultAcctNumbersPerAcctId", "SameAcctNumberInMultAccounts", "MissingMgmtStyle", "LinkedToHistoryAccountWithValue", "LinkedWithRecursiveLink", "LinkedInDifferentRegistrations", "LinkedWithNoTransactions", "StrewnAcrossMultipleAccounts", "FundFamilyVsCustodianComparison", "NotPartOfSleeveStrategy", "ModelAccountAssignment", "ModelCustodialAccountAssignment", "ModelAccountAssignmentWithoutCustodial", "ModelCustodialAccountAssignmentWithoutSleeves", "SleeveCustodialAccountsWithBalance", "SleeveAccountsWithNegBalance" ] }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "Audit", "AccountAssignment", "AccountAssignmentModelAgg" ] }, { "name": "clientId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "registrationId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "accountId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "asOfDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "hasValue", "in": "query", "required": false, "type": "boolean" }, { "name": "editedStartDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "editedEndDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "pageQueryId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "includeAdditionalAccounts", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "fundFamilyId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "representativeId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountBaseDto" }, "xml": { "name": "AccountBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/GroupNumbers": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of account group numbers that the logged in user has access to.\r\nThe return is limited to pages of 10000. Use $top and $skip in the query string to page through the data.", "operationId": "Accounts_GetGroupNum", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/List": { "post": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_GetListByIdAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "manipulator", "in": "header", "required": true }, { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "Audit", "AccountAssignment", "AccountAssignmentModelAgg" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountBaseDto" }, "xml": { "name": "AccountBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/List/AccountNumber": { "post": { "tags": [ "Portfolio/Accounts" ], "summary": "Get a list of accounts for an array of AccountNumbers.", "operationId": "Accounts_GetEntityByAccountNumberListAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "manipulator", "in": "header", "required": true }, { "name": "accountNumberList", "in": "body", "description": "Array of account numbers.", "required": true, "schema": { "items": { "type": "string" }, "type": "array" } }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "Audit", "AccountAssignment", "AccountAssignmentModelAgg" ] }, { "name": "lookupBasis", "in": "query", "required": false, "type": "string", "default": 7, "enum": [ "Account", "Asset" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountBaseDto" }, "xml": { "name": "AccountBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/List/Id": { "post": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_PostV1PortfolioAccountsListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "manipulator", "in": "header", "required": true }, { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "Audit", "AccountAssignment", "AccountAssignmentModelAgg" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountBaseDto" }, "xml": { "name": "AccountBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/ListCounts": { "post": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_GetListCountByIdAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/NewPortfolio": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a list of accounts that the logged in user has access to.\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "Accounts_GetNewPortfolio", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isActive", "in": "query", "description": "Optional. Default: null. If provided returns only the active (true) or inactive accounts (false).", "required": false, "type": "boolean" }, { "name": "createdDateStart", "in": "query", "description": "Optional. Default: null. If provided returns accounts created on or after the date provided.", "required": false, "type": "string", "format": "date-time" }, { "name": "newAccountFilter", "in": "query", "description": "Optional. Default: null. When provided limits the return to only those accounts included in the status provided.", "required": false, "type": "string" }, { "name": "registrationId", "in": "query", "description": "Optional. Default: null. When provided limits the return to only those accounts that belong to the registration specified.", "required": false, "type": "integer", "format": "int32" }, { "name": "clientId", "in": "query", "description": "Optional. Default: null. When provided limits the return to only those accounts that belong to the client specified.", "required": false, "type": "integer", "format": "int32" }, { "name": "repId", "in": "query", "description": "Optional. Default: null. When provided limits the return to only those accounts that belong to the rep specified.", "required": false, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.NewPortfolioAccountDto" }, "xml": { "name": "NewPortfolioAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_CreateNewPortfolioAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "newDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.NewAccountDto" } }, { "name": "generateAccountNumber", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.NewAccountDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/NewPortfolio/{key}": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets the account that has the provided key.", "operationId": "Accounts_GetNewPortfolioByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.NewPortfolioAccountDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Accounts" ], "summary": "Simple dto update", "operationId": "Accounts_UpdateNewAccountAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.NewPortfolioAccountDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.NewPortfolioAccountDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/NewPortfolio/ByAll/Pending": { "post": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_RefreshByAllAccountAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/NewPortfolio/Client/{clientId}/ByAll/Investor/{key}": { "post": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_CreateAccountFromByAllAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/NewPortfolio/Counts": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Get counts for new accounts UI left navigation.", "operationId": "Accounts_GetNewAccountsCount", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "additionalProperties": { "type": "integer", "format": "int32" }, "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/NewPortfolio/Counts/Header": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Get counts for new accounts UI page header.", "operationId": "Accounts_GetNewAccountsHeaderCount", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "status", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/NewPortfolio/List": { "post": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_GetNewPortfolioListById", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.NewPortfolioAccountDto" }, "xml": { "name": "NewPortfolioAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/NewPortfolio/List/AccountNumber": { "post": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_GetNewPortfolioListByAccountNumber", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountNumbers", "in": "body", "required": true, "schema": { "items": { "type": "string" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.NewPortfolioAccountDto" }, "xml": { "name": "NewPortfolioAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/NewPortfolio/List/Id": { "post": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_PostV1PortfolioAccountsNewPortfolioListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.NewPortfolioAccountDto" }, "xml": { "name": "NewPortfolioAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/NewPortfolio/New": { "get": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_GetNewAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "expandClient", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Billing", "RecurringAdjustments", "FeePayingAccounts", "Portfolio", "HouseholdMembers", "Notes", "Documents", "AdditionalAccounts", "Suitability", "UserDefinedFields", "EntityOptions", "TargetAllocations", "CreditCard", "AssetExclusion", "PortfolioGroups", "FinancialPlanningFee", "AppLinks", "TieredFeeAccounts", "HouseholdBills", "AdditionalRepresentatives", "ClientChanges", "ClientRepAdditional", "All" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "expandRegistration", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Notes", "Beneficiaries", "Suitability", "UserDefinedFields", "EntityOptions", "Contact", "AdditionalRepresentativesPercent", "Decedent", "FeePayingAccounts", "AdditionalRepresentatives", "RegistrationChanges", "RegistrationRepAdditionals", "TargetAllocations", "All" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "expandAccount", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Billing", "RecurringAdjustments", "GeneralAccounts", "Portfolio", "ModelingInfo", "Notes", "Documents", "Compliance", "Systematics", "AccountManagers", "TaxRates", "UserDefinedFields", "EntityOptions", "ReferralSchedules", "BillAccountSchedules", "TargetAllocations", "Sma", "BondTrade", "ProductEquivalents", "CompositeExclusions", "FutureCashflows", "GrowthRates", "Goals", "Suitability", "PermissibleAggregateModels", "AstroTaxSchedules", "AstroAccount", "AdditionalClients", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.NewAccountDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Number/{accountNumber}": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets the account that has the provided Custodial Account Number. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Accounts_GetV1PortfolioAccountsNumberByAccountNumber", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "manipulator", "in": "header", "required": true }, { "name": "accountNumber", "in": "path", "description": "Custodial Account Number of the desired return account object.", "required": true, "type": "string" }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "Audit", "AccountAssignment", "AccountAssignmentModelAgg" ] }, { "name": "lookupBasis", "in": "query", "required": false, "type": "string", "default": 7, "enum": [ "Account", "Asset" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountBaseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/OrionCustomIndexing/ClientInformation": { "get": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_OciPerformanceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountIds", "in": "query", "required": true, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataProcess.Performance.OrionCustomIndexing.Models.OrionCustomIndexingClientInformation" }, "xml": { "name": "OrionCustomIndexingClientInformation", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/OrionCustomIndexing/ClientInformation/Action/Run": { "post": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_UpdateOciClientInformation", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/OrionCustomIndexing/ClientInformation/Calculate": { "post": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_CalculateOciClientInformationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Performance.OrionCustomIndexing.OrionCustomIndexingClientInformationRequest" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/OrionCustomIndexing/ClientInformation/Csv": { "get": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_GetOciClientInformationCsvAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountIds", "in": "query", "required": true, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/OutOfTolerance": { "get": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_GetAccountsOutOfToleranceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "manipulator", "in": "header", "required": true }, { "name": "includeMMInRebalance", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "ignoreDollarModel", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountBaseDto" }, "xml": { "name": "AccountBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/OutOfTolerance/List": { "post": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_GetAccountsOutOfToleranceByListAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "manipulator", "in": "header", "required": true }, { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "includeMMInRebalance", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "includePendingValue", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "ignoreDollarModel", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountBaseDto" }, "xml": { "name": "AccountBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/qs": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a list of accounts returned by a Query Studio Query in the provided Dashboard Card ID.", "operationId": "Accounts_GetV1PortfolioAccountsQs", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "queryStudioQueryId", "in": "query", "description": "Returns only the results from the query studio query with the provided guid.", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountBaseDto" }, "xml": { "name": "AccountBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Rep/{repId}/RmdSummary": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Endpoint to get rep rmd summary information for Insight rep tile", "operationId": "Accounts_GetRmdSummaryForRep", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "repId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "additionalProperties": { "type": "object" }, "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/RmdCalculation": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a list Rmd Calculaions.", "operationId": "Accounts_GetRmdCalculationsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "filter", "in": "query", "required": false, "type": "string", "enum": [ "AccountsOffTrack", "AccountsOnTrack", "RmdSatisfied" ] }, { "name": "clientId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "Full" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RmdDashboardBaseDto" }, "xml": { "name": "RmdDashboardBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/RmdCalculation/Actions/MailMerge": { "post": { "tags": [ "Portfolio/Accounts" ], "summary": "Upload a word file to be merged.", "operationId": "Accounts_RmdMailMergeAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RmdMailMergeFileImportDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/RmdCalculation/Actions/MailMerge/{filename}": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Used to download a previously generated mail merge.", "operationId": "Accounts_DownloadMailMergeAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "filename", "in": "path", "description": "The filename provided by the generate endpoint.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/RmdCalculation/Actions/Recalc": { "post": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_RmdRecalc", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RmdSystematicReclacDto" }, "xml": { "name": "RmdSystematicReclacDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/RmdCalculation/Update": { "get": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_RmdUpdateAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/RmdCalculationCounts": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Endpoint to get counts for all filters", "operationId": "Accounts_GetRmdCalculationCounts", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "resetCache", "in": "query", "description": "Optional. Default: false. The result is cached for thirty minutes. To force the cache to refresh call with resetCache = true.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "additionalProperties": { "type": "number", "format": "double" }, "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Search/Advanced": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a list of accounts that the logged in user has access to filtered by supplied search parameters.", "operationId": "Accounts_GetAdvancedAccountSearchAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "manipulator", "in": "header", "required": true }, { "name": "assetId", "in": "query", "description": "Optional. Default: null. Asset ID.", "required": false, "type": "integer", "format": "int32" }, { "name": "registrationTypeId", "in": "query", "description": "Optional. Default: null. Registration type ID.", "required": false, "type": "integer", "format": "int32" }, { "name": "lastName", "in": "query", "description": "Optional. Default: null. Account last name.", "required": false, "type": "string" }, { "name": "firstName", "in": "query", "description": "Optional. Default: null. Client first name.", "required": false, "type": "string" }, { "name": "accountNumber", "in": "query", "description": "Optional. Default: null. Account number.", "required": false, "type": "string" }, { "name": "secondaryAccountNumber", "in": "query", "description": "Optional. Default: null. Secondary account number.", "required": false, "type": "string" }, { "name": "outsideId", "in": "query", "description": "Optional. Default: null. Outside Id.", "required": false, "type": "string" }, { "name": "registrationId", "in": "query", "description": "Optional. Default: null. Registration ID.", "required": false, "type": "integer", "format": "int32" }, { "name": "clientId", "in": "query", "description": "Optional. Default: null. Client ID.", "required": false, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "query", "description": "Optional. Default: null. Account ID.", "required": false, "type": "integer", "format": "int32" }, { "name": "representativeId", "in": "query", "description": "Optional. Default: null. Representative Id.", "required": false, "type": "integer", "format": "int32" }, { "name": "brokerDealerId", "in": "query", "description": "Optional. Default: null. Broker Dealer Id.", "required": false, "type": "integer", "format": "int32" }, { "name": "subAdvisorId", "in": "query", "description": "Optional. Default: null. SubAdvisor Id.", "required": false, "type": "integer", "format": "int32" }, { "name": "targetAggregateModelId", "in": "query", "description": "Optional. Default: null. Model Target Id.", "required": false, "type": "integer", "format": "int32" }, { "name": "custodianId", "in": "query", "description": "Optional. Default: null. Custodian Id.", "required": false, "type": "integer", "format": "int32" }, { "name": "includeSleeveStrategies", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "sleeveStrategyId", "in": "query", "description": "Optional. Used to apply sleeve strategy restriction rules.", "required": false, "type": "integer", "format": "int32" }, { "name": "includeSleeves", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "isActive", "in": "query", "required": false, "type": "boolean" }, { "name": "filter", "in": "query", "required": false, "type": "string", "enum": [ "MissingInformation", "ActiveAccountsWithZeroBalance", "InactiveAccountsNotZero", "AcctsWithMultAcctNumbersPerAcctId", "SameAcctNumberInMultAccounts", "MissingMgmtStyle", "LinkedToHistoryAccountWithValue", "LinkedWithRecursiveLink", "LinkedInDifferentRegistrations", "LinkedWithNoTransactions", "StrewnAcrossMultipleAccounts", "FundFamilyVsCustodianComparison", "NotPartOfSleeveStrategy", "ModelAccountAssignment", "ModelCustodialAccountAssignment", "ModelAccountAssignmentWithoutCustodial", "ModelCustodialAccountAssignmentWithoutSleeves", "SleeveCustodialAccountsWithBalance", "SleeveAccountsWithNegBalance" ] }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "Audit", "AccountAssignment", "AccountAssignmentModelAgg" ] }, { "name": "sleeveStrategyAggregateId", "in": "query", "description": "Optional. Used to apply sleeve strategy aggregate restriction rules.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountBaseDto" }, "xml": { "name": "AccountBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Search/Advanced/Count": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a count of accounts that the logged in user has access to filtered by supplied search parameters.", "operationId": "Accounts_GetAdvancedAccountSearchCount", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "assetId", "in": "query", "description": "Optional. Default: null. Asset ID.", "required": false, "type": "integer", "format": "int32" }, { "name": "registrationTypeId", "in": "query", "description": "Optional. Default: null. Registration type ID.", "required": false, "type": "integer", "format": "int32" }, { "name": "lastName", "in": "query", "description": "Optional. Default: null. Account last name.", "required": false, "type": "string" }, { "name": "firstName", "in": "query", "description": "Optional. Default: null. Client first name.", "required": false, "type": "string" }, { "name": "accountNumber", "in": "query", "description": "Optional. Default: null. Account number.", "required": false, "type": "string" }, { "name": "secondaryAccountNumber", "in": "query", "description": "Optional. Default: null. Secondary account number.", "required": false, "type": "string" }, { "name": "outsideId", "in": "query", "description": "Optional. Default: null. Outside Id.", "required": false, "type": "string" }, { "name": "registrationId", "in": "query", "description": "Optional. Default: null. Registration ID.", "required": false, "type": "integer", "format": "int32" }, { "name": "clientId", "in": "query", "description": "Optional. Default: null. Client ID.", "required": false, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "query", "description": "Optional. Default: null. Account ID.", "required": false, "type": "integer", "format": "int32" }, { "name": "representativeId", "in": "query", "description": "Optional. Default: null. Representative Id.", "required": false, "type": "integer", "format": "int32" }, { "name": "brokerDealerId", "in": "query", "description": "Optional. Default: null. Broker Dealer Id.", "required": false, "type": "integer", "format": "int32" }, { "name": "subAdvisorId", "in": "query", "description": "Optional. Default: null. SubAdvisor Id.", "required": false, "type": "integer", "format": "int32" }, { "name": "targetAggregateModelId", "in": "query", "description": "Optional. Default: null. Model Target Id.", "required": false, "type": "integer", "format": "int32" }, { "name": "custodianId", "in": "query", "description": "Optional. Default: null. Custodian Id.", "required": false, "type": "integer", "format": "int32" }, { "name": "includeSleeveStrategies", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "sleeveStrategyId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "includeSleeves", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "isActive", "in": "query", "required": false, "type": "boolean" }, { "name": "accountFilter", "in": "query", "required": false, "type": "string", "enum": [ "MissingInformation", "ActiveAccountsWithZeroBalance", "InactiveAccountsNotZero", "AcctsWithMultAcctNumbersPerAcctId", "SameAcctNumberInMultAccounts", "MissingMgmtStyle", "LinkedToHistoryAccountWithValue", "LinkedWithRecursiveLink", "LinkedInDifferentRegistrations", "LinkedWithNoTransactions", "StrewnAcrossMultipleAccounts", "FundFamilyVsCustodianComparison", "NotPartOfSleeveStrategy", "ModelAccountAssignment", "ModelCustodialAccountAssignment", "ModelAccountAssignmentWithoutCustodial", "ModelCustodialAccountAssignmentWithoutSleeves", "SleeveCustodialAccountsWithBalance", "SleeveAccountsWithNegBalance" ] }, { "name": "sleeveStrategyAggregateId", "in": "query", "description": "Optional. Used to apply sleeve strategy aggregate restriction rules.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Simple": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of accounts that the logged in user has access to.\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "Accounts_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return accounts that have value (true) or don't have value (false).", "required": false, "type": "boolean" }, { "name": "isActive", "in": "query", "description": "Optional. Default: null. If provided returns only the active (true) or inactive accounts (false).", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Simple/List": { "post": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of accounts that match one of the keys in the provided list.", "operationId": "Accounts_GetSimpleListById", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Simple/List/AccountNumber": { "post": { "tags": [ "Portfolio/Accounts" ], "summary": "Get a list of simple accounts for an array of AccountNumbers.", "operationId": "Accounts_GetSimpleByAccountNumberList", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountNumberList", "in": "body", "description": "Array of account numbers.", "required": true, "schema": { "items": { "type": "string" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Simple/List/Id": { "post": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of accounts that match one of the keys in the provided list.", "operationId": "Accounts_PostV1PortfolioAccountsSimpleListId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Simple/Search": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of accounts that the logged in user has access to where the account number or outside Id begin with the search string or the Id is the search string.", "operationId": "Accounts_GetAccountSearchAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "search", "in": "query", "description": "Account Id, partial account number, or partial outside Id to search for.", "required": true, "type": "string" }, { "name": "top", "in": "query", "description": "Optional. Default: null. The maximum number of products to return. If null returns all.", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Optional. Default: 0. Defines number of items to skip.", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "isActive", "in": "query", "required": false, "type": "boolean" }, { "name": "clientId", "in": "query", "description": "Optional. Default: null. If provided only accounts for the specified client are returned.", "required": false, "type": "integer", "format": "int32" }, { "name": "includeAdditionalAccounts", "in": "query", "description": "Optional. Default: false. If clientId is provided this paramter determines if that client's additional accounts should be included in the search results or not.", "required": false, "type": "boolean", "default": false }, { "name": "useContain", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "useDirect", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleAccount" }, "xml": { "name": "SimpleAccount", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Simple/Search/{search}": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of accounts that the logged in user has access to where the account number or outside Id begin with the search string or the Id is the search string.", "operationId": "Accounts_GetV1PortfolioAccountsSimpleSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "search", "in": "path", "description": "Account Id, partial account number, or partial outside Id to search for.", "required": true, "type": "string" }, { "name": "top", "in": "query", "description": "Optional. Default: null. The maximum number of products to return. If null returns all.", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Optional. Default: 0. Defines number of items to skip.", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "isActive", "in": "query", "required": false, "type": "boolean" }, { "name": "clientId", "in": "query", "description": "Optional. Default: null. If provided only accounts for the specified client are returned.", "required": false, "type": "integer", "format": "int32" }, { "name": "includeAdditionalAccounts", "in": "query", "description": "Optional. Default: false. If clientId is provided this paramter determines if that client's additional accounts should be included in the search results or not.", "required": false, "type": "boolean", "default": false }, { "name": "useContain", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "useDirect", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleAccount" }, "xml": { "name": "SimpleAccount", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Simple/Search/Number": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of accounts that the logged in user has access to where the account number contains the search string.", "operationId": "Accounts_GetAccountSearchByNumberAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "search", "in": "query", "description": "partial account number to search for", "required": true, "type": "string" }, { "name": "exactMatch", "in": "query", "description": "Optional. Default = False, which does a contains match. When True, it does an exact match (not case sensitive).", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleAccount" }, "xml": { "name": "SimpleAccount", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Simple/Search/Number/{search}": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of accounts that the logged in user has access to where the account number contains the search string.", "operationId": "Accounts_GetV1PortfolioAccountsSimpleSearchNumberBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "search", "in": "path", "description": "partial account number to search for", "required": true, "type": "string" }, { "name": "exactMatch", "in": "query", "description": "Optional. Default = False, which does a contains match. When True, it does an exact match (not case sensitive).", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleAccount" }, "xml": { "name": "SimpleAccount", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Simple/Search/OutsideId": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of accounts that the logged in user has access to where the outside id exactly matches the search string.", "operationId": "Accounts_GetAccountSearchByOutsideId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "outside id to search for", "required": true, "type": "string" }, { "name": "exactMatch", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleAccount" }, "xml": { "name": "SimpleAccount", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Simple/Search/OutsideId/{search}": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of accounts that the logged in user has access to where the outside id exactly matches the search string.", "operationId": "Accounts_GetV1PortfolioAccountsSimpleSearchOutsideIdBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "outside id to search for", "required": true, "type": "string" }, { "name": "exactMatch", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleAccount" }, "xml": { "name": "SimpleAccount", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Simple/Search/SecondaryNumber": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of accounts that the logged in user has access to where the secondary account number contains the search string.", "operationId": "Accounts_GetAccountSearchBySecondaryNumber", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "partial secondary account number to search for", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleAccount" }, "xml": { "name": "SimpleAccount", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Simple/Search/SecondaryNumber/{search}": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of accounts that the logged in user has access to where the secondary account number contains the search string.", "operationId": "Accounts_GetV1PortfolioAccountsSimpleSearchSecondaryNumberBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "partial secondary account number to search for", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleAccount" }, "xml": { "name": "SimpleAccount", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/SyncToEclipse": { "post": { "tags": [ "Portfolio/Accounts" ], "summary": "Attempt to Sync multiple OC accounts to Eclipse.\r\nAccount Id's will be matched with Eclipse firms, and if a match is found\r\nwill be added to the partial extract table in the OC firm Database.\r\nIf the account is sleeved, only the RegistrationId will be added telling the \r\npartial import proccess to sync the entire registration.", "operationId": "Accounts_AddAccountsForPartialImportAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/UpdateDoNotTradeAndSma/{key}": { "put": { "tags": [ "Portfolio/Accounts" ], "summary": "Update Account SMA and DoNotTrade settings from Eclipse", "operationId": "Accounts_UpdateDoNotTradeAndSmaAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the account that will have an updated EclipseSMA.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.AccountDoNotTradeAndSmaDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Value": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of accounts (including aum for today) that the logged in user has access to.", "operationId": "Accounts_GetValue", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return accounts that have value (true) or don't have value (false).", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Value/{asOfDate}": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of accounts (including aum for the end of the date specified) that the logged in user has access to.", "operationId": "Accounts_GetValueAsOfDate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return accounts that have value (true) or don't have value (false).", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Value/{asOfDate}/List": { "post": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of accounts that match one of the keys in the provided list.", "operationId": "Accounts_GetValueAsOfDateListById", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Value/{asOfDate}/List/Id": { "post": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of accounts that match one of the keys in the provided list.", "operationId": "Accounts_PostV1PortfolioAccountsValueByAsOfDateListId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Value/{asOfDate}/Search": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of clients (including aum for the end of the date specified) that the logged in user has access to where the account number or outside Id begin with the search string or the Id is the search string.", "operationId": "Accounts_GetValueAsOfDateAccountSearchAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "search", "in": "query", "description": "Account Id, partial account number, or partial outside Id to search for.", "required": true, "type": "string" }, { "name": "useContain", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "useDirect", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Value/{asOfDate}/Search/{search}": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of clients (including aum for the end of the date specified) that the logged in user has access to where the account number or outside Id begin with the search string or the Id is the search string.", "operationId": "Accounts_GetV1PortfolioAccountsValueByAsOfDateSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "search", "in": "path", "description": "Account Id, partial account number, or partial outside Id to search for.", "required": true, "type": "string" }, { "name": "useContain", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "useDirect", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Value/{asOfDate}/Search/Number": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of clients (including aum for the end of the date specified) that the logged in user has access to where the account number contains the search string.", "operationId": "Accounts_GetValueAsOfDateAccountSearchByNumber", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "search", "in": "query", "description": "partial account number to search for.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Value/{asOfDate}/Search/Number/{search}": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of clients (including aum for the end of the date specified) that the logged in user has access to where the account number contains the search string.", "operationId": "Accounts_GetV1PortfolioAccountsValueByAsOfDateSearchNumberBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "search", "in": "path", "description": "partial account number to search for.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Value/{asOfDate}/Search/OutsideId": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of clients (including aum for the end of the date specified) that the logged in user has access to where the outside id exactly matches the search string.", "operationId": "Accounts_GetValueAsOfDateAccountSearchByOutsideId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "search", "in": "query", "description": "outside id to search for.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Value/{asOfDate}/Search/OutsideId/{search}": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of clients (including aum for the end of the date specified) that the logged in user has access to where the outside id exactly matches the search string.", "operationId": "Accounts_GetV1PortfolioAccountsValueByAsOfDateSearchOutsideIdBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "search", "in": "path", "description": "outside id to search for.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Value/{asOfDate}/Search/SecondaryNumber": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of clients (including aum for the end of the date specified) that the logged in user has access to where the secondary account number contains the search string.", "operationId": "Accounts_GetValueAsOfDateAccountSearchBySecondaryNumber", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "search", "in": "query", "description": "partial secondary account number to search for.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Value/{asOfDate}/Search/SecondaryNumber/{search}": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of clients (including aum for the end of the date specified) that the logged in user has access to where the secondary account number contains the search string.", "operationId": "Accounts_GetV1PortfolioAccountsValueByAsOfDateSearchSecondaryNumberBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "search", "in": "path", "description": "partial secondary account number to search for.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Value/List": { "post": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of accounts that match one of the keys in the provided list.", "operationId": "Accounts_GetValueListById", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Value/List/Async": { "post": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of accounts that match one of the keys in the provided list.", "operationId": "Accounts_GetValueAsOfDateListByIdAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "asOfDate", "in": "query", "description": "The aum returned is as of the end of this date.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Value/List/Id": { "post": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of accounts that match one of the keys in the provided list.", "operationId": "Accounts_PostV1PortfolioAccountsValueListId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Value/List/Id/Async": { "post": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of accounts that match one of the keys in the provided list.", "operationId": "Accounts_PostV1PortfolioAccountsValueListIdAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "asOfDate", "in": "query", "description": "The aum returned is as of the end of this date.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Value/Search": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of accounts (including aum for today) that the logged in user has access to where the account number or outside Id begin with the search string or the Id is the search string.", "operationId": "Accounts_GetValueAccountSearchAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "search", "in": "query", "description": "Account Id, partial account number, or partial outside Id to search for.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Value/Search/{search}": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of accounts (including aum for today) that the logged in user has access to where the account number or outside Id begin with the search string or the Id is the search string.", "operationId": "Accounts_GetV1PortfolioAccountsValueSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "search", "in": "path", "description": "Account Id, partial account number, or partial outside Id to search for.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Value/Search/Number": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of accounts (including aum for today) that the logged in user has access to where the account number contains the search string.", "operationId": "Accounts_GetValueAccountSearchByNumber", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "partial account number to search for.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Value/Search/Number/{search}": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of accounts (including aum for today) that the logged in user has access to where the account number contains the search string.", "operationId": "Accounts_GetV1PortfolioAccountsValueSearchNumberBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "partial account number to search for.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Value/Search/OutsideId": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of accounts (including aum for today) that the logged in user has access to where the outside id exactly matches the search string.", "operationId": "Accounts_GetValueAccountSearchByOutsideId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "outside id to search for.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Value/Search/OutsideId/{search}": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of accounts (including aum for today) that the logged in user has access to where the outside id exactly matches the search string.", "operationId": "Accounts_GetV1PortfolioAccountsValueSearchOutsideIdBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "outside id to search for.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Value/Search/SecondaryNumber": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of accounts (including aum for today) that the logged in user has access to where the secondary account number contains the search string.", "operationId": "Accounts_GetValueAccountSearchBySecondaryNumber", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "partial secondary account number to search for.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Value/Search/SecondaryNumber/{search}": { "get": { "tags": [ "Portfolio/Accounts" ], "summary": "Gets a simple list of accounts (including aum for today) that the logged in user has access to where the secondary account number contains the search string.", "operationId": "Accounts_GetV1PortfolioAccountsValueSearchSecondaryNumberBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "partial secondary account number to search for.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Verbose": { "get": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_GetVerboseAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "isActive", "in": "query", "required": false, "type": "boolean" }, { "name": "isManaged", "in": "query", "required": false, "type": "boolean" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Billing", "RecurringAdjustments", "GeneralAccounts", "Portfolio", "ModelingInfo", "Notes", "Documents", "Compliance", "Systematics", "AccountManagers", "TaxRates", "UserDefinedFields", "EntityOptions", "ReferralSchedules", "BillAccountSchedules", "TargetAllocations", "Sma", "BondTrade", "ProductEquivalents", "CompositeExclusions", "FutureCashflows", "GrowthRates", "Goals", "Suitability", "PermissibleAggregateModels", "AstroTaxSchedules", "AstroAccount", "AdditionalClients", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountVerboseDto" }, "xml": { "name": "AccountVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Accounts" ], "summary": "Update accounts.", "operationId": "Accounts_UpdateVerboseAccountsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "updatedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountVerboseDto" }, "xml": { "name": "AccountVerboseDto", "wrapped": true }, "type": "array" } }, { "name": "useDefaultName", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountVerboseDto" }, "xml": { "name": "AccountVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/Accounts" ], "summary": "Create new account for existing registration", "operationId": "Accounts_CreateVerboseAccountAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "newDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountVerboseDto" } }, { "name": "generateAccountNumber", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Verbose/{key}": { "get": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_GetVerboseByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Billing", "RecurringAdjustments", "GeneralAccounts", "Portfolio", "ModelingInfo", "Notes", "Documents", "Compliance", "Systematics", "AccountManagers", "TaxRates", "UserDefinedFields", "EntityOptions", "ReferralSchedules", "BillAccountSchedules", "TargetAllocations", "Sma", "BondTrade", "ProductEquivalents", "CompositeExclusions", "FutureCashflows", "GrowthRates", "Goals", "Suitability", "PermissibleAggregateModels", "AstroTaxSchedules", "AstroAccount", "AdditionalClients", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_UpdateVerboseAccountAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountVerboseDto" } }, { "name": "generateAccountNumber", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Verbose/{key}/ModelingInfo": { "put": { "tags": [ "Portfolio/Accounts" ], "summary": "Used to save models without actually associating the account to these models.", "operationId": "Accounts_UpdateModelingInfoAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountModelingInfoDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountModelingInfoDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Verbose/List": { "post": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_GetVerboseListByIdAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Billing", "RecurringAdjustments", "GeneralAccounts", "Portfolio", "ModelingInfo", "Notes", "Documents", "Compliance", "Systematics", "AccountManagers", "TaxRates", "UserDefinedFields", "EntityOptions", "ReferralSchedules", "BillAccountSchedules", "TargetAllocations", "Sma", "BondTrade", "ProductEquivalents", "CompositeExclusions", "FutureCashflows", "GrowthRates", "Goals", "Suitability", "PermissibleAggregateModels", "AstroTaxSchedules", "AstroAccount", "AdditionalClients", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountVerboseDto" }, "xml": { "name": "AccountVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Verbose/List/AccountNumber": { "post": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_GetVerboseByAccountNumberListAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "accountNumberList", "in": "body", "required": true, "schema": { "items": { "type": "string" }, "type": "array" } }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Billing", "RecurringAdjustments", "GeneralAccounts", "Portfolio", "ModelingInfo", "Notes", "Documents", "Compliance", "Systematics", "AccountManagers", "TaxRates", "UserDefinedFields", "EntityOptions", "ReferralSchedules", "BillAccountSchedules", "TargetAllocations", "Sma", "BondTrade", "ProductEquivalents", "CompositeExclusions", "FutureCashflows", "GrowthRates", "Goals", "Suitability", "PermissibleAggregateModels", "AstroTaxSchedules", "AstroAccount", "AdditionalClients", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountVerboseDto" }, "xml": { "name": "AccountVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Verbose/List/Id": { "post": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_PostV1PortfolioAccountsVerboseListId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Billing", "RecurringAdjustments", "GeneralAccounts", "Portfolio", "ModelingInfo", "Notes", "Documents", "Compliance", "Systematics", "AccountManagers", "TaxRates", "UserDefinedFields", "EntityOptions", "ReferralSchedules", "BillAccountSchedules", "TargetAllocations", "Sma", "BondTrade", "ProductEquivalents", "CompositeExclusions", "FutureCashflows", "GrowthRates", "Goals", "Suitability", "PermissibleAggregateModels", "AstroTaxSchedules", "AstroAccount", "AdditionalClients", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountVerboseDto" }, "xml": { "name": "AccountVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Verbose/New": { "get": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_GetNewVerboseAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Billing", "RecurringAdjustments", "GeneralAccounts", "Portfolio", "ModelingInfo", "Notes", "Documents", "Compliance", "Systematics", "AccountManagers", "TaxRates", "UserDefinedFields", "EntityOptions", "ReferralSchedules", "BillAccountSchedules", "TargetAllocations", "Sma", "BondTrade", "ProductEquivalents", "CompositeExclusions", "FutureCashflows", "GrowthRates", "Goals", "Suitability", "PermissibleAggregateModels", "AstroTaxSchedules", "AstroAccount", "AdditionalClients", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Accounts/Verbose/Number/{accountNumber}": { "get": { "tags": [ "Portfolio/Accounts" ], "operationId": "Accounts_GetVerboseByAccountNumberAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "accountNumber", "in": "path", "required": true, "type": "string" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Billing", "RecurringAdjustments", "GeneralAccounts", "Portfolio", "ModelingInfo", "Notes", "Documents", "Compliance", "Systematics", "AccountManagers", "TaxRates", "UserDefinedFields", "EntityOptions", "ReferralSchedules", "BillAccountSchedules", "TargetAllocations", "Sma", "BondTrade", "ProductEquivalents", "CompositeExclusions", "FutureCashflows", "GrowthRates", "Goals", "Suitability", "PermissibleAggregateModels", "AstroTaxSchedules", "AstroAccount", "AdditionalClients", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/AccountStatuses": { "get": { "tags": [ "Portfolio/AccountStatuses" ], "summary": "Get all account statuses", "operationId": "AccountStatuses_GetAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "displayAll", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountStatusDto" }, "xml": { "name": "SimpleAccountStatusDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ALClientOps": { "get": { "tags": [ "Portfolio/ALClientOps" ], "summary": "Gets all Client OPS.", "operationId": "AlClientOps_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.AlClientOpsDto" }, "xml": { "name": "AlClientOpsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/ALClientOps" ], "summary": "Update multiple clients OPS.", "operationId": "AlClientOps_UpdateClientsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updatedItems", "in": "body", "description": "List of OPS clients to be updated", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.AlClientOpsDto" }, "xml": { "name": "AlClientOpsDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "description": "Cancellation token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.AlClientOpsDto" }, "xml": { "name": "AlClientOpsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/ALClientOps" ], "summary": "Create a new OPS record cor a client", "operationId": "AlClientOps_CreateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "OPS object to be saved for client.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.AlClientOpsDto" } }, { "name": "ct", "in": "header", "description": "Cancellation Token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.AlClientOpsDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ALClientOps/{key}": { "get": { "tags": [ "Portfolio/ALClientOps" ], "summary": "Gets Client OPS by key passed in.", "operationId": "AlClientOps_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "ID of the client to get OPS for.", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "description": "Cancellation token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.AlClientOpsDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/ALClientOps" ], "summary": "Update an OPS for a client.", "operationId": "AlClientOps_UpdateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "ID of the Client to update.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.AlClientOpsDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.AlClientOpsDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/ALClientOps" ], "summary": "Delete an OPS for a client.", "operationId": "AlClientOps_DeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "ID of the client to delete the OPS for.", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ALClientOps/Action/Delete": { "put": { "tags": [ "Portfolio/ALClientOps" ], "summary": "Deletes multiple clients OPS. Returns a list of deleted items", "operationId": "AlClientOps_DeleteClientsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "idsToDelete", "in": "body", "description": "List of OPS client ids to be deleted", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "description": "Cancellation token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/AssetLevelStrategies": { "get": { "tags": [ "Portfolio/AssetLevelStrategies" ], "summary": "Returns a list of all the asset level strategies that the logged in user has access to.", "operationId": "AssetLevelStrategies_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetLevelStrategyDto" }, "xml": { "name": "AssetLevelStrategyDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/AssetLevelStrategies" ], "operationId": "AssetLevelStrategies_UpdateItems", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updatedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetLevelStrategyDto" }, "xml": { "name": "AssetLevelStrategyDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetLevelStrategyDto" }, "xml": { "name": "AssetLevelStrategyDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/AssetLevelStrategies" ], "operationId": "AssetLevelStrategies_CreateItem", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetLevelStrategyDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetLevelStrategyDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/AssetLevelStrategies/{key}": { "get": { "tags": [ "Portfolio/AssetLevelStrategies" ], "summary": "Get asset level strategy by key", "operationId": "AssetLevelStrategies_GetItemByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetLevelStrategyDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/AssetLevelStrategies" ], "operationId": "AssetLevelStrategies_UpdateItem", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetLevelStrategyDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetLevelStrategyDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/AssetLevelStrategies" ], "summary": "Delete asset level strategy", "operationId": "AssetLevelStrategies_DeleteItem", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/AssetLevelStrategies/Action/AutoAssign": { "put": { "tags": [ "Portfolio/AssetLevelStrategies" ], "operationId": "AssetLevelStrategies_AutoAssignStrategies", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/AssetLevelStrategies/Simple": { "get": { "tags": [ "Portfolio/AssetLevelStrategies" ], "summary": "Gets a simple list of asset level strategies that the logged in user has access to.", "operationId": "AssetLevelStrategies_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Assets": { "get": { "tags": [ "Portfolio/Assets" ], "operationId": "Assets_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "registrationId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "productId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "assetId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "asOfDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "includeCostBasis", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "hasValue", "in": "query", "required": false, "type": "boolean" }, { "name": "editedStartDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "editedEndDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "alternativeOnly", "in": "query", "required": false, "type": "boolean" }, { "name": "custodianName", "in": "query", "required": false, "type": "string" }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "Alternative" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetBaseDto" }, "xml": { "name": "AssetBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Assets/{key}": { "get": { "tags": [ "Portfolio/Assets" ], "summary": "Gets the asset that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Assets_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "asOfDate", "in": "query", "description": "The asset value returned is as of the end of this date.", "required": false, "type": "string", "format": "date-time" }, { "name": "includeCostBasis", "in": "query", "description": "Optional bool. Default is false. When true, the Cost Basis property will be populated. This requires extra calculation which will reduce performance when true.", "required": false, "type": "boolean", "default": false }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "Alternative" ] }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetBaseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Assets" ], "summary": "Simple dto update", "operationId": "Assets_UpdateAssetAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Assets/{key}/Action/MoveToAccount/{accountId}": { "put": { "tags": [ "Portfolio/Assets" ], "summary": "Move asset to different account", "operationId": "Assets_MoveAssetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Assets/{key}/Price": { "get": { "tags": [ "Portfolio/Assets" ], "operationId": "Assets_GetPrice", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RealtimePriceDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Assets/{key}/Price/{asOfDate}": { "get": { "tags": [ "Portfolio/Assets" ], "operationId": "Assets_GetV1PortfolioAssetsByKeyPriceByAsOfDate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "asOfDate", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RealtimePriceDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Assets/{key}/Prices/Historical": { "get": { "tags": [ "Portfolio/Assets" ], "summary": "Gets the price history of an asset", "operationId": "Assets_GetAssetPriceHistoryAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The asset ID", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "description": "Optional. The start of the range for the price date.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. The end of the range for the price date.", "required": false, "type": "string", "format": "date-time" }, { "name": "returnAdjustedPrices", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetPriceDto" }, "xml": { "name": "AssetPriceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Assets/{key}/Transactions": { "get": { "tags": [ "Portfolio/Assets" ], "operationId": "Assets_GetTransactions", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "transTypeId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TradingTransactionDto" }, "xml": { "name": "TradingTransactionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Assets/{key}/Value": { "get": { "tags": [ "Portfolio/Assets" ], "summary": "Gets the simple assets (including aum for the end of today) that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Assets_GetValueByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAsset2WithValueDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Assets/{key}/Value/{asOfDate}": { "get": { "tags": [ "Portfolio/Assets" ], "summary": "Gets the simple assets (including aum for the end of the date specified) that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Assets_GetValueAsOfDateByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAsset2WithValueDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Assets/{prodId}/BuyOptionShares": { "post": { "tags": [ "Portfolio/Assets" ], "operationId": "Assets_GetBuyOptionShares", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "prodId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "accountIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.BuyOptionSharesDto" }, "xml": { "name": "BuyOptionSharesDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Assets/{prodId}/SellOptionShares": { "post": { "tags": [ "Portfolio/Assets" ], "operationId": "Assets_GetSellOptionShares", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "prodId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "accountIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SellOptionSharesDto" }, "xml": { "name": "SellOptionSharesDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Assets/Action/Delete": { "put": { "tags": [ "Portfolio/Assets" ], "summary": "Deletes every asset provided in the list of ids.", "operationId": "Assets_ActionDeleteAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "description": "The list of asset to delete.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Assets/Action/RemoveHistorical": { "put": { "tags": [ "Portfolio/Assets" ], "summary": "Remove the _Hist for every asset provided in the list of ids", "operationId": "Assets_RemoveHistoricalAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "description": "The list of asset to delete.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetDto" }, "xml": { "name": "AssetDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Assets/Alternative": { "get": { "tags": [ "Portfolio/Assets" ], "summary": "Gets a list of alternative assets\r\nThe return is not limited to pages. Although you can use $top and $skip to page through data, our recommended best practice can be found on the Orion Developer Portal.\r\nOptional. Default: null. When provided only assets for the clientId specified are returned.Optional. Default: null. When provided only assets for the registrationId specified are returned.Optional. Default: null. When provided only assets for the accountId specified are returned.Optional. Default: null. When provided only assets for the productId specified are returned.Optional. Default: null. When provided only assets for the assetId specified are returned.Optional. Default: null. If provided the value of the asset on that date will be returned.Optional. Default: null. If provided the asset details will include cost basis data.", "description": "Sample Request\r\n\tGET /Portfolio/Assets/Alternative?assetId=1\r\n[\r\n {\r\n \"value\": 123,\r\n \"accountNumber\": \"ACCOUNTNUMBER\",\r\n \"ticker\": \"THE_TICKER\",\r\n \"currentShares\": 123,\r\n \"currentPrice\": 1,\r\n \"isManaged\": true,\r\n \"assetClass\": \"Alternative\",\r\n \"productCategory\": \"Alternative\",\r\n \"productCategoryAbbreviation\": \"E\",\r\n \"isCustodialCash\": false,\r\n \"secondaryAccountNumber\": null,\r\n \"assetLevelStrategyId\": null,\r\n \"assetLevelStrategy\": null,\r\n \"status\": 3,\r\n \"isStrategyOverride\": false,\r\n \"createdBy\": \"created@by.com\",\r\n \"createdDate\": \"22023-07-18T07:46:19.28-05:00\",\r\n \"editedBy\": \"edited@by.com\",\r\n \"editedDate\": \"2023-07-18T10:44:24-05:00\",\r\n \"registrationId\": 5,\r\n \"clientId\": 4,\r\n \"isActive\": true,\r\n \"downloadSymbol\": 123,\r\n \"accountType\": \"Non-Profit\",\r\n \"fundFamily\": \"Fund family\",\r\n \"custodian\": \"Custodian Name\",\r\n \"asOfDate\": \"2023-07-18\",\r\n \"managementStyle\": \"Managed Account\",\r\n \"productType\": \"Miscellaneous\",\r\n \"productSubType\": \"Limited Partnership\",\r\n \"isGlobalExcluded\": false,\r\n \"isFeeExcluded\": false,\r\n \"excludeAmountType\": null,\r\n \"excludeAmount\": 0,\r\n \"excludePercentOf\": null,\r\n \"isRebalance\": false,\r\n \"isAdvisorOnly\": true,\r\n \"isAdvReportable\": true,\r\n \"is13FReportable\": true,\r\n \"mscsFundAccountNumber\": null,\r\n \"lastReconDate\": null,\r\n \"isOrionVision\": null,\r\n \"assetPercentOfAccount\": 100,\r\n \"name\": \"Name of Product\",\r\n \"registrationName\": \"Name on Registration\",\r\n \"accountId\": 3,\r\n \"currentValue\": 123,\r\n \"valuation\": 123,\r\n \"committedCapital\": 123,\r\n \"committedCapitalDate\": \"2023-07-18\",\r\n \"contributedCapital\": 123,\r\n \"distribution\": 123,\r\n \"unfundedCommitmentAdjustment\": null,\r\n \"unfundedCommitmentAmount\": 0,\r\n \"costBasis\": null,\r\n \"productId\": 1,\r\n \"recallableDistribution\": null,\r\n \"upcomingCapitalCallDate\": null,\r\n \"upcomingCapitalCallAmount\": null,\r\n \"upcomingCapitalCallAmountType\": null,\r\n \"upcomingDistributionDate\": null,\r\n \"upcomingDistributionAmount\": null,\r\n \"upcomingDistributionAmountType\": null,\r\n \"managerName\": null,\r\n \"lastValuationDate\": \"2023-07-18T00:00:00-06:00\",\r\n \"accountSweepAssetProductName\": \"Sweep Asset\",\r\n \"accountSweepAssetValueAsOf\": null,\r\n \"id\": 1\r\n }\r\n]", "operationId": "Assets_GetAlternativeAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "clientId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "registrationId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "productId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "assetId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "asOfDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "includeCostBasis", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetAlternativeDto" }, "xml": { "name": "AssetAlternativeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Assets/AssetExclusion/{key}": { "get": { "tags": [ "Portfolio/Assets" ], "operationId": "Assets_GetAssetExclusion", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetBillingDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Assets/Historical": { "get": { "tags": [ "Portfolio/Assets" ], "summary": "Gets any assets where the account number ends with _hist.", "operationId": "Assets_GetHistoricalAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetDto" }, "xml": { "name": "AssetDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Assets/List": { "post": { "tags": [ "Portfolio/Assets" ], "summary": "Returns a list of Assets that are found for the list of Id's posted in the message body.", "operationId": "Assets_GetListByIdAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "Array of Asset ID's", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "includeCostBasis", "in": "query", "description": "Optional bool. Default is false. When true, the Cost Basis property will be populated. This requires extra calculation which will reduce performance when true.", "required": false, "type": "boolean", "default": false }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetDto" }, "xml": { "name": "AssetDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Assets/List/AccountId": { "post": { "tags": [ "Portfolio/Assets" ], "summary": "Returns a list of Assets that are found for the list of AccountId's posted in the message body.", "operationId": "Assets_GetListByAccountIdAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "Array of Account ID's", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "includeCostBasis", "in": "query", "description": "Optional bool. Default is false. When true, the Cost Basis property will be populated. This requires extra calculation which will reduce performance when true.", "required": false, "type": "boolean", "default": false }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetDto" }, "xml": { "name": "AssetDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Assets/List/Id": { "post": { "tags": [ "Portfolio/Assets" ], "summary": "Returns a list of Assets that are found for the list of Id's posted in the message body.", "operationId": "Assets_PostV1PortfolioAssetsListId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "Array of Asset ID's", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "includeCostBasis", "in": "query", "description": "Optional bool. Default is false. When true, the Cost Basis property will be populated. This requires extra calculation which will reduce performance when true.", "required": false, "type": "boolean", "default": false }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetDto" }, "xml": { "name": "AssetDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Assets/ListCounts": { "post": { "tags": [ "Portfolio/Assets" ], "operationId": "Assets_GetListCountById", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Assets/Simple": { "get": { "tags": [ "Portfolio/Assets" ], "summary": "Gets a simple list of assets for a given portfolio.", "operationId": "Assets_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return assets that have value (true).", "required": false, "type": "boolean" }, { "name": "registrationId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAsset2WithValueDto" }, "xml": { "name": "SimpleAsset2WithValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Assets/Simple/Search": { "get": { "tags": [ "Portfolio/Assets" ], "summary": "Gets a simple list of assets by the search criteria.", "operationId": "Assets_GetAssetSearchAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "Asset Id", "required": true, "type": "string" }, { "name": "clientId", "in": "query", "description": "Optional. Default: null. Returns only matching asset for the client Id provided", "required": false, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "query", "description": "Optional. Default: null. Returns only matching asset for the account Id provided", "required": false, "type": "integer", "format": "int32" }, { "name": "top", "in": "query", "description": "Optional. Default: null. The maximum number of products to return. If null returns all.", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Optional. Default: 0. Defines number of items to skip.", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAssetDto" }, "xml": { "name": "SimpleAssetDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Assets/Simple/Search/{search}": { "get": { "tags": [ "Portfolio/Assets" ], "summary": "Gets a simple list of assets by the search criteria.", "operationId": "Assets_GetV1PortfolioAssetsSimpleSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "Asset Id", "required": true, "type": "string" }, { "name": "clientId", "in": "query", "description": "Optional. Default: null. Returns only matching asset for the client Id provided", "required": false, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "query", "description": "Optional. Default: null. Returns only matching asset for the account Id provided", "required": false, "type": "integer", "format": "int32" }, { "name": "top", "in": "query", "description": "Optional. Default: null. The maximum number of products to return. If null returns all.", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Optional. Default: 0. Defines number of items to skip.", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAssetDto" }, "xml": { "name": "SimpleAssetDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Assets/Value": { "get": { "tags": [ "Portfolio/Assets" ], "summary": "Gets a simple list of assets (including aum for today) that the logged in user has access to.", "operationId": "Assets_GetValue", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "editedStartDate", "in": "query", "description": "Optional. When provided only records that were edited after the date provided will be returned.", "required": false, "type": "string", "format": "date-time" }, { "name": "editedEndDate", "in": "query", "description": "Optional. When provided only records that were edited before the date provided will be returned.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAsset2WithValueDto" }, "xml": { "name": "SimpleAsset2WithValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Assets/Value/{asOfDate}": { "get": { "tags": [ "Portfolio/Assets" ], "summary": "Gets a simple list of assets (including aum for the end of the date specified) that the logged in user has access to.", "operationId": "Assets_GetValueAsOfDate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "editedStartDate", "in": "query", "description": "Optional. When provided only records that were edited after the date provided will be returned.", "required": false, "type": "string", "format": "date-time" }, { "name": "editedEndDate", "in": "query", "description": "Optional. When provided only records that were edited before the date provided will be returned.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAsset2WithValueDto" }, "xml": { "name": "SimpleAsset2WithValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Assets/Value/{asOfDate}/List": { "post": { "tags": [ "Portfolio/Assets" ], "summary": "Gets a simple list of assets that match one of the keys in the provided list.", "operationId": "Assets_GetValueAsOfDateListById", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAsset2WithValueDto" }, "xml": { "name": "SimpleAsset2WithValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Assets/Value/{asOfDate}/List/Id": { "post": { "tags": [ "Portfolio/Assets" ], "summary": "Gets a simple list of assets that match one of the keys in the provided list.", "operationId": "Assets_PostV1PortfolioAssetsValueByAsOfDateListId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAsset2WithValueDto" }, "xml": { "name": "SimpleAsset2WithValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Assets/Value/List": { "post": { "tags": [ "Portfolio/Assets" ], "summary": "Gets a simple list of assets that match one of the keys in the provided list.", "operationId": "Assets_GetValueListById", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAsset2WithValueDto" }, "xml": { "name": "SimpleAsset2WithValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Assets/Value/List/Id": { "post": { "tags": [ "Portfolio/Assets" ], "summary": "Gets a simple list of assets that match one of the keys in the provided list.", "operationId": "Assets_PostV1PortfolioAssetsValueListId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAsset2WithValueDto" }, "xml": { "name": "SimpleAsset2WithValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Assets/Verbose": { "get": { "tags": [ "Portfolio/Assets" ], "operationId": "Assets_GetVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isActive", "in": "query", "required": false, "type": "boolean" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Billing", "Portfolio", "StepUps", "Bifurcates", "CostBasisHistories", "CostBasisLots", "UserDefinedFields", "EntityOptions", "UserDefinedTimeFields", "AssetValuations", "Commitments", "AlternativeSchedules", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetVerboseDto" }, "xml": { "name": "AssetVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Assets" ], "summary": "Update multiple assets", "operationId": "Assets_UpdateVerboseAssetsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updatedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetVerboseDto" }, "xml": { "name": "AssetVerboseDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetVerboseDto" }, "xml": { "name": "AssetVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/Assets" ], "summary": "Create asset", "operationId": "Assets_CreateVerboseAssetAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetVerboseDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Assets/Verbose/{key}": { "get": { "tags": [ "Portfolio/Assets" ], "operationId": "Assets_GetVerboseByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Billing", "Portfolio", "StepUps", "Bifurcates", "CostBasisHistories", "CostBasisLots", "UserDefinedFields", "EntityOptions", "UserDefinedTimeFields", "AssetValuations", "Commitments", "AlternativeSchedules", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Assets" ], "summary": "Update single asset", "operationId": "Assets_UpdateVerboseAssetAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetVerboseDto" } }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Assets/Verbose/ByProduct/{key}": { "get": { "tags": [ "Portfolio/Assets" ], "operationId": "Assets_GetAssetsWithSameProductId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Billing", "Portfolio", "StepUps", "Bifurcates", "CostBasisHistories", "CostBasisLots", "UserDefinedFields", "EntityOptions", "UserDefinedTimeFields", "AssetValuations", "Commitments", "AlternativeSchedules", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetVerboseDto" }, "xml": { "name": "AssetVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Assets/Verbose/CopyHistoricalData": { "get": { "tags": [ "Portfolio/Assets" ], "operationId": "Assets_CopyHistoricalData", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "assetCopyHistoricalData.assetIdToEdit", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "assetCopyHistoricalData.assetIdToCopy", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "assetCopyHistoricalData.percentage", "in": "query", "required": false, "type": "number", "format": "double" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.CommitmentLedgerDto" }, "xml": { "name": "CommitmentLedgerDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Assets/Verbose/List": { "post": { "tags": [ "Portfolio/Assets" ], "operationId": "Assets_GetVerboseListById", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Billing", "Portfolio", "StepUps", "Bifurcates", "CostBasisHistories", "CostBasisLots", "UserDefinedFields", "EntityOptions", "UserDefinedTimeFields", "AssetValuations", "Commitments", "AlternativeSchedules", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetVerboseDto" }, "xml": { "name": "AssetVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Assets/Verbose/List/Id": { "post": { "tags": [ "Portfolio/Assets" ], "operationId": "Assets_PostV1PortfolioAssetsVerboseListId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Billing", "Portfolio", "StepUps", "Bifurcates", "CostBasisHistories", "CostBasisLots", "UserDefinedFields", "EntityOptions", "UserDefinedTimeFields", "AssetValuations", "Commitments", "AlternativeSchedules", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetVerboseDto" }, "xml": { "name": "AssetVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Assets/Verbose/New": { "get": { "tags": [ "Portfolio/Assets" ], "operationId": "Assets_GetNewVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Billing", "Portfolio", "StepUps", "Bifurcates", "CostBasisHistories", "CostBasisLots", "UserDefinedFields", "EntityOptions", "UserDefinedTimeFields", "AssetValuations", "Commitments", "AlternativeSchedules", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/Assets" ], "summary": "Create multiple assets", "operationId": "Assets_CreateMultipleVerboseAssetsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newDtos", "in": "body", "description": "List of Dtos to add", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetVerboseDto" }, "xml": { "name": "AssetVerboseDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetVerboseDto" }, "xml": { "name": "AssetVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/AvailableAccountNumbers/Next": { "get": { "tags": [ "Portfolio/AvailableAccountNumbers" ], "summary": "Gets the next available account number. Each time this endpoint is called the account number that is returned is marked as being used and will not be returned again.", "operationId": "AvailableAccountNumbers_GetNextAvailableAccountNumber", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Benchmarks": { "get": { "tags": [ "Portfolio/Benchmarks" ], "summary": "Gets a list of benchmarks that the logged in user has access to.\r\nThe return is limited to pages of 1000. Use $top and $skip in the query string to page through the data.", "operationId": "Benchmarks_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "bmType", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BenchmarkDto" }, "xml": { "name": "BenchmarkDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Benchmarks/{key}/{bmType}": { "get": { "tags": [ "Portfolio/Benchmarks" ], "summary": "Gets the benchmark that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Benchmarks_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "bmType", "in": "path", "description": "Either B for Benchmark or P for Product.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BenchmarkDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Benchmarks/Simple": { "get": { "tags": [ "Portfolio/Benchmarks" ], "summary": "Gets a simple list of benchmarks that the logged in user has access to.", "operationId": "Benchmarks_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleBenchmarkDto" }, "xml": { "name": "SimpleBenchmarkDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Benchmarks/Simple/Search": { "get": { "tags": [ "Portfolio/Benchmarks" ], "summary": "Gets a simple list of benchmarks that the logged in user has access to where the name contains the search string.", "operationId": "Benchmarks_GetBenchmarkSearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "Benchmark Id, partial Benchmark name, or partial outside Id to search for.", "required": true, "type": "string" }, { "name": "top", "in": "query", "description": "Optional. Default: null. The maximum number of products to return. If null returns all.", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Optional. Default: 0. Defines number of items to skip.", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleBenchmarkDto" }, "xml": { "name": "SimpleBenchmarkDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Benchmarks/Simple/Search/{search}": { "get": { "tags": [ "Portfolio/Benchmarks" ], "summary": "Gets a simple list of benchmarks that the logged in user has access to where the name contains the search string.", "operationId": "Benchmarks_GetV1PortfolioBenchmarksSimpleSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "Benchmark Id, partial Benchmark name, or partial outside Id to search for.", "required": true, "type": "string" }, { "name": "top", "in": "query", "description": "Optional. Default: null. The maximum number of products to return. If null returns all.", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Optional. Default: 0. Defines number of items to skip.", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleBenchmarkDto" }, "xml": { "name": "SimpleBenchmarkDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/BondRatings": { "get": { "tags": [ "Portfolio/BondRatings" ], "summary": "Gets a list of bond ratings that the logged in user has access to.", "operationId": "BondRatings_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "source", "in": "query", "description": "Optional. Default: null. When provided only ratings with the provided source are returned. Ex: \"S&P\" or \"Moody\"", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BondRatingDto" }, "xml": { "name": "BondRatingDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/BondRatings" ], "summary": "Used to create a new bond rating. Upon successful creation a 201 will be returned with the location of the newly created bond rating.", "operationId": "BondRatings_Create", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BondRatingDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/BondRatings/{key}": { "get": { "tags": [ "Portfolio/BondRatings" ], "summary": "Gets the bond rating that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "BondRatings_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BondRatingDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/BondRatings" ], "summary": "Used to update an existing bond rating. Upon successful modification a 200 will be returned.", "operationId": "BondRatings_Update", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BondRatingDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BondRatingDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/BondRatings" ], "summary": "Used to delete an existing bond rating. Upon successful deletion a 204 will be returned.", "operationId": "BondRatings_Delete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/BondRatings/Simple": { "get": { "tags": [ "Portfolio/BondRatings" ], "summary": "Gets a simple list of bond ratings that the logged in user has access to.", "operationId": "BondRatings_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "source", "in": "query", "description": "Optional. Default: null. When provided only ratings with the provided source are returned. Ex: \"S&P\" or \"Moody\"", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/BrokerDealers": { "get": { "tags": [ "Portfolio/BrokerDealers" ], "summary": "Gets a list of broker/dealers that the logged in user has access to.", "operationId": "BrokerDealers_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BrokerDealerDto" }, "xml": { "name": "BrokerDealerDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/BrokerDealers/{additionalContactId}/SSNTaxId": { "put": { "tags": [ "Portfolio/BrokerDealers" ], "summary": "Retrieve or update SSN for addtional contact.", "description": "If updateInfo.SSN is null => we will just retrieve SSN otherwise we will attempt to update SSN with data in updateInfo.SSN", "operationId": "BrokerDealers_UpdateSSNTaxId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "additionalContactId", "in": "path", "description": "The personal id of the additional contact", "required": true, "type": "integer", "format": "int32" }, { "name": "updateInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.UpdateSsnDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/BrokerDealers/{key}": { "get": { "tags": [ "Portfolio/BrokerDealers" ], "summary": "Gets the broker/dealer that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "BrokerDealers_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BrokerDealerDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/BrokerDealers/{key}/Documents": { "get": { "tags": [ "Portfolio/BrokerDealers" ], "operationId": "BrokerDealers_GetBlobs", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "fileType", "in": "query", "required": false, "items": { "type": "string", "enum": [ "CrmDocuments", "Payable" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" }, "xml": { "name": "BlobBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/BrokerDealers" ], "operationId": "BrokerDealers_CreateBlobAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "file", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BrokerDealerFileDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/BrokerDealers/{key}/Documents/{fileId}": { "get": { "tags": [ "Portfolio/BrokerDealers" ], "summary": "Gets a file for the broker/dealer with the specified key and the file with the specified key.", "operationId": "BrokerDealers_GetBlobDto", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "description": "Key of the file to be returned.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/BrokerDealers" ], "operationId": "BrokerDealers_UpdateBlobAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "file", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BrokerDealerFileDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/BrokerDealers" ], "operationId": "BrokerDealers_DeleteBlob", "consumes": [], "produces": [], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/BrokerDealers/{key}/Documents/{fileId}/Download": { "get": { "tags": [ "Portfolio/BrokerDealers" ], "summary": "Gets the raw data of the specific file with the blobId provided which is associated to the broker/dealer with the specified key.", "operationId": "BrokerDealers_GetBlobFile", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "description": "Key of the file to be downloaded.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/BrokerDealers/{key}/ReportImage": { "get": { "tags": [ "Portfolio/BrokerDealers" ], "summary": "Gets the representative's report image if one exists. If none exists a 404 will be thrown.", "operationId": "BrokerDealers_GetImageById", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/BrokerDealers/{key}/Simple": { "get": { "tags": [ "Portfolio/BrokerDealers" ], "summary": "Gets the simple broker/dealer that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "BrokerDealers_GetSimpleByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/BrokerDealers/{key}/UserDefinedFields": { "get": { "tags": [ "Portfolio/BrokerDealers" ], "operationId": "BrokerDealers_GetUserDefinedFields", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "entities", "in": "query", "required": false, "items": { "type": "string", "enum": [ "BrokerDealers", "Wholesalers", "Representatives", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Products", "FundFamilies", "ModelRanges", "PortfolioGroups" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/BrokerDealers/Action/Delete": { "put": { "tags": [ "Portfolio/BrokerDealers" ], "operationId": "BrokerDealers_ActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/BrokerDealers/Action/RecalculateAUMData": { "put": { "tags": [ "Portfolio/BrokerDealers" ], "summary": "Endpoint to recalculate AUM data for a broker/dealer", "operationId": "BrokerDealers_RecalculateAUMData", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BrokerDealerDto" }, "xml": { "name": "BrokerDealerDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/BrokerDealers/Simple": { "get": { "tags": [ "Portfolio/BrokerDealers" ], "summary": "Gets a simple list of broker/dealers that the logged in user has access to.", "operationId": "BrokerDealers_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return broker/dealers that have value (true) or don't have value (false).", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/BrokerDealers/Simple/List": { "post": { "tags": [ "Portfolio/BrokerDealers" ], "operationId": "BrokerDealers_GetSimpleListById", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/BrokerDealers/Simple/List/Id": { "post": { "tags": [ "Portfolio/BrokerDealers" ], "operationId": "BrokerDealers_PostV1PortfolioBrokerDealersSimpleListId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/BrokerDealers/Simple/Search": { "get": { "tags": [ "Portfolio/BrokerDealers" ], "summary": "Gets a simple list of broker dealers that the logged in user has access to where the broker dealers first name, lastname, or entityname begins with the search string or Id is exact match.", "operationId": "BrokerDealers_GetSimpleRepresentativeSearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "Partial representative name to search for.", "required": true, "type": "string" }, { "name": "hasEmail", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/BrokerDealers/Simple/Search/{search}": { "get": { "tags": [ "Portfolio/BrokerDealers" ], "summary": "Gets a simple list of broker dealers that the logged in user has access to where the broker dealers first name, lastname, or entityname begins with the search string or Id is exact match.", "operationId": "BrokerDealers_GetV1PortfolioBrokerDealersSimpleSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "Partial representative name to search for.", "required": true, "type": "string" }, { "name": "hasEmail", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/BrokerDealers/Value": { "get": { "tags": [ "Portfolio/BrokerDealers" ], "summary": "Gets a simple list of broker/dealers (including aum for today) that the logged in user has access to.\r\nOptional. When provided will only return broker/dealers that have value (true) or don't have value (false).", "operationId": "BrokerDealers_GetValue", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "hasValue", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.SimpleValueDto" }, "xml": { "name": "SimpleValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/BrokerDealers/Value/{asOfDate}": { "get": { "tags": [ "Portfolio/BrokerDealers" ], "summary": "Gets a simple list of broker/dealers (including aum for the end of the date specified) that the logged in user has access to.", "operationId": "BrokerDealers_GetValueAsOfDate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return broker/dealers that have value (true) or don't have value (false).", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.SimpleValueDto" }, "xml": { "name": "SimpleValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/BrokerDealers/Verbose": { "get": { "tags": [ "Portfolio/BrokerDealers" ], "operationId": "BrokerDealers_GetVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isActive", "in": "query", "required": false, "type": "boolean" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "AdditionalContacts", "AdvPayee", "Notes", "Documents", "UserDefinedFields", "ReportImage", "BrokerDealerRevenueShare", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BrokerDealerVerboseDto" }, "xml": { "name": "BrokerDealerVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/BrokerDealers" ], "operationId": "BrokerDealers_UpdateVerboseBrokerDealerAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updatedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BrokerDealerVerboseDto" }, "xml": { "name": "BrokerDealerVerboseDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BrokerDealerVerboseDto" }, "xml": { "name": "BrokerDealerVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/BrokerDealers" ], "summary": "Create new broker/dealer.", "operationId": "BrokerDealers_CreateVerboseBrokerDealer", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BrokerDealerVerboseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BrokerDealerVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/BrokerDealers/Verbose/{key}": { "get": { "tags": [ "Portfolio/BrokerDealers" ], "operationId": "BrokerDealers_GetVerboseByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "AdditionalContacts", "AdvPayee", "Notes", "Documents", "UserDefinedFields", "ReportImage", "BrokerDealerRevenueShare", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BrokerDealerVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/BrokerDealers" ], "operationId": "BrokerDealers_PutV1PortfolioBrokerDealersVerboseByKey", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BrokerDealerVerboseDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BrokerDealerVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/BrokerDealers/Verbose/{key}/SSNTaxId": { "put": { "tags": [ "Portfolio/BrokerDealers" ], "summary": "Retrieve or update SSN for broker dealer.", "description": "If updateInfo.SSN is null => we will just retrieve SSN otherwise we will attempt to update SSN with data in updateInfo.SSN", "operationId": "BrokerDealers_UpdateBrokerDealerSSNTaxId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The personal id of the additional contact", "required": true, "type": "integer", "format": "int32" }, { "name": "updateInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.UpdateSsnDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/BrokerDealers/Verbose/List": { "post": { "tags": [ "Portfolio/BrokerDealers" ], "operationId": "BrokerDealers_GetVerboseListById", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "AdditionalContacts", "AdvPayee", "Notes", "Documents", "UserDefinedFields", "ReportImage", "BrokerDealerRevenueShare", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BrokerDealerVerboseDto" }, "xml": { "name": "BrokerDealerVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/BrokerDealers/Verbose/List/Id": { "post": { "tags": [ "Portfolio/BrokerDealers" ], "operationId": "BrokerDealers_PostV1PortfolioBrokerDealersVerboseListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "AdditionalContacts", "AdvPayee", "Notes", "Documents", "UserDefinedFields", "ReportImage", "BrokerDealerRevenueShare", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BrokerDealerVerboseDto" }, "xml": { "name": "BrokerDealerVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/BrokerDealers/Verbose/New": { "get": { "tags": [ "Portfolio/BrokerDealers" ], "operationId": "BrokerDealers_GetNewVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "AdditionalContacts", "AdvPayee", "Notes", "Documents", "UserDefinedFields", "ReportImage", "BrokerDealerRevenueShare", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BrokerDealerVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/BusinessLines": { "get": { "tags": [ "Portfolio/BusinessLines" ], "summary": "Gets a list of business lines that the logged in user has access to.\r\nThe return is limited to pages of 1000. Use $top and $skip in the query string to page through the data.", "operationId": "BusinessLines_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BusinessLineDto" }, "xml": { "name": "BusinessLineDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/BusinessLines" ], "summary": "Used to create a new business line. Upon successful creation a 201 will be returned with the location of the nearly created business line.", "operationId": "BusinessLines_Create", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BusinessLineDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/BusinessLines/{key}": { "get": { "tags": [ "Portfolio/BusinessLines" ], "summary": "Gets the business line that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "BusinessLines_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BusinessLineDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/BusinessLines" ], "summary": "Used to update an existing business line. Upon successful modification a 200 will be returned.", "operationId": "BusinessLines_Update", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BusinessLineDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BusinessLineDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/BusinessLines" ], "summary": "Used to delete an existing business line. Upon successful deletion a 204 will be returned.", "operationId": "BusinessLines_Delete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/BusinessLines/Action/Delete": { "put": { "tags": [ "Portfolio/BusinessLines" ], "operationId": "BusinessLines_ActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/BusinessLines/Simple": { "get": { "tags": [ "Portfolio/BusinessLines" ], "summary": "Gets a simple list of business lines that the logged in user has access to.", "operationId": "BusinessLines_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ClientCategories": { "get": { "tags": [ "Portfolio/ClientCategories" ], "summary": "Gets a simple list of client categories that the logged in user has access to.\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "ClientCategories_GetCategories", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleClientCategory" }, "xml": { "name": "SimpleClientCategory", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ClientCategories/Simple": { "get": { "tags": [ "Portfolio/ClientCategories" ], "summary": "Gets a simple list of client categories that the logged in user has access to.\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "ClientCategories_GetV1PortfolioClientCategoriesSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleClientCategory" }, "xml": { "name": "SimpleClientCategory", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ClientChanges/{clientId}": { "get": { "tags": [ "Portfolio/ClientChanges" ], "summary": "Gets a list of client changes for specific client id.", "operationId": "ClientChanges_GetClientChangesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/ClientChanges" ], "summary": "Updates a list of client changes for specific client id.", "operationId": "ClientChanges_UpdateClientChangesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "items", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientChangeDto" }, "xml": { "name": "ClientChangeDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a list of clients that the logged in user has access to. \r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "Clients_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return clients that have value (true) or don't have value (false).", "required": false, "type": "boolean" }, { "name": "isActive", "in": "query", "description": "Optional. Default: null. If provided returns only the active (true) or inactive clients (false).", "required": false, "type": "boolean" }, { "name": "categoryId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "householdFilter", "in": "query", "description": "Optional. Default: null.", "required": false, "type": "string", "enum": [ "MissingInformation", "ActiveClientsNoActiveAccounts", "InactiveClientsActiveAccounts", "HHWithAdditionalAccounts" ] }, { "name": "representativeId", "in": "query", "description": "Optional. Default: null. If provided only registrations that fall within the representative specified will be returned.", "required": false, "type": "integer", "format": "int32" }, { "name": "registrationSSN", "in": "query", "description": "Optional. Default: null. If provided only registration that has specified SSN will be returned.", "required": false, "type": "string" }, { "name": "sleeveStrategyId", "in": "query", "description": "Optional. Default: null. If provided returns only clients that have at least one registration assigned to the sleeve strategy.", "required": false, "type": "integer", "format": "int32" }, { "name": "sleeveStrategyAggId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "BlendedModelManagement", "BlendedModelManagementDetails", "Prospects" ] }, { "name": "accountId", "in": "query", "description": "Optional. Default: null. If provided only the client with the account specified will be returned.", "required": false, "type": "integer", "format": "int32" }, { "name": "pageQueryId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "entitySessionId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientBaseDto" }, "xml": { "name": "ClientBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{clientId}/HouseholdMembers/{householdMemberId}/SSNTaxId": { "put": { "tags": [ "Portfolio/Clients" ], "summary": "Retrieve or update SSN for household member.", "description": "If updateInfo.SSN is null => we will just retrieve SSN otherwise we will attempt to update SSN with data in updateInfo.SSN", "operationId": "Clients_UpdateHouseholdMembersSSNTaxIdAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "householdMemberId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updateInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.UpdateSsnDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{clientId}/ModelTolerance": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Returns a comparison of an Registration to its Assigned Model Targets.", "operationId": "Clients_ModelTolerance", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "includeCash", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "grouping", "in": "query", "required": false, "type": "string", "default": 9, "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "includePendingValue", "in": "query", "required": false, "type": "string", "default": 2, "enum": [ "UseDefault", "Current", "PendingTransactions", "PendingTransactionsAndOrders" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelToleranceDto" }, "xml": { "name": "ModelToleranceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{clientId}/PortfolioGroupChanges": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a list of portfolio group changes that the logged in user has access to.", "operationId": "PortfolioGroupChanges_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "description": "Required.", "required": true, "type": "integer", "format": "int32" }, { "name": "portfolioGroupId", "in": "query", "description": "Optional.", "required": false, "type": "integer", "format": "int32" }, { "name": "entity", "in": "query", "description": "Optional.", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PortfolioGroupChangeDto" }, "xml": { "name": "PortfolioGroupChangeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{clientId}/PortfolioGroups": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets portfolio groups for a specific client.", "operationId": "ClientPortfolioGroups_GetPortfolioGroups", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "description": "Required.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PortfolioGroupDto" }, "xml": { "name": "PortfolioGroupDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Clients" ], "summary": "", "operationId": "ClientPortfolioGroups_UpdateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "items", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PortfolioGroupFullDto" }, "xml": { "name": "PortfolioGroupFullDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/Clients" ], "summary": "Create a portfolio group for a specific client.", "operationId": "ClientPortfolioGroups_CreatePortfolioGroupAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "description": "Required.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "Required.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PortfolioGroupFullDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PortfolioGroupFullDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{clientId}/RegistrationRepPayouts": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Retrieves registration rep additionals for the given client ID", "operationId": "Clients_GetRegistrationRepAdditionalsByClientIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "description": "Client ID to lookup", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "description": "Cancellation token", "required": true } ], "responses": { "200": { "description": "List of RegistrationRepAdditionalDto", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationRepAdditionalDto" }, "xml": { "name": "RegistrationRepAdditionalDto", "wrapped": true }, "type": "array" } }, "403": { "description": "New rep split is not yet enabled" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{clientId}/Registrations/Simple": { "get": { "tags": [ "Portfolio/Clients" ], "operationId": "Clients_GetRegistrationsSimpleAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "includeAccounts", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "includeAdditionalAccounts", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleRegistrationsWithSimpleAccountsDto" }, "xml": { "name": "SimpleRegistrationsWithSimpleAccountsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{clientkey}/PortfolioGroups/{key}": { "put": { "tags": [ "Portfolio/Clients" ], "summary": "Update the portfolio group has the provided key.", "operationId": "ClientPortfolioGroups_UpdatePortfolioGroupsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientkey", "in": "path", "description": "Required. ClientId for the portfolio group.", "required": true, "type": "integer", "format": "int32" }, { "name": "key", "in": "path", "description": "Id of the portfolio group.", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "description": "Key of the desired return object.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PortfolioGroupFullDto" } }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "onlyChanges", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PortfolioGroupFullDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{clientkey}/PortfolioGroups/Action/Delete": { "put": { "tags": [ "Portfolio/Clients" ], "operationId": "ClientPortfolioGroups_DeletePortfolioGroups", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientkey", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets the client that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Clients_GetEntityByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "BlendedModelManagement", "BlendedModelManagementDetails", "Prospects" ] }, { "name": "onlyActive", "in": "query", "description": "If true, will only return active accounts.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientBaseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Clients" ], "summary": "Simple dto update", "operationId": "Clients_UpdateClientAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/{fileType}": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Obsolete. Will be removed after the June 2014 build. Use Portfolio/Clients/{key:int}/Documents instead.", "operationId": "Clients_GetBlobs", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "fileType", "in": "path", "description": "The type of file to return. Can be set to any of the following:\r\n RPT_1099, QuarterlyStatements, YearEndStatements, CrmDocuments, CustodialStatements, Form_5498", "required": true, "type": "string", "enum": [ "RPT_1099", "QuarterlyStatements", "YearEndStatements", "CrmDocuments", "CustodialStatements", "Form_5498", "FeeLetters", "QualifiedTradeConfirms", "InsightPresentations", "PortfolioViewDashboards" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientBlobBaseDto" }, "xml": { "name": "ClientBlobBaseDto", "wrapped": true }, "type": "array" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/{fileType}/{fileId}": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Obsolete. Will be removed after the June 2014 build. Use Portfolio/Clients/{key:int}/Documents/{fileId:int} instead.", "operationId": "Clients_GetBlob", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "fileType", "in": "path", "description": "The type of file to return. Can be set to any of the following:\r\n RPT_1099, QuarterlyStatements, YearEndStatements, CrmDocuments, CustodialStatements, Form_5498", "required": true, "type": "string", "enum": [ "RPT_1099", "QuarterlyStatements", "YearEndStatements", "CrmDocuments", "CustodialStatements", "Form_5498", "FeeLetters", "QualifiedTradeConfirms", "InsightPresentations", "PortfolioViewDashboards" ] }, { "name": "fileId", "in": "path", "description": "Key of the file to be downloaded.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/Accounts": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a list of accounts that fall below the client with the specified key, which the logged in user has access to. By default the list does not include additional accounts.", "operationId": "Clients_GetAccountsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "isActive", "in": "query", "description": "Optional. Default null. When true - only active accounts are returned, when False, only inactive accounts, when null all accounts.", "required": false, "type": "boolean" }, { "name": "includeAdditionalAccounts", "in": "query", "description": "Optional. Default false. When true - additional accounts will also be returned.", "required": false, "type": "boolean", "default": false }, { "name": "accountStatusId", "in": "query", "description": "Optional. filter by account status .", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountDto" }, "xml": { "name": "AccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/Accounts/AumOverTime": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a list of Aum data representative of the range provided for all the accounts within the client with the specified key.", "operationId": "Clients_GetAccountsAumOverTimeAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "description": "Optional. Default: inception date. The start of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default: yesterday. The end of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "cancellationToken", "in": "header", "required": false }, { "name": "clientPerformanceInclude", "in": "query", "description": "Optional. Default: Default. When set only accounts/registrations that have value/are active will be returned.", "required": false, "type": "string", "default": -1, "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, { "name": "interval", "in": "query", "description": "Optional. Default: \"A\" Automatic. Options are:\r\n\"A\" Automatic\r\n\"M\" Monthly\r\n\"W\" Weekly\r\n\"D\" Daily", "required": false, "type": "string", "default": "A" }, { "name": "unmangedInclusionOverride", "in": "query", "description": "Optional. Default: no override. Used to override the unmanaged setting. To include all unmanaged assets set this parameter to \"ActivitySummary\".", "required": false, "type": "string", "enum": [ "Unmanaged", "Performance", "ActivitySummary", "Allocation", "PortfolioDetail", "TaxDetail" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AumOverTimeDto" }, "xml": { "name": "AumOverTimeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/Accounts/ModelAggs/Simple": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a list of Model Aggregate records that are used by the selected client in active accounts.", "operationId": "Clients_GetModelAggsForAccount", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired client record.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.SimpleAggregateModel" }, "xml": { "name": "SimpleAggregateModel", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/Accounts/NetAmountInvested": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a list of Aum data representative of the range provided for all the accounts within the client with the specified key. Also returns a list of data to show the net amount invested overtime.", "operationId": "Clients_GetAccountsAumOverTimeWithNetAmountInvestedAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "description": "Optional. Default: inception date. The start of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default: yesterday. The end of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "interval", "in": "query", "description": "Optional. Default: \"A\" Automatic. Options are:\r\n\"A\" Automatic\r\n\"M\" Monthly\r\n\"W\" Weekly\r\n\"D\" Daily", "required": false, "type": "string", "default": "A" }, { "name": "cancellationToken", "in": "header", "required": false }, { "name": "clientPerformanceInclude", "in": "query", "description": "Optional. Default: Default. When set only accounts/registrations that have value/are active will be returned.", "required": false, "type": "string", "default": -1, "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, { "name": "unmangedInclusionOverride", "in": "query", "description": "Optional. Default: no override. Used to override the unmanaged setting. To include all unmanaged assets set this parameter to \"ActivitySummary\".", "required": false, "type": "string", "enum": [ "Unmanaged", "Performance", "ActivitySummary", "Allocation", "PortfolioDetail", "TaxDetail" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AumOverTimeWithNetAmountInvestedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/Accounts/Simple": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a list of simple accounts that fall below the client with the specified key, which the logged in user has access to. By default the list does not include additional accounts.", "operationId": "Clients_GetAccountsSimpleAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "isActive", "in": "query", "description": "Optional. Default null. When true - only active accounts are returned, when False, only inactive accounts, when null all accounts.", "required": false, "type": "boolean" }, { "name": "includeAdditionalAccounts", "in": "query", "description": "Optional. Default false. When true - additional accounts will also be returned.", "required": false, "type": "boolean", "default": false }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleAccount" }, "xml": { "name": "SimpleAccount", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/Accounts/Value": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a simple list of accounts (including aum for today) that fall below the client with the specified key, which the logged in user has access to.", "operationId": "Clients_GetAccountsValue", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return accounts that have value (true) or don't have value (false).", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/Accounts/Value/{asOfDate}": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a simple list of accounts (including aum for the end of the date specified) that fall below the client with the specified key, which the logged in user has access to.", "operationId": "Clients_GetAccountsValueAsOfDate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return accounts that have value (true) or don't have value (false).", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/AdditionalAccounts": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a list of additional accounts that are assigned to the client with the specified key, which the logged in user has access to.", "operationId": "Clients_GetAdditionalAccounts", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientAdditionalAccountDto" }, "xml": { "name": "ClientAdditionalAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/Clients" ], "operationId": "Clients_CreateAdditionalAccountAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "account", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientAdditionalAccountDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/AdditionalAccounts/{additionalAccountId}": { "delete": { "tags": [ "Portfolio/Clients" ], "operationId": "Clients_RemoveAdditionalAccountAsync", "consumes": [], "produces": [], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "additionalAccountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/AdditionalRepresentativesPercent": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets additional representative with percent by id", "operationId": "Clients_GetAdditionalRepresentativesPercentByClientId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AdditionalRepAssignmentPercent" }, "xml": { "name": "AdditionalRepAssignmentPercent", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/Assets": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a list of assets that fall below the client with the specified key, which the logged in user has access to.", "operationId": "Clients_GetAssetsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "includeCostBasis", "in": "query", "description": "Optional bool. Default is false. When true, the Cost Basis property will be populated. This requires extra calculation which will reduce performance when true.", "required": false, "type": "boolean", "default": false }, { "name": "hasValue", "in": "query", "description": "Optional flag to filter out assets that currently have no shares.", "required": false, "type": "boolean" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetDto" }, "xml": { "name": "AssetDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/Assets/{asOfDate}": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a list of assets that fall below the client with the specified key, which the logged in user has access to.", "operationId": "Clients_GetV1PortfolioClientsByKeyAssetsByAsOfDate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "asOfDate", "in": "path", "description": "The asset value returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "includeCostBasis", "in": "query", "description": "Optional bool. Default is false. When true, the Cost Basis property will be populated. This requires extra calculation which will reduce performance when true.", "required": false, "type": "boolean", "default": false }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetDto" }, "xml": { "name": "AssetDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/AumOverTime": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a list of Aum data representative of the range provided for the client with the specified key.", "operationId": "Clients_GetAumOverTimeAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "description": "Optional. Default: inception date. The start of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default: yesterday. The end of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "interval", "in": "query", "description": "Optional. Default: \"A\" Automatic. Options are:\r\n\"A\" Automatic\r\n\"M\" Monthly\r\n\"W\" Weekly\r\n\"D\" Daily", "required": false, "type": "string", "default": "A" }, { "name": "cancellationToken", "in": "header", "required": false }, { "name": "clientPerformanceInclude", "in": "query", "description": "Optional. Default: Default. When set only accounts/registrations that have value/are active will be returned.", "required": false, "type": "string", "default": -1, "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, { "name": "unmangedInclusionOverride", "in": "query", "description": "Optional. Default: no override. Used to override the unmanaged setting. To include all unmanaged assets set this parameter to \"ActivitySummary\".", "required": false, "type": "string", "enum": [ "Unmanaged", "Performance", "ActivitySummary", "Allocation", "PortfolioDetail", "TaxDetail" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AumOverTimeDto" }, "xml": { "name": "AumOverTimeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/BalanceSheet": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Get balance sheets for the client", "operationId": "BalanceSheets_GetItemByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BalanceSheet.ClientWithBalanceSheetsDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Clients" ], "summary": "Update client's balance sheets.", "operationId": "BalanceSheets_UpdateBalanceSheet", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BalanceSheet.ClientWithBalanceSheetsDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BalanceSheet.ClientWithBalanceSheetsDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/BalanceSheet/ByAllAccounts/Refresh": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Add, edit or remove ByAllAccounts data on the Balance Sheets.", "operationId": "BalanceSheets_RefreshByAllAccountsInfo", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BalanceSheet.ClientWithBalanceSheetsDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/BalanceSheet/Category": { "get": { "tags": [ "Portfolio/Clients" ], "operationId": "BalanceSheets_GetClientCategories", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/Bills": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a list of bills that fall below the client with the specified key, which the logged in user has access to.", "operationId": "Clients_GetBillsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "isValid", "in": "query", "description": "Optional. Default: null. If provided will only show the valid or invalid bills.", "required": false, "type": "boolean" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.SimpleBillDto" }, "xml": { "name": "SimpleBillDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/Calculate/InceptionDate": { "post": { "tags": [ "Portfolio/Clients" ], "summary": "Used to calculate the appropriate inception date for the provided client.", "operationId": "Clients_CalculateInceptionDate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "endDate", "in": "query", "description": "Optional. Default: Today. The end date of the reporting period.", "required": false, "type": "string", "format": "date-time" }, { "name": "inclusionOption", "in": "query", "description": "Optional. Default: Database default. Indicates which accounts/registrations to include.", "required": false, "type": "string", "default": -1, "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, { "name": "unmanagedInclusionOption", "in": "query", "description": "Optional. Default: Database default. Indicates how unmanaged assets are handled.", "required": false, "type": "string", "enum": [ "Unmanaged", "Performance", "ActivitySummary", "Allocation", "PortfolioDetail", "TaxDetail" ] }, { "name": "reportCategory", "in": "query", "required": false, "type": "string", "enum": [ "Unmanaged", "Performance", "ActivitySummary", "Allocation", "PortfolioDetail", "TaxDetail" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RunReport.InceptionDateDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/ClientPortalRedirect": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Returns a 302 Redirect with the ClientPortal SSO. The current user must have access to the client, and the client must have a \"User\" setup for the client portal.", "operationId": "Clients_ClientPortalRedirect", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Orion ClientId.", "required": true, "type": "integer", "format": "int32" }, { "name": "useDefaultLandingPage", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "useCurrentProfile", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/Documents": { "get": { "tags": [ "Portfolio/Clients" ], "operationId": "Clients_GetBlobsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "fileType", "in": "query", "required": false, "items": { "type": "string", "enum": [ "RPT_1099", "QuarterlyStatements", "YearEndStatements", "CrmDocuments", "CustodialStatements", "Form_5498", "FeeLetters", "QualifiedTradeConfirms", "InsightPresentations", "PortfolioViewDashboards" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "excludedLocation", "in": "query", "required": false, "items": { "type": "string", "enum": [ "Undefined", "Database", "FileServer", "AmazonS3", "HttpGet", "RedtailIms", "Communities" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientBlobBaseDto" }, "xml": { "name": "ClientBlobBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/Clients" ], "operationId": "Clients_CreateBlobAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "file", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientFileDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientBlobBaseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/Documents/{fileId}": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a file for the client with the specified key and the file with the specified key.", "operationId": "Clients_GetBlobDtoAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "description": "Key of the file to be returned.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientBlobBaseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Clients" ], "operationId": "Clients_UpdateBlobAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "file", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientFileDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientBlobBaseDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/Clients" ], "operationId": "Clients_DeleteBlobAsync", "consumes": [], "produces": [], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/Documents/{fileId}/Download": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets the raw data of the specific file with the blobId provided which is associated to the client with the specified key.", "operationId": "Clients_GetBlobFile", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "description": "Key of the file to be downloaded.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/Documents/Action/MoveToClient/{clientId}": { "put": { "tags": [ "Portfolio/Clients" ], "summary": "Move documents to different household", "operationId": "Clients_MoveDocumentsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "fileIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/GoalTracking": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Returns goal summary and performance info for all accounts in the household", "operationId": "Clients_GetGoalTrackingSummary", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "description": "Optional. Default: Earliest start date of all the goals.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default: Today. The end date of the reporting period.", "required": false, "type": "string", "format": "date-time" }, { "name": "inclusionOption", "in": "query", "description": "Optional. Default: Database default. Indicates which accounts/registrations to include.", "required": false, "type": "string", "default": -1, "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/Integrations/{app}": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Retreives the Intgration information for the specified integration partner application for the specified client id.", "operationId": "Clients_GetClientAppDetail", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "app", "in": "path", "description": "Integraton partners application code", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.AppLinkDetailForClientDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Clients" ], "summary": "Updates the specified Clients integration information for the specified partner app.", "operationId": "Clients_UpdateClientAppDetail", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "app", "in": "path", "required": true, "type": "string" }, { "name": "dto", "in": "body", "description": "Integration Info to store with this ClientId.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.AppLinkDetailForClientDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.AppLinkDetailForClientDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/Clients" ], "summary": "Deletes the integration information for the specified integration application, and for the specified ClientId.", "operationId": "Clients_DeleteUserIntegrationDtl", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "app", "in": "path", "description": "Integraton partners application code", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/NetAmountInvested": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a list of Aum data representative of the range provided for all the client with the specified key. Also returns a list of data to show the net amount invested overtime.", "operationId": "Clients_GetAumOverTimeWithNetAmountInvestedAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "description": "Optional. Default: inception date. The start of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default: yesterday. The end of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "interval", "in": "query", "description": "Optional. Default: \"A\" Automatic. Options are:\r\n\"A\" Automatic\r\n\"M\" Monthly\r\n\"W\" Weekly\r\n\"D\" Daily", "required": false, "type": "string", "default": "A" }, { "name": "cancellationToken", "in": "header", "required": false }, { "name": "clientPerformanceInclude", "in": "query", "description": "Optional. Default: Default. When set only accounts/registrations that have value/are active will be returned.", "required": false, "type": "string", "default": -1, "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, { "name": "unmangedInclusionOverride", "in": "query", "description": "Optional. Default: no override. Used to override the unmanaged setting. To include all unmanaged assets set this parameter to \"ActivitySummary\".", "required": false, "type": "string", "enum": [ "Unmanaged", "Performance", "ActivitySummary", "Allocation", "PortfolioDetail", "TaxDetail" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AumOverTimeWithNetAmountInvestedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/Performance": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Used to verbosely return performance. Has the ability to return client performance, benchmark performance, and statistical data for the client over a number of date ranges.", "operationId": "Clients_GetPerformanceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the client that performance will be calculated for.", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "description": "Optional. The start of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default: Today. The end of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "cancellationToken", "in": "header", "required": false }, { "name": "clientPerformanceInclude", "in": "query", "description": "Optional. Default: Default. When set only accounts/registrations that have value/are active will be returned.", "required": false, "type": "string", "default": -1, "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, { "name": "returnStyle", "in": "query", "description": "Optional. Default: 3 PortfolioSummary & PortfolioDaily\r\n1 = Returns Portfolio Performance Summary\r\n2 = Returns Portfolio Daily Factors\r\n4 = Modifies return style 1 to include beginning and ending market value. Also includes accrued interest if performance was calculated including accrued interest.\r\n8 = Returns Benchmark Performance Summary\r\n16 = Returns Benchmark Daily Factors\r\n32 = **does nothing\r\n64 = Returns Statistical Summary", "required": false, "type": "string", "default": 3, "enum": [ "PortfolioSummary", "PortfolioDaily", "PortfolioDetailed", "BenchmarkSummary", "BenchmarkDaily", "AssetGroupAssignment", "StatisticSummary" ] }, { "name": "interval", "in": "query", "description": "Optional. Default: \"A\" Automatic. Options are:\r\n\"A\" Automatic\r\n\"M\" Monthly\r\n\"W\" Weekly\r\n\"D\" Daily", "required": false, "type": "string", "default": "A" }, { "name": "periods", "in": "query", "description": "Optional. Bitwise parameter for requesting commonly used date ranges.\r\n1 = MTD\r\n2 = QTD\r\n4 = YTD\r\n8 = 1yr\r\n16 = 3yr\r\n32 = 5yr\r\n64 = 10yr\r\n128 = inception\r\n256 = day", "required": false, "type": "string", "default": 0, "enum": [ "None", "Day", "MTD", "QTD", "YTD", "OneYear", "ThreeYear", "FiveYear", "TenYear", "Inception", "AllDates" ] }, { "name": "calendarYears", "in": "query", "description": "Optional. Comma delimited list of calendar years for which performance should be calculated.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Performance.PerformancePortfolio" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/Performance/{grouping}": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Used to verbosely return performance. Has the ability to return grouped client performance, benchmark performance, and statistical data for the client over a number of date ranges.", "operationId": "Clients_GetV1PortfolioClientsByKeyPerformanceByGrouping", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the client that performance will be calculated for.", "required": true, "type": "integer", "format": "int32" }, { "name": "grouping", "in": "path", "description": "Defines how the client is grouped for the performance return. Can be set to any of the follow: \r\n Client, Registration, Account, Asset, AssetClass, ProductType, MgmntStyle, RiskCategory, AssetCategory, or AssetLevelStrategy.", "required": true, "type": "string", "enum": [ "Undefined", "Representative", "Client", "Registration", "Account", "Asset", "AssetClass", "ProductType", "Platform", "RiskCategory", "Product", "IndexBlend", "AssetCategory", "AssetLevelStrategy", "AggregateModel", "AccountType", "PortfolioGroup" ] }, { "name": "startDate", "in": "query", "description": "Optional. The start of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default: Today. The end of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "cancellationToken", "in": "header", "required": false }, { "name": "clientPerformanceInclude", "in": "query", "description": "Optional. Default: Default. When set only accounts/registrations that have value/are active will be returned.", "required": false, "type": "string", "default": -1, "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, { "name": "returnStyle", "in": "query", "description": "Optional. Default: 3 Portfolio Summary & Portfolio Daily\r\n1 = Returns Portfolio Performance Summary\r\n2 = Returns Portfolio Daily Factors\r\n4 = Modifies return style 1 to include beginning and ending market value. Also includes accrued interest if performance was calculated including accrued interest.\r\n8 = Returns Benchmark Performance Summary\r\n16 = Returns Benchmark Daily Factors\r\n32 = **does nothing\r\n64 = Returns Statistical Summary", "required": false, "type": "string", "default": 3, "enum": [ "PortfolioSummary", "PortfolioDaily", "PortfolioDetailed", "BenchmarkSummary", "BenchmarkDaily", "AssetGroupAssignment", "StatisticSummary" ] }, { "name": "interval", "in": "query", "description": "Optional. Default: \"A\" Automatic. Options are:\r\n\"A\" Automatic\r\n\"M\" Monthly\r\n\"W\" Weekly\r\n\"D\" Daily", "required": false, "type": "string", "default": "A" }, { "name": "periods", "in": "query", "description": "Optional. Bitwise parameter for requesting commonly used date ranges.\r\n1 = MTD\r\n2 = QTD\r\n4 = YTD\r\n8 = 1yr\r\n16 = 3yr\r\n32 = 5yr\r\n64 = 10yr\r\n128 = inception\r\n256 = day", "required": false, "type": "string", "default": 0, "enum": [ "None", "Day", "MTD", "QTD", "YTD", "OneYear", "ThreeYear", "FiveYear", "TenYear", "Inception", "AllDates" ] }, { "name": "calendarYears", "in": "query", "description": "Optional. Comma delimited list of calendar years for which performance should be calculated.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Performance.PerformancePortfolio" }, "xml": { "name": "PerformancePortfolio", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/Performance/Interval": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Used to return interval performance. Has the ability to return client performance in sequential intervals over a number the date range specified.", "operationId": "Clients_GetPerformanceIntervalAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the client that performance will be calculated for.", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "description": "Optional. The start of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default: Today. The end of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "interval", "in": "query", "description": "Optional. Default: \"A\" Automatic. Options are:\r\n\"A\" Automatic\r\n\"M\" Monthly\r\n\"W\" Weekly\r\n\"D\" Daily", "required": false, "type": "string", "default": "A" }, { "name": "cancellationToken", "in": "header", "required": false }, { "name": "clientPerformanceInclude", "in": "query", "description": "Optional. Default: Default. When set only accounts/registrations that have value/are active will be returned.", "required": false, "type": "string", "default": -1, "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Reporting.PerformancePortfolioDetailDto" }, "xml": { "name": "PerformancePortfolioDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/Performance/Interval/{grouping}": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Used to return interval performance. Has the ability to return grouped client performance in sequential intervals over a number the date range specified.", "operationId": "Clients_GetV1PortfolioClientsByKeyPerformanceIntervalByGrouping", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the client that performance will be calculated for.", "required": true, "type": "integer", "format": "int32" }, { "name": "grouping", "in": "path", "description": "Defines how the client is grouped for the performance return. Can be set to any of the follow: \r\n Client, Registration, Account, Asset, AssetClass, ProductType, MgmntStyle, RiskCategory, AssetCategory, or AssetLevelStrategy.", "required": true, "type": "string", "enum": [ "Undefined", "Representative", "Client", "Registration", "Account", "Asset", "AssetClass", "ProductType", "Platform", "RiskCategory", "Product", "IndexBlend", "AssetCategory", "AssetLevelStrategy", "AggregateModel", "AccountType", "PortfolioGroup" ] }, { "name": "startDate", "in": "query", "description": "Optional. The start of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default: Today. The end of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "interval", "in": "query", "description": "Optional. Default: \"A\" Automatic. Options are:\r\n\"A\" Automatic\r\n\"M\" Monthly\r\n\"W\" Weekly\r\n\"D\" Daily", "required": false, "type": "string", "default": "A" }, { "name": "cancellationToken", "in": "header", "required": false }, { "name": "clientPerformanceInclude", "in": "query", "description": "Optional. Default: Default. When set only accounts/registrations that have value/are active will be returned.", "required": false, "type": "string", "default": -1, "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Reporting.PerformancePortfolioDetailDto" }, "xml": { "name": "PerformancePortfolioDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/Performance/Summary": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Used to return summary performance. Has the ability to return performance for the client over a number of date ranges.", "operationId": "Clients_GetPerformanceSummaryAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the client that performance will be calculated for.", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "description": "Optional. The start of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default: Today. The end of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "cancellationToken", "in": "header", "required": false }, { "name": "clientPerformanceInclude", "in": "query", "description": "Optional. Default: Default. When set only accounts/registrations that have value/are active will be returned.", "required": false, "type": "string", "default": -1, "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, { "name": "periods", "in": "query", "description": "Optional. Bitwise parameter for requesting commonly used date ranges.\r\n1 = MTD\r\n2 = QTD\r\n4 = YTD\r\n8 = 1yr\r\n16 = 3yr\r\n32 = 5yr\r\n64 = 10yr\r\n128 = inception\r\n256 = day", "required": false, "type": "string", "default": 0, "enum": [ "None", "Day", "MTD", "QTD", "YTD", "OneYear", "ThreeYear", "FiveYear", "TenYear", "Inception", "AllDates" ] }, { "name": "calendarYears", "in": "query", "description": "Optional. Comma delimited list of calendar years for which performance should be calculated.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.PerformancePortfolioSummaryDto" }, "xml": { "name": "PerformancePortfolioSummaryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/Performance/Summary/{grouping}": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Used to return summary performance. Has the ability to return grouped client performance for the client over a number of date ranges.", "operationId": "Clients_GetV1PortfolioClientsByKeyPerformanceSummaryByGrouping", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the client that performance will be calculated for.", "required": true, "type": "integer", "format": "int32" }, { "name": "grouping", "in": "path", "description": "Defines how the client is grouped for the performance return. Can be set to any of the follow: \r\n Client, Registration, Account, Asset, AssetClass, ProductType, MgmntStyle, RiskCategory, AssetCategory, or AssetLevelStrategy.", "required": true, "type": "string", "enum": [ "Undefined", "Representative", "Client", "Registration", "Account", "Asset", "AssetClass", "ProductType", "Platform", "RiskCategory", "Product", "IndexBlend", "AssetCategory", "AssetLevelStrategy", "AggregateModel", "AccountType", "PortfolioGroup" ] }, { "name": "startDate", "in": "query", "description": "Optional. The start of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default: Today. The end of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "cancellationToken", "in": "header", "required": false }, { "name": "clientPerformanceInclude", "in": "query", "description": "Optional. Default: Default. When set only accounts/registrations that have value/are active will be returned.", "required": false, "type": "string", "default": -1, "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, { "name": "periods", "in": "query", "description": "Optional. Bitwise parameter for requesting commonly used date ranges.\r\n1 = MTD\r\n2 = QTD\r\n4 = YTD\r\n8 = 1yr\r\n16 = 3yr\r\n32 = 5yr\r\n64 = 10yr\r\n128 = inception\r\n256 = day", "required": false, "type": "string", "default": 0, "enum": [ "None", "Day", "MTD", "QTD", "YTD", "OneYear", "ThreeYear", "FiveYear", "TenYear", "Inception", "AllDates" ] }, { "name": "calendarYears", "in": "query", "description": "Optional. Comma delimited list of calendar years for which performance should be calculated.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.PerformancePortfolioSummaryDto" }, "xml": { "name": "PerformancePortfolioSummaryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/PortfolioTree": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a tree representation of the client with the key provided. Also includes the registrations within that client and the accounts within those registrations.", "operationId": "Clients_GetTreeAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "includeAdditionalAccounts", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "includeAdditionalDetail", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "includeRepresentative", "in": "query", "description": "Optional. Default is false. When true, rep information will be included.", "required": false, "type": "boolean", "default": false }, { "name": "portfolioTreeFilter", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "PortfolioTree", "PortfolioGroups", "RegistrationsOnly", "AccountsOnly", "None" ] }, { "name": "skipInceptionDate", "in": "query", "description": "Optional: Skips calculating the inception date", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientPortfolioTreeDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/Registrations": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a list of registrations that fall below the client with the specified key, which the logged in user has access to.", "operationId": "Clients_GetRegistrationsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "isActive", "in": "query", "description": "Optional. Default null. When true - only active registrations are returned, when False, only inactive registrations, when null all registrations.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/RepSimple": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets representative simple of the client with the key provided.", "operationId": "Clients_GetRepSimpleByClientIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleRepresentative" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/RmdCalculations": { "get": { "tags": [ "Portfolio/Clients" ], "operationId": "Clients_GetRmdCalculations", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RmdDashboardDto" }, "xml": { "name": "RmdDashboardDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/Simple": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets the simple client that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Clients_GetSimpleByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleClient" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/SSNTaxId": { "put": { "tags": [ "Portfolio/Clients" ], "summary": "Retrieve or update SSN for client.", "description": "If updateInfo.SSN is null => we will just retrieve SSN otherwise we will attempt to update SSN with data in updateInfo.SSN", "operationId": "Clients_UpdateSSNTaxIdAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updateInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.UpdateSsnDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/Transactions": { "get": { "tags": [ "Portfolio/Clients" ], "operationId": "Clients_GetTransactions", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "transTypeId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TradingTransactionDto" }, "xml": { "name": "TradingTransactionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/UnderlyingCounts": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets the underlying counts for the client with the specified key, which the logged in user has access to.", "operationId": "Clients_GetUnderlyingCounts", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientUnderlyingCountsDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/UserDefinedFields": { "get": { "tags": [ "Portfolio/Clients" ], "operationId": "Clients_GetUserDefinedFieldsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "entities", "in": "query", "required": false, "items": { "type": "string", "enum": [ "BrokerDealers", "Wholesalers", "Representatives", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Products", "FundFamilies", "ModelRanges", "PortfolioGroups" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/Value": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets the simple client (including aum for the end of today) that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Clients_GetValueByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "includeCash", "in": "query", "description": "Optional. Default: false. When true the cash value will be returned along with the client value.", "required": false, "type": "boolean", "default": false }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.SimpleValueDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/{key}/Value/{asOfDate}": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets the simple client (including aum for the end of the date specified) that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Clients_GetValueAsOfDateByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "includeCash", "in": "query", "description": "Optional. Default: false. When true the cash value will be returned along with the client value.", "required": false, "type": "boolean", "default": false }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.SimpleValueDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/Action/Cancel": { "put": { "tags": [ "Portfolio/Clients" ], "summary": "Cancels the Entire household, or specified accounts within the household", "operationId": "Clients_CancelAccountsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancel", "in": "body", "description": "Instructions used for cancellation. AsOfDate - date to process cancellation as of, CancelType - Full or Partial, when full, the AccountIds[] is ignored. ZeroAssets - when true will add zeroing transactions, ExcludeDownload, when true will add account to be ignored in confirm system, Create final bill will create refund invoices if required.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CancelAccountsActionDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/Action/Delete": { "put": { "tags": [ "Portfolio/Clients" ], "operationId": "Clients_ActionDeleteAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/Action/ToggleRiskAlerts": { "post": { "tags": [ "Portfolio/Clients" ], "operationId": "Clients_ToggleRiskAlertsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "disable", "in": "query", "required": true, "type": "boolean" }, { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlendedModelManagementClientDto" }, "xml": { "name": "BlendedModelManagementClientDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/Action/ValidateRepresentatives/{clientId}": { "post": { "tags": [ "Portfolio/Clients" ], "summary": "Validates the representatives list for a client\r\nSample Request\r\nPOST Portfolio/Clients/Action/ValidateRepresentatives/123\r\n [\r\n {\r\n \"clientId\": 123,\r\n \"createdBy\": \"test.user\",\r\n \"createdDate\": \"2024-11-27\",\r\n \"editedBy\": \"test.user\",\r\n \"editedDate\": \"2024-11-27\",\r\n \"endDate\": \"9999-12-31\",\r\n \"id\": 1,\r\n \"isActive\": true,\r\n \"isCurrentRecord\": true,\r\n \"isPrimary\": true,\r\n \"isStartRecord\": true,\r\n \"isSystemGenerated\": false,\r\n \"isValid\": null,\r\n \"notes\": null,\r\n \"payoutRate\": 1,\r\n \"representativeId\": 1,\r\n \"representativeTitleId\": null,\r\n \"simpleRep\":\r\n {\r\n \"id\": 1,\r\n \"isActive\": true,\r\n \"name\": \"test, rep\",\r\n \"number\": \"123\"\r\n },\r\n \"startDate\": \"1900-01-01\",\r\n \"validationMessage\": null\r\n }\r\n ]", "operationId": "Clients_ValidateClientRepresentativesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "description": "Client ID", "required": true, "type": "integer", "format": "int32" }, { "name": "clientRepAdditionals", "in": "body", "description": "List of Client Rep Additional", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientRepAdditionalDetailDto" }, "xml": { "name": "ClientRepAdditionalDetailDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientRepAdditionalDetailDto" }, "xml": { "name": "ClientRepAdditionalDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/Count": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Returns the number of clients matching the same URI filters and OData $filter as {M:OAS.WebApi.Domains.Portfolio.ClientsController.GetAsync(System.Threading.CancellationToken,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32},System.Nullable{OAS.DataAccess.Domains.Portfolio.ClientsAccessExtension.HouseholdFilterValues},System.Nullable{System.Int32},System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},OAS.WebApi.Domains.Portfolio.ClientsController.ClientReturnStyle,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32})},\r\nwithout applying $top/$skip to the count (order-by is ignored for counting).", "operationId": "Clients_GetClientsListCountAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "hasValue", "in": "query", "required": false, "type": "boolean" }, { "name": "isActive", "in": "query", "required": false, "type": "boolean" }, { "name": "categoryId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "householdFilter", "in": "query", "required": false, "type": "string", "enum": [ "MissingInformation", "ActiveClientsNoActiveAccounts", "InactiveClientsActiveAccounts", "HHWithAdditionalAccounts" ] }, { "name": "representativeId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "registrationSSN", "in": "query", "required": false, "type": "string" }, { "name": "sleeveStrategyId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "sleeveStrategyAggId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "BlendedModelManagement", "BlendedModelManagementDetails", "Prospects" ] }, { "name": "accountId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "pageQueryId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "entitySessionId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.ListCountDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/Grid": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a list of clients that the logged in user has access to. \r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "Clients_GetClientForGridAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "manipulator", "in": "header", "required": true }, { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return clients that have value (true) or don't have value (false).", "required": false, "type": "boolean" }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "top", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "isActive", "in": "query", "description": "Optional. Default: null. If provided returns only the active (true) or inactive clients (false).", "required": false, "type": "boolean" }, { "name": "categoryId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "householdFilter", "in": "query", "description": "Optional. Default: null.", "required": false, "type": "string", "enum": [ "MissingInformation", "ActiveClientsNoActiveAccounts", "InactiveClientsActiveAccounts", "HHWithAdditionalAccounts" ] }, { "name": "representativeId", "in": "query", "description": "Optional. Default: null. If provided only registrations that fall within the representative specified will be returned.", "required": false, "type": "integer", "format": "int32" }, { "name": "registrationSSN", "in": "query", "description": "Optional. Default: null. If provided only registration that has specified SSN will be returned.", "required": false, "type": "string" }, { "name": "sleeveStrategyId", "in": "query", "description": "Optional. Default: null. If provided returns only clients that have at least one registration assigned to the sleeve strategy.", "required": false, "type": "integer", "format": "int32" }, { "name": "sleeveStrategyAggId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "BlendedModelManagement", "BlendedModelManagementDetails", "Prospects" ] }, { "name": "registrationId", "in": "query", "description": "Optional. Default: null. If provided only the client with the registration specified will be returned.", "required": false, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "query", "description": "Optional. Default: null. If provided only the client with the account specified will be returned.", "required": false, "type": "integer", "format": "int32" }, { "name": "pageQueryId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "refreshCache", "in": "query", "description": "Default: false. If true then refresh cached responses.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientBaseDto" }, "xml": { "name": "ClientBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/List": { "post": { "tags": [ "Portfolio/Clients" ], "operationId": "Clients_GetListByIdAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientDto" }, "xml": { "name": "ClientDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/List/Accounts": { "post": { "tags": [ "Portfolio/Clients" ], "operationId": "Clients_GetAccountListByIdAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountDto" }, "xml": { "name": "AccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/List/Accounts/Id": { "post": { "tags": [ "Portfolio/Clients" ], "operationId": "Clients_PostV1PortfolioClientsListAccountsId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountDto" }, "xml": { "name": "AccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/List/Id": { "post": { "tags": [ "Portfolio/Clients" ], "operationId": "Clients_PostV1PortfolioClientsListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientDto" }, "xml": { "name": "ClientDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/List/PortfolioTrees": { "post": { "tags": [ "Portfolio/Clients" ], "operationId": "Clients_GetPortfolioTreesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientPortfolioTreeDto" }, "xml": { "name": "ClientPortfolioTreeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/ListCounts": { "post": { "tags": [ "Portfolio/Clients" ], "operationId": "Clients_GetListCountByIdAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/PortfolioGroupChanges": { "put": { "tags": [ "Portfolio/Clients" ], "summary": "Update list of portfolio group change.", "operationId": "PortfolioGroupChanges_UpdateList", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updatedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PortfolioGroupChangeDto" }, "xml": { "name": "PortfolioGroupChangeDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PortfolioGroupChangeDto" }, "xml": { "name": "PortfolioGroupChangeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/PortfolioGroupChanges/{key}": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets the portfolio group change that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "PortfolioGroupChanges_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Required. Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PortfolioGroupChangeDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Clients" ], "summary": "Update portfolio group change that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "PortfolioGroupChanges_Update", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Required.", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PortfolioGroupChangeDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PortfolioGroupChangeDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/Clients" ], "summary": "Delete the portfolio group change that has the provided key.", "operationId": "PortfolioGroupChanges_Delete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Required.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/PortfolioGroups/{key}": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets the portfolio group that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ClientPortfolioGroups_GetPortfolioGroupByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PortfolioGroupFullDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/PortfolioTree": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a tree representation of the client with the key provided. Also includes the registrations within that client and the accounts within those registrations.", "operationId": "Clients_GetTreeForEntityAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "query", "description": "Required. Specify the {OAS.DataModel.Enums.Entity}Entity (Household, Registration, Account) which is the level to return the tree for.", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "query", "description": "Specify the record Id to return the tree for.", "required": true, "type": "integer", "format": "int32" }, { "name": "includeAdditionalAccounts", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "includeAdditionalDetail", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "includeRepresentative", "in": "query", "description": "Optional. Default is false. When true, rep information will be included.", "required": false, "type": "boolean", "default": false }, { "name": "skipInceptionDate", "in": "query", "description": "Optional: Skips calculating the inception date", "required": false, "type": "boolean", "default": false }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientPortfolioTreeDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/qs": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a list of clients returned by a Query Studio Query in the provided Dashboard Card ID", "operationId": "Clients_GetClientsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "queryStudioQueryId", "in": "query", "description": "Returns only the results from the query studio query with the provided guid.", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientBaseDto" }, "xml": { "name": "ClientBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/Search/Advanced": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a list of clients that the logged in user has access to filtered by supplied search parameters.", "operationId": "Clients_GetAdvancedClientSearchAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "query", "description": "Optional. Default: null. Client ID.", "required": false, "type": "integer", "format": "int32" }, { "name": "firstName", "in": "query", "description": "Optional. Default: null. Client first name.", "required": false, "type": "string" }, { "name": "lastName", "in": "query", "description": "Optional. Default: null. Client last name.", "required": false, "type": "string" }, { "name": "ssnLast4", "in": "query", "description": "Optional. Default: null. Last 4 digits of client tax ID or SSN.", "required": false, "type": "string" }, { "name": "repLastName", "in": "query", "description": "Optional. Default: null. Rep last name.", "required": false, "type": "string" }, { "name": "repNumber", "in": "query", "description": "Optional. Default: null. Rep number.", "required": false, "type": "string" }, { "name": "repId", "in": "query", "description": "Optional. Default: null. Rep ID.", "required": false, "type": "integer", "format": "int32" }, { "name": "isActive", "in": "query", "description": "Optional. Default: null.", "required": false, "type": "boolean" }, { "name": "fullName", "in": "query", "required": false, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientDto" }, "xml": { "name": "ClientDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/Search/Advanced/Count": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a count of clients that the logged in user has access to filtered by supplied search parameters.", "operationId": "Clients_GetAdvancedClientSearchCountAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "query", "description": "Optional. Default: null. Client ID.", "required": false, "type": "integer", "format": "int32" }, { "name": "firstName", "in": "query", "description": "Optional. Default: null. Client first name.", "required": false, "type": "string" }, { "name": "lastName", "in": "query", "description": "Optional. Default: null. Client last name.", "required": false, "type": "string" }, { "name": "ssnLast4", "in": "query", "description": "Optional. Default: null. Last 4 digits of client tax ID or SSN.", "required": false, "type": "string" }, { "name": "repLastName", "in": "query", "description": "Optional. Default: null. Rep last name.", "required": false, "type": "string" }, { "name": "repNumber", "in": "query", "description": "Optional. Default: null. Rep number.", "required": false, "type": "string" }, { "name": "repId", "in": "query", "description": "Optional. Default: null. Rep ID.", "required": false, "type": "integer", "format": "int32" }, { "name": "isActive", "in": "query", "description": "Optional. Default: null.", "required": false, "type": "boolean" }, { "name": "fullName", "in": "query", "required": false, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/Simple": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a simple list of clients that the logged in user has access to. \r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "Clients_GetSimpleAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return clients that have value (true) or don't have value (false).", "required": false, "type": "boolean" }, { "name": "resetCache", "in": "query", "description": "Optional. Default: false. The result is cached for fifteen minutes. To force the cache to refresh call with resetCache = true.", "required": false, "type": "boolean", "default": false }, { "name": "isActive", "in": "query", "description": "Optional. Default: null. If provided returns only the active (true) or inactive clients(false).", "required": false, "type": "boolean" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleClient" }, "xml": { "name": "SimpleClient", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/Simple/List": { "post": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a simple list of clients that match one of the keys in the provided list.", "operationId": "Clients_GetSimpleByIdListAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleClient" }, "xml": { "name": "SimpleClient", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/Simple/List/Id": { "post": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a simple list of clients that match one of the keys in the provided list.", "operationId": "Clients_PostV1PortfolioClientsSimpleListId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleClient" }, "xml": { "name": "SimpleClient", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/Simple/Search": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a simple list of clients that the logged in user has access to where the clients first name, lastname, or entityname begins with the search string or Id is exact match.", "operationId": "Clients_GetSimpleClientSearchAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "Partial client name to search for.", "required": true, "type": "string" }, { "name": "top", "in": "query", "description": "Optional. Default: null. The maximum number of products to return. If null returns all.", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Optional. Default: 0. Defines number of items to skip.", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return clients that have value (true) or don't have value (false).", "required": false, "type": "boolean" }, { "name": "isActive", "in": "query", "description": "Optional. Default: null. If provided returns only the active (true) or inactive clients(false).", "required": false, "type": "boolean" }, { "name": "hasEmail", "in": "query", "description": "Optional.", "required": false, "type": "boolean" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleClient" }, "xml": { "name": "SimpleClient", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/Simple/Search/{search}": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a simple list of clients that the logged in user has access to where the clients first name, lastname, or entityname begins with the search string or Id is exact match.", "operationId": "Clients_GetV1PortfolioClientsSimpleSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "Partial client name to search for.", "required": true, "type": "string" }, { "name": "top", "in": "query", "description": "Optional. Default: null. The maximum number of products to return. If null returns all.", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Optional. Default: 0. Defines number of items to skip.", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return clients that have value (true) or don't have value (false).", "required": false, "type": "boolean" }, { "name": "isActive", "in": "query", "description": "Optional. Default: null. If provided returns only the active (true) or inactive clients(false).", "required": false, "type": "boolean" }, { "name": "hasEmail", "in": "query", "description": "Optional.", "required": false, "type": "boolean" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleClient" }, "xml": { "name": "SimpleClient", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/Simple/Search/LastName": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a simple list of clients that the logged in user has access to where the clients lastname begins with the search string.", "operationId": "Clients_GetSimpleClientSearchByLastNameAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "Partial client name to search for.", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleClient" }, "xml": { "name": "SimpleClient", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/Simple/Search/LastName/{search}": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a simple list of clients that the logged in user has access to where the clients lastname begins with the search string.", "operationId": "Clients_GetV1PortfolioClientsSimpleSearchLastNameBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "Partial client name to search for.", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleClient" }, "xml": { "name": "SimpleClient", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/TargetAllocationGroupings": { "get": { "tags": [ "Portfolio/Clients" ], "operationId": "Clients_GetTargetAllocationGroupings", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/Value": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a simple list of clients (including aum for today) that the logged in user has access to.\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "Clients_GetValueAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return clients that have value (true) or don't have value (false).", "required": false, "type": "boolean" }, { "name": "resetCache", "in": "query", "description": "Optional. Default: false. The result is cached for fifteen minuetes. To force the cache to refresh call with resetCache = true.", "required": false, "type": "boolean", "default": false }, { "name": "includeCash", "in": "query", "description": "Optional. Default: false. When true the cash value will be returned along with the client value.", "required": false, "type": "boolean", "default": false }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.SimpleValueDto" }, "xml": { "name": "SimpleValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/Value/{asOfDate}": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a simple list of clients (including aum for the end of the date specified) that the logged in user has access to.\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "Clients_GetValueAsOfDateAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return clients that have value (true) or don't have value (false).", "required": false, "type": "boolean" }, { "name": "resetCache", "in": "query", "description": "Optional. Default: false. The result is cached for fifteen minuetes. To force the cache to refresh call with resetCache = true.", "required": false, "type": "boolean", "default": false }, { "name": "includeCash", "in": "query", "description": "Optional. Default: false. When true the cash value will be returned along with the client value.", "required": false, "type": "boolean", "default": false }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.SimpleValueDto" }, "xml": { "name": "SimpleValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/Value/{asOfDate}/Search": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a simple list of clients (including aum for the end of the date specified) that the logged in user has access to where the clients first name, lastname, or entityname begins with the search string.", "operationId": "Clients_GetValueAsOfDateClientSearchAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "search", "in": "query", "description": "Partial client name to search for.", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.SimpleValueDto" }, "xml": { "name": "SimpleValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/Value/{asOfDate}/Search/{search}": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a simple list of clients (including aum for the end of the date specified) that the logged in user has access to where the clients first name, lastname, or entityname begins with the search string.", "operationId": "Clients_GetV1PortfolioClientsValueByAsOfDateSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "search", "in": "path", "description": "Partial client name to search for.", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.SimpleValueDto" }, "xml": { "name": "SimpleValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/Value/{asOfDate}/Search/LastName": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a simple list of clients (including aum for the end of the date specified) that the logged in user has access to where the clients lastname begins with the search string.", "operationId": "Clients_GetValueAsOfDateClientSearchByLastNameAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "search", "in": "query", "description": "Partial client name to search for.", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.SimpleValueDto" }, "xml": { "name": "SimpleValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/Value/{asOfDate}/Search/LastName/{search}": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a simple list of clients (including aum for the end of the date specified) that the logged in user has access to where the clients lastname begins with the search string.", "operationId": "Clients_GetV1PortfolioClientsValueByAsOfDateSearchLastNameBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "search", "in": "path", "description": "Partial client name to search for.", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.SimpleValueDto" }, "xml": { "name": "SimpleValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/Value/Search": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a simple list of clients (including aum for today) that the logged in user has access to where the clients first name, lastname, or entityname begins with the search string.", "operationId": "Clients_GetValueClientSearchAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "Partial client name to search for.", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.SimpleValueDto" }, "xml": { "name": "SimpleValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/Value/Search/{search}": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a simple list of clients (including aum for today) that the logged in user has access to where the clients first name, lastname, or entityname begins with the search string.", "operationId": "Clients_GetV1PortfolioClientsValueSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "Partial client name to search for.", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.SimpleValueDto" }, "xml": { "name": "SimpleValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/Value/Search/LastName": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a simple list of clients (including aum for today) that the logged in user has access to where the clients lastname begins with the search string.", "operationId": "Clients_GetValueClientSearchByLastNameAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "Partial client name to search for.", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.SimpleValueDto" }, "xml": { "name": "SimpleValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/Value/Search/LastName/{search}": { "get": { "tags": [ "Portfolio/Clients" ], "summary": "Gets a simple list of clients (including aum for today) that the logged in user has access to where the clients lastname begins with the search string.", "operationId": "Clients_GetV1PortfolioClientsValueSearchLastNameBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "Partial client name to search for.", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.SimpleValueDto" }, "xml": { "name": "SimpleValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/Verbose": { "get": { "tags": [ "Portfolio/Clients" ], "operationId": "Clients_GetVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isActive", "in": "query", "required": false, "type": "boolean" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Billing", "RecurringAdjustments", "FeePayingAccounts", "Portfolio", "HouseholdMembers", "Notes", "Documents", "AdditionalAccounts", "Suitability", "UserDefinedFields", "EntityOptions", "TargetAllocations", "CreditCard", "AssetExclusion", "PortfolioGroups", "FinancialPlanningFee", "AppLinks", "TieredFeeAccounts", "HouseholdBills", "AdditionalRepresentatives", "ClientChanges", "ClientRepAdditional", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientVerboseDto" }, "xml": { "name": "ClientVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Clients" ], "summary": "Update clients", "operationId": "Clients_UpdateVerboseClientsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "updatedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientVerboseDto" }, "xml": { "name": "ClientVerboseDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientVerboseDto" }, "xml": { "name": "ClientVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/Clients" ], "summary": "Create client", "operationId": "Clients_CreateVerboseClientAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "newDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientVerboseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/Verbose/{key}": { "get": { "tags": [ "Portfolio/Clients" ], "operationId": "Clients_GetVerboseByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Billing", "RecurringAdjustments", "FeePayingAccounts", "Portfolio", "HouseholdMembers", "Notes", "Documents", "AdditionalAccounts", "Suitability", "UserDefinedFields", "EntityOptions", "TargetAllocations", "CreditCard", "AssetExclusion", "PortfolioGroups", "FinancialPlanningFee", "AppLinks", "TieredFeeAccounts", "HouseholdBills", "AdditionalRepresentatives", "ClientChanges", "ClientRepAdditional", "All" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Clients" ], "operationId": "Clients_UpdateVerboseClientAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientVerboseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "patch": { "tags": [ "Portfolio/Clients" ], "summary": "Allows part of the client to be updated", "operationId": "Clients_PatchVerboseClientAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data", "application/json-patch+json" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "patchedItem", "in": "body", "description": "https://github.com/myquay/JsonPatch", "required": true, "schema": { "$ref": "#/definitions/JsonPatch.JsonPatchDocumentOfOAS.WebApi.DTO.Portfolio.ClientVerboseDto" } }, { "name": "appLinkId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "externalIntId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/Verbose/HouseholdBills/{key}": { "get": { "tags": [ "Portfolio/Clients" ], "operationId": "Clients_GetVerboseHouseholdBillsByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Billing", "RecurringAdjustments", "FeePayingAccounts", "Portfolio", "HouseholdMembers", "Notes", "Documents", "AdditionalAccounts", "Suitability", "UserDefinedFields", "EntityOptions", "TargetAllocations", "CreditCard", "AssetExclusion", "PortfolioGroups", "FinancialPlanningFee", "AppLinks", "TieredFeeAccounts", "HouseholdBills", "AdditionalRepresentatives", "ClientChanges", "ClientRepAdditional", "All" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.HouseholdBillDto" }, "xml": { "name": "HouseholdBillDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/Verbose/List": { "post": { "tags": [ "Portfolio/Clients" ], "operationId": "Clients_GetVerboseListById", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Billing", "RecurringAdjustments", "FeePayingAccounts", "Portfolio", "HouseholdMembers", "Notes", "Documents", "AdditionalAccounts", "Suitability", "UserDefinedFields", "EntityOptions", "TargetAllocations", "CreditCard", "AssetExclusion", "PortfolioGroups", "FinancialPlanningFee", "AppLinks", "TieredFeeAccounts", "HouseholdBills", "AdditionalRepresentatives", "ClientChanges", "ClientRepAdditional", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientVerboseDto" }, "xml": { "name": "ClientVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/Verbose/List/Id": { "post": { "tags": [ "Portfolio/Clients" ], "operationId": "Clients_PostV1PortfolioClientsVerboseListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Billing", "RecurringAdjustments", "FeePayingAccounts", "Portfolio", "HouseholdMembers", "Notes", "Documents", "AdditionalAccounts", "Suitability", "UserDefinedFields", "EntityOptions", "TargetAllocations", "CreditCard", "AssetExclusion", "PortfolioGroups", "FinancialPlanningFee", "AppLinks", "TieredFeeAccounts", "HouseholdBills", "AdditionalRepresentatives", "ClientChanges", "ClientRepAdditional", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientVerboseDto" }, "xml": { "name": "ClientVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Clients/Verbose/New": { "get": { "tags": [ "Portfolio/Clients" ], "operationId": "Clients_GetNewVerboseAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Billing", "RecurringAdjustments", "FeePayingAccounts", "Portfolio", "HouseholdMembers", "Notes", "Documents", "AdditionalAccounts", "Suitability", "UserDefinedFields", "EntityOptions", "TargetAllocations", "CreditCard", "AssetExclusion", "PortfolioGroups", "FinancialPlanningFee", "AppLinks", "TieredFeeAccounts", "HouseholdBills", "AdditionalRepresentatives", "ClientChanges", "ClientRepAdditional", "All" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/CompareTool/{entityType}/{entityId}": { "get": { "tags": [ "Portfolio/CompareTool" ], "operationId": "CompareTool_GetCompareToolViewModelAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityType", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/CompareTool/AccountIds/{entityType}/{entityId}": { "get": { "tags": [ "Portfolio/CompareTool" ], "operationId": "CompareTool_GetAccountIdsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityType", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/CorporateActionNotifications": { "get": { "tags": [ "Portfolio/CorporateActionNotifications" ], "operationId": "CorporateActionsNotifications_GetListAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CorpActionNotificationDTO" }, "xml": { "name": "CorpActionNotificationDTO", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/CorporateActionNotifications/{corpActionProcessId}/accounts": { "get": { "tags": [ "Portfolio/CorporateActionNotifications" ], "operationId": "CorporateActionsNotifications_GetAccountsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "corpActionProcessId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CorpActionNotificationAccountDTO" }, "xml": { "name": "CorpActionNotificationAccountDTO", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/CostBasis/Queue/AccountList/Create": { "put": { "tags": [ "Portfolio/CostBasis" ], "summary": "Creates Orion Stored Cost Basis Queues for all the assets for the given list of accounts", "description": "Sample Request\r\n PUT /Portfolio/CostBasis/Queue/AccountList/Create\r\n {\r\n \"accountIds\": [1234]\r\n }\r\n or\r\n PUT /Portfolio/CostBasis/Queue/AccountList/Create?orionLastUpdate=12/31/2010\r\n {\r\n \"accountIds\": [1234]\r\n }", "operationId": "OrionStoredCostBasisQueue_AccountListCreateManyAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountIds", "in": "body", "description": "List of Accounts to lookup assets to create", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "orionLastUpdate", "in": "query", "description": "Override OrionLastUpdate date if granted the privilege", "required": false, "type": "string", "format": "date-time" }, { "name": "ct", "in": "header", "description": "Cancellation Token", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/CostBasis/Queue/AssetList/Create": { "put": { "tags": [ "Portfolio/CostBasis" ], "summary": "Creates Orion Stored Cost Basis Queues for a list of assets", "description": "Sample Request\r\n PUT /Portfolio/CostBasis/Queue/AssetList/Create\r\n {\r\n \"assetIds\": [1234]\r\n }", "operationId": "OrionStoredCostBasisQueue_AssetListCreateManyAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "assetIds", "in": "body", "description": "List of assets to create", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/CostBasis/Queue/List": { "get": { "tags": [ "Portfolio/CostBasis" ], "summary": "Gets the list of Orion Stored Cost Basis Queue that the user has access to", "description": "Sample Request\r\n\tGET /Portfolio/CostBasis/Queue/List\r\n\t{\r\n\t\t\"startDate\": \"12/31/2009\",\r\n\t\t\"endDate\": \"04/10/2023\"\r\n\t}", "operationId": "OrionStoredCostBasisQueue_GetListAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "description": "Start Date to filter from", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "End Date to filter to", "required": false, "type": "string", "format": "date-time" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.OrionStoredCostBasisQueueDto" }, "xml": { "name": "OrionStoredCostBasisQueueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Counts": { "get": { "tags": [ "Portfolio/Counts" ], "summary": "Endpoint to get counts for all filters", "operationId": "Portfolio_GetCounts", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "isActive", "in": "query", "description": "Optional. Default: null. If provided returns only the active (true) or inactive clients (false).", "required": false, "type": "boolean" }, { "name": "resetCache", "in": "query", "description": "Optional. Default: false. The result is cached for thirty minutes. To force the cache to refresh call with resetCache = true.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PorfolioCountsDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/CrmDocuments/Categories": { "get": { "tags": [ "Portfolio/CrmDocuments" ], "operationId": "CrmDocuments_GetCategories", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/CustodianRealized": { "get": { "tags": [ "Portfolio/CustodianRealized" ], "summary": "TODO", "operationId": "CustodianRealized_GetListFiltered", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "query", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "downloadFormatId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "downloadSourceId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "auditType", "in": "query", "required": false, "items": { "type": "string", "enum": [ "CustodialRealizedSharesDoNotMatch", "CustodialRealizedMissing", "CustodialUnrealizedMissing", "CustodialRealizedUnknownAcquiredDate", "CustodialUnrealizedUnknownAcquiredDate", "CustodialRealizedUnknownCostBasis", "CustodialUnrealizedUnknownCostBasis", "OrionUnknownCostBasis", "MoneyMarketProducts", "OrionMissingCostBasis" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "hasErrors", "in": "query", "required": false, "type": "boolean" }, { "name": "assetHasErrors", "in": "query", "required": false, "type": "boolean" }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "WithErrors" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.CustodianRealizedDto" }, "xml": { "name": "CustodianRealizedDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/CustodianRealized" ], "operationId": "CustodianRealized_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.CustodianRealizedDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.CustodianRealizedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/CustodianRealized/{key}": { "get": { "tags": [ "Portfolio/CustodianRealized" ], "summary": "Gets the custodian realized lot that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "CustodianRealized_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "WithErrors" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.CustodianRealizedDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/CustodianRealized" ], "operationId": "CustodianRealized_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.CustodianRealizedDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.CustodianRealizedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/CustodianRealized/Action/Delete": { "put": { "tags": [ "Portfolio/CustodianRealized" ], "operationId": "CustodianRealized_ActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Custodians": { "get": { "tags": [ "Portfolio/Custodians" ], "summary": "Gets a list of custodians that the logged in user has access to.", "operationId": "Custodians_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CustodianDto" }, "xml": { "name": "CustodianDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Custodians/{key}": { "get": { "tags": [ "Portfolio/Custodians" ], "summary": "Gets the custodian that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Custodians_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CustodianDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Custodians/{key}/Accounts": { "get": { "tags": [ "Portfolio/Custodians" ], "summary": "Gets a list of accounts that fall below the custodian with the specified key, which the logged in user has access to.", "operationId": "Custodians_GetAccountsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountDto" }, "xml": { "name": "AccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Custodians/{key}/Accounts/Value": { "get": { "tags": [ "Portfolio/Custodians" ], "summary": "Gets a simple list of accounts (including aum for today) that fall below the custodian with the specified key, which the logged in user has access to.", "operationId": "Custodians_GetAccountsValue", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return accounts that have value (true) or don't have value (false).", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Custodians/{key}/Accounts/Value/{asOfDate}": { "get": { "tags": [ "Portfolio/Custodians" ], "summary": "Gets a simple list of accounts (including aum for the end of the date specified) that fall below the custodian with the specified key, which the logged in user has access to.", "operationId": "Custodians_GetAccountsValueAsOfDate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return accounts that have value (true) or don't have value (false).", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Custodians/CheckCutoffTimes": { "put": { "tags": [ "Portfolio/Custodians" ], "summary": "Compares the current time to the custodian cutoff time in the entity options and returns and warning message if the current time is later than the cutoff time plus buffer of 5 minutes.\r\nAdded all of the rights that are also used with any of the calls to generate trades because after generate trades in called, this call is made. This call shouldn't fail at that point.", "operationId": "Custodians_CheckCutoffTimesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "Key of the desired custodians to check.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CustodianCutOffError" }, "xml": { "name": "CustodianCutOffError", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Custodians/global": { "get": { "tags": [ "Portfolio/Custodians" ], "operationId": "Custodians_GetGlobalCustodians", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Custodians/Simple": { "get": { "tags": [ "Portfolio/Custodians" ], "summary": "Gets a simple list of custodians that the logged in user has access to.", "operationId": "Custodians_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return clients that have value (true) or don't have value (false).", "required": false, "type": "boolean" }, { "name": "fixEnabled", "in": "query", "description": "Optional. Default: false. If True, returns only custodians that are Fix Enabled", "required": false, "type": "boolean", "default": false }, { "name": "productType", "in": "query", "description": "Required when fixEnabled = true. Used to find product type specific FIX information.", "required": false, "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, { "name": "fix44", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "billInstanceId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "includeMasterAccountNumber", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleCustodian" }, "xml": { "name": "SimpleCustodian", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Custodians/Simple/Search": { "get": { "tags": [ "Portfolio/Custodians" ], "summary": "Search for specific custodians", "operationId": "Custodians_GetSimpleCustodianSearchAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "Search criteria", "required": true, "type": "string" }, { "name": "top", "in": "query", "description": "Top", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Skip", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "cancellationToken", "in": "header", "description": "Cancellation Token", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleCustodian" }, "xml": { "name": "SimpleCustodian", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Custodians/Simple/Search/{search}": { "get": { "tags": [ "Portfolio/Custodians" ], "summary": "Search for specific custodians", "operationId": "Custodians_GetV1PortfolioCustodiansSimpleSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "Search criteria", "required": true, "type": "string" }, { "name": "top", "in": "query", "description": "Top", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Skip", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "cancellationToken", "in": "header", "description": "Cancellation Token", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleCustodian" }, "xml": { "name": "SimpleCustodian", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Custodians/Value": { "get": { "tags": [ "Portfolio/Custodians" ], "summary": "Gets a simple list of custodians (including aum for today) that the logged in user has access to.", "operationId": "Custodians_GetValue", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return custodians that have value (true) or don't have value (false).", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.SimpleValueDto" }, "xml": { "name": "SimpleValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Custodians/Value/{asOfDate}": { "get": { "tags": [ "Portfolio/Custodians" ], "summary": "Gets a simple list of custodians (including aum for the end of the date specified) that the logged in user has access to.", "operationId": "Custodians_GetValueAsOfDate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return custodians that have value (true) or don't have value (false).", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.SimpleValueDto" }, "xml": { "name": "SimpleValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Custodians/Verbose": { "get": { "tags": [ "Portfolio/Custodians" ], "operationId": "Custodians_GetVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "EntityOptions", "FixTradingSettings", "Algorithms", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CustodianVerboseDto" }, "xml": { "name": "CustodianVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Custodians" ], "operationId": "Custodians_UpdateVerboseCustodiansAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updatedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CustodianVerboseDto" }, "xml": { "name": "CustodianVerboseDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CustodianVerboseDto" }, "xml": { "name": "CustodianVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/Custodians" ], "summary": "Create a custodian", "operationId": "Custodians_CreateVerboseCustodian", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CustodianVerboseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CustodianVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Custodians/Verbose/{key}": { "get": { "tags": [ "Portfolio/Custodians" ], "operationId": "Custodians_GetVerboseByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "EntityOptions", "FixTradingSettings", "Algorithms", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CustodianVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Custodians" ], "operationId": "Custodians_UpdateVerboseCustodianAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CustodianVerboseDto" } }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "allowNullCustodian", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CustodianVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/Custodians" ], "summary": "Used to delete an existing custodian. Upon successful deletion a 204 will be returned.", "operationId": "Custodians_Delete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Custodians/Verbose/List": { "post": { "tags": [ "Portfolio/Custodians" ], "operationId": "Custodians_GetVerboseListById", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "EntityOptions", "FixTradingSettings", "Algorithms", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CustodianVerboseDto" }, "xml": { "name": "CustodianVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Custodians/Verbose/List/Id": { "post": { "tags": [ "Portfolio/Custodians" ], "operationId": "Custodians_PostV1PortfolioCustodiansVerboseListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "EntityOptions", "FixTradingSettings", "Algorithms", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CustodianVerboseDto" }, "xml": { "name": "CustodianVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Custodians/Verbose/New": { "get": { "tags": [ "Portfolio/Custodians" ], "operationId": "Custodians_GetNewVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "EntityOptions", "FixTradingSettings", "Algorithms", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CustodianVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/CustodianUnRealized": { "get": { "tags": [ "Portfolio/CustodianUnRealized" ], "summary": "TODO", "operationId": "CustodianUnrealized_GetListFiltered", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "query", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "downloadFormatId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "downloadSourceId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "auditType", "in": "query", "required": false, "items": { "type": "string", "enum": [ "CustodialRealizedSharesDoNotMatch", "CustodialRealizedMissing", "CustodialUnrealizedMissing", "CustodialRealizedUnknownAcquiredDate", "CustodialUnrealizedUnknownAcquiredDate", "CustodialRealizedUnknownCostBasis", "CustodialUnrealizedUnknownCostBasis", "OrionUnknownCostBasis", "MoneyMarketProducts", "OrionMissingCostBasis" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "asOfDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "hasErrors", "in": "query", "required": false, "type": "boolean" }, { "name": "assetHasErrors", "in": "query", "required": false, "type": "boolean" }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "WithErrors" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.CustodianUnrealizedDto" }, "xml": { "name": "CustodianUnrealizedDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/CustodianUnRealized" ], "operationId": "CustodianUnrealized_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.CustodianUnrealizedDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.CustodianUnrealizedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/CustodianUnRealized/{key}": { "get": { "tags": [ "Portfolio/CustodianUnRealized" ], "summary": "Gets the custodian unrealized lot that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "CustodianUnrealized_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "WithErrors" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.CustodianUnrealizedDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/CustodianUnRealized" ], "operationId": "CustodianUnrealized_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.CustodianUnrealizedDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.CustodianUnrealizedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/CustodianUnRealized/Action/Delete": { "put": { "tags": [ "Portfolio/CustodianUnRealized" ], "operationId": "CustodianUnrealized_ActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/CustodianUnRealized/Verbose": { "get": { "tags": [ "Portfolio/CustodianUnRealized" ], "operationId": "CustodianUnrealized_GetVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "AdditionalInformation", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.CustodianUnrealizedVerboseDto" }, "xml": { "name": "CustodianUnrealizedVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/CustodianUnRealized" ], "operationId": "CustodianUnrealized_CreateVerboseCustodianUnrealized", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.CustodianUnrealizedVerboseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.CustodianUnrealizedVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/CustodianUnRealized/Verbose/{key}": { "get": { "tags": [ "Portfolio/CustodianUnRealized" ], "operationId": "CustodianUnrealized_GetVerboseByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "AdditionalInformation", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.CustodianUnrealizedVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/CustodianUnRealized" ], "operationId": "CustodianUnrealized_UpdateVerboseCustodianUnrealized", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.CustodianUnrealizedVerboseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.CustodianUnrealizedVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/CustodianUnRealized" ], "summary": "Used to delete an existing Custodian Unrealized. Upon successful deletion a 204 will be returned.", "operationId": "CustodianUnrealized_Delete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Element/NewAccount/{newAccountId}/NewAccountNewPortfolio": { "post": { "tags": [ "Portfolio/Element" ], "operationId": "NewAccounts_CreateNewAccountNewPortfolioAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "newAccountId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Element/NewAccount/{newAccountId}/NewAccountRegistration": { "post": { "tags": [ "Portfolio/Element" ], "operationId": "NewAccounts_CreateNewAccountRegistrationAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "newAccountId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Element/NewHousehold/{newHouseholdId}/blob": { "post": { "tags": [ "Portfolio/Element" ], "operationId": "NewHouseholds_AddBlob", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "newHouseholdId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "newHouseholdFile", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.NewHouseholdFileDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Element/NewHousehold/{newHouseholdId}/blob/{blobId}": { "get": { "tags": [ "Portfolio/Element" ], "operationId": "NewHouseholds_GetBlob", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "newHouseholdId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "blobId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Esg/Restriction/Mappings": { "get": { "tags": [ "Portfolio/Esg" ], "operationId": "Esg_GetEsgRestrictionMappingsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Esg/Restriction/Securities/{categoryId}": { "get": { "tags": [ "Portfolio/Esg" ], "operationId": "Esg_GetEsgSecuritiesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "categoryId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/FundFamilies": { "get": { "tags": [ "Portfolio/FundFamilies" ], "summary": "Gets a list of fund families that the logged in user has access to.", "operationId": "FundFamilies_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "isUsed", "in": "query", "description": "Optional. When provided will only return fund families that are used (true) or are not used (false).", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.FundFamilyDto" }, "xml": { "name": "FundFamilyDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/FundFamilies" ], "summary": "Add fund families to current database.", "operationId": "FundFamilies_AddFundFamilies", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "fundFamilies", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.FundFamilyWithErrorsDto" }, "xml": { "name": "FundFamilyWithErrorsDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/FundFamilies" ], "summary": "Remove a collection of fund family from current database.", "operationId": "FundFamilies_DeleteFundFamilies", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "fundFamilies", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.FundFamilyWithErrorsDto" }, "xml": { "name": "FundFamilyWithErrorsDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/FundFamilies/{key}": { "get": { "tags": [ "Portfolio/FundFamilies" ], "summary": "Gets the fund families that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "FundFamilies_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.FundFamilyDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/FundFamilies" ], "summary": "Remove fund family from current database.", "operationId": "FundFamilies_DeleteByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/FundFamilies/{key}/Accounts": { "get": { "tags": [ "Portfolio/FundFamilies" ], "summary": "Gets a list of accounts that fall below the fund family with the specified key, which the logged in user has access to.", "operationId": "FundFamilies_GetAccountsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountDto" }, "xml": { "name": "AccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/FundFamilies/{key}/Accounts/Value": { "get": { "tags": [ "Portfolio/FundFamilies" ], "summary": "Gets a simple list of accounts (including aum for today) that fall below the fund family with the specified key, which the logged in user has access to.", "operationId": "FundFamilies_GetAccountsValue", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return accounts that have value (true) or don't have value (false).", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/FundFamilies/{key}/Accounts/Value/{asOfDate}": { "get": { "tags": [ "Portfolio/FundFamilies" ], "summary": "Gets a simple list of accounts (including aum for the end of the date specified) that fall below the fund family with the specified key, which the logged in user has access to.", "operationId": "FundFamilies_GetAccountsValueAsOfDate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return accounts that have value (true) or don't have value (false).", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/FundFamilies/{key}/CustodianTradeFileFormats": { "get": { "tags": [ "Portfolio/FundFamilies" ], "summary": "Gets a list of custodian trade file formats assigned to the fund family.", "operationId": "FundFamilies_GetCustodianTradeFileFormats", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.CustodianTradeFileFormat" }, "xml": { "name": "CustodianTradeFileFormat", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/FundFamilies/{key}/UserDefinedFields": { "get": { "tags": [ "Portfolio/FundFamilies" ], "operationId": "FundFamilies_GetUserDefinedFields", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "entities", "in": "query", "required": false, "items": { "type": "string", "enum": [ "BrokerDealers", "Wholesalers", "Representatives", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Products", "FundFamilies", "ModelRanges", "PortfolioGroups" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/FundFamilies/CollectFmtSimple": { "get": { "tags": [ "Portfolio/FundFamilies" ], "summary": "Gets a simple list of collection formats that the logged in user has access to.", "operationId": "FundFamilies_GetCollectoFormatSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/FundFamilies/CollectMethodSimple": { "get": { "tags": [ "Portfolio/FundFamilies" ], "summary": "Gets a simple list of collection formats that the logged in user has access to.", "operationId": "FundFamilies_CollectMethodSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/FundFamilies/Create": { "post": { "tags": [ "Portfolio/FundFamilies" ], "summary": "Saves new FundFamily", "operationId": "FundFamilies_CreateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "fundFamilyDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.FundFamilyDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.FundFamilyDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/FundFamilies/EndResultTradeFormats": { "get": { "tags": [ "Portfolio/FundFamilies" ], "summary": "Gets a list of trade formats with end results that the logged in user has access to.", "operationId": "FundFamilies_GetEndResultTradeFormatsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TradeFormatDto" }, "xml": { "name": "TradeFormatDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/FundFamilies/EndResultTradeFormats/Simple": { "get": { "tags": [ "Portfolio/FundFamilies" ], "summary": "Gets a simple list of trade formats with end results that the logged in user has access to. Often used for dropdowns.", "operationId": "FundFamilies_GetEndResultTradeFormatsSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/FundFamilies/Simple": { "get": { "tags": [ "Portfolio/FundFamilies" ], "summary": "Gets a simple list of fund families that the logged in user has access to.", "operationId": "FundFamilies_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isUsed", "in": "query", "description": "Optional. When provided will only return fund families that are used (true) or are not used (false).", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/FundFamilies/Simple/Search": { "get": { "tags": [ "Portfolio/FundFamilies" ], "summary": "Gets a simple list of fund families.", "description": "Sample Request\r\n\tGET /Simple/Search/{search}", "operationId": "FundFamilies_GetSimpleFundFamilySearchAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "the text to be searched", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/FundFamilies/Simple/Search/{search}": { "get": { "tags": [ "Portfolio/FundFamilies" ], "summary": "Gets a simple list of fund families.", "description": "Sample Request\r\n\tGET /Simple/Search/{search}", "operationId": "FundFamilies_GetV1PortfolioFundFamiliesSimpleSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "the text to be searched", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/FundFamilies/TradeFormats/Simple": { "get": { "tags": [ "Portfolio/FundFamilies" ], "summary": "Gets a simple list of trade formats that the logged in user has access to. Often used for dropdowns.", "operationId": "FundFamilies_GetTradeFormatsSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/FundFamilies/Update": { "put": { "tags": [ "Portfolio/FundFamilies" ], "summary": "Update fund family", "operationId": "FundFamilies_UpdateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "fundFamilyDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.FundFamilyDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.FundFamilyDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/FundFamilies/Value": { "get": { "tags": [ "Portfolio/FundFamilies" ], "summary": "Gets a simple list of fund families (including aum for today) that the logged in user has access to.", "operationId": "FundFamilies_GetValue", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.SimpleValueDto" }, "xml": { "name": "SimpleValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/FundFamilies/Value/{asOfDate}": { "get": { "tags": [ "Portfolio/FundFamilies" ], "summary": "Gets a simple list of fund families (including aum for the end of the date specified) that the logged in user has access to.", "operationId": "FundFamilies_GetValueAsOfDate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.SimpleValueDto" }, "xml": { "name": "SimpleValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Genders": { "get": { "tags": [ "Portfolio/Genders" ], "summary": "Gets a simple list of genders that the logged in user has access to.", "operationId": "Genders_GetGenders", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.Domains.Portfolio.Gender" }, "xml": { "name": "Gender", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Genders/Simple": { "get": { "tags": [ "Portfolio/Genders" ], "summary": "Gets a simple list of genders that the logged in user has access to.", "operationId": "Genders_GetV1PortfolioGendersSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.Domains.Portfolio.Gender" }, "xml": { "name": "Gender", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Goals": { "get": { "tags": [ "Portfolio/Goals" ], "summary": "Update a goal.", "operationId": "Goal_GetAllAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.GoalDto" }, "xml": { "name": "GoalDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/Goals" ], "summary": "Create new goal.", "operationId": "Goal_CreateGoalAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "goal", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.GoalDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Goals/{key}": { "get": { "tags": [ "Portfolio/Goals" ], "summary": "Find goal by id.", "operationId": "Goal_FindAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.GoalDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Goals" ], "summary": "Update an existing goal.", "operationId": "Goal_UpdateGoalAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.GoalDto" } }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.GoalDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/Goals" ], "summary": "Delete goal by id.", "operationId": "Goal_DeleteGoalAsync", "consumes": [], "produces": [], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Goals/Types": { "get": { "tags": [ "Portfolio/Goals" ], "summary": "Return goal types.", "operationId": "Goal_GetGoalTypesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.GoalType" }, "xml": { "name": "GoalType", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/HouseholdMemberTypes": { "get": { "tags": [ "Portfolio/HouseholdMemberTypes" ], "summary": "Gets a list of household member types.", "operationId": "HouseholdMemberTypes_GetHouseholdMemberTypes", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "includeCommonOptions", "in": "query", "description": "Optional. Default: True. If true the return list will include existing household member types as well as \"Husband\", \"Wife\", \"Son\", and \"Daughter\". If false the return list will include only existing household member types.", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/IndexBlends": { "get": { "tags": [ "Portfolio/IndexBlends" ], "summary": "Gets a list of index blends that the logged in user has access to.", "operationId": "IndexBlends_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.IndexBlendDto" }, "xml": { "name": "IndexBlendDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/IndexBlends" ], "summary": "Used to create a new index blend.", "operationId": "IndexBlends_Create", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.IndexBlendFullDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.IndexBlendFullDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/IndexBlends/{key}": { "get": { "tags": [ "Portfolio/IndexBlends" ], "summary": "Gets the index blend that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "IndexBlends_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.IndexBlendFullDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/IndexBlends" ], "summary": "Used to update an existing index blend. Upon successful modification a 200 will be returned.", "operationId": "IndexBlends_UpdateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.IndexBlendFullDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.IndexBlendFullDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/IndexBlends" ], "summary": "Used to delete an existing index blend. Upon successful deletion a 204 will be returned.", "operationId": "IndexBlends_DeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/IndexBlends/{key}/DateRanges": { "get": { "tags": [ "Portfolio/IndexBlends" ], "operationId": "IndexBlends_GetDateRangesByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.IndexBlendDetailDateRange" }, "xml": { "name": "IndexBlendDetailDateRange", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/IndexBlends/{key}/Intervals": { "get": { "tags": [ "Portfolio/IndexBlends" ], "operationId": "IndexBlends_GetIntervalsByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/IndexBlends/Simple": { "get": { "tags": [ "Portfolio/IndexBlends" ], "summary": "Gets a simple list of index blends that the logged in user has access to.", "operationId": "IndexBlends_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/InvestmentObjectives": { "get": { "tags": [ "Portfolio/InvestmentObjectives" ], "operationId": "InvestmentObjectives_GetAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.InvestmentObjectiveDto" }, "xml": { "name": "InvestmentObjectiveDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/InvestmentObjectives" ], "operationId": "InvestmentObjectives_UpdateObjectives", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "objectives", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.InvestmentObjectiveDto" }, "xml": { "name": "InvestmentObjectiveDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.InvestmentObjectiveDto" }, "xml": { "name": "InvestmentObjectiveDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/InvestmentObjectives/{key}": { "delete": { "tags": [ "Portfolio/InvestmentObjectives" ], "operationId": "InvestmentObjectives_DeleteObjective", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/InvestmentObjectives/Simple": { "get": { "tags": [ "Portfolio/InvestmentObjectives" ], "summary": "Method to get all investment objectives", "operationId": "InvestmentObjectives_GetAllSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/InvestmentObjectives/Verbose": { "get": { "tags": [ "Portfolio/InvestmentObjectives" ], "operationId": "InvestmentObjectives_GetVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "General", "HypotheticalMonthlyPerformanceValue", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.InvestmentObjectiveVerboseDto" }, "xml": { "name": "InvestmentObjectiveVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/InvestmentObjectives" ], "summary": "Update multiple Investment Objectives", "operationId": "InvestmentObjectives_UpdateVerboseInvestmentObjectives", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updatedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.InvestmentObjectiveVerboseDto" }, "xml": { "name": "InvestmentObjectiveVerboseDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.InvestmentObjectiveVerboseDto" }, "xml": { "name": "InvestmentObjectiveVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/InvestmentObjectives" ], "summary": "Create new investment objectives.", "operationId": "InvestmentObjectives_CreateVerboseInvestmentObjective", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.InvestmentObjectiveVerboseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.InvestmentObjectiveVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/InvestmentObjectives/Verbose/{key}": { "get": { "tags": [ "Portfolio/InvestmentObjectives" ], "operationId": "InvestmentObjectives_GetVerboseByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "General", "HypotheticalMonthlyPerformanceValue", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.InvestmentObjectiveVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/InvestmentObjectives" ], "operationId": "InvestmentObjectives_UpdateVerboseInvestmentObjective", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.InvestmentObjectiveVerboseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.InvestmentObjectiveVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/InvestmentObjectives/Verbose/New": { "get": { "tags": [ "Portfolio/InvestmentObjectives" ], "operationId": "InvestmentObjectives_GetNewVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "General", "HypotheticalMonthlyPerformanceValue", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.InvestmentObjectiveVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Locale": { "get": { "tags": [ "Portfolio/Locale" ], "summary": "Get all Locales", "operationId": "Locale_GetAllItemsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.LocaleDto" }, "xml": { "name": "LocaleDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Locale/Available": { "get": { "tags": [ "Portfolio/Locale" ], "operationId": "Locale_GetLocaleInformationAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.LocaleDto" }, "xml": { "name": "LocaleDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Locale/Simple": { "get": { "tags": [ "Portfolio/Locale" ], "operationId": "Locale_GetAllLocaleInformationAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Managers": { "get": { "tags": [ "Portfolio/Managers" ], "summary": "Get all Managers", "operationId": "Managers_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ManagerDto" }, "xml": { "name": "ManagerDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/Managers" ], "summary": "Adds a new Manager to the database.", "operationId": "Managers_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "Manager object to update", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ManagerDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ManagerDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Managers/{key}": { "get": { "tags": [ "Portfolio/Managers" ], "summary": "Gets the Manager that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Managers_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ManagerDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Managers" ], "summary": "Updates the Manager that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Managers_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired update object.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "Manager object to update", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ManagerDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ManagerDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/Managers" ], "summary": "Deletes the specified Manager from the database.", "operationId": "Managers_DeleteEntity", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the Manager.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Managers/Simple": { "get": { "tags": [ "Portfolio/Managers" ], "summary": "Get all Managers", "operationId": "Managers_GetAllSimpleItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/MatrixB50": { "get": { "tags": [ "Portfolio/MatrixB50" ], "operationId": "MatrixB50_GetData", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startCreatedDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endCreatedDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "status", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.MatrixB50Dto" }, "xml": { "name": "MatrixB50Dto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/MatrixB50/List/UpdateStatus": { "put": { "tags": [ "Portfolio/MatrixB50" ], "operationId": "MatrixB50_UpdateStatusAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "token", "in": "header", "required": true }, { "name": "status", "in": "query", "required": true, "type": "string" }, { "name": "idList", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/MatrixB50/Status": { "get": { "tags": [ "Portfolio/MatrixB50" ], "operationId": "MatrixB50_Status", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "includeAll", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/NoteCategories": { "get": { "tags": [ "Portfolio/NoteCategories" ], "summary": "Gets a list of note categories for the entity provided", "operationId": "NoteCategories_GetNoteCategories", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "query", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/OfacChecks": { "get": { "tags": [ "Portfolio/OfacChecks" ], "summary": "Gets a list of OFAC check records that the logged in user has access to.", "operationId": "OfacChecks_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "status", "in": "query", "required": false, "type": "string", "enum": [ "NeedsReview", "NoMatch", "Match" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.OfacCheckDto" }, "xml": { "name": "OfacCheckDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/OfacChecks/{key}": { "get": { "tags": [ "Portfolio/OfacChecks" ], "summary": "Gets the ofac check that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "OfacChecks_GetEntityByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.OfacCheckDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/OfacChecks/Actions/SetStatus": { "put": { "tags": [ "Portfolio/OfacChecks" ], "operationId": "OfacChecks_SetStatusAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ofacIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "status", "in": "query", "required": true, "type": "string", "enum": [ "NeedsReview", "NoMatch", "Match" ] }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/OfacFiles/DownloadOfacFiles": { "get": { "tags": [ "Portfolio/OfacFiles" ], "summary": "Download OFAC Files from to https://www.treasury.gov/resource-center/sanctions/SDN-List/Pages/default.aspx", "operationId": "Ofacs_DownloadOfacFilesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/OrionRealized": { "get": { "tags": [ "Portfolio/OrionRealized" ], "summary": "TODO", "operationId": "OrionRealized_GetListFiltered", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "query", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "downloadFormatId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "downloadSourceId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "auditType", "in": "query", "required": false, "items": { "type": "string", "enum": [ "CustodialRealizedSharesDoNotMatch", "CustodialRealizedMissing", "CustodialUnrealizedMissing", "CustodialRealizedUnknownAcquiredDate", "CustodialUnrealizedUnknownAcquiredDate", "CustodialRealizedUnknownCostBasis", "CustodialUnrealizedUnknownCostBasis", "OrionUnknownCostBasis", "MoneyMarketProducts", "OrionMissingCostBasis" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "hasErrors", "in": "query", "required": false, "type": "boolean" }, { "name": "assetHasErrors", "in": "query", "required": false, "type": "boolean" }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "WithErrors" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.OrionRealizedDto" }, "xml": { "name": "OrionRealizedDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/OrionRealized" ], "operationId": "OrionRealized_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.OrionRealizedDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.OrionRealizedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/OrionRealized/{key}": { "get": { "tags": [ "Portfolio/OrionRealized" ], "summary": "Gets the orion realized lot that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "OrionRealized_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "WithErrors" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.OrionRealizedDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/OrionRealized" ], "operationId": "OrionRealized_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.OrionRealizedDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.OrionRealizedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/OrionRealized/Action/Delete": { "put": { "tags": [ "Portfolio/OrionRealized" ], "operationId": "OrionRealized_ActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/OrionUnrealized": { "get": { "tags": [ "Portfolio/OrionUnrealized" ], "summary": "TODO", "operationId": "OrionUnrealized_GetListFiltered", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "query", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "downloadFormatId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "downloadSourceId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "auditType", "in": "query", "required": false, "items": { "type": "string", "enum": [ "CustodialRealizedSharesDoNotMatch", "CustodialRealizedMissing", "CustodialUnrealizedMissing", "CustodialRealizedUnknownAcquiredDate", "CustodialUnrealizedUnknownAcquiredDate", "CustodialRealizedUnknownCostBasis", "CustodialUnrealizedUnknownCostBasis", "OrionUnknownCostBasis", "MoneyMarketProducts", "OrionMissingCostBasis" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "asOfDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "hasErrors", "in": "query", "required": false, "type": "boolean" }, { "name": "assetHasErrors", "in": "query", "required": false, "type": "boolean" }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "WithErrors" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.OrionUnrealizedDto" }, "xml": { "name": "OrionUnrealizedDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/OrionUnrealized" ], "operationId": "OrionUnrealized_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.OrionUnrealizedDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.OrionUnrealizedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/OrionUnrealized/{key}": { "get": { "tags": [ "Portfolio/OrionUnrealized" ], "summary": "Gets the orion unrealized lot that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "OrionUnrealized_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "WithErrors" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.OrionUnrealizedDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/OrionUnrealized" ], "operationId": "OrionUnrealized_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.OrionUnrealizedDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.OrionUnrealizedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/OrionUnrealized/Action/Delete": { "put": { "tags": [ "Portfolio/OrionUnrealized" ], "operationId": "OrionUnrealized_ActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int64" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int64" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ParentCategories": { "get": { "tags": [ "Portfolio/ParentCategories" ], "summary": "Gets a list of parent categories that the logged in user has access to.", "operationId": "ParentCategories_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ParentCategoryDto" }, "xml": { "name": "ParentCategoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/ParentCategories" ], "operationId": "ParentCategories_CreateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ParentCategoryDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ParentCategories/{key}": { "get": { "tags": [ "Portfolio/ParentCategories" ], "operationId": "ParentCategories_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ParentCategoryDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/ParentCategories" ], "operationId": "ParentCategories_UpdateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ParentCategoryDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/ParentCategories" ], "operationId": "ParentCategories_DeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Participants/Simple": { "get": { "tags": [ "Portfolio/Participants" ], "operationId": "Participants_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PlanAdministrators": { "get": { "tags": [ "Portfolio/PlanAdministrators" ], "operationId": "PlanAdministrators_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlanAdministratorDto" }, "xml": { "name": "PlanAdministratorDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/PlanAdministrators" ], "operationId": "PlanAdministrators_Create", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlanAdministratorDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlanAdministratorDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PlanAdministrators/{key}": { "get": { "tags": [ "Portfolio/PlanAdministrators" ], "operationId": "PlanAdministrators_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlanAdministratorDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/PlanAdministrators" ], "operationId": "PlanAdministrators_Update", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlanAdministratorDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlanAdministratorDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/PlanAdministrators" ], "operationId": "PlanAdministrators_Delete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PlanAdministrators/Action/Delete": { "put": { "tags": [ "Portfolio/PlanAdministrators" ], "operationId": "PlanAdministrators_PutV1PortfolioPlanAdministratorsActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "paIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PlanAdministrators/Simple": { "get": { "tags": [ "Portfolio/PlanAdministrators" ], "summary": "Gets a simple list of plans that the logged in user has access to.", "operationId": "PlanAdministrators_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Plans": { "get": { "tags": [ "Portfolio/Plans" ], "summary": "Gets a list of plans that the logged in user has access to.", "operationId": "Plans_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlanDto" }, "xml": { "name": "PlanDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Plans/{key}": { "get": { "tags": [ "Portfolio/Plans" ], "summary": "Gets the plan that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Plans_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlanDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Plans/{planId}/Participants": { "post": { "tags": [ "Portfolio/Plans" ], "operationId": "Plans_CreateParticipantAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "planId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlanParticipantAddDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ParticipantAccountDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Plans/{planId}/Participants/Validate": { "post": { "tags": [ "Portfolio/Plans" ], "operationId": "Plans_ValidateParticipantAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "planId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlanParticipantAddDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlanParticipantValidationResultDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Plans/{planId}/Sponsor/SSNTaxId": { "put": { "tags": [ "Portfolio/Plans" ], "summary": "Update plan summary tax id.", "operationId": "Plans_UpdatePlanSummarySSNTaxId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "planId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updateInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.UpdateSsnDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Plans/Qualified/{registrationTypeId}": { "get": { "tags": [ "Portfolio/Plans" ], "summary": "Gets a simple list of qualified plans that the logged in user has access to.", "operationId": "Plans_GetQualified", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "registrationTypeId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimplePlan" }, "xml": { "name": "SimplePlan", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Plans/Search": { "get": { "tags": [ "Portfolio/Plans" ], "summary": "Gets a list of plans that the logged in user has access to where the plan name begins with the search string or Id is exact match.", "operationId": "Plans_GetSearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "Partial plan name to search for.", "required": true, "type": "string" }, { "name": "top", "in": "query", "description": "Optional. Default: null. The maximum number of plans to return. If null returns all.", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Optional. Default: 0. Defines number of items to skip.", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlanDto" }, "xml": { "name": "PlanDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Plans/Search/{search}": { "get": { "tags": [ "Portfolio/Plans" ], "summary": "Gets a list of plans that the logged in user has access to where the plan name begins with the search string or Id is exact match.", "operationId": "Plans_GetV1PortfolioPlansSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "Partial plan name to search for.", "required": true, "type": "string" }, { "name": "top", "in": "query", "description": "Optional. Default: null. The maximum number of plans to return. If null returns all.", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Optional. Default: 0. Defines number of items to skip.", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlanDto" }, "xml": { "name": "PlanDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Plans/Simple": { "get": { "tags": [ "Portfolio/Plans" ], "summary": "Gets a simple list of plans that the logged in user has access to.", "operationId": "Plans_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimplePlan" }, "xml": { "name": "SimplePlan", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Plans/Verbose": { "get": { "tags": [ "Portfolio/Plans" ], "operationId": "Plans_GetVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Personal", "Sponsor", "Platforms", "Participants", "Fees", "Representatives", "Notes", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlanVerboseDto" }, "xml": { "name": "PlanVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Plans" ], "summary": "Update a list of plan summary.", "operationId": "Plans_UpdateVerbosePlans", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updatedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlanVerboseDto" }, "xml": { "name": "PlanVerboseDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlanVerboseDto" }, "xml": { "name": "PlanVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/Plans" ], "summary": "Create a plan", "operationId": "Plans_CreateVerbosePlan", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlanVerboseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlanVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Plans/Verbose/{key}": { "get": { "tags": [ "Portfolio/Plans" ], "operationId": "Plans_GetVerboseByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Personal", "Sponsor", "Platforms", "Participants", "Fees", "Representatives", "Notes", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlanVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Plans" ], "summary": "Update plan summary", "operationId": "Plans_UpdateVerbosePlan", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlanVerboseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlanVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/Plans" ], "summary": "Used to delete an existing plan. Upon successful deletion a 204 will be returned.", "operationId": "Plans_DeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Plans/Verbose/List": { "post": { "tags": [ "Portfolio/Plans" ], "operationId": "Plans_GetVerboseListById", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Personal", "Sponsor", "Platforms", "Participants", "Fees", "Representatives", "Notes", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlanVerboseDto" }, "xml": { "name": "PlanVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Plans/Verbose/List/Id": { "post": { "tags": [ "Portfolio/Plans" ], "operationId": "Plans_PostV1PortfolioPlansVerboseListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Personal", "Sponsor", "Platforms", "Participants", "Fees", "Representatives", "Notes", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlanVerboseDto" }, "xml": { "name": "PlanVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Plans/Verbose/New": { "get": { "tags": [ "Portfolio/Plans" ], "operationId": "Plans_GetNewVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Personal", "Sponsor", "Platforms", "Participants", "Fees", "Representatives", "Notes", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlanVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PlanSponsors/Simple": { "get": { "tags": [ "Portfolio/PlanSponsors" ], "operationId": "PlanSponsors_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Platforms": { "get": { "tags": [ "Portfolio/Platforms" ], "summary": "Gets a list of platforms that the logged in user has access to.", "operationId": "Platforms_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isActive", "in": "query", "description": "Optional. When provided will only return platforms that are active (true) or aren't active (false).", "required": false, "type": "boolean" }, { "name": "subAdvisorId", "in": "query", "description": "Optional. When provided will only return platforms that this sub advisor uses on their models.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlatformDto" }, "xml": { "name": "PlatformDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/Platforms" ], "summary": "Used to create a new platform. Upon successful creation a 201 will be returned with the location of the newly created platform.", "operationId": "Platforms_CreateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "token", "in": "header", "description": "The token.", "required": true }, { "name": "dto", "in": "body", "description": "The dto.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlatformDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Platforms/{key}": { "get": { "tags": [ "Portfolio/Platforms" ], "summary": "Gets the platform that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Platforms_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlatformDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Platforms" ], "summary": "Used to update an existing product platform. Upon successful modification a 200 will be returned.", "operationId": "Platforms_UpdateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The key.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "The dto.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlatformDto" } }, { "name": "token", "in": "header", "description": "The token.", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlatformDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/Platforms" ], "summary": "Used to delete an existing product platform. Upon successful deletion a 204 will be returned.", "operationId": "Platforms_DeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The key.", "required": true, "type": "integer", "format": "int32" }, { "name": "token", "in": "header", "description": "The token.", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Platforms/{key}/Accounts": { "get": { "tags": [ "Portfolio/Platforms" ], "summary": "Gets a list of accounts that fall below the platform with the specified key, which the logged in user has access to.", "operationId": "Platforms_GetAccountsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountDto" }, "xml": { "name": "AccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Platforms/{key}/Accounts/Value": { "get": { "tags": [ "Portfolio/Platforms" ], "summary": "Gets a simple list of accounts (including aum for today) that fall below the platform with the specified key, which the logged in user has access to.", "operationId": "Platforms_GetAccountsValue", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return accounts that have value (true) or don't have value (false).", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Platforms/{key}/Accounts/Value/{asOfDate}": { "get": { "tags": [ "Portfolio/Platforms" ], "summary": "Gets a simple list of accounts (including aum for the end of the date specified) that fall below the platform with the specified key, which the logged in user has access to.", "operationId": "Platforms_GetAccountsValueAsOfDate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return accounts that have value (true) or don't have value (false).", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Platforms/Search": { "get": { "tags": [ "Portfolio/Platforms" ], "operationId": "Platforms_Search", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "top", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Platforms/Search/{search}": { "get": { "tags": [ "Portfolio/Platforms" ], "operationId": "Platforms_GetV1PortfolioPlatformsSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "required": true, "type": "string" }, { "name": "top", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Platforms/Simple": { "get": { "tags": [ "Portfolio/Platforms" ], "summary": "Gets a simple list of platforms that the logged in user has access to.", "operationId": "Platforms_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isActive", "in": "query", "description": "Optional. When provided will only return platforms that are active (true) or aren't active (false).", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Platforms/Value": { "get": { "tags": [ "Portfolio/Platforms" ], "summary": "Gets a simple list of platforms (including aum for today) that the logged in user has access to.", "operationId": "Platforms_GetValue", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.SimpleValueDto" }, "xml": { "name": "SimpleValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Platforms/Value/{asOfDate}": { "get": { "tags": [ "Portfolio/Platforms" ], "summary": "Gets a simple list of platforms (including aum for the end of the date specified) that the logged in user has access to.", "operationId": "Platforms_GetValueAsOfDate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.SimpleValueDto" }, "xml": { "name": "SimpleValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PlatformTypes": { "get": { "tags": [ "Portfolio/PlatformTypes" ], "summary": "Gets a list of platform typess that the logged in user has access to.", "operationId": "PlatformTypes_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlatformTypeDto" }, "xml": { "name": "PlatformTypeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PlatformTypes/Simple": { "get": { "tags": [ "Portfolio/PlatformTypes" ], "operationId": "PlatformTypes_GetSimpleAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PortfolioAudit/Cache/{key}/LastRefreshDate": { "get": { "tags": [ "Portfolio/PortfolioAudit" ], "summary": "", "operationId": "Portfolio_GetLastRefreshedDate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PortfolioGroupAutomation": { "get": { "tags": [ "Portfolio/PortfolioGroupAutomation" ], "summary": "Get the Portfolio Group Automation Configuration for the current identity", "operationId": "PortfolioGroupAutomation_GetPortfolioAutomationConfigAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.Reporting.FirmJobs.IPortfolioGroupAssignmentAutomationOptions" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/PortfolioGroupAutomation" ], "summary": "Create or update the Portfolio Group Automation Configuration for the current identity", "operationId": "PortfolioGroupAutomation_UpdatePortfolioAutomationConfigAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "The config to create or update", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Reporting.FirmJobs.PortfolioGroupAssignmentAutomationOptions" } }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "runJob", "in": "query", "description": "Set to true to run the Portfolio Group Assignment Automation Job after the update", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PortfolioGroupAutomation/Run": { "post": { "tags": [ "Portfolio/PortfolioGroupAutomation" ], "summary": "Run the Portfolio Group Assignment Automation Job for the current identity client", "operationId": "PortfolioGroupAutomation_RunPortfolioGroupAutomationProcess", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PortfolioGroupAutomation/Run/Household/{householdId}": { "post": { "tags": [ "Portfolio/PortfolioGroupAutomation" ], "summary": "Run the Portfolio Group Assignment Automation Job single household", "operationId": "PortfolioGroupAutomation_RunPortfolioGroupAutomationProcessForHouseholdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "householdId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PortfolioGroups": { "get": { "tags": [ "Portfolio/PortfolioGroups" ], "summary": "Gets a list of portfolio groups that the logged in user has access to.", "operationId": "PortfolioGroups_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "portfolioGroupId", "in": "query", "description": "Optional. When provided only the portfolio group with the specified key will be returned.", "required": false, "type": "integer", "format": "int32" }, { "name": "clientId", "in": "query", "description": "Optional. When provided only portfolio groups for the specified client will be returned.", "required": false, "type": "integer", "format": "int32" }, { "name": "representativeId", "in": "query", "description": "Optional. Default: null. If provided only portfolio groups that fall within the representative specified will be returned.", "required": false, "type": "integer", "format": "int32" }, { "name": "registrationId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "assetId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "transactionId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PortfolioGroupDto" }, "xml": { "name": "PortfolioGroupDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/PortfolioGroups" ], "summary": "", "operationId": "PortfolioGroups_CreateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PortfolioGroupFullDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PortfolioGroupFullDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PortfolioGroups/{key}": { "get": { "tags": [ "Portfolio/PortfolioGroups" ], "summary": "Gets the portfolio group that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "PortfolioGroups_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PortfolioGroupFullDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/PortfolioGroups" ], "summary": "", "operationId": "PortfolioGroups_UpdateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PortfolioGroupFullDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PortfolioGroupFullDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/PortfolioGroups" ], "summary": "", "operationId": "PortfolioGroups_Delete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PortfolioGroups/{key}/Accounts": { "get": { "tags": [ "Portfolio/PortfolioGroups" ], "summary": "Gets a list of registrations that fall below the portfolio group with the specified key, which the logged in user has access to.", "operationId": "PortfolioGroups_GetAccountsPortfolioKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "isActive", "in": "query", "description": "Optional. Default: null. If provided returns only the active (true) or inactive accounts (false).", "required": false, "type": "boolean" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountDto" }, "xml": { "name": "AccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PortfolioGroups/{key}/Assets": { "get": { "tags": [ "Portfolio/PortfolioGroups" ], "summary": "Gets a list of asset that fall below the portfolio group with the specified key, which the logged in user has access to.", "operationId": "PortfolioGroups_GetAssetsPortfolioKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "asOfDate", "in": "query", "description": "Optional. Default: null. If provided the value of the asset on that date will be returned.", "required": false, "type": "string", "format": "date-time" }, { "name": "includeCostBasis", "in": "query", "description": "Optional. Default: false. When true, the Cost Basis property will be populated. This requires extra calculation which will reduce performance when true.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetDto" }, "xml": { "name": "AssetDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PortfolioGroups/{key}/Calculate/InceptionDate": { "post": { "tags": [ "Portfolio/PortfolioGroups" ], "summary": "Used to calculate the appropriate inception date for the provided portfolio group.", "operationId": "PortfolioGroups_CalculateInceptionDateAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "endDate", "in": "query", "description": "Optional. Default: Today. The end date of the reporting period.", "required": false, "type": "string", "format": "date-time" }, { "name": "inclusionOption", "in": "query", "description": "Optional. Default: Database default. Indicates which accounts/registrations to include.", "required": false, "type": "string", "default": -1, "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, { "name": "unmanagedInclusionOption", "in": "query", "description": "Optional. Default: Database default. Indicates how unmanaged assets are handled.", "required": false, "type": "string", "enum": [ "Unmanaged", "Performance", "ActivitySummary", "Allocation", "PortfolioDetail", "TaxDetail" ] }, { "name": "reportCategory", "in": "query", "required": false, "type": "string", "enum": [ "Unmanaged", "Performance", "ActivitySummary", "Allocation", "PortfolioDetail", "TaxDetail" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RunReport.InceptionDateDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PortfolioGroups/{key}/Clients": { "get": { "tags": [ "Portfolio/PortfolioGroups" ], "summary": "Gets a list of clients that fall below the portfolio group with the specified key, which the logged in user has access to.", "operationId": "PortfolioGroups_GetClientsByPortfolioKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "isActive", "in": "query", "description": "Optional. Default: null. If provided returns only the active (true) or inactive clients (false).", "required": false, "type": "boolean" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientDto" }, "xml": { "name": "ClientDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PortfolioGroups/{key}/NetAmountInvested": { "get": { "tags": [ "Portfolio/PortfolioGroups" ], "summary": "", "operationId": "PortfolioGroups_GetPortfolioGroupNetAmountInvestedAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "interval", "in": "query", "required": false, "type": "string", "default": "A" }, { "name": "cancellationToken", "in": "header", "required": false }, { "name": "clientPerformanceInclude", "in": "query", "required": false, "type": "string", "default": -1, "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, { "name": "unmangedInclusionOverride", "in": "query", "required": false, "type": "string", "enum": [ "Unmanaged", "Performance", "ActivitySummary", "Allocation", "PortfolioDetail", "TaxDetail" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AumOverTimeWithNetAmountInvestedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PortfolioGroups/{key}/Registrations": { "get": { "tags": [ "Portfolio/PortfolioGroups" ], "summary": "Gets a list of registrations that fall below the portfolio group with the specified key, which the logged in user has access to.", "operationId": "PortfolioGroups_GetRegistrationsByPortfolioKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "isActive", "in": "query", "description": "Optional. Default: null. If provided returns only the active (true) or inactive registrations (false).", "required": false, "type": "boolean" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationDto" }, "xml": { "name": "RegistrationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PortfolioGroups/{key}/Simple": { "get": { "tags": [ "Portfolio/PortfolioGroups" ], "summary": "Gets the simple portfolio group that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "PortfolioGroups_GetSimpleByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimplePortfolioGroup" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PortfolioGroups/{key}/Transactions": { "get": { "tags": [ "Portfolio/PortfolioGroups" ], "summary": "Gets a list of registrations that fall below the portfolio group with the specified key, which the logged in user has access to.", "operationId": "PortfolioGroups_GetTransactionsByPortfolioKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "startDate", "in": "query", "description": "Optional. Default null. If provided only transaction that come after the start date will be returned.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default null. If provided only transaction that come before the end date will be returned.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionDto" }, "xml": { "name": "TransactionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PortfolioGroups/{key}/UserDefinedFields": { "get": { "tags": [ "Portfolio/PortfolioGroups" ], "operationId": "PortfolioGroups_GetUserDefinedFieldsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "entities", "in": "query", "required": false, "items": { "type": "string", "enum": [ "BrokerDealers", "Wholesalers", "Representatives", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Products", "FundFamilies", "ModelRanges", "PortfolioGroups" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PortfolioGroups/Search": { "get": { "tags": [ "Portfolio/PortfolioGroups" ], "summary": "Gets a list of portfolio groups that the logged in user has access to where the clients first name, lastname, or entityname begins with the search string or Id is exact match.", "operationId": "PortfolioGroups_GetSearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "Partial client name to search for.", "required": true, "type": "string" }, { "name": "top", "in": "query", "description": "Optional. Default: null. The maximum number of products to return. If null returns all.", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Optional. Default: 0. Defines number of items to skip.", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PortfolioGroupDto" }, "xml": { "name": "PortfolioGroupDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PortfolioGroups/Search/{search}": { "get": { "tags": [ "Portfolio/PortfolioGroups" ], "summary": "Gets a list of portfolio groups that the logged in user has access to where the clients first name, lastname, or entityname begins with the search string or Id is exact match.", "operationId": "PortfolioGroups_GetV1PortfolioPortfolioGroupsSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "Partial client name to search for.", "required": true, "type": "string" }, { "name": "top", "in": "query", "description": "Optional. Default: null. The maximum number of products to return. If null returns all.", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Optional. Default: 0. Defines number of items to skip.", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PortfolioGroupDto" }, "xml": { "name": "PortfolioGroupDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PortfolioGroups/Simple": { "get": { "tags": [ "Portfolio/PortfolioGroups" ], "summary": "Gets a simple list of portfolio groups that the logged in user has access to.", "operationId": "PortfolioGroups_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PortfolioGroups/Simple/List": { "post": { "tags": [ "Portfolio/PortfolioGroups" ], "summary": "Gets a simple list of portfolio groups that match one of the keys in the provided list.", "operationId": "PortfolioGroups_GetSimpleListById", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PortfolioGroups/Simple/List/Id": { "post": { "tags": [ "Portfolio/PortfolioGroups" ], "summary": "Gets a simple list of portfolio groups that match one of the keys in the provided list.", "operationId": "PortfolioGroups_PostV1PortfolioPortfolioGroupsSimpleListId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PortfolioGroups/Simple/Search": { "get": { "tags": [ "Portfolio/PortfolioGroups" ], "summary": "Gets a simple list of clients that the logged in user has access to where the clients first name, lastname, or entityname begins with the search string or Id is exact match.", "operationId": "PortfolioGroups_GetSimplePortfolioGroupSearchAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "Partial client name to search for.", "required": true, "type": "string" }, { "name": "top", "in": "query", "description": "Optional. Default: null. The maximum number of products to return. If null returns all.", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Optional. Default: 0. Defines number of items to skip.", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return clients that have value (true) or don't have value (false).", "required": false, "type": "boolean" }, { "name": "isActive", "in": "query", "description": "Optional. Default: null. If provided returns only the active (true) or inactive clients(false).", "required": false, "type": "boolean" }, { "name": "hasEmail", "in": "query", "description": "Optional.", "required": false, "type": "boolean" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimplePortfolioGroupDto" }, "xml": { "name": "SimplePortfolioGroupDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PortfolioGroups/Simple/Search/{search}": { "get": { "tags": [ "Portfolio/PortfolioGroups" ], "summary": "Gets a simple list of clients that the logged in user has access to where the clients first name, lastname, or entityname begins with the search string or Id is exact match.", "operationId": "PortfolioGroups_GetV1PortfolioPortfolioGroupsSimpleSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "Partial client name to search for.", "required": true, "type": "string" }, { "name": "top", "in": "query", "description": "Optional. Default: null. The maximum number of products to return. If null returns all.", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Optional. Default: 0. Defines number of items to skip.", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return clients that have value (true) or don't have value (false).", "required": false, "type": "boolean" }, { "name": "isActive", "in": "query", "description": "Optional. Default: null. If provided returns only the active (true) or inactive clients(false).", "required": false, "type": "boolean" }, { "name": "hasEmail", "in": "query", "description": "Optional.", "required": false, "type": "boolean" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimplePortfolioGroupDto" }, "xml": { "name": "SimplePortfolioGroupDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PortfolioGroups/Verbose": { "post": { "tags": [ "Portfolio/PortfolioGroups" ], "operationId": "PortfolioGroups_CreateVerboseAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PortfolioGroupFullDto" } }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "TargetAllocations", "All" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PortfolioGroupFullDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PortfolioGroups/Verbose/{key}": { "get": { "tags": [ "Portfolio/PortfolioGroups" ], "operationId": "PortfolioGroups_GetVerboseByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "TargetAllocations", "All" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PortfolioGroupFullDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/PortfolioGroups" ], "operationId": "PortfolioGroups_UpdateVerboseAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PortfolioGroupFullDto" } }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "TargetAllocations", "All" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PortfolioGroupFullDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PortfolioGroups/Verbose/New": { "get": { "tags": [ "Portfolio/PortfolioGroups" ], "operationId": "PortfolioGroups_GetNewVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "TargetAllocations", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PortfolioGroupFullDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductCategories": { "get": { "tags": [ "Portfolio/ProductCategories" ], "summary": "Gets a list of product categories that the logged in user has access to.", "operationId": "ProductCategories_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductCategoryDto" }, "xml": { "name": "ProductCategoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/ProductCategories" ], "summary": "Used to create a new product category. Upon successful creation a 201 will be returned with the location of the newly created product category.", "operationId": "ProductCategories_Create", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductCategoryDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductCategories/{key}": { "get": { "tags": [ "Portfolio/ProductCategories" ], "summary": "Gets the product category that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ProductCategories_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductCategoryDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/ProductCategories" ], "summary": "Used to update an existing product category. Upon successful modification a 200 will be returned.", "operationId": "ProductCategories_Update", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductCategoryDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductCategoryDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/ProductCategories" ], "summary": "Used to delete an existing product category. Upon successful deletion a 204 will be returned.", "operationId": "ProductCategories_Delete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductCategories/Action/EstablishColors": { "put": { "tags": [ "Portfolio/ProductCategories" ], "summary": "Generates a random color for every product category that has no color. The ids of any product category affected is returned.", "operationId": "ProductCategories_ActionEstablishColors", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductCategories/Simple": { "get": { "tags": [ "Portfolio/ProductCategories" ], "summary": "Gets a simple list of product categories that the logged in user has access to.", "operationId": "ProductCategories_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductCategories/Simple/Search": { "get": { "tags": [ "Portfolio/ProductCategories" ], "summary": "Gets a simple list of portfolio classes by the search criteria.", "operationId": "ProductCategories_GetSimpleSearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "Product Class Id, Description or Name", "required": true, "type": "string" }, { "name": "top", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductCategories/Simple/Search/{search}": { "get": { "tags": [ "Portfolio/ProductCategories" ], "summary": "Gets a simple list of portfolio classes by the search criteria.", "operationId": "ProductCategories_GetV1PortfolioProductCategoriesSimpleSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "Product Class Id, Description or Name", "required": true, "type": "string" }, { "name": "top", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductCategories/Weighted": { "get": { "tags": [ "Portfolio/ProductCategories" ], "summary": "Gets a list of weighted asset categories that the logged in user has access to.", "operationId": "ProductCategoriesWeighted_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductCategoryWeightedDto" }, "xml": { "name": "ProductCategoryWeightedDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/ProductCategories" ], "summary": "Mass update product categories weights", "operationId": "ProductCategoriesWeighted_UpdateProductCategoryWeights", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updatedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductCategoryWeightedDto" }, "xml": { "name": "ProductCategoryWeightedDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductCategoryWeightedDto" }, "xml": { "name": "ProductCategoryWeightedDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/ProductCategories" ], "summary": "Create weighted product categories", "operationId": "ProductCategoriesWeighted_CreateProductCategoryWeighted", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductCategoryWeightedDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductCategoryWeightedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductCategories/Weighted/{key}": { "get": { "tags": [ "Portfolio/ProductCategories" ], "summary": "Gets a list of weighted asset categories that the logged in user has access to.", "operationId": "ProductCategoriesWeighted_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductCategoryWeightedDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/ProductCategories" ], "summary": "Update weighted product categories", "operationId": "ProductCategoriesWeighted_UpdateProductCategoryWeight", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductCategoryWeightedDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductCategoryWeightedDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/ProductCategories" ], "summary": "Delete product category weight", "operationId": "ProductCategoriesWeighted_DeleteItem", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductCategories/Weighted/Products/{productId}": { "get": { "tags": [ "Portfolio/ProductCategories" ], "summary": "Get all weighted asset categories by product", "operationId": "ProductCategoriesWeighted_GetProductCategoriesWeighted", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductCategoryWeightedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductCategories/Weighted/Products/{productId}/Representative/{representativeId}": { "get": { "tags": [ "Portfolio/ProductCategories" ], "summary": "Get all weighted asset categories by product and representative", "operationId": "ProductCategoriesWeighted_GetProductCategoryWeight", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "representativeId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductCategoryWeightedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductClassAutoAssignOverride": { "get": { "tags": [ "Portfolio/ProductClassAutoAssignOverride" ], "summary": "Gets a list of product class Auto Assign Overrides that the logged in user has access to.", "operationId": "ProductClassAutoAssignOverride_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "providerId", "in": "query", "description": "Optional. Default: null. If provided returns only Auto Assign Overrides for the given product description provider Id.", "required": false, "type": "integer", "format": "int32" }, { "name": "providerAssigned", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassAutoAssignOverrideDto" }, "xml": { "name": "ProductClassAutoAssignOverrideDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/ProductClassAutoAssignOverride" ], "summary": "", "operationId": "ProductClassAutoAssignOverride_Upsert", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "overRecords", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassAutoAssignOverrideDto" }, "xml": { "name": "ProductClassAutoAssignOverrideDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassAutoAssignOverrideDto" }, "xml": { "name": "ProductClassAutoAssignOverrideDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductClassAutoAssignOverride/{providerId}/{abbreviation}": { "get": { "tags": [ "Portfolio/ProductClassAutoAssignOverride" ], "summary": "Gets the product class Auto Assign Override that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ProductClassAutoAssignOverride_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "providerId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "abbreviation", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassAutoAssignOverrideDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductClassAutoAssignOverride/List": { "post": { "tags": [ "Portfolio/ProductClassAutoAssignOverride" ], "summary": "Gets the product class Auto Assign Overrides for the provided keys.", "operationId": "ProductClassAutoAssignOverride_GetListById", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassAutoAssignOverrideKeyDto" }, "xml": { "name": "ProductClassAutoAssignOverrideKeyDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassAutoAssignOverrideDto" }, "xml": { "name": "ProductClassAutoAssignOverrideDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductClassAutoAssignOverride/List/Id": { "post": { "tags": [ "Portfolio/ProductClassAutoAssignOverride" ], "summary": "Gets the product class Auto Assign Overrides for the provided keys.", "operationId": "ProductClassAutoAssignOverride_PostV1PortfolioProductClassAutoAssignOverrideListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassAutoAssignOverrideKeyDto" }, "xml": { "name": "ProductClassAutoAssignOverrideKeyDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassAutoAssignOverrideDto" }, "xml": { "name": "ProductClassAutoAssignOverrideDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductClassAutoAssignOverride/ProductClass/Simple": { "get": { "tags": [ "Portfolio/ProductClassAutoAssignOverride" ], "operationId": "ProductClassAutoAssignOverride_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductClasses": { "get": { "tags": [ "Portfolio/ProductClasses" ], "summary": "Gets a list of product classes that the logged in user has access to.", "operationId": "ProductClasses_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "filter", "in": "query", "description": "Filter product classes by those that are used by assets.", "required": false, "type": "string", "enum": [ "All", "Used", "HasValue" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassDto" }, "xml": { "name": "ProductClassDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductClasses/{key}": { "get": { "tags": [ "Portfolio/ProductClasses" ], "summary": "Gets the product class that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ProductClasses_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductClasses/{key}/Simple": { "get": { "tags": [ "Portfolio/ProductClasses" ], "summary": "Gets the simple product class that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ProductClasses_GetSimpleByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductClasses/Action/EstablishColors": { "put": { "tags": [ "Portfolio/ProductClasses" ], "summary": "Generates a random color for every product class that has no color. The ids of any product class affected is returned.", "operationId": "ProductClasses_ActionEstablishColors", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductClasses/Reset": { "put": { "tags": [ "Portfolio/ProductClasses" ], "operationId": "ProductClasses_ResetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductClasses/Simple": { "get": { "tags": [ "Portfolio/ProductClasses" ], "summary": "Gets a simple list of productClasses that the logged in user has access to.", "operationId": "ProductClasses_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "filter", "in": "query", "required": false, "type": "string", "enum": [ "All", "Used", "HasValue" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductClasses/Simple/Search": { "get": { "tags": [ "Portfolio/ProductClasses" ], "summary": "Gets a simple list of portfolio classes by the search criteria.", "operationId": "ProductClasses_GetSimpleSearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "Product Class Id, Description or Name", "required": true, "type": "string" }, { "name": "top", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleProductClass" }, "xml": { "name": "SimpleProductClass", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductClasses/Simple/Search/{search}": { "get": { "tags": [ "Portfolio/ProductClasses" ], "summary": "Gets a simple list of portfolio classes by the search criteria.", "operationId": "ProductClasses_GetV1PortfolioProductClassesSimpleSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "Product Class Id, Description or Name", "required": true, "type": "string" }, { "name": "top", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleProductClass" }, "xml": { "name": "SimpleProductClass", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductClasses/Verbose": { "get": { "tags": [ "Portfolio/ProductClasses" ], "operationId": "ProductClasses_GetVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "EntityOptions", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassVerboseDto" }, "xml": { "name": "ProductClassVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/ProductClasses" ], "operationId": "ProductClasses_UpdateVerboseAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updatedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassVerboseDto" }, "xml": { "name": "ProductClassVerboseDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassVerboseDto" }, "xml": { "name": "ProductClassVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/ProductClasses" ], "summary": "Create a product class", "operationId": "ProductClasses_CreateVerbose", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassVerboseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductClasses/Verbose/{key}": { "get": { "tags": [ "Portfolio/ProductClasses" ], "operationId": "ProductClasses_GetVerboseByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "EntityOptions", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/ProductClasses" ], "operationId": "ProductClasses_PutV1PortfolioProductClassesVerboseByKey", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassVerboseDto" } }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/ProductClasses" ], "summary": "Used to delete an existing product class. Upon successful deletion a 204 will be returned.", "operationId": "ProductClasses_DeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "reassignKey", "in": "query", "description": "Optional. If provided, will reassociate any products associated to the product class to be deleted to this other product class.\r\n Will also uncheck auto-assign for thos products", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductClasses/Verbose/CanDelete/{key}": { "get": { "tags": [ "Portfolio/ProductClasses" ], "summary": "Gets a list of errors if a delete was attempted on the product class.", "operationId": "ProductClasses_CanDelete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "ID of the product class to check", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.Validation.IValidationError" }, "xml": { "name": "IValidationError", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductClasses/Verbose/List": { "post": { "tags": [ "Portfolio/ProductClasses" ], "operationId": "ProductClasses_GetVerboseListById", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "EntityOptions", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassVerboseDto" }, "xml": { "name": "ProductClassVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductClasses/Verbose/List/Id": { "post": { "tags": [ "Portfolio/ProductClasses" ], "operationId": "ProductClasses_PostV1PortfolioProductClassesVerboseListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "EntityOptions", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassVerboseDto" }, "xml": { "name": "ProductClassVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductClasses/Verbose/New": { "get": { "tags": [ "Portfolio/ProductClasses" ], "operationId": "ProductClasses_GetNewVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "EntityOptions", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductClasses/Weighted": { "get": { "tags": [ "Portfolio/ProductClasses" ], "summary": "Gets a list of weighted asset classes that the logged in user has access to.", "operationId": "ProductClassesWeighted_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassWeightedDto" }, "xml": { "name": "ProductClassWeightedDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/ProductClasses" ], "summary": "Mass update product classes weights", "operationId": "ProductClassesWeighted_UpdateProductClassWeights", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updatedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassWeightedDto" }, "xml": { "name": "ProductClassWeightedDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassWeightedDto" }, "xml": { "name": "ProductClassWeightedDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/ProductClasses" ], "summary": "Create weighted product classes", "operationId": "ProductClassesWeighted_CreateProductClassWeighted", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassWeightedDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassWeightedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductClasses/Weighted/{key}": { "get": { "tags": [ "Portfolio/ProductClasses" ], "summary": "Gets a list of weighted asset classes that the logged in user has access to.", "operationId": "ProductClassesWeighted_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassWeightedDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/ProductClasses" ], "summary": "Update weighted product classes", "operationId": "ProductClassesWeighted_UpdateProductClassWeight", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassWeightedDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassWeightedDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/ProductClasses" ], "summary": "Delete product class weight", "operationId": "ProductClassesWeighted_DeleteItem", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductClasses/Weighted/Products/{productId}": { "get": { "tags": [ "Portfolio/ProductClasses" ], "summary": "Get all weighted asset classes by product", "operationId": "ProductClassesWeighted_GetProductClassesWeighted", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassWeightedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductClasses/Weighted/Products/{productId}/Representative/{representativeId}": { "get": { "tags": [ "Portfolio/ProductClasses" ], "summary": "Get all weighted asset classes by product and representative", "operationId": "ProductClassesWeighted_GetProductClassWeight", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "representativeId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassWeightedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductDescriptionProvider/Assignments": { "get": { "tags": [ "Portfolio/ProductDescriptionProvider" ], "summary": "Gets a list of product description provider assignments that the logged in user has access to.", "operationId": "ProductDescriptionProviderControllerAssignment_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductDescriptionAssignmentDto" }, "xml": { "name": "ProductDescriptionAssignmentDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/ProductDescriptionProvider" ], "operationId": "ProductDescriptionProviderControllerAssignment_UpdateAssignments", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "updatedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductDescriptionAssignmentDto" }, "xml": { "name": "ProductDescriptionAssignmentDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductDescriptionAssignmentDto" }, "xml": { "name": "ProductDescriptionAssignmentDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductDescriptionProvider/Assignments/{key}": { "get": { "tags": [ "Portfolio/ProductDescriptionProvider" ], "summary": "Gets the product description provider assignments for the product type provided.", "operationId": "ProductDescriptionProviderControllerAssignment_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductDescriptionAssignmentDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/ProductDescriptionProvider" ], "operationId": "ProductDescriptionProviderControllerAssignment_UpdateAssignment", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductDescriptionAssignmentDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductDescriptionAssignmentDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductDescriptionProvider/Assignments/RunAutoAssignments": { "post": { "tags": [ "Portfolio/ProductDescriptionProvider" ], "operationId": "ProductDescriptionProviderControllerAssignment_RunAutoAssignments", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductDescriptionProvider/Simple": { "get": { "tags": [ "Portfolio/ProductDescriptionProvider" ], "operationId": "ProductDescriptionProvider_GetSimpleAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductExpenseRatio": { "get": { "tags": [ "Portfolio/ProductExpenseRatio" ], "summary": "Gets a list of Product Expense Ratios", "operationId": "ProductExpenseRatio_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "query", "description": "Optional. If provided, returns only the most recent value by the asOfDate. Use today's date to retrieve only the latest values", "required": false, "type": "string", "format": "date-time" }, { "name": "productId", "in": "query", "description": "Optional. If provided, returns only values for the provided productId", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductExpenseRatioDto" }, "xml": { "name": "ProductExpenseRatioDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products": { "get": { "tags": [ "Portfolio/Products" ], "summary": "Gets a list of local products that the logged in user has access to.\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "Products_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "productFilter", "in": "query", "required": false, "type": "string", "enum": [ "None", "LocalProducts", "CurrentlyOwnedProducts", "HasEverOwnedProducts", "MissingRiskCategories", "MissingAssetClasses", "Top1000BySubType" ] }, { "name": "ownedOnDate", "in": "query", "description": "Optional. Default: null. If provided returns only products that were owned on the date provided.", "required": false, "type": "string", "format": "date-time" }, { "name": "searchTicker", "in": "query", "description": "Optional. Default: null. If provided returns only products with a ticker that contains the text provided.", "required": false, "type": "string" }, { "name": "exactTicker", "in": "query", "description": "Optional. Default: null. If provided returns only products with a ticker that exactly matches the text provided.", "required": false, "type": "string" }, { "name": "exactCusip", "in": "query", "description": "Optional. Default: null. If provided returns only products with a cusip that exactly matches the text provided.", "required": false, "type": "string" }, { "name": "searchCusip", "in": "query", "description": "Optional. Default: null. If provided returns only products with a cusip that contains the text provided.", "required": false, "type": "string" }, { "name": "exactDownloadSymbol", "in": "query", "description": "Optional. Default: null. If provided returns only products with a download symbol that exactly matches the text provided.", "required": false, "type": "string" }, { "name": "searchDownloadSymbol", "in": "query", "description": "Optional. Default: null. If provided returns only products with a download symbol that contains the text provided.", "required": false, "type": "string" }, { "name": "exactSymbol", "in": "query", "description": "Optional. Default: null. If provided returns only products with a ticker, cusip, or download symbol that exactly matches the text provided.", "required": false, "type": "string" }, { "name": "searchSymbol", "in": "query", "description": "Optional. Default: null. If provided returns only products with a ticker, cusip, or download symbol that contains the text provided.", "required": false, "type": "string" }, { "name": "searchName", "in": "query", "description": "Optional. Default: null. If provided returns only products with a name that contains the text provided.", "required": false, "type": "string" }, { "name": "searchId", "in": "query", "description": "Optional. Default: null. If provided returns only products with the id specified.", "required": false, "type": "integer", "format": "int32" }, { "name": "productType", "in": "query", "description": "Optional. Default: null. If provided returns only products that are of the specified type.", "required": false, "items": { "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "isCustodialCash", "in": "query", "description": "Optional. Default: null. If provided returns only products that are (or aren't) custodial cash.", "required": false, "type": "boolean" }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "enum": [ "Standard", "Audit", "BondProductAudit", "Alternative" ] }, { "name": "fundFamilyId", "in": "query", "description": "Optional. Default: null. If provided returns only products that assigned to the provided fund family (not master fund family).", "required": false, "type": "integer", "format": "int32" }, { "name": "bondAuditAsOfDate", "in": "query", "description": "Optional. Default: null. If returnStyle = BondProductAudit then this is the date to use. If not provided Today is used.", "required": false, "type": "string", "format": "date-time" }, { "name": "alternativeOnly", "in": "query", "description": "Optional. Default: false. If true, returns only products that are considered to be alternative.", "required": false, "type": "boolean", "default": false }, { "name": "manipulator", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.LocalProductBaseDto" }, "xml": { "name": "LocalProductBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/{key}": { "get": { "tags": [ "Portfolio/Products" ], "summary": "Gets the local product that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Products_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "enum": [ "Standard", "Audit", "BondProductAudit", "Alternative" ] }, { "name": "bondAuditAsOfDate", "in": "query", "description": "Optional. Default: null. If returnStyle = BondProductAudit then this is the date to use. If not provided Today is used.", "required": false, "type": "string", "format": "date-time" }, { "name": "manipulator", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.LocalProductBaseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/AssetClassificationData": { "post": { "tags": [ "Portfolio/Products" ], "summary": "Get a list of data for provided symbol.", "operationId": "ProductAssetClassificationData_GetAssetDataByTicker", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "tickers", "in": "body", "description": "Array of tickers.", "required": true, "schema": { "items": { "type": "string" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductDescriptionWithMorningstarDataDto" }, "xml": { "name": "ProductDescriptionWithMorningstarDataDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/BondCalls": { "get": { "tags": [ "Portfolio/Products" ], "summary": "Gets a list of Product Bond Call Prices that the logged in user has access to.\r\nThe return is limited to pages of 1000. Use $top and $skip in the query string to page through the data.", "operationId": "ProductsBondCalls_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "query", "description": "Optional. Default null. Product Id of the desired return object.", "required": false, "type": "integer", "format": "int32" }, { "name": "callDate", "in": "query", "description": "Optional. Default null. Call Date of the desired return object.", "required": false, "type": "string", "format": "date-time" }, { "name": "startDate", "in": "query", "description": "Optional. Default null. If provided, returns any bond call that happened on or after the date.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default null. If provided, returns any bond call that happened on or before the date.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductBondCallDto" }, "xml": { "name": "ProductBondCallDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Products" ], "operationId": "ProductsBondCalls_UpdateBondCalls", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updatedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductBondCallDto" }, "xml": { "name": "ProductBondCallDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductBondCallDto" }, "xml": { "name": "ProductBondCallDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/Products" ], "summary": "Used to create a new product bondCall. Upon successful creation a 201 will be returned with the location of the nearly created bond call.", "operationId": "ProductsBondCalls_CreateBondCall", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductBondCallDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductBondCallDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/BondCalls/{productId}/{callDate}": { "get": { "tags": [ "Portfolio/Products" ], "summary": "Gets the product/call date that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ProductsBondCalls_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "path", "description": "Product Id of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "callDate", "in": "path", "description": "Price date of the desired return object.", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductBondCallDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Products" ], "summary": "Used to update an existing bond call. Upon successful modification a 200 will be returned.", "operationId": "ProductsBondCalls_UpdateBondCall", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "path", "description": "Product Id of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "callDate", "in": "path", "description": "Call date of the desired return object.", "required": true, "type": "string", "format": "date-time" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductBondCallDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductBondCallDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/Products" ], "summary": "Used to delete an existing bond call. Upon successful deletion a 204 will be returned.", "operationId": "ProductsBondCalls_DeleteBondCall", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "path", "description": "Product Id of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "callDate", "in": "path", "description": "Call date of the desired return object.", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/BondCalls/Action/Delete": { "put": { "tags": [ "Portfolio/Products" ], "operationId": "ProductsBondCalls_ActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductBondCallKeyDto" }, "xml": { "name": "ProductBondCallKeyDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductBondCallKeyDto" }, "xml": { "name": "ProductBondCallKeyDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/BondCalls/List": { "post": { "tags": [ "Portfolio/Products" ], "operationId": "ProductsBondCalls_CreateBondCalls", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductBondCallDto" }, "xml": { "name": "ProductBondCallDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductBondCallDto" }, "xml": { "name": "ProductBondCallDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/Counts": { "get": { "tags": [ "Portfolio/Products" ], "operationId": "Products_GetCounts", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PorfolioProductCountsDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/Exclusions": { "get": { "tags": [ "Portfolio/Products" ], "summary": "Gets a list of product entity exclusions that the logged in user has access to.\r\nThe return is limited to pages of 10000. Use $top and $skip in the query string to page through the data.", "operationId": "ProductEntityExclusions_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "query", "description": "Optional. The entity to return exclusions for.", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "parentId", "in": "query", "description": "Optional. The specific key of the entity to return for (can only be specified when also specifying entity).", "required": false, "type": "integer", "format": "int32" }, { "name": "productId", "in": "query", "description": "Optional. The product to return exclusions for.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductEntityExclusionDto" }, "xml": { "name": "ProductEntityExclusionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/Products" ], "summary": "Used to create a new Product Entity Exclusion. Upon successful creation a 201 will be returned with the location of the nearly created local price.", "operationId": "ProductEntityExclusions_Create", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductEntityExclusionDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductEntityExclusionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/Exclusions/{key}": { "get": { "tags": [ "Portfolio/Products" ], "summary": "Gets the product entity exclusion that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ProductEntityExclusions_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductEntityExclusionDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Products" ], "summary": "Used to update an existing Product Entity Exclusion. Upon successful modification a 200 will be returned.", "operationId": "ProductEntityExclusions_Update", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Product Entity Exclusion Id of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductEntityExclusionDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductEntityExclusionDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/Products" ], "summary": "Used to delete an existing Product Entity Exclusion. Upon successful deletion a 204 will be returned.", "operationId": "ProductEntityExclusions_Delete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Product Entity Exclusion Id to be deleted", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/Exclusions/ByTickerList": { "post": { "tags": [ "Portfolio/Products" ], "summary": "", "operationId": "ProductEntityExclusions_GetByTickerList", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "tickers", "in": "body", "required": true, "schema": { "items": { "type": "string" }, "type": "array" } }, { "name": "entity", "in": "query", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductEntityExclusionDto" }, "xml": { "name": "ProductEntityExclusionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/Exclusions/EnMasse": { "post": { "tags": [ "Portfolio/Products" ], "operationId": "ProductEntityExclusions_UpdateEnMasse", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "enMasse", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.EnMasseDtoOfOAS.WebApi.DTO.Portfolio.ProductEntityExclusionDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductEntityExclusionDto" }, "xml": { "name": "ProductEntityExclusionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/Grid/Bond/New": { "get": { "tags": [ "Portfolio/Products" ], "summary": "Get a list of Bond audit products that the logged in user has access to\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "description": "Sample Request\r\n GET v1/Portfolio/Products/Grid/New?$top=50000&fundFamilyId=&ownedOnDate=&productFilter=haseverownedproducts&productType=&returnStyle=Standard&searchId=&searchName=&searchSymbol=\r\nReturns: \r\n[\r\n {\r\n \"shareClassName\": \"0\",\r\n \"productCategoryAbbreviation\": \"E\",\r\n \"riskCategoryProductDescriptionProviderName\": null,\r\n \"assetClassProductDescriptionProviderName\": \"Test\",\r\n \"editedBy\": \"test@test.com\",\r\n \"editedDate\": \"2024-01-03\",\r\n \"id\": 1,\r\n \"productName\": \"Test\",\r\n \"ticker\": \"Test\",\r\n \"productType\": \"Stock/ETF\",\r\n \"assetClassDescription\": \"Test\",\r\n \"currentOrionPrice\": 123.12,\r\n \"currentOrionPriceDate\": \"2024-10-28\" \r\n }\r\n]", "operationId": "Products_GetAllBondNewAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "manipulator", "in": "header", "required": true }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "productFilter", "in": "query", "required": false, "type": "string", "enum": [ "None", "LocalProducts", "CurrentlyOwnedProducts", "HasEverOwnedProducts", "MissingRiskCategories", "MissingAssetClasses", "Top1000BySubType" ] }, { "name": "ownedOnDate", "in": "query", "description": "Optional. Default: null. If provided returns only products that were owned on the date provided.", "required": false, "type": "string", "format": "date-time" }, { "name": "searchTicker", "in": "query", "description": "Optional. Default: null. If provided returns only products with a ticker that contains the text provided.", "required": false, "type": "string" }, { "name": "exactTicker", "in": "query", "description": "Optional. Default: null. If provided returns only products with a ticker that exactly matches the text provided.", "required": false, "type": "string" }, { "name": "exactCusip", "in": "query", "description": "Optional. Default: null. If provided returns only products with a cusip that exactly matches the text provided.", "required": false, "type": "string" }, { "name": "searchCusip", "in": "query", "description": "Optional. Default: null. If provided returns only products with a cusip that contains the text provided.", "required": false, "type": "string" }, { "name": "exactDownloadSymbol", "in": "query", "description": "Optional. Default: null. If provided returns only products with a download symbol that exactly matches the text provided.", "required": false, "type": "string" }, { "name": "searchDownloadSymbol", "in": "query", "description": "Optional. Default: null. If provided returns only products with a download symbol that contains the text provided.", "required": false, "type": "string" }, { "name": "exactSymbol", "in": "query", "description": "Optional. Default: null. If provided returns only products with a ticker, cusip, or download symbol that exactly matches the text provided.", "required": false, "type": "string" }, { "name": "searchSymbol", "in": "query", "description": "Optional. Default: null. If provided returns only products with a ticker, cusip, or download symbol that contains the text provided.", "required": false, "type": "string" }, { "name": "searchName", "in": "query", "description": "Optional. Default: null. If provided returns only products with a name that contains the text provided.", "required": false, "type": "string" }, { "name": "searchId", "in": "query", "description": "Optional. Default: null. If provided returns only products with the id specified.", "required": false, "type": "integer", "format": "int32" }, { "name": "productType", "in": "query", "description": "Optional. Default: null. If provided returns only products that are of the specified type.", "required": false, "items": { "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "isCustodialCash", "in": "query", "description": "Optional. Default: null. If provided returns only products that are (or aren't) custodial cash.", "required": false, "type": "boolean" }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "enum": [ "Standard", "Audit", "BondProductAudit", "Alternative" ] }, { "name": "fundFamilyId", "in": "query", "description": "Optional. Default: null. If provided returns only products that assigned to the provided fund family (not master fund family).", "required": false, "type": "integer", "format": "int32" }, { "name": "bondAuditAsOfDate", "in": "query", "description": "Optional. Default: null. If returnStyle = BondProductAudit then this is the date to use. If not provided Today is used.", "required": false, "type": "string", "format": "date-time" }, { "name": "alternativeOnly", "in": "query", "description": "Optional. Default: false. If true, returns only products that are considered to be alternative.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.LocalProductBaseDto" }, "xml": { "name": "LocalProductBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/Grid/New": { "get": { "tags": [ "Portfolio/Products" ], "summary": "Get a list of products that the logged in user has access to\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "description": "Sample Request\r\n GET v1/Portfolio/Products/Grid/New?$top=50000&fundFamilyId=&ownedOnDate=&productFilter=haseverownedproducts&productType=&returnStyle=Standard&searchId=&searchName=&searchSymbol=\r\nReturns: \r\n[\r\n {\r\n \"shareClassName\": \"0\",\r\n \"productCategoryAbbreviation\": \"E\",\r\n \"riskCategoryProductDescriptionProviderName\": null,\r\n \"assetClassProductDescriptionProviderName\": \"Test\",\r\n \"editedBy\": \"test@test.com\",\r\n \"editedDate\": \"2024-01-03\",\r\n \"id\": 1,\r\n \"productName\": \"Test\",\r\n \"ticker\": \"Test\",\r\n \"productType\": \"Stock/ETF\",\r\n \"assetClassDescription\": \"Test\",\r\n \"currentOrionPrice\": 123.12,\r\n \"currentOrionPriceDate\": \"2024-10-28\" \r\n }\r\n]", "operationId": "Products_GetAllNewAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "manipulator", "in": "header", "required": true }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "productFilter", "in": "query", "required": false, "type": "string", "enum": [ "None", "LocalProducts", "CurrentlyOwnedProducts", "HasEverOwnedProducts", "MissingRiskCategories", "MissingAssetClasses", "Top1000BySubType" ] }, { "name": "ownedOnDate", "in": "query", "description": "Optional. Default: null. If provided returns only products that were owned on the date provided.", "required": false, "type": "string", "format": "date-time" }, { "name": "searchTicker", "in": "query", "description": "Optional. Default: null. If provided returns only products with a ticker that contains the text provided.", "required": false, "type": "string" }, { "name": "exactTicker", "in": "query", "description": "Optional. Default: null. If provided returns only products with a ticker that exactly matches the text provided.", "required": false, "type": "string" }, { "name": "exactCusip", "in": "query", "description": "Optional. Default: null. If provided returns only products with a cusip that exactly matches the text provided.", "required": false, "type": "string" }, { "name": "searchCusip", "in": "query", "description": "Optional. Default: null. If provided returns only products with a cusip that contains the text provided.", "required": false, "type": "string" }, { "name": "exactDownloadSymbol", "in": "query", "description": "Optional. Default: null. If provided returns only products with a download symbol that exactly matches the text provided.", "required": false, "type": "string" }, { "name": "searchDownloadSymbol", "in": "query", "description": "Optional. Default: null. If provided returns only products with a download symbol that contains the text provided.", "required": false, "type": "string" }, { "name": "exactSymbol", "in": "query", "description": "Optional. Default: null. If provided returns only products with a ticker, cusip, or download symbol that exactly matches the text provided.", "required": false, "type": "string" }, { "name": "searchSymbol", "in": "query", "description": "Optional. Default: null. If provided returns only products with a ticker, cusip, or download symbol that contains the text provided.", "required": false, "type": "string" }, { "name": "searchName", "in": "query", "description": "Optional. Default: null. If provided returns only products with a name that contains the text provided.", "required": false, "type": "string" }, { "name": "searchId", "in": "query", "description": "Optional. Default: null. If provided returns only products with the id specified.", "required": false, "type": "integer", "format": "int32" }, { "name": "productType", "in": "query", "description": "Optional. Default: null. If provided returns only products that are of the specified type.", "required": false, "items": { "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "isCustodialCash", "in": "query", "description": "Optional. Default: null. If provided returns only products that are (or aren't) custodial cash.", "required": false, "type": "boolean" }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "enum": [ "Standard", "Audit", "BondProductAudit", "Alternative" ] }, { "name": "fundFamilyId", "in": "query", "description": "Optional. Default: null. If provided returns only products that assigned to the provided fund family (not master fund family).", "required": false, "type": "integer", "format": "int32" }, { "name": "bondAuditAsOfDate", "in": "query", "description": "Optional. Default: null. If returnStyle = BondProductAudit then this is the date to use. If not provided Today is used.", "required": false, "type": "string", "format": "date-time" }, { "name": "alternativeOnly", "in": "query", "description": "Optional. Default: false. If true, returns only products that are considered to be alternative.", "required": false, "type": "boolean", "default": false }, { "name": "entity", "in": "query", "description": "Optional. Default: null. If provided filters products based on entity hierarchy (BD > Rep > Client > Registration > Account).", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "query", "description": "Optional. Default: null. If provided with entity, filters products for the specific entity ID.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.LocalProductBaseDto" }, "xml": { "name": "LocalProductBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/HoldingsData": { "post": { "tags": [ "Portfolio/Products" ], "summary": "Get a list of Holdings data for provided symbol.", "operationId": "ProductAssetClassificationData_GetHoldingsDataByTicker", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "data", "in": "body", "description": "Array of tickers and the date of interest.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductsHoldingsData" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductHoldingsDto" }, "xml": { "name": "ProductHoldingsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/Import/Filter": { "post": { "tags": [ "Portfolio/Products" ], "summary": "Allows uploading a list of products to be custom filtered by product ID or download symbol", "operationId": "Products_CustomFilterProductsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "fileData", "in": "body", "description": "File containing either Product ID or Download Symbol column", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ImportFileFilterDto" } }, { "name": "token", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/List": { "post": { "tags": [ "Portfolio/Products" ], "operationId": "Products_GetListByIdAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "enum": [ "Standard", "Audit", "BondProductAudit", "Alternative" ] }, { "name": "bondAuditAsOfDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "manipulator", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.LocalProductBaseDto" }, "xml": { "name": "LocalProductBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/List/Id": { "post": { "tags": [ "Portfolio/Products" ], "operationId": "Products_PostV1PortfolioProductsListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "enum": [ "Standard", "Audit", "BondProductAudit", "Alternative" ] }, { "name": "bondAuditAsOfDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "manipulator", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.LocalProductBaseDto" }, "xml": { "name": "LocalProductBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/List/Id/Minimal": { "post": { "tags": [ "Portfolio/Products" ], "operationId": "Products_GetMinimalProductsById", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.LocalProductMinimalDto" }, "xml": { "name": "LocalProductMinimalDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/List/Id/OrionVision": { "put": { "tags": [ "Portfolio/Products" ], "summary": "Updates Orion Vision Alternative Product Fields", "operationId": "Products_UpdateOrionVisionAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "keys", "in": "body", "description": "Required. List of Product Ids", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "option", "in": "query", "description": "Required. Orion Vision value to update", "required": true, "type": "string", "enum": [ "IsOrionVision", "IsOrionVisionPending" ] }, { "name": "newValue", "in": "query", "description": "Required. new values", "required": true, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductExtensionAlternative" }, "xml": { "name": "ProductExtensionAlternative", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/List/Ticker": { "post": { "tags": [ "Portfolio/Products" ], "summary": "Get a list of products for an array of tickers.", "operationId": "Products_GetListByTickerAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "tickerList", "in": "body", "description": "Array of tickers.", "required": true, "schema": { "items": { "type": "string" }, "type": "array" } }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "enum": [ "Standard", "Audit", "BondProductAudit", "Alternative" ] }, { "name": "bondAuditAsOfDate", "in": "query", "description": "Optional. Default: null. If returnStyle = BondProductAudit then this is the date to use. If not provided Today is used.", "required": false, "type": "string", "format": "date-time" }, { "name": "manipulator", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.LocalProductBaseDto" }, "xml": { "name": "LocalProductBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/NameMappingDST": { "get": { "tags": [ "Portfolio/Products" ], "summary": "Get all PropertyTypes", "operationId": "ProductNameMappingsDst_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductNameMappingDstDto" }, "xml": { "name": "ProductNameMappingDstDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/Products" ], "summary": "Adds a new PropertyType to the database.", "operationId": "ProductNameMappingsDst_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductNameMappingDstDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductNameMappingDstDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/NameMappingDST/{key}": { "get": { "tags": [ "Portfolio/Products" ], "summary": "Gets the PropertyType that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ProductNameMappingsDst_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductNameMappingDstDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Products" ], "summary": "", "operationId": "ProductNameMappingsDst_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired update object.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "Object to update", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductNameMappingDstDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductNameMappingDstDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/Products" ], "summary": "", "operationId": "ProductNameMappingsDst_DeleteEntity", "consumes": [], "produces": [], "parameters": [ { "name": "key", "in": "path", "description": "Key of the object to delete.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/Prices/Local": { "get": { "tags": [ "Portfolio/Products" ], "summary": "Gets a list of local prices that the logged in user has access to.\r\nThe return is limited to pages of 1000. Use $top and $skip in the query string to page through the data.", "operationId": "ProductsPricesLocal_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "query", "description": "Optional. Default null. Product Id of the desired return object.", "required": false, "type": "integer", "format": "int32" }, { "name": "priceDate", "in": "query", "description": "Optional. Default null. Price Date of the desired return object.", "required": false, "type": "string", "format": "date-time" }, { "name": "startDate", "in": "query", "description": "Optional. Default null. If provided, returns any local price on or after the date.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default null. If provided, returns any local price on or before the date.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PriceLocalDto" }, "xml": { "name": "PriceLocalDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Products" ], "operationId": "ProductsPricesLocal_UpsertListAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PriceLocalDto" }, "xml": { "name": "PriceLocalDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/Products" ], "summary": "Used to create a new local price. Upon successful creation a 201 will be returned with the location of the nearly created local price.", "operationId": "ProductsPricesLocal_CreateLocalPrice", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PriceLocalDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/Prices/Local/{productId}/{priceDate}": { "get": { "tags": [ "Portfolio/Products" ], "summary": "Gets the local price that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ProductsPricesLocal_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "path", "description": "Product Id of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "priceDate", "in": "path", "description": "Price date of the desired return object.", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PriceLocalDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Products" ], "summary": "Used to update an existing local price. Upon successful modification a 200 will be returned.", "operationId": "ProductsPricesLocal_UpdateLocalPrice", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "path", "description": "Product Id of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "priceDate", "in": "path", "description": "Price date of the desired return object.", "required": true, "type": "string", "format": "date-time" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PriceLocalDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PriceLocalDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/Products" ], "summary": "Used to delete an existing local price. Upon successful deletion a 204 will be returned.", "operationId": "ProductsPricesLocal_DeleteLocalPrice", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "path", "description": "Product Id of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "priceDate", "in": "path", "description": "Price date of the desired return object.", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/Prices/Local/Action/Delete": { "put": { "tags": [ "Portfolio/Products" ], "operationId": "ProductsPricesLocal_ActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PriceLocalKeyDto" }, "xml": { "name": "PriceLocalKeyDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PriceLocalKeyDto" }, "xml": { "name": "PriceLocalKeyDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/Prices/Local/List": { "post": { "tags": [ "Portfolio/Products" ], "operationId": "ProductsPricesLocal_GetListById", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PriceLocalKeyDto" }, "xml": { "name": "PriceLocalKeyDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PriceLocalDto" }, "xml": { "name": "PriceLocalDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/Prices/Local/List/Id": { "post": { "tags": [ "Portfolio/Products" ], "operationId": "ProductsPricesLocal_PostV1PortfolioProductsPricesLocalListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PriceLocalKeyDto" }, "xml": { "name": "PriceLocalKeyDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PriceLocalDto" }, "xml": { "name": "PriceLocalDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/Search": { "get": { "tags": [ "Portfolio/Products" ], "operationId": "Products_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "top", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "productType", "in": "query", "required": false, "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, { "name": "currentlyOwned", "in": "query", "required": false, "type": "boolean" }, { "name": "currentlyHasValue", "in": "query", "required": false, "type": "boolean" }, { "name": "ownedOn", "in": "query", "required": false, "type": "string" }, { "name": "hasValueOn", "in": "query", "required": false, "type": "string" }, { "name": "accountId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "enabledOnly", "in": "query", "required": false, "type": "boolean" }, { "name": "alternativeOnly", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Search.SearchProductDto" }, "xml": { "name": "SearchProductDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/Search/{search}": { "get": { "tags": [ "Portfolio/Products" ], "operationId": "Products_GetV1PortfolioProductsSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "required": true, "type": "string" }, { "name": "top", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "productType", "in": "query", "required": false, "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, { "name": "currentlyOwned", "in": "query", "required": false, "type": "boolean" }, { "name": "currentlyHasValue", "in": "query", "required": false, "type": "boolean" }, { "name": "ownedOn", "in": "query", "required": false, "type": "string" }, { "name": "hasValueOn", "in": "query", "required": false, "type": "string" }, { "name": "accountId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "enabledOnly", "in": "query", "required": false, "type": "boolean" }, { "name": "alternativeOnly", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Search.SearchProductDto" }, "xml": { "name": "SearchProductDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/Simple/{key}": { "get": { "tags": [ "Portfolio/Products" ], "summary": "Gets the local product that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Products_GetSimpleByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Search.SearchProductDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/Simple/List": { "post": { "tags": [ "Portfolio/Products" ], "operationId": "Products_GetSimpleListById", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/Simple/List/Id": { "post": { "tags": [ "Portfolio/Products" ], "operationId": "Products_PostV1PortfolioProductsSimpleListId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/Verbose": { "get": { "tags": [ "Portfolio/Products" ], "operationId": "Products_GetVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "ProductGroup", "EntityOptions", "UserDefinedFields", "UserDefinedTimeFields", "Billing", "AlternativeExpectedReturns", "Alternative", "AssumedRates", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.LocalProductVerboseDto" }, "xml": { "name": "LocalProductVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Products" ], "operationId": "Products_UpdateVerboseClientsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "updatedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.LocalProductVerboseDto" }, "xml": { "name": "LocalProductVerboseDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.LocalProductVerboseDto" }, "xml": { "name": "LocalProductVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/Products" ], "summary": "Create new local product", "operationId": "Products_CreateLocalProductAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "localProductVerboseDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.LocalProductVerboseDto" } }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.LocalProductVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/Verbose/{key}": { "get": { "tags": [ "Portfolio/Products" ], "operationId": "Products_GetVerboseByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "ProductGroup", "EntityOptions", "UserDefinedFields", "UserDefinedTimeFields", "Billing", "AlternativeExpectedReturns", "Alternative", "AssumedRates", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.LocalProductVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Products" ], "operationId": "Products_UpdatedLocalProductAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.LocalProductVerboseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.LocalProductVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/Verbose/List": { "post": { "tags": [ "Portfolio/Products" ], "operationId": "Products_GetVerboseListByIdAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "ProductGroup", "EntityOptions", "UserDefinedFields", "UserDefinedTimeFields", "Billing", "AlternativeExpectedReturns", "Alternative", "AssumedRates", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.LocalProductVerboseDto" }, "xml": { "name": "LocalProductVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/Verbose/List/Id": { "post": { "tags": [ "Portfolio/Products" ], "operationId": "Products_PostV1PortfolioProductsVerboseListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "ProductGroup", "EntityOptions", "UserDefinedFields", "UserDefinedTimeFields", "Billing", "AlternativeExpectedReturns", "Alternative", "AssumedRates", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.LocalProductVerboseDto" }, "xml": { "name": "LocalProductVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/Verbose/Many": { "post": { "tags": [ "Portfolio/Products" ], "summary": "Creates one or more local products.", "operationId": "Products_CreateLocalProductsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "localProductVerboseDtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.LocalProductVerboseDto" }, "xml": { "name": "LocalProductVerboseDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/Verbose/New/{key}": { "get": { "tags": [ "Portfolio/Products" ], "operationId": "Products_MokupNewLocalProduct", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "ProductGroup", "EntityOptions", "UserDefinedFields", "UserDefinedTimeFields", "Billing", "AlternativeExpectedReturns", "Alternative", "AssumedRates", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.LocalProductVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Products/Weightings/Remove": { "post": { "tags": [ "Portfolio/Products" ], "summary": "", "operationId": "Products_RemoveProductWeightings", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "removeAssetClassWeightings", "in": "query", "required": true, "type": "boolean" }, { "name": "removeAssetCategoryWeightings", "in": "query", "required": true, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ProductTypes/Simple": { "get": { "tags": [ "Portfolio/ProductTypes" ], "operationId": "ProductTypes_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PropertyTypes": { "get": { "tags": [ "Portfolio/PropertyTypes" ], "summary": "Get all PropertyTypes", "operationId": "PropertyTypes_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PropertyTypeDto" }, "xml": { "name": "PropertyTypeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/PropertyTypes" ], "summary": "Adds a new PropertyType to the database.", "operationId": "PropertyTypes_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PropertyTypeDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PropertyTypeDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PropertyTypes/{key}": { "get": { "tags": [ "Portfolio/PropertyTypes" ], "summary": "Gets the PropertyType that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "PropertyTypes_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PropertyTypeDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/PropertyTypes" ], "summary": "Updates the PropertyType that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "PropertyTypes_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired update object.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "PropertyType object to update", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PropertyTypeDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PropertyTypeDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/PropertyTypes" ], "summary": "Deletes the specified PropertyType from the database.", "operationId": "PropertyTypes_DeleteEntity", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the PropertyType.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PropertyTypes/Simple": { "get": { "tags": [ "Portfolio/PropertyTypes" ], "summary": "Get all PropertyTypes", "operationId": "PropertyTypes_GetAllSimpleItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PropertyTypes/Weighted": { "get": { "tags": [ "Portfolio/PropertyTypes" ], "summary": "Gets a list of weighted asset property types that the logged in user has access to.", "operationId": "PropertyTypeWeighteds_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductPropertyTypeWeightedDto" }, "xml": { "name": "ProductPropertyTypeWeightedDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/PropertyTypes" ], "summary": "Mass update product property types", "operationId": "PropertyTypeWeighteds_UpdateProductPropertyTypeWeights", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updatedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductPropertyTypeWeightedDto" }, "xml": { "name": "ProductPropertyTypeWeightedDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductPropertyTypeWeightedDto" }, "xml": { "name": "ProductPropertyTypeWeightedDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/PropertyTypes" ], "summary": "Create weighted product property types", "operationId": "PropertyTypeWeighteds_CreateProductPropertyTypeWeighted", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductPropertyTypeWeightedDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductPropertyTypeWeightedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PropertyTypes/Weighted/{key}": { "get": { "tags": [ "Portfolio/PropertyTypes" ], "summary": "Gets a list of weighted asset property types that the logged in user has access to.", "operationId": "PropertyTypeWeighteds_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductPropertyTypeWeightedDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/PropertyTypes" ], "summary": "Update weighted product property types", "operationId": "PropertyTypeWeighteds_UpdateProductPropertyTypeWeight", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductPropertyTypeWeightedDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductPropertyTypeWeightedDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/PropertyTypes" ], "summary": "Delete product property type", "operationId": "PropertyTypeWeighteds_DeleteItem", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PropertyTypes/Weighted/Products/{productId}": { "get": { "tags": [ "Portfolio/PropertyTypes" ], "summary": "Get all weighted asset property types by product", "operationId": "PropertyTypeWeighteds_GetProductPropertyTypesWeighted", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductPropertyTypeWeightedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/PropertyTypes/Weighted/Products/{productId}/Representative/{representativeId}": { "get": { "tags": [ "Portfolio/PropertyTypes" ], "summary": "Get all weighted asset property types by product and representative", "operationId": "PropertyTypeWeighteds_GetProductPropertyTypeWeight", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "representativeId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductPropertyTypeWeightedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/QPENonManaged": { "get": { "tags": [ "Portfolio/QPENonManaged" ], "summary": "Gets a list of qpenonmanaged that the logged in user has access to.", "operationId": "QpeNonManaged_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.QpeNonManagedDto" }, "xml": { "name": "QpeNonManagedDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/QPENonManaged" ], "operationId": "QpeNonManaged_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.QpeNonManagedDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.QpeNonManagedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/QPENonManaged/{key}": { "get": { "tags": [ "Portfolio/QPENonManaged" ], "summary": "Gets the qpenonmanaged that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "QpeNonManaged_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.QpeNonManagedDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/QPENonManaged" ], "operationId": "QpeNonManaged_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.QpeNonManagedDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.QpeNonManagedDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/QPENonManaged" ], "operationId": "QpeNonManaged_Delete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/QPENonManaged/Action/Delete": { "put": { "tags": [ "Portfolio/QPENonManaged" ], "operationId": "QpeNonManaged_ActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Regions": { "get": { "tags": [ "Portfolio/Regions" ], "summary": "Get all Regions", "operationId": "Regions_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegionDto" }, "xml": { "name": "RegionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/Regions" ], "summary": "Adds a new Region to the database.", "operationId": "Regions_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegionDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Regions/{key}": { "get": { "tags": [ "Portfolio/Regions" ], "summary": "Gets the Region that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Regions_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegionDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Regions" ], "summary": "Updates the Region that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Regions_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired update object.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "Region object to update", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegionDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegionDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/Regions" ], "summary": "Deletes the specified Region from the database.", "operationId": "Regions_DeleteEntity", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the Region.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Regions/Simple": { "get": { "tags": [ "Portfolio/Regions" ], "summary": "Get all Regions", "operationId": "Regions_GetAllSimpleItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Regions/Weighted": { "get": { "tags": [ "Portfolio/Regions" ], "summary": "Gets a list of weighted asset regions that the logged in user has access to.", "operationId": "RegionWeighteds_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductRegionWeightedDto" }, "xml": { "name": "ProductRegionWeightedDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Regions" ], "summary": "Mass update product regions", "operationId": "RegionWeighteds_UpdateProductRegionWeights", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updatedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductRegionWeightedDto" }, "xml": { "name": "ProductRegionWeightedDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductRegionWeightedDto" }, "xml": { "name": "ProductRegionWeightedDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/Regions" ], "summary": "Create weighted product regions", "operationId": "RegionWeighteds_CreateProductRegionWeighted", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductRegionWeightedDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductRegionWeightedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Regions/Weighted/{key}": { "get": { "tags": [ "Portfolio/Regions" ], "summary": "Gets a list of weighted asset regions that the logged in user has access to.", "operationId": "RegionWeighteds_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductRegionWeightedDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Regions" ], "summary": "Update weighted product regions", "operationId": "RegionWeighteds_UpdateProductRegionWeight", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductRegionWeightedDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductRegionWeightedDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/Regions" ], "summary": "Delete product region", "operationId": "RegionWeighteds_DeleteItem", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Regions/Weighted/Products/{productId}": { "get": { "tags": [ "Portfolio/Regions" ], "summary": "Get all weighted asset regions by product", "operationId": "RegionWeighteds_GetProductRegionWeighteds", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductRegionWeightedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Regions/Weighted/Products/{productId}/Representative/{representativeId}": { "get": { "tags": [ "Portfolio/Regions" ], "summary": "Get all weighted asset regions by product and representative", "operationId": "RegionWeighteds_GetProductRegionWeight", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "representativeId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductRegionWeightedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/RegistrationChanges/{registrationId}": { "get": { "tags": [ "Portfolio/RegistrationChanges" ], "summary": "Gets a list of registration changes for specific registration id.", "operationId": "RegistrationChanges_GetRegistrationChangesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "registrationId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/RegistrationChanges" ], "summary": "Updates a list of registration changes for specific registration id.", "operationId": "RegistrationChanges_UpdateRegistrationChangesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "registrationId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "items", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationChangeDto" }, "xml": { "name": "RegistrationChangeDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets a list of registrations that the logged in user has access to.\r\nThe return is limited to pages of 1000. Use $top and $skip in the query string to page through the data.", "operationId": "Registrations_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "queryOptions", "in": "header", "required": true }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "isActive", "in": "query", "description": "Optional. Default: null. If provided only active/inactive registrations are returned.", "required": false, "type": "boolean" }, { "name": "registrationFilter", "in": "query", "description": "Optional. Default: null. If provided the registration list will be filtered as specified.", "required": false, "type": "string", "enum": [ "MissingInformation", "RegMissingSSN", "MissingSuitability", "MissingRiskProfile", "ObjectiveMisalignment" ] }, { "name": "representativeId", "in": "query", "description": "Optional. Default: null. If provided only registrations that fall within the representative specified will be returned.", "required": false, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "query", "description": "Optional. Default: null. If provided only the registration with the account specified will be returned.", "required": false, "type": "integer", "format": "int32" }, { "name": "entitySessionId", "in": "query", "description": "Optional. Default: null. If provided filters only registrations based on entity session.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/{clientId}/Client/Payouts": { "get": { "tags": [ "Portfolio/Registrations" ], "operationId": "Registrations_GetClientPayoutsForRegistrationAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientPayoutOptionDto" }, "xml": { "name": "ClientPayoutOptionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/{key}": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets the registration that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Registrations_GetEntityByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Registrations" ], "summary": "Simple dto update", "operationId": "Registrations_UpdateRegistrationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/{key}/Accounts": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Obsolete. This endpoint may no longer exist at anytime after August 2016. Use Portfolio/Accounts/?registrationId={key}&isActive={isActive} instead.", "operationId": "Registrations_GetAccountsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "manipulator", "in": "header", "required": true }, { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "isActive", "in": "query", "description": "Optional. Default null. When true - only active accounts are returned, when False, only inactive accounts, when null all accounts.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountBaseDto" }, "xml": { "name": "AccountBaseDto", "wrapped": true }, "type": "array" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/{key}/Accounts/Value": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets a simple list of accounts (including aum for today) that fall below the registration with the specified key, which the logged in user has access to.", "operationId": "Registrations_GetAccountsValue", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return accounts that have value (true) or don't have value (false).", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/{key}/Accounts/Value/{asOfDate}": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets a simple list of accounts (including aum for the end of the date specified) that fall below the registration with the specified key, which the logged in user has access to.", "operationId": "Registrations_GetAccountsValueAsOfDate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return accounts that have value (true) or don't have value (false).", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/{key}/Action/MoveToClient/{clientId}": { "put": { "tags": [ "Portfolio/Registrations" ], "summary": "Move registration to different household", "operationId": "Registrations_PutV1PortfolioRegistrationsByKeyActionMoveToClientByClientId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/{key}/Action/Split": { "put": { "tags": [ "Portfolio/Registrations" ], "summary": "Splits the active, non-sleeved accounts in this registration into their own registration (each of which is a copy of this registartion).", "operationId": "Registrations_SplitRegistrationAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/{key}/AdditionalRepresentativesPercent": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets additional representative with percent by id", "operationId": "Registrations_GetAdditionalRepresentativesPercentByRegistrationId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AdditionalRepAssignmentPercent" }, "xml": { "name": "AdditionalRepAssignmentPercent", "wrapped": true }, "type": "array" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/{key}/Assets": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets a list of assets that fall within the registration with the specified key, which the logged in user has access to.", "operationId": "Registrations_GetAssetsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "includeCostBasis", "in": "query", "description": "Optional bool. Default is false. When true, the Cost Basis property will be populated. This requires extra calculation which will reduce performance when true.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetDto" }, "xml": { "name": "AssetDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/{key}/Assets/{asOfDate}": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets a list of assets that fall within the registration with the specified key, which the logged in user has access to.", "operationId": "Registrations_GetV1PortfolioRegistrationsByKeyAssetsByAsOfDate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "asOfDate", "in": "path", "description": "The asset value returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "includeCostBasis", "in": "query", "description": "Optional bool. Default is false. When true, the Cost Basis property will be populated. This requires extra calculation which will reduce performance when true.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetDto" }, "xml": { "name": "AssetDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/{key}/Assets/Value": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets a simple list of assets (including aum for today) that fall within the registration with the specified key, which the logged in user has access to.", "operationId": "Registrations_GetAssetsValue", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return accounts that have value (true) or don't have value (false).", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAssetWithValue" }, "xml": { "name": "SimpleAssetWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/{key}/Assets/Value/{asOfDate}": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets a simple list of assets (including aum for the end of the date specified) that fall within the registration with the specified key, which the logged in user has access to.", "operationId": "Registrations_GetAssetsValueAsOfDate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return accounts that have value (true) or don't have value (false).", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAssetWithValue" }, "xml": { "name": "SimpleAssetWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/{key}/AumOverTime": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets a list of Aum data representative of the range provided for the registration with the specified key.", "operationId": "Registrations_GetAumOverTimeAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "description": "Optional. Default: inception date. The start of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default: yesterday. The end of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "interval", "in": "query", "description": "Optional. Default: \"A\" Automatic. Options are:\r\n\"A\" Automatic\r\n\"M\" Monthly\r\n\"W\" Weekly\r\n\"D\" Daily", "required": false, "type": "string", "default": "A" }, { "name": "cancellationToken", "in": "header", "required": false }, { "name": "clientPerformanceInclude", "in": "query", "description": "Optional. Default: Default. When set only accounts/registrations that have value/are active will be returned.", "required": false, "type": "string", "default": -1, "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, { "name": "unmangedInclusionOverride", "in": "query", "description": "Optional. Default: no override. Used to override the unmanaged setting. To include all unmanaged assets set this parameter to \"ActivitySummary\".", "required": false, "type": "string", "enum": [ "Unmanaged", "Performance", "ActivitySummary", "Allocation", "PortfolioDetail", "TaxDetail" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AumOverTimeDto" }, "xml": { "name": "AumOverTimeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/{key}/Beneficiary/{beneficiaryId}/SSN": { "put": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets SSN for beneficiary", "operationId": "Registrations_GetBeneficiarySSNAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "beneficiaryId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "reason", "in": "body", "required": true, "schema": { "type": "string" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/{key}/Calculate/InceptionDate": { "post": { "tags": [ "Portfolio/Registrations" ], "summary": "Used to calculate the appropriate inception date for the provided registration.", "operationId": "Registrations_CalculateInceptionDate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "endDate", "in": "query", "description": "Optional. Default: Today. The end date of the reporting period.", "required": false, "type": "string", "format": "date-time" }, { "name": "inclusionOption", "in": "query", "description": "Optional. Default: Database default. Indicates which accounts/registrations to include.", "required": false, "type": "string", "default": -1, "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, { "name": "unmanagedInclusionOption", "in": "query", "description": "Optional. Default: Database default. Indicates how unmanaged assets are handled.", "required": false, "type": "string", "enum": [ "Unmanaged", "Performance", "ActivitySummary", "Allocation", "PortfolioDetail", "TaxDetail" ] }, { "name": "reportCategory", "in": "query", "required": false, "type": "string", "enum": [ "Unmanaged", "Performance", "ActivitySummary", "Allocation", "PortfolioDetail", "TaxDetail" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RunReport.InceptionDateDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/{key}/CustomIndex": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Get full set of Registrations's Custom Index Input data", "operationId": "Registrations_GetCustomIndexDataByRegistrationAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationCustomIndexDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/{key}/DeceasedSSNTaxId": { "put": { "tags": [ "Portfolio/Registrations" ], "summary": "Retrieve or update SSN for client.", "description": "If updateInfo.SSN is null => we will just retrieve SSN otherwise we will attempt to update SSN with data in updateInfo.SSN", "operationId": "Registrations_UpdateDeceasedSSNTaxIdAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updateInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.UpdateSsnDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/{key}/FirstActiveAccount/Custodian/EntityOptions/Code/{code}": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets the specified entity option (by code) from the registrations first (lowest pk) active account's custodian.", "operationId": "Registrations_GetCustodianEntityOptionFromFirstActiveAccountAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "code", "in": "path", "description": "Code of the desired return object.", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/{key}/NetAmountInvested": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets a list of Aum data representative of the range provided for registration with the specified key. Also returns a list of data to show the net amount invested overtime.", "operationId": "Registrations_GetAumOverTimeWithNetAmountInvestedAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "description": "Optional. Default: inception date. The start of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default: yesterday. The end of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "interval", "in": "query", "description": "Optional. Default: \"A\" Automatic. Options are:\r\n\"A\" Automatic\r\n\"M\" Monthly\r\n\"W\" Weekly\r\n\"D\" Daily", "required": false, "type": "string", "default": "A" }, { "name": "cancellationToken", "in": "header", "required": false }, { "name": "clientPerformanceInclude", "in": "query", "description": "Optional. Default: Default. When set only accounts/registrations that have value/are active will be returned.", "required": false, "type": "string", "default": -1, "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, { "name": "unmangedInclusionOverride", "in": "query", "description": "Optional. Default: no override. Used to override the unmanaged setting. To include all unmanaged assets set this parameter to \"ActivitySummary\".", "required": false, "type": "string", "enum": [ "Unmanaged", "Performance", "ActivitySummary", "Allocation", "PortfolioDetail", "TaxDetail" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AumOverTimeWithNetAmountInvestedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/{key}/Performance": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Used to verbosely return performance. Has the ability to return account performance, benchmark performance, and statistical data for the registration over a number of date ranges.", "operationId": "Registrations_GetPerformanceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the registration that performance will be calculated for.", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "description": "Optional. The start of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default: Today. The end of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "cancellationToken", "in": "header", "required": false }, { "name": "clientPerformanceInclude", "in": "query", "description": "Optional. Default: Default. When set only accounts/registrations that have value/are active will be returned.", "required": false, "type": "string", "default": -1, "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, { "name": "returnStyle", "in": "query", "description": "Optional. Default: 3 PortfolioSummary & PortfolioDaily\r\n1 = Returns Portfolio Performance Summary\r\n2 = Returns Portfolio Daily Factors\r\n4 = Modifies return style 1 to include beginning and ending market value. Also includes accrued interest if performance was calculated including accrued interest.\r\n8 = Returns Benchmark Performance Summary\r\n16 = Returns Benchmark Daily Factors\r\n32 = **does nothing\r\n64 = Returns Statistical Summary", "required": false, "type": "string", "default": 3, "enum": [ "PortfolioSummary", "PortfolioDaily", "PortfolioDetailed", "BenchmarkSummary", "BenchmarkDaily", "AssetGroupAssignment", "StatisticSummary" ] }, { "name": "interval", "in": "query", "description": "Optional. Default: \"A\" Automatic. Options are:\r\n\"A\" Automatic\r\n\"M\" Monthly\r\n\"W\" Weekly\r\n\"D\" Daily", "required": false, "type": "string", "default": "A" }, { "name": "periods", "in": "query", "description": "Optional. Bitwise parameter for requesting commonly used date ranges.\r\n1 = MTD\r\n2 = QTD\r\n4 = YTD\r\n8 = 1yr\r\n16 = 3yr\r\n32 = 5yr\r\n64 = 10yr\r\n128 = inception\r\n256 = day", "required": false, "type": "string", "default": 0, "enum": [ "None", "Day", "MTD", "QTD", "YTD", "OneYear", "ThreeYear", "FiveYear", "TenYear", "Inception", "AllDates" ] }, { "name": "calendarYears", "in": "query", "description": "Optional. Comma delimited list of calendar years for which performance should be calculated.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Performance.PerformancePortfolio" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/{key}/Performance/{grouping}": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Used to verbosely return performance. Has the ability to return grouped account performance, benchmark performance, and statistical data for the registration over a number of date ranges.", "operationId": "Registrations_GetV1PortfolioRegistrationsByKeyPerformanceByGrouping", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the registration that performance will be calculated for.", "required": true, "type": "integer", "format": "int32" }, { "name": "grouping", "in": "path", "description": "Defines how the registration is grouped for the performance return. Can be set to any of the follow:\r\n Registration, Account, Asset, AssetClass, ProductType, MgmntStyle, RiskCategory, AssetCategory, or AssetLevelStrategy.", "required": true, "type": "string", "enum": [ "Undefined", "Representative", "Client", "Registration", "Account", "Asset", "AssetClass", "ProductType", "Platform", "RiskCategory", "Product", "IndexBlend", "AssetCategory", "AssetLevelStrategy", "AggregateModel", "AccountType", "PortfolioGroup" ] }, { "name": "startDate", "in": "query", "description": "Optional. The start of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default: Today. The end of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "cancellationToken", "in": "header", "required": false }, { "name": "clientPerformanceInclude", "in": "query", "description": "Optional. Default: Default. When set only accounts/registrations that have value/are active will be returned.", "required": false, "type": "string", "default": -1, "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, { "name": "returnStyle", "in": "query", "description": "Optional. Default: 3 Portfolio Summary & Portfolio Daily\r\n1 = Returns Portfolio Performance Summary\r\n2 = Returns Portfolio Daily Factors\r\n4 = Modifies return style 1 to include beginning and ending market value. Also includes accrued interest if performance was calculated including accrued interest.\r\n8 = Returns Benchmark Performance Summary\r\n16 = Returns Benchmark Daily Factors\r\n32 = **does nothing\r\n64 = Returns Statistical Summary", "required": false, "type": "string", "default": 3, "enum": [ "PortfolioSummary", "PortfolioDaily", "PortfolioDetailed", "BenchmarkSummary", "BenchmarkDaily", "AssetGroupAssignment", "StatisticSummary" ] }, { "name": "interval", "in": "query", "description": "Optional. Default: \"A\" Automatic. Options are:\r\n\"A\" Automatic\r\n\"M\" Monthly\r\n\"W\" Weekly\r\n\"D\" Daily", "required": false, "type": "string", "default": "A" }, { "name": "periods", "in": "query", "description": "Optional. Bitwise parameter for requesting commonly used date ranges.\r\n1 = MTD\r\n2 = QTD\r\n4 = YTD\r\n8 = 1yr\r\n16 = 3yr\r\n32 = 5yr\r\n64 = 10yr\r\n128 = inception\r\n256 = day", "required": false, "type": "string", "default": 0, "enum": [ "None", "Day", "MTD", "QTD", "YTD", "OneYear", "ThreeYear", "FiveYear", "TenYear", "Inception", "AllDates" ] }, { "name": "calendarYears", "in": "query", "description": "Optional. Comma delimited list of calendar years for which performance should be calculated.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Performance.PerformancePortfolio" }, "xml": { "name": "PerformancePortfolio", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/{key}/Performance/Interval": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Used to return interval performance. Has the ability to return registration performance in sequential intervals over a number the date range specified.", "operationId": "Registrations_GetPerformanceIntervalAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the registration that performance will be calculated for.", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "description": "Optional. The start of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default: Today. The end of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "interval", "in": "query", "description": "Optional. Default: \"A\" Automatic. Options are:\r\n\"A\" Automatic\r\n\"M\" Monthly\r\n\"W\" Weekly\r\n\"D\" Daily", "required": false, "type": "string", "default": "A" }, { "name": "cancellationToken", "in": "header", "required": false }, { "name": "clientPerformanceInclude", "in": "query", "description": "Optional. Default: Default. When set only accounts/registrations that have value/are active will be returned.", "required": false, "type": "string", "default": -1, "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Reporting.PerformancePortfolioDetailDto" }, "xml": { "name": "PerformancePortfolioDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/{key}/Performance/Interval/{grouping}": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Used to return interval performance. Has the ability to return grouped registration performance in sequential intervals over a number the date range specified.", "operationId": "Registrations_GetV1PortfolioRegistrationsByKeyPerformanceIntervalByGrouping", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the registration that performance will be calculated for.", "required": true, "type": "integer", "format": "int32" }, { "name": "grouping", "in": "path", "description": "Defines how the registration is grouped for the performance return. Can be set to any of the follow:\r\n Registration, Account, Asset, AssetClass, ProductType, MgmntStyle, RiskCategory, AssetCategory, or AssetLevelStrategy.", "required": true, "type": "string", "enum": [ "Undefined", "Representative", "Client", "Registration", "Account", "Asset", "AssetClass", "ProductType", "Platform", "RiskCategory", "Product", "IndexBlend", "AssetCategory", "AssetLevelStrategy", "AggregateModel", "AccountType", "PortfolioGroup" ] }, { "name": "startDate", "in": "query", "description": "Optional. The start of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default: Today. The end of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "interval", "in": "query", "description": "Optional. Default: \"A\" Automatic. Options are:\r\n\"A\" Automatic\r\n\"M\" Monthly\r\n\"W\" Weekly\r\n\"D\" Daily", "required": false, "type": "string", "default": "A" }, { "name": "cancellationToken", "in": "header", "required": false }, { "name": "clientPerformanceInclude", "in": "query", "description": "Optional. Default: Default. When set only accounts/registrations that have value/are active will be returned.", "required": false, "type": "string", "default": -1, "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Reporting.PerformancePortfolioDetailDto" }, "xml": { "name": "PerformancePortfolioDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/{key}/Performance/Summary": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Used to return summary performance. Has the ability to return performance for the registration over a number of date ranges.", "operationId": "Registrations_GetPerformanceSummaryAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the registration that performance will be calculated for.", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "description": "Optional. The start of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default: Today. The end of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "cancellationToken", "in": "header", "required": false }, { "name": "clientPerformanceInclude", "in": "query", "description": "Optional. Default: Default. When set only accounts/registrations that have value/are active will be returned.", "required": false, "type": "string", "default": -1, "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, { "name": "periods", "in": "query", "description": "Optional. Bitwise parameter for requesting commonly used date ranges.\r\n1 = MTD\r\n2 = QTD\r\n4 = YTD\r\n8 = 1yr\r\n16 = 3yr\r\n32 = 5yr\r\n64 = 10yr\r\n128 = inception\r\n256 = day", "required": false, "type": "string", "default": 0, "enum": [ "None", "Day", "MTD", "QTD", "YTD", "OneYear", "ThreeYear", "FiveYear", "TenYear", "Inception", "AllDates" ] }, { "name": "calendarYears", "in": "query", "description": "Optional. Comma delimited list of calendar years for which performance should be calculated.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.PerformancePortfolioSummaryDto" }, "xml": { "name": "PerformancePortfolioSummaryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/{key}/Performance/Summary/{grouping}": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Used to return summary performance. Has the ability to return grouped account performance for the registration over a number of date ranges.", "operationId": "Registrations_GetV1PortfolioRegistrationsByKeyPerformanceSummaryByGrouping", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the registration that performance will be calculated for.", "required": true, "type": "integer", "format": "int32" }, { "name": "grouping", "in": "path", "description": "Defines how the registration is grouped for the performance return. Can be set to any of the follow:\r\n Registration, Account, Asset, AssetClass, ProductType, MgmntStyle, RiskCategory, AssetCategory, or AssetLevelStrategy.", "required": true, "type": "string", "enum": [ "Undefined", "Representative", "Client", "Registration", "Account", "Asset", "AssetClass", "ProductType", "Platform", "RiskCategory", "Product", "IndexBlend", "AssetCategory", "AssetLevelStrategy", "AggregateModel", "AccountType", "PortfolioGroup" ] }, { "name": "startDate", "in": "query", "description": "Optional. The start of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default: Today. The end of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "cancellationToken", "in": "header", "required": false }, { "name": "clientPerformanceInclude", "in": "query", "description": "Optional. Default: Default. When set only accounts/registrations that have value/are active will be returned.", "required": false, "type": "string", "default": -1, "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, { "name": "periods", "in": "query", "description": "Optional. Bitwise parameter for requesting commonly used date ranges.\r\n1 = MTD\r\n2 = QTD\r\n4 = YTD\r\n8 = 1yr\r\n16 = 3yr\r\n32 = 5yr\r\n64 = 10yr\r\n128 = inception\r\n256 = day", "required": false, "type": "string", "default": 0, "enum": [ "None", "Day", "MTD", "QTD", "YTD", "OneYear", "ThreeYear", "FiveYear", "TenYear", "Inception", "AllDates" ] }, { "name": "calendarYears", "in": "query", "description": "Optional. Comma delimited list of calendar years for which performance should be calculated.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.PerformancePortfolioSummaryDto" }, "xml": { "name": "PerformancePortfolioSummaryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/{key}/PortfolioTree": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets a tree representation of the registration with the key provided. Also includes the accounts within that registration.", "operationId": "Registrations_GetTreeAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "includeAdditionalDetail", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/{key}/Simple": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets the simple registration that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Registrations_GetSimpleByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/{key}/SSNTaxId": { "put": { "tags": [ "Portfolio/Registrations" ], "summary": "Retrieve or update SSN for client.", "description": "If updateInfo.SSN is null => we will just retrieve SSN otherwise we will attempt to update SSN with data in updateInfo.SSN", "operationId": "Registrations_UpdateSSNTaxIdAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updateInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.UpdateSsnDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/{key}/Transactions": { "get": { "tags": [ "Portfolio/Registrations" ], "operationId": "Registrations_GetTransactions", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "transTypeId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TradingTransactionDto" }, "xml": { "name": "TradingTransactionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/{key}/UnlinkedAccounts": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets unlinked accounts for a registration, optionally excluding accounts linked to a specific account.", "operationId": "Registrations_GetUnlinkedAccountsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "description": "Registration ID.", "required": true, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "query", "description": "Optional. When provided, excludes accounts that are linked to this account.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.LinkedAccountsDto" }, "xml": { "name": "LinkedAccountsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/{key}/UserDefinedFields": { "get": { "tags": [ "Portfolio/Registrations" ], "operationId": "Registrations_GetUserDefinedFieldsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "entities", "in": "query", "required": false, "items": { "type": "string", "enum": [ "BrokerDealers", "Wholesalers", "Representatives", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Products", "FundFamilies", "ModelRanges", "PortfolioGroups" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/{key}/Value": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets the simple registration (including aum for the end of today) that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Registrations_GetValueByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "includeCash", "in": "query", "description": "Optional. Default: false. When true the cash value will be returned along with the registration value.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.SimpleValueDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/{key}/Value/{asOfDate}": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets the simple registration (including aum for the end of the date specified) that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Registrations_GetValueAsOfDateByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "includeCash", "in": "query", "description": "Optional. Default: false. When true the cash value will be returned along with the registration value.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.SimpleValueDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/{registrationId}/ModelTolerance": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Returns a comparison of an Registration to its Assigned Model Targets.", "operationId": "Registrations_ModelTolerance", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "registrationId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "includeCash", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "grouping", "in": "query", "required": false, "type": "string", "default": 9, "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "includePendingValue", "in": "query", "required": false, "type": "string", "default": 2, "enum": [ "UseDefault", "Current", "PendingTransactions", "PendingTransactionsAndOrders" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelToleranceDto" }, "xml": { "name": "ModelToleranceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/Action/Delete": { "put": { "tags": [ "Portfolio/Registrations" ], "operationId": "Registrations_ActionDeleteAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/Action/MoveToClient/{clientId}": { "put": { "tags": [ "Portfolio/Registrations" ], "summary": "Move registration to different household", "operationId": "Registrations_MoveRegistrationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.MoveRegistrationDto" } }, { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/Action/ValidateRepPayouts/{registrationId}": { "post": { "tags": [ "Portfolio/Registrations" ], "summary": "Used to validate registration representative additional overrides", "operationId": "Registrations_ValidateRegistrationRepAdditionalsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "registrationId", "in": "path", "description": "Registration ID to validate for", "required": true, "type": "integer", "format": "int32" }, { "name": "registrationRepAdditionals", "in": "body", "description": "List of representative additional overrides", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationRepAdditionalDto" }, "xml": { "name": "RegistrationRepAdditionalDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationRepAdditionalDto" }, "xml": { "name": "RegistrationRepAdditionalDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/Beneficiary/Relations": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets a simple list of beneficiary relations that the logged in user has access to.", "operationId": "Registrations_GetBeneficiaryTypesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "includeDefaultList", "in": "query", "description": "Optional. Default: true. If true the default relation options are included in the return set. When false, they are not.", "required": false, "type": "boolean", "default": true }, { "name": "includeDatabaseList", "in": "query", "description": "Optional. Default: true. If true the database relation options are included in the return set. When false, they are not.", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/Count": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Returns the number of registrations matching the same URI filters and OData $filter as {M:OAS.WebApi.Domains.Portfolio.RegistrationsController.GetAsync(System.Web.Http.OData.Query.ODataQueryOptions{OAS.WebApi.DTO.Portfolio.RegistrationDto},System.Threading.CancellationToken,System.Nullable{System.Boolean},System.Nullable{OAS.DataAccess.Domains.Portfolio.RegistrationsAccessExtension.RegistrationFilterValues},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32})},\r\nwithout applying $top/$skip to the count (order-by is ignored for counting).", "operationId": "Registrations_GetRegistrationsListCountAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "queryOptions", "in": "header", "required": true }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "isActive", "in": "query", "required": false, "type": "boolean" }, { "name": "registrationFilter", "in": "query", "required": false, "type": "string", "enum": [ "MissingInformation", "RegMissingSSN", "MissingSuitability", "MissingRiskProfile", "ObjectiveMisalignment" ] }, { "name": "representativeId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "entitySessionId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.ListCountDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/Grid": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets a list of registrations that the logged in user has access to.\r\nThe return is limited to pages of 1000. Use $top and $skip in the query string to page through the data.", "operationId": "Registrations_GetV1PortfolioRegistrationsGrid", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "manipulator", "in": "header", "required": true }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "isActive", "in": "query", "description": "Optional. Default: null. If provided only active/inactive registrations are returned.", "required": false, "type": "boolean" }, { "name": "registrationFilter", "in": "query", "description": "Optional. Default: null. If provided the registration list will be filtered as specified.", "required": false, "type": "string", "enum": [ "MissingInformation", "RegMissingSSN", "MissingSuitability", "MissingRiskProfile", "ObjectiveMisalignment" ] }, { "name": "representativeId", "in": "query", "description": "Optional. Default: null. If provided only registrations that fall within the representative specified will be returned.", "required": false, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "query", "description": "Optional. Default: null. If provided only the registration with the account specified will be returned.", "required": false, "type": "integer", "format": "int32" }, { "name": "investmentObjective", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "refreshCache", "in": "query", "description": "Optional. Default: false. If true then refresh cached response.", "required": false, "type": "boolean", "default": false }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "top", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/List": { "post": { "tags": [ "Portfolio/Registrations" ], "operationId": "Registrations_GetListByIdAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/List/Id": { "post": { "tags": [ "Portfolio/Registrations" ], "operationId": "Registrations_PostV1PortfolioRegistrationsListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/ListCounts": { "post": { "tags": [ "Portfolio/Registrations" ], "operationId": "Registrations_GetListCountByIdAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/qs": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets a list of registrations returned by a Query Studio Query in the provided Dashboard Card ID", "operationId": "Registrations_GetV1PortfolioRegistrationsQs", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "queryStudioQueryId", "in": "query", "description": "Returns only the results from the query studio query with the provided guid.", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/Search/Advanced": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets a list of registrations that the logged in user has access to filtered by supplied search parameters.", "operationId": "Registrations_GetAdvancedRegistrationSearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "registrationId", "in": "query", "description": "Optional. Default: null. Registration ID.", "required": false, "type": "integer", "format": "int32" }, { "name": "firstName", "in": "query", "description": "Optional. Default: null. Registration client first name.", "required": false, "type": "string" }, { "name": "lastName", "in": "query", "description": "Optional. Default: null. Registration client last name.", "required": false, "type": "string" }, { "name": "name", "in": "query", "required": false, "type": "string" }, { "name": "registrationTypeId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "ssnLast4", "in": "query", "description": "Optional. Default: null. Last 4 digits of registration client tax ID or SSN.", "required": false, "type": "string" }, { "name": "clientId", "in": "query", "description": "Optional. Default: null. Registration client ID.", "required": false, "type": "integer", "format": "int32" }, { "name": "isActive", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationDto" }, "xml": { "name": "RegistrationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/Search/Advanced/Count": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets a count of registrations that the logged in user has access to filtered by supplied search parameters.", "operationId": "Registrations_GetAdvancedRegistrationSearchCount", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "registrationId", "in": "query", "description": "Optional. Default: null. Registration ID.", "required": false, "type": "integer", "format": "int32" }, { "name": "firstName", "in": "query", "description": "Optional. Default: null. Registration client first name.", "required": false, "type": "string" }, { "name": "lastName", "in": "query", "description": "Optional. Default: null. Registration client last name.", "required": false, "type": "string" }, { "name": "name", "in": "query", "required": false, "type": "string" }, { "name": "registrationTypeId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "ssnLast4", "in": "query", "description": "Optional. Default: null. Last 4 digits of registration client tax ID or SSN.", "required": false, "type": "string" }, { "name": "clientId", "in": "query", "description": "Optional. Default: null. Registration client ID.", "required": false, "type": "integer", "format": "int32" }, { "name": "isActive", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/Simple": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets a simple list of registrations that the logged in user has access to.\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "Registrations_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/Simple/List": { "post": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets a simple list of registrations that match one of the keys in the provided list.", "operationId": "Registrations_GetSimpleListById", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/Simple/List/Id": { "post": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets a simple list of registrations that match one of the keys in the provided list.", "operationId": "Registrations_PostV1PortfolioRegistrationsSimpleListId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/Simple/Search": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets a simple list of registrations that the logged in user has access to where the registrations first name, or lastname begins with the search string or entityName contains the search string or Id is exact match.\r\nIf the useContain parameter is set to false then the entityName will do a begins with search.", "operationId": "Registrations_GetSimpleRegistrationSearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "Partial client name to search for.", "required": true, "type": "string" }, { "name": "top", "in": "query", "description": "Optional. Default: null. The maximum number of products to return. If null returns all.", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Optional. Default: 0. Defines number of items to skip.", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "isActive", "in": "query", "required": false, "type": "boolean" }, { "name": "useContain", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/Simple/Search/{search}": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets a simple list of registrations that the logged in user has access to where the registrations first name, or lastname begins with the search string or entityName contains the search string or Id is exact match.\r\nIf the useContain parameter is set to false then the entityName will do a begins with search.", "operationId": "Registrations_GetV1PortfolioRegistrationsSimpleSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "Partial client name to search for.", "required": true, "type": "string" }, { "name": "top", "in": "query", "description": "Optional. Default: null. The maximum number of products to return. If null returns all.", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Optional. Default: 0. Defines number of items to skip.", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "isActive", "in": "query", "required": false, "type": "boolean" }, { "name": "useContain", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/Simple/Search/LastName": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets a simple list of registrations that the logged in user has access to where the registrations lastname begins with the search string or Id is exact match.", "operationId": "Registrations_GetSimpleRegistrationSearchByLastName", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "Partial client name to search for.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/Simple/Search/LastName/{search}": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets a simple list of registrations that the logged in user has access to where the registrations lastname begins with the search string or Id is exact match.", "operationId": "Registrations_GetV1PortfolioRegistrationsSimpleSearchLastNameBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "Partial client name to search for.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/SyncToEclipse": { "post": { "tags": [ "Portfolio/Registrations" ], "operationId": "Registrations_AddRegistrationsForPartialImportAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "registrationIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/Type": { "post": { "tags": [ "Portfolio/Registrations" ], "operationId": "RegistrationTypes_CreateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationTypeDto" } }, { "name": "token", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationTypeDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/Type/{key}": { "put": { "tags": [ "Portfolio/Registrations" ], "operationId": "RegistrationTypes_UpdateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationTypeDto" } }, { "name": "token", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationTypeDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/Registrations" ], "summary": "Delete a registration type by ID", "description": "Sample Request\r\n DELETE v1/Portfolio/Registrations/Type/1", "operationId": "RegistrationTypes_DeleteEntityAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "token", "in": "header", "required": false } ], "responses": { "200": { "description": "Success", "schema": { "type": "object" } }, "400": { "description": "Failed" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/Types": { "get": { "tags": [ "Portfolio/Registrations" ], "operationId": "RegistrationTypes_GetRegistrationTypes", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/Types/{key}": { "get": { "tags": [ "Portfolio/Registrations" ], "operationId": "RegistrationTypes_GetRegistrationTypeById", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationTypeDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/Types/List": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets a list of registration types that the logged in user has access to.\r\nThe return is limited to pages of 1000. Use $top and $skip in the query string to page through the data.", "operationId": "RegistrationTypes_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isActive", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationTypeDto" }, "xml": { "name": "RegistrationTypeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/Value": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets a simple list of registrations (including aum for today) that the logged in user has access to.\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "Registrations_GetValue", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return registrations that have value (true) or don't have value (false).", "required": false, "type": "boolean" }, { "name": "resetCache", "in": "query", "description": "Optional. Default: false. The result is cached for fifteen minuetes. To force the cache to refresh call with resetCache = true.", "required": false, "type": "boolean", "default": false }, { "name": "includeCash", "in": "query", "description": "Optional. Default: false. When true the cash value will be returned along with the registration value.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.SimpleValueDto" }, "xml": { "name": "SimpleValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/Value/{asOfDate}": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets a simple list of registrations (including aum for the end of the date specified) that the logged in user has access to.\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "Registrations_GetValueAsOfDate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return registrations that have value (true) or don't have value (false).", "required": false, "type": "boolean" }, { "name": "resetCache", "in": "query", "description": "Optional. Default: false. The result is cached for fifteen minuetes. To force the cache to refresh call with resetCache = true.", "required": false, "type": "boolean", "default": false }, { "name": "includeCash", "in": "query", "description": "Optional. Default: false. When true the cash value will be returned along with the registration value.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.SimpleValueDto" }, "xml": { "name": "SimpleValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/Value/{asOfDate}/Search": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets a simple list of clients (including aum for the end of the date specified) that the logged in user has access to where the registrations first name, lastname, or entityname begins with the search string.", "operationId": "Registrations_GetValueAsOfDateRegistrationSearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "search", "in": "query", "description": "Partial client name to search for.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.SimpleValueDto" }, "xml": { "name": "SimpleValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/Value/{asOfDate}/Search/{search}": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets a simple list of clients (including aum for the end of the date specified) that the logged in user has access to where the registrations first name, lastname, or entityname begins with the search string.", "operationId": "Registrations_GetV1PortfolioRegistrationsValueByAsOfDateSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "search", "in": "path", "description": "Partial client name to search for.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.SimpleValueDto" }, "xml": { "name": "SimpleValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/Value/{asOfDate}/Search/LastName": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets a simple list of clients (including aum for the end of the date specified) that the logged in user has access to where the registrations lastname begins with the search string.", "operationId": "Registrations_GetValueAsOfDateRegistrationSearchByLastName", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "search", "in": "query", "description": "Partial client name to search for.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.SimpleValueDto" }, "xml": { "name": "SimpleValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/Value/{asOfDate}/Search/LastName/{search}": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets a simple list of clients (including aum for the end of the date specified) that the logged in user has access to where the registrations lastname begins with the search string.", "operationId": "Registrations_GetV1PortfolioRegistrationsValueByAsOfDateSearchLastNameBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "search", "in": "path", "description": "Partial client name to search for.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.SimpleValueDto" }, "xml": { "name": "SimpleValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/Value/Search": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets a simple list of registrations (including aum for today) that the logged in user has access to where the registrations first name, lastname, or entityname begins with the search string.", "operationId": "Registrations_GetValueRegistrationSearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "Partial client name to search for.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.SimpleValueDto" }, "xml": { "name": "SimpleValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/Value/Search/{search}": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets a simple list of registrations (including aum for today) that the logged in user has access to where the registrations first name, lastname, or entityname begins with the search string.", "operationId": "Registrations_GetV1PortfolioRegistrationsValueSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "Partial client name to search for.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.SimpleValueDto" }, "xml": { "name": "SimpleValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/Value/Search/LastName": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets a simple list of registrations (including aum for today) that the logged in user has access to where the registrations lastname begins with the search string.", "operationId": "Registrations_GetValueRegistrationSearchByLastName", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "Partial client name to search for.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.SimpleValueDto" }, "xml": { "name": "SimpleValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/Value/Search/LastName/{search}": { "get": { "tags": [ "Portfolio/Registrations" ], "summary": "Gets a simple list of registrations (including aum for today) that the logged in user has access to where the registrations lastname begins with the search string.", "operationId": "Registrations_GetV1PortfolioRegistrationsValueSearchLastNameBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "Partial client name to search for.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.SimpleValueDto" }, "xml": { "name": "SimpleValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/Verbose": { "get": { "tags": [ "Portfolio/Registrations" ], "operationId": "Registrations_GetVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isActive", "in": "query", "required": false, "type": "boolean" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Notes", "Beneficiaries", "Suitability", "UserDefinedFields", "EntityOptions", "Contact", "AdditionalRepresentativesPercent", "Decedent", "FeePayingAccounts", "AdditionalRepresentatives", "RegistrationChanges", "RegistrationRepAdditionals", "TargetAllocations", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationVerboseDto" }, "xml": { "name": "RegistrationVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Registrations" ], "operationId": "Registrations_UpdateVerboseRegistrationsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updatedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationVerboseDto" }, "xml": { "name": "RegistrationVerboseDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationVerboseDto" }, "xml": { "name": "RegistrationVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/Registrations" ], "summary": "Create a registration", "operationId": "Registrations_CreateVerboseRegistrationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationVerboseDto" } }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/Verbose/{key}": { "get": { "tags": [ "Portfolio/Registrations" ], "operationId": "Registrations_GetVerboseByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Notes", "Beneficiaries", "Suitability", "UserDefinedFields", "EntityOptions", "Contact", "AdditionalRepresentativesPercent", "Decedent", "FeePayingAccounts", "AdditionalRepresentatives", "RegistrationChanges", "RegistrationRepAdditionals", "TargetAllocations", "All" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Registrations" ], "operationId": "Registrations_UpdateVerboseRegistrationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationVerboseDto" } }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/Verbose/{key}/Beneficiaries": { "put": { "tags": [ "Portfolio/Registrations" ], "summary": "Update registration beneficiary information", "operationId": "Registrations_UpdateVerboseRegistrationBeneficiariesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Id of the desired registration", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "description": "Registration with updated benficaries", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationVerboseDto" } }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationBeneficiaryDto" }, "xml": { "name": "RegistrationBeneficiaryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/Verbose/List": { "post": { "tags": [ "Portfolio/Registrations" ], "operationId": "Registrations_GetVerboseListById", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Notes", "Beneficiaries", "Suitability", "UserDefinedFields", "EntityOptions", "Contact", "AdditionalRepresentativesPercent", "Decedent", "FeePayingAccounts", "AdditionalRepresentatives", "RegistrationChanges", "RegistrationRepAdditionals", "TargetAllocations", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationVerboseDto" }, "xml": { "name": "RegistrationVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/Verbose/List/Id": { "post": { "tags": [ "Portfolio/Registrations" ], "operationId": "Registrations_PostV1PortfolioRegistrationsVerboseListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Notes", "Beneficiaries", "Suitability", "UserDefinedFields", "EntityOptions", "Contact", "AdditionalRepresentativesPercent", "Decedent", "FeePayingAccounts", "AdditionalRepresentatives", "RegistrationChanges", "RegistrationRepAdditionals", "TargetAllocations", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationVerboseDto" }, "xml": { "name": "RegistrationVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Registrations/Verbose/New": { "get": { "tags": [ "Portfolio/Registrations" ], "operationId": "Registrations_GetNewVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Notes", "Beneficiaries", "Suitability", "UserDefinedFields", "EntityOptions", "Contact", "AdditionalRepresentativesPercent", "Decedent", "FeePayingAccounts", "AdditionalRepresentatives", "RegistrationChanges", "RegistrationRepAdditionals", "TargetAllocations", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ReportGroup/Clients": { "post": { "tags": [ "Portfolio/ReportGroup" ], "summary": "Used to create a new report group client. Upon successful creation a 201 will be returned with the location of the nearly created client.", "operationId": "ReportGroupClients_CreateReportGroupClient", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ReportGroup.ReportGroupClientFullDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ReportGroup/Clients/{key}": { "get": { "tags": [ "Portfolio/ReportGroup" ], "summary": "Gets the report group clients that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ReportGroupClients_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ReportGroup.ReportGroupClientFullDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/ReportGroup" ], "summary": "Used to update an existing report group client. Upon successful modification a 200 will be returned.", "operationId": "ReportGroupClients_UpdateReportGroupClient", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ReportGroup.ReportGroupClientFullDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ReportGroup.ReportGroupClientFullDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/ReportGroup" ], "summary": "Used to delete an existing report group client. Upon successful deletion a 204 will be returned.", "operationId": "ReportGroupClients_DeleteReportGroupClient", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ReportGroup/Clients/Simple": { "get": { "tags": [ "Portfolio/ReportGroup" ], "summary": "Gets a list of report group clients (clients that either have no accounts assigned or only have additional accounts).", "operationId": "ReportGroupClients_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "hasAdditionalAccounts", "in": "query", "description": "Optional. Default: true. When True, only households that have additional acocunts are returned. When False, All Households are returned.", "required": false, "type": "boolean", "default": true }, { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return clients that have value (true) or don't have value (false).", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ReportGroup.ReportGroupClientDto" }, "xml": { "name": "ReportGroupClientDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/RepresentativeChanges/{representativeId}": { "get": { "tags": [ "Portfolio/RepresentativeChanges" ], "summary": "Gets a list of representative changes for specific representative id.", "operationId": "RepresentativeChanges_GetRepresentativeChangesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "representativeId", "in": "path", "description": "Required. Representative Id.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "description": "Cancellation token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/RepresentativeChanges" ], "summary": "Updates a list of representative changes for specific representative id.", "operationId": "RepresentativeChanges_UpdateRepresentativeChangesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "representativeId", "in": "path", "description": "Required. Representative Id.", "required": true, "type": "integer", "format": "int32" }, { "name": "items", "in": "body", "description": "Required. List of Rep changes to save", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RepresentativeChangeDto" }, "xml": { "name": "RepresentativeChangeDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "description": "Cancellation token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Representatives": { "get": { "tags": [ "Portfolio/Representatives" ], "summary": "Gets a list of representatives that the logged in user has access to.\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "Representatives_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "isUsed", "in": "query", "description": "Optional. When provided will only return representatives that have are used (true) or are not used (false).", "required": false, "type": "boolean" }, { "name": "brokerDealerId", "in": "query", "description": "Optional. When provided will only return representatives are tied to the provided BrokerDealerId (3).", "required": false, "type": "integer", "format": "int32" }, { "name": "riaId", "in": "query", "description": "Optional. When provided will only return representatives are tied to the provided RiaId (5).", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Representatives/{key}": { "get": { "tags": [ "Portfolio/Representatives" ], "summary": "Gets the representative that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Representatives_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Representatives/{key}/Accounts": { "get": { "tags": [ "Portfolio/Representatives" ], "summary": "Gets a list of accounts that fall below the representative with the specified key, which the logged in user has access to.", "operationId": "Representatives_GetAccountsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "isActive", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountDto" }, "xml": { "name": "AccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Representatives/{key}/Accounts/Value": { "get": { "tags": [ "Portfolio/Representatives" ], "summary": "Gets a simple list of accounts (including aum for today) that fall below the representative with the specified key, which the logged in user has access to.", "operationId": "Representatives_GetAccountsValue", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return accounts that have value (true) or don't have value (false).", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Representatives/{key}/Accounts/Value/{asOfDate}": { "get": { "tags": [ "Portfolio/Representatives" ], "summary": "Gets a simple list of accounts (including aum for the end of the date specified) that fall below the representative with the specified key, which the logged in user has access to.", "operationId": "Representatives_GetAccountsValueAsOfDate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return accounts that have value (true) or don't have value (false).", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Representatives/{key}/Clients/Simple/Search": { "get": { "tags": [ "Portfolio/Representatives" ], "summary": "Gets a simple list of clients that the logged in user has access to where the clients first name, lastname, or entityname begins with the search string or Id is exact match.", "operationId": "Representatives_GetSimpleClientSearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "representative Id. Filters the list of clients by this rep id.", "required": true, "type": "integer", "format": "int32" }, { "name": "search", "in": "query", "description": "Partial client name to search for.", "required": true, "type": "string" }, { "name": "top", "in": "query", "description": "Optional. Default: null. The maximum number of products to return. If null returns all.", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Optional. Default: 0. Defines number of items to skip.", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleClient" }, "xml": { "name": "SimpleClient", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Representatives/{key}/Documents": { "get": { "tags": [ "Portfolio/Representatives" ], "operationId": "Representatives_GetBlobs", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "fileType", "in": "query", "required": false, "items": { "type": "string", "enum": [ "QuarterlyStatements", "CrmDocuments", "Payable" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" }, "xml": { "name": "BlobBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/Representatives" ], "operationId": "Representatives_CreateBlobAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "file", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RepresentativeFileDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Representatives/{key}/Documents/{fileId}": { "get": { "tags": [ "Portfolio/Representatives" ], "summary": "Gets a file for the client with the specified key and the file with the specified key.", "operationId": "Representatives_GetBlobDto", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "description": "Key of the file to be returned.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Representatives" ], "operationId": "Representatives_UpdateBlobAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "file", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RepresentativeFileDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/Representatives" ], "operationId": "Representatives_DeleteBlob", "consumes": [], "produces": [], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Representatives/{key}/Documents/{fileId}/Download": { "get": { "tags": [ "Portfolio/Representatives" ], "summary": "Gets the raw data of the specific file with the blobId provided which is associated to the client with the specified key.", "operationId": "Representatives_GetBlobFile", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "description": "Key of the file to be downloaded.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Representatives/{key}/MakeDefault": { "put": { "tags": [ "Portfolio/Representatives" ], "summary": "Sets the rep as the default.", "operationId": "Representatives_ActionMakeDefault", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The rep to mark as default.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RepresentativeDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Representatives/{key}/ReportImage": { "get": { "tags": [ "Portfolio/Representatives" ], "summary": "Gets the representative's report image if one exists. If none exists a 404 will be thrown.", "operationId": "Representatives_GetRepImageById", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Representatives/{key}/Simple": { "get": { "tags": [ "Portfolio/Representatives" ], "summary": "Gets the simple representative that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Representatives_GetSimpleByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleRepresentative" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Representatives/{key}/SSNTaxId": { "put": { "tags": [ "Portfolio/Representatives" ], "summary": "Retrieve or update SSN for representative.", "description": "If updateInfo.SSN is null => we will just retrieve SSN otherwise we will attempt to update SSN with data in updateInfo.SSN", "operationId": "Representatives_UpdateSSNTaxId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updateInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.UpdateSsnDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Representatives/{key}/Subadvisors": { "get": { "tags": [ "Portfolio/Representatives" ], "operationId": "Representatives_GetApprovedSubadvisorsForRep", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Representatives/{key}/UserDefinedFields": { "get": { "tags": [ "Portfolio/Representatives" ], "operationId": "Representatives_GetUserDefinedFields", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "entities", "in": "query", "required": false, "items": { "type": "string", "enum": [ "BrokerDealers", "Wholesalers", "Representatives", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Products", "FundFamilies", "ModelRanges", "PortfolioGroups" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Representatives/Action/Delete": { "post": { "tags": [ "Portfolio/Representatives" ], "operationId": "Representatives_ActionDeleteAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Representatives/Action/RecalculateAUMData": { "put": { "tags": [ "Portfolio/Representatives" ], "summary": "Endpoint to recalculate AUM data for a representative", "operationId": "Representatives_RecalculateAUMData", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Representatives/Action/ValidateChangeHistory/{repId}": { "post": { "tags": [ "Portfolio/Representatives" ], "operationId": "Representatives_ValidateChangeHistoryAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "repId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "changeHistory", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RepBrokerDealerDto" }, "xml": { "name": "RepBrokerDealerDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RepBrokerDealerDto" }, "xml": { "name": "RepBrokerDealerDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Representatives/Client/{key}": { "get": { "tags": [ "Portfolio/Representatives" ], "summary": "Gets a simple list of representatives that matches the client key.", "operationId": "Representatives_GetSimpleRepByClientId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of client of the desired return objects.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Representatives/GetDefault": { "get": { "tags": [ "Portfolio/Representatives" ], "summary": "Gets the default rep", "operationId": "Representatives_GetDefault", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Representatives/Reptitles": { "get": { "tags": [ "Portfolio/Representatives" ], "operationId": "Representatives_GetRepTitles", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Representatives" ], "operationId": "Representatives_UpdateRepTitles", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "repTitles", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Representatives/Simple": { "get": { "tags": [ "Portfolio/Representatives" ], "summary": "Gets a simple list of representatives that the logged in user has access to.", "operationId": "Representatives_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "isUsed", "in": "query", "description": "Optional. When provided will only return representatives that have are used (true) or are not used (false).", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Representatives/Simple/List": { "post": { "tags": [ "Portfolio/Representatives" ], "summary": "Gets a simple list of representatives that match one of the keys in the provided list.", "operationId": "Representatives_GetSimpleListById", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Representatives/Simple/List/Id": { "post": { "tags": [ "Portfolio/Representatives" ], "summary": "Gets a simple list of representatives that match one of the keys in the provided list.", "operationId": "Representatives_PostV1PortfolioRepresentativesSimpleListId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Representatives/Simple/Search": { "get": { "tags": [ "Portfolio/Representatives" ], "summary": "Gets a simple list of representatives that the logged in user has access to where the representatives first name, lastname, or entityname begins with the search string or Id is exact match.", "operationId": "Representatives_GetSimpleRepresentativeSearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "Partial representative name to search for.", "required": true, "type": "string" }, { "name": "hasEmail", "in": "query", "required": false, "type": "boolean" }, { "name": "isUsed", "in": "query", "required": false, "type": "boolean" }, { "name": "isActive", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Representatives/Simple/Search/{search}": { "get": { "tags": [ "Portfolio/Representatives" ], "summary": "Gets a simple list of representatives that the logged in user has access to where the representatives first name, lastname, or entityname begins with the search string or Id is exact match.", "operationId": "Representatives_GetV1PortfolioRepresentativesSimpleSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "Partial representative name to search for.", "required": true, "type": "string" }, { "name": "hasEmail", "in": "query", "required": false, "type": "boolean" }, { "name": "isUsed", "in": "query", "required": false, "type": "boolean" }, { "name": "isActive", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Representatives/Value": { "get": { "tags": [ "Portfolio/Representatives" ], "summary": "Gets a simple list of representatives (including aum for today) that the logged in user has access to.\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "Representatives_GetValue", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Representatives/Value/{asOfDate}": { "get": { "tags": [ "Portfolio/Representatives" ], "summary": "Gets a simple list of representatives (including aum for the end of the date specified) that the logged in user has access to.\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "Representatives_GetValueAsOfDate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Representatives/Verbose": { "get": { "tags": [ "Portfolio/Representatives" ], "operationId": "Representatives_GetVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isActive", "in": "query", "required": false, "type": "boolean" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "BillRepresentativePlatforms", "ReportImage", "Notes", "Documents", "UserDefinedFields", "EntityOptions", "RepresentativeChanges", "RepBrokerDealers", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto" }, "xml": { "name": "RepresentativeVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Representatives" ], "operationId": "Representatives_UpdateVerboseRepresentativesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updatedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto" }, "xml": { "name": "RepresentativeVerboseDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto" }, "xml": { "name": "RepresentativeVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/Representatives" ], "summary": "Create new representative.", "operationId": "Representatives_CreateVerboseRepresentativeAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Representatives/Verbose/{key}": { "get": { "tags": [ "Portfolio/Representatives" ], "operationId": "Representatives_GetVerboseByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "BillRepresentativePlatforms", "ReportImage", "Notes", "Documents", "UserDefinedFields", "EntityOptions", "RepresentativeChanges", "RepBrokerDealers", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Representatives" ], "operationId": "Representatives_UpdateVerboseRepresentativeAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Representatives/Verbose/List": { "post": { "tags": [ "Portfolio/Representatives" ], "operationId": "Representatives_GetVerboseListById", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "BillRepresentativePlatforms", "ReportImage", "Notes", "Documents", "UserDefinedFields", "EntityOptions", "RepresentativeChanges", "RepBrokerDealers", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto" }, "xml": { "name": "RepresentativeVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Representatives/Verbose/List/Id": { "post": { "tags": [ "Portfolio/Representatives" ], "operationId": "Representatives_PostV1PortfolioRepresentativesVerboseListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "BillRepresentativePlatforms", "ReportImage", "Notes", "Documents", "UserDefinedFields", "EntityOptions", "RepresentativeChanges", "RepBrokerDealers", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto" }, "xml": { "name": "RepresentativeVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Representatives/Verbose/New": { "get": { "tags": [ "Portfolio/Representatives" ], "operationId": "Representatives_GetNewVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "BillRepresentativePlatforms", "ReportImage", "Notes", "Documents", "UserDefinedFields", "EntityOptions", "RepresentativeChanges", "RepBrokerDealers", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ReturnObjectives": { "get": { "tags": [ "Portfolio/ReturnObjectives" ], "operationId": "ReturnObjectives_GetAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ReturnObjective" }, "xml": { "name": "ReturnObjective", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/ReturnObjectives" ], "operationId": "ReturnObjectives_UpdateObjectives", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "objectives", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ReturnObjective" }, "xml": { "name": "ReturnObjective", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ReturnObjective" }, "xml": { "name": "ReturnObjective", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ReturnObjectives/Simple": { "get": { "tags": [ "Portfolio/ReturnObjectives" ], "summary": "Method to get all return objectives", "operationId": "ReturnObjectives_GetAllSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Rias": { "get": { "tags": [ "Portfolio/Rias" ], "operationId": "Rias_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RiaDto" }, "xml": { "name": "RiaDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/Rias" ], "operationId": "Rias_Create", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RiaDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Rias/{key}": { "get": { "tags": [ "Portfolio/Rias" ], "operationId": "Rias_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RiaDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Rias" ], "operationId": "Rias_Update", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RiaDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RiaDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/Rias" ], "operationId": "Rias_Delete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Rias/Action/Delete": { "put": { "tags": [ "Portfolio/Rias" ], "operationId": "Rias_PutV1PortfolioRiasActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "riaIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Rias/Simple": { "get": { "tags": [ "Portfolio/Rias" ], "operationId": "Rias_GetSimpleAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Rias/Simple/List": { "post": { "tags": [ "Portfolio/Rias" ], "operationId": "Rias_GetSimpleListById", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Rias/Simple/List/Id": { "post": { "tags": [ "Portfolio/Rias" ], "operationId": "Rias_PostV1PortfolioRiasSimpleListId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Rias/Simple/Search": { "get": { "tags": [ "Portfolio/Rias" ], "operationId": "Rias_GetSimpleSearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Rias/Simple/Search/{search}": { "get": { "tags": [ "Portfolio/Rias" ], "operationId": "Rias_GetV1PortfolioRiasSimpleSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/RiskCategories": { "get": { "tags": [ "Portfolio/RiskCategories" ], "summary": "Gets a list of risk categories that the logged in user has access to.", "operationId": "RiskCategories_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RiskCategoryDto" }, "xml": { "name": "RiskCategoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/RiskCategories/{key}": { "get": { "tags": [ "Portfolio/RiskCategories" ], "summary": "Gets the risk category that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "RiskCategories_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RiskCategoryDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/RiskCategories/Action/EstablishColors": { "put": { "tags": [ "Portfolio/RiskCategories" ], "summary": "Generates a random color for every risk category that has no color. The ids of any risk category affected is returned.", "operationId": "RiskCategories_ActionEstablishColors", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/RiskCategories/Exclusions": { "get": { "tags": [ "Portfolio/RiskCategories" ], "summary": "Gets a list of risk categories that the logged in user has access to.", "operationId": "RiskCategories_GetExcluded", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RiskCategoryDto" }, "xml": { "name": "RiskCategoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/RiskCategories/Simple": { "get": { "tags": [ "Portfolio/RiskCategories" ], "summary": "Gets a simple list of riskCategories that the logged in user has access to.", "operationId": "RiskCategories_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/RiskCategories/Simple/Search": { "get": { "tags": [ "Portfolio/RiskCategories" ], "summary": "Gets a simple list of risk categories by the search criteria.", "operationId": "RiskCategories_GetSimpleSearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "Risk Category Id, Abbrev or Full Name", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleRiskCategory" }, "xml": { "name": "SimpleRiskCategory", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/RiskCategories/Simple/Search/{search}": { "get": { "tags": [ "Portfolio/RiskCategories" ], "summary": "Gets a simple list of risk categories by the search criteria.", "operationId": "RiskCategories_GetV1PortfolioRiskCategoriesSimpleSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "Risk Category Id, Abbrev or Full Name", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleRiskCategory" }, "xml": { "name": "SimpleRiskCategory", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/RiskCategories/Value": { "get": { "tags": [ "Portfolio/RiskCategories" ], "summary": "Gets a simple list of risk categories with most rescently cached value that the logged in user has access to.", "operationId": "RiskCategories_GetValue", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.SimpleValueDto" }, "xml": { "name": "SimpleValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/RiskCategories/Verbose": { "get": { "tags": [ "Portfolio/RiskCategories" ], "operationId": "RiskCategories_GetVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "EntityOptions", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RiskCategoryVerboseDto" }, "xml": { "name": "RiskCategoryVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/RiskCategories" ], "operationId": "RiskCategories_UpdateVerboseRiskCategoriesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updatedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RiskCategoryVerboseDto" }, "xml": { "name": "RiskCategoryVerboseDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RiskCategoryVerboseDto" }, "xml": { "name": "RiskCategoryVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/RiskCategories" ], "summary": "Create a risk category", "operationId": "RiskCategories_CreateVerbose", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RiskCategoryVerboseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RiskCategoryVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/RiskCategories/Verbose/{key}": { "get": { "tags": [ "Portfolio/RiskCategories" ], "operationId": "RiskCategories_GetVerboseByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "EntityOptions", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RiskCategoryVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/RiskCategories" ], "operationId": "RiskCategories_UpdateVerboseRiskCategoryAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RiskCategoryVerboseDto" } }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RiskCategoryVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/RiskCategories" ], "summary": "Used to delete an existing risk category. Upon successful deletion a 204 will be returned.", "operationId": "RiskCategories_DeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "reassignKey", "in": "query", "description": "Optional. If provided, will reassociate any products associated to the risk category to be deleted to this other risk category.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/RiskCategories/Verbose/CanDelete/{key}": { "get": { "tags": [ "Portfolio/RiskCategories" ], "summary": "Gets a list of errors if a delete was attempted on the risk category", "operationId": "RiskCategories_CanDelete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "ID of the risk category to check", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.Validation.IValidationError" }, "xml": { "name": "IValidationError", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/RiskCategories/Verbose/List": { "post": { "tags": [ "Portfolio/RiskCategories" ], "operationId": "RiskCategories_GetVerboseListById", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "EntityOptions", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RiskCategoryVerboseDto" }, "xml": { "name": "RiskCategoryVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/RiskCategories/Verbose/List/Id": { "post": { "tags": [ "Portfolio/RiskCategories" ], "operationId": "RiskCategories_PostV1PortfolioRiskCategoriesVerboseListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "EntityOptions", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RiskCategoryVerboseDto" }, "xml": { "name": "RiskCategoryVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/RiskCategories/Verbose/New": { "get": { "tags": [ "Portfolio/RiskCategories" ], "operationId": "RiskCategories_GetNewVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "EntityOptions", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RiskCategoryVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/RiskCategoryAutoAssignOverride": { "get": { "tags": [ "Portfolio/RiskCategoryAutoAssignOverride" ], "summary": "Gets a list of Risk Category Auto Assign Overrides that the logged in user has access to.", "operationId": "RiskCategoryAutoAssignOverride_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "providerId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "providerAssigned", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RiskCategoryAutoAssignOverrideDto" }, "xml": { "name": "RiskCategoryAutoAssignOverrideDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/RiskCategoryAutoAssignOverride" ], "summary": "", "operationId": "RiskCategoryAutoAssignOverride_Upsert", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "overRecords", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RiskCategoryAutoAssignOverrideDto" }, "xml": { "name": "RiskCategoryAutoAssignOverrideDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RiskCategoryAutoAssignOverrideDto" }, "xml": { "name": "RiskCategoryAutoAssignOverrideDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/RiskCategoryAutoAssignOverride/{providerId}/{abbreviation}": { "get": { "tags": [ "Portfolio/RiskCategoryAutoAssignOverride" ], "summary": "Gets the Risk Category Auto Assign Override that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "RiskCategoryAutoAssignOverride_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "providerId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "abbreviation", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RiskCategoryAutoAssignOverrideDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/RiskCategoryAutoAssignOverride/List": { "post": { "tags": [ "Portfolio/RiskCategoryAutoAssignOverride" ], "summary": "Gets the product classe Auto Assign Overrides for the provided keys.", "operationId": "RiskCategoryAutoAssignOverride_GetListById", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RiskCategoryAutoAssignOverrideKeyDto" }, "xml": { "name": "RiskCategoryAutoAssignOverrideKeyDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RiskCategoryAutoAssignOverrideDto" }, "xml": { "name": "RiskCategoryAutoAssignOverrideDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/RiskCategoryAutoAssignOverride/List/Id": { "post": { "tags": [ "Portfolio/RiskCategoryAutoAssignOverride" ], "summary": "Gets the product classe Auto Assign Overrides for the provided keys.", "operationId": "RiskCategoryAutoAssignOverride_PostV1PortfolioRiskCategoryAutoAssignOverrideListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RiskCategoryAutoAssignOverrideKeyDto" }, "xml": { "name": "RiskCategoryAutoAssignOverrideKeyDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RiskCategoryAutoAssignOverrideDto" }, "xml": { "name": "RiskCategoryAutoAssignOverrideDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/RiskCategoryAutoAssignOverride/RiskCategory/Simple": { "get": { "tags": [ "Portfolio/RiskCategoryAutoAssignOverride" ], "operationId": "RiskCategoryAutoAssignOverride_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Global/Assignments": { "post": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Retrieves global security class assignment records", "description": "Sample Request\r\n POST Portfolio/SecurityClassificatio/Global/Assignments\r\n [{\r\n \"RequestId\": 1,\r\n \"SecurityClassificationMethodId\": 231,\r\n \"ProductIds\": [1,20120,12615]\r\n }]", "operationId": "SecurityClassificationAssignmentGlobal_GetListAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "description": "SecurityClassificationGlobalAssignmentRequestDto[]", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassificationGlobalAssignmentRequestDto" }, "xml": { "name": "SecurityClassificationGlobalAssignmentRequestDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassificationGlobalAssignmentResponseDto" }, "xml": { "name": "SecurityClassificationGlobalAssignmentResponseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Global/Assignments/{globalMethodId}": { "post": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Retrieves global security class assignment records by download symbol for a specific global method.", "description": "Sample Request\r\n POST /Portfolio/SecurityClassification/Global/Assignments/58\r\n [\"dia\",\"msft\"]", "operationId": "SecurityClassificationAssignmentGlobal_GetListBySymbolAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "globalMethodId", "in": "path", "description": "Global security classification method id.", "required": true, "type": "integer", "format": "int32" }, { "name": "symbols", "in": "body", "description": "Download symbols.", "required": true, "schema": { "items": { "type": "string" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassificationGlobalAssignmentBySymbolResponseDto" }, "xml": { "name": "SecurityClassificationGlobalAssignmentBySymbolResponseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Global/Derivations": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Gets a list of Global Security Class Derivations.\r\nThe return is limited to pages of 100000. Use $top and $skip in the query string to page through the data.\r\nPass a combination of paremeters to filter the results.", "description": "Sample Request\r\n GET /Portfolio/SecurityClassification/Global/Derivations?$top=1000&$skip=0&baseSecurityClassIds=1&baseSecurityClassIds=2&classificationMethodIds=4", "operationId": "DerivationsGlobal_GetAllAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "manipulator", "in": "header", "description": "Projection Manipulator", "required": true }, { "name": "cancellationToken", "in": "header", "description": "Cancellation Token", "required": true }, { "name": "baseSecurityClassIds", "in": "query", "description": "Optional: List of Security Class Base Ids", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "classificationMethodIds", "in": "query", "description": "Optional: List of Classification Method Ids", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "derivedSecurityClassIds", "in": "query", "description": "Optional: List of Derived Security Class Ids", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.DerivationGlobalDto" }, "xml": { "name": "DerivationGlobalDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Creates a Global Security Class Derivation", "description": "Sample Request\r\n POST /Portfolio/SecurityClassification/Global/Derivations", "operationId": "DerivationsGlobal_CreateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "DerivationGlobalDto", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.DerivationGlobalDto" } }, { "name": "cancellationToken", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Global/Derivations/{securityClassificationMethodId}/{baseSecurityClassId}/{derivedSecurityClassId}": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Gets a single Global Security Class Derivation", "description": "Sample Request\r\n GET /Portfolio/SecurityClassification/Global/Derivations/1/2/3", "operationId": "DerivationsGlobal_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "securityClassificationMethodId", "in": "path", "description": "SecurityClassificationMethodId", "required": true, "type": "integer", "format": "int32" }, { "name": "baseSecurityClassId", "in": "path", "description": "BaseSecurityClassId", "required": true, "type": "integer", "format": "int32" }, { "name": "derivedSecurityClassId", "in": "path", "description": "DerivedSecurityClassId", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.DerivationGlobalDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Delete a Global Security Class Derivation", "description": "Sample Request\r\n DELETE /Portfolio/SecurityClassification/Global/Derivations/1/2/3", "operationId": "DerivationsGlobal_DeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "securityClassificationMethodId", "in": "path", "description": "SecurityClassificationMethodId", "required": true, "type": "integer", "format": "int32" }, { "name": "baseSecurityClassId", "in": "path", "description": "BaseSecurityClassId", "required": true, "type": "integer", "format": "int32" }, { "name": "derivedSecurityClassId", "in": "path", "description": "DerivedSecurityClassId", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Global/MethodAlClients": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Gets a list of Security classification method AlClients global records.\r\nThe return is limited to pages of 100000. Use $top and $skip in the query string to page through the data.", "description": "Sample Request\r\n GET /Portfolio/SecurityClassification/Global/MethodAlClients?$top=1000&$skip=0", "operationId": "MethodAlClientsGlobal_GetAllAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "manipulator", "in": "header", "required": true }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "clientIds", "in": "query", "description": "List of AlClientIds to filter by", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "securityClassificationMethodIds", "in": "query", "description": "List of Method Global IDs to filter by.", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodAlClientGlobalDto" }, "xml": { "name": "MethodAlClientGlobalDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Creates a new Security classification method alclient global.", "description": "Sample Request\r\n POST /Portfolio/SecurityClassification/Global/MethodAlClients", "operationId": "MethodAlClientsGlobal_CreateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "The MethodAlClientGlobalDto object.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodAlClientGlobalDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Global/MethodAlClients/{alClientId}/{methodGlobalId}": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Gets a Security classification method AlClients global record.\r\nThe return is limited to pages of 100000. Use $top and $skip in the query string to page through the data.", "description": "Sample Request\r\n GET /Portfolio/SecurityClassification/Global/MethodAlClients/{alClientId:int}/{methodGlobalId:int}", "operationId": "MethodAlClientsGlobal_GetOneAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "alClientId", "in": "path", "description": "AlClient ID", "required": true, "type": "integer", "format": "int32" }, { "name": "methodGlobalId", "in": "path", "description": "Method Global ID", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Deletes a Security classification method global by ID.", "description": "Sample Request\r\n DELETE /Portfolio/SecurityClassification/Global/MethodAlClients/1/1", "operationId": "MethodAlClientsGlobal_DeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "alClientId", "in": "path", "description": "The AlClient id.", "required": true, "type": "integer", "format": "int32" }, { "name": "methodGlobalId", "in": "path", "description": "The Method Global id.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "Success", "schema": { "type": "object" } }, "400": { "description": "Failed" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Global/MethodAlClients/{methodGlobalId}": { "put": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Adds/Updates/Deletes AlClient access for a Security Classification Method.", "description": "Sample Request\r\n PUT /Portfolio/SecurityClassification/Global/MethodAlClients/1", "operationId": "MethodAlClientsGlobal_UpdateByMethodGlobalIdAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "methodGlobalId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodAlClientGlobalDto" }, "xml": { "name": "MethodAlClientGlobalDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "Success", "schema": { "type": "object" } }, "400": { "description": "Failed" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Global/MethodRuleDataset": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Returns the method rule data sets for global security classification rule configuration", "operationId": "MethodRuleDataset_GetAllAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "description": "Cancellation token", "required": true }, { "name": "classificationMethodId", "in": "query", "description": "Optional classification method ID to filter out circular dependencies", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodRuleDataSetDto" }, "xml": { "name": "MethodRuleDataSetDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Global/Methods": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Gets a list of Security classification method global data.\r\nThe return is limited to pages of 100000. Use $top and $skip in the query string to page through the data.", "description": "Sample Request\r\n GET /Portfolio/SecurityClassification/Global/Methods?$top=1000&$skip=0", "operationId": "MethodsGlobal_GetAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "manipulator", "in": "header", "required": true }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodGlobalDto" }, "xml": { "name": "MethodGlobalDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Creates a new Security classification method global.", "description": "Sample Request\r\n POST /Portfolio/SecurityClassification/Global/Methods", "operationId": "MethodsGlobal_CreateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "The MethodGlobalDto object.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodGlobalDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Global/Methods/{classificationMethodId}/MethodRules": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Get a list of Security Classification Method Rules by Method ID.", "description": "Sample Request\r\n GET /Portfolio/SecurityClassification/Global/Method/1/MethodRules?$top=1000&$skip=0", "operationId": "MethodsGlobal_MethodRulesByMethodIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "classificationMethodId", "in": "path", "description": "The classification method ID.", "required": true, "type": "integer", "format": "int32" }, { "name": "manipulator", "in": "header", "description": "The projection manipulator for the query.", "required": true }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true }, { "name": "securityClassIds", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "Success. Returns the list of security classification method rules", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodRuleGlobalDto" }, "xml": { "name": "MethodRuleGlobalDto", "wrapped": true }, "type": "array" } }, "400": { "description": "If the request is invalid." } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Bulk add/edit/deletes Security Classification Method Rules record by Classification Method ID.", "description": "Sample Request\r\n PUT /Portfolio/SecurityClassification/Global/Method/33/MethodRules", "operationId": "MethodsGlobal_VerboseUpdateMethodRuleAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "classificationMethodId", "in": "path", "description": "The classification method ID.", "required": true, "type": "integer", "format": "int32" }, { "name": "dtos", "in": "body", "description": "Security Classification Method Rules.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodRuleGlobalDto" }, "xml": { "name": "MethodRuleGlobalDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "Success.", "schema": { "type": "object" } }, "400": { "description": "If the request is invalid." } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Create a Security Classification Method Rules record by Classification Method ID.", "description": "Sample Request\r\n POST /Portfolio/SecurityClassification/Global/Method/33/MethodRules", "operationId": "MethodsGlobal_CreateMethodRuleAync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "classificationMethodId", "in": "path", "description": "The classification method ID.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodRuleGlobalDto" } }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "Success. Returns the created security classification method rule", "schema": { "type": "object" } }, "400": { "description": "If the request is invalid." } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Global/Methods/{classificationMethodId}/MethodRules/{runOrder}": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Get a Security Classification Method Rules record by run order id.", "description": "Sample Request\r\n GET /Portfolio/SecurityClassification/Global/Method/33/MethodRules/1", "operationId": "MethodsGlobal_GetMethodRuleByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "classificationMethodId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "runOrder", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "Success. Returns the list of security classification method rules", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodRuleGlobalDto" } }, "400": { "description": "If the request is invalid." } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Updates a Security Classification Method Rules record by Classification Method ID.", "description": "Sample Request\r\n PUT /Portfolio/SecurityClassification/Global/Method/33/MethodRules/1", "operationId": "MethodsGlobal_UpdateMethodRuleAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "classificationMethodId", "in": "path", "description": "The classification method ID.", "required": true, "type": "integer", "format": "int32" }, { "name": "runOrder", "in": "path", "description": "The run order id.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodRuleGlobalDto" } }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "Success. Returns the updated security classification method rule", "schema": { "type": "object" } }, "400": { "description": "If the request is invalid." } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Deletes a Security Classification Method Rules record by Classification Method ID and RunOrder ID.", "description": "Sample Request\r\n DELETE /Portfolio/SecurityClassification/Global/Method/33/MethodRules/3", "operationId": "MethodsGlobal_DeleteMethodRuleAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "classificationMethodId", "in": "path", "description": "The classification method ID.", "required": true, "type": "integer", "format": "int32" }, { "name": "runOrder", "in": "path", "description": "The run order id.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "Success.", "schema": { "type": "object" } }, "400": { "description": "If the request is invalid." } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Global/Methods/{classificationMethodId}/MethodRules/Preview/{impactedProducts}": { "post": { "tags": [ "Portfolio/SecurityClassification" ], "operationId": "MethodsGlobal_PreviewMethodRulesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "classificationMethodId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodRuleGlobalDto" }, "xml": { "name": "MethodRuleGlobalDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "impactedProducts", "in": "path", "required": true, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Global/Methods/{key}": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Gets Security classification method global for a single record by key.", "description": "Sample Request\r\n GET /Portfolio/SecurityClassification/Global/Methods/1", "operationId": "MethodsGlobal_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodGlobalDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Updates a new Security classification method global.", "description": "Sample Request\r\n PUT /Portfolio/SecurityClassification/Global/Methods/1", "operationId": "MethodsGlobal_UpdateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The Method Global id.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "The MethodGlobalDto object.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodGlobalDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Deletes a Security classification method global by ID.", "description": "Sample Request\r\n DELETE /Portfolio/SecurityClassification/Global/Methods/1", "operationId": "MethodsGlobal_DeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The Method Global id.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "Success", "schema": { "type": "object" } }, "400": { "description": "Failed" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Global/Methods/Actions/GlobalRecalculation/{key}": { "post": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "", "operationId": "MethodsGlobal_GlobalRecalculation", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Global/Methods/ListForLocal": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Gets a list of Security classification method global data for local use.\r\nReturns active methods and respects restricted access based on the current user's AlClient.", "description": "Sample Request\r\n GET /Portfolio/SecurityClassification/Global/Methods/ListForLocal", "operationId": "MethodsGlobal_ListForLocalAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodGlobalDto" }, "xml": { "name": "MethodGlobalDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Global/Methods/Simple": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Gets a list of Security classification method global simple data.", "description": "Sample Request\r\n GET /Portfolio/SecurityClassification/Global/Methods/Simple?searchText=morning&$top=1000&$skip=0", "operationId": "MethodsGlobal_GetSimpleAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "manipulator", "in": "header", "required": true }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "searchText", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Global/Methods/Verbose/{key}": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "operationId": "MethodsGlobal_GetVerboseByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "MethodGlobal", "SecurityClassesGlobal", "DerivationsGlobal", "MethodRulesGlobal", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.ClassificationMethodGlobalVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Updates a verbose Security classification method global", "description": "Sample Request\r\n PUT /Portfolio/SecurityClassification/Global/Methods/Verbose", "operationId": "MethodsGlobal_UpdateVerboseAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Security classification method global ID", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "description": "Security classification method global", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.ClassificationMethodGlobalVerboseDto" } }, { "name": "cancellationToken", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Global/Products": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Retrieves all Security Classification Product Globals based on the provided filters.", "description": "Sample Requests\r\nGet All - GET /Portfolio/SecurityClassification/Global/Products\r\nBy Security Class Ids - GET /Portfolio/SecurityClassification/Global/Products?securityClassIds=28&securityClassIds=27\r\nBy Classification Methods - GET /Portfolio/SecurityClassification/Global/Products?classificationMethodIds=8&classificationMethodIds=9\r\nBy Product Ids - GET /Portfolio/SecurityClassification/Global/Products?productIds=20120&productIds=9\r\nEntity Session - GET /Portfolio/SecurityClassification/Global/Products?entitySessionId=-2146875255", "operationId": "SecurityClassificationsProductsGlobal_GetAllAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "manipulator", "in": "header", "required": true }, { "name": "cancellationToken", "in": "header", "description": "Token to cancel the operation.", "required": true }, { "name": "securityClassIds", "in": "query", "description": "Optional list of Security Class IDs to filter by.", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "classificationMethodIds", "in": "query", "description": "Optional list of Classification Method IDs to filter by.", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "productIds", "in": "query", "description": "Optional list of Product IDs to filter by.", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "entitySessionId", "in": "query", "description": "Optional Entity Session ID to filter by.", "required": false, "type": "integer", "format": "int32" }, { "name": "productFilter", "in": "query", "description": "Optional product filter (e.g. CurrentlyOwnedProducts, HasEverOwnedProducts).", "required": false, "type": "string", "enum": [ "None", "LocalProducts", "CurrentlyOwnedProducts", "HasEverOwnedProducts", "MissingRiskCategories", "MissingAssetClasses", "Top1000BySubType" ] }, { "name": "view", "in": "query", "required": false, "type": "string", "enum": [ "CurrentlyOwnedAssigned", "CurrentlyOwnedInherited", "CurrentlyOwnedAssignedToDefault", "CurrentlyOwnedAll", "EverOwnedAssigned", "EverOwnedInherited", "EverOwnedAssignedToDefault", "EverOwnedAll", "AllAssignedProducts", "CustomList", "Top1000BySubType" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassificationProductGlobalDto" }, "xml": { "name": "SecurityClassificationProductGlobalDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Global/Products/{classificationMethodId}": { "put": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Updates or inserts Security Classification Product Globals.", "description": "Sample Request\r\nPUT /Portfolio/SecurityClassification/Global/Products/8/20120\r\n[\r\n {\r\n \"securityClassId\": 23,\r\n \"securityClassificationMethodId\": 8,\r\n \"productId\": 20120,\r\n \"classificationWeight\": 0.125,\r\n \"isManual\": true\r\n },\r\n {\r\n \"securityClassId\": 25,\r\n \"securityClassificationMethodId\": 8,\r\n \"productId\": 20120,\r\n \"classificationWeight\": 0.875,\r\n \"isManual\": true\r\n }\r\n]", "operationId": "SecurityClassificationsProductsGlobal_UpsertByMethodAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "classificationMethodId", "in": "path", "description": "The ID of the Classification Method.", "required": true, "type": "integer", "format": "int32" }, { "name": "dtos", "in": "body", "description": "The list of DTOs to upsert.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassificationProductGlobalDto" }, "xml": { "name": "SecurityClassificationProductGlobalDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "description": "Token to cancel the operation.", "required": true }, { "name": "persistedPayload", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Deletes all weightings for a specific Classification Method.", "description": "Sample Request\r\n DELETE /Portfolio/SecurityClassification/Global/Products/8", "operationId": "SecurityClassificationsProductsGlobal_DeleteAllAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "classificationMethodId", "in": "path", "description": "The ID of the Classification Method.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "description": "Token to cancel the operation.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Global/Products/{classificationMethodId}/{productId}": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Retrieves the weightings for a specific Classification Method and Product.", "description": "Sample Request\r\nGET /Portfolio/SecurityClassification/Global/Products/8/20120", "operationId": "SecurityClassificationsProductsGlobal_GetWeightingsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "classificationMethodId", "in": "path", "description": "The ID of the Classification Method.", "required": true, "type": "integer", "format": "int32" }, { "name": "productId", "in": "path", "description": "The ID of the Product.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "description": "Token to cancel the operation.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Updates or inserts Security Classification Product Globals.", "description": "Sample Request\r\nPUT /Portfolio/SecurityClassification/Global/Products/8/20120\r\n[\r\n {\r\n \"securityClassId\": 23,\r\n \"securityClassificationMethodId\": 8,\r\n \"productId\": 20120,\r\n \"classificationWeight\": 0.125,\r\n \"isManual\": true\r\n },\r\n {\r\n \"securityClassId\": 25,\r\n \"securityClassificationMethodId\": 8,\r\n \"productId\": 20120,\r\n \"classificationWeight\": 0.875,\r\n \"isManual\": true\r\n }\r\n]", "operationId": "SecurityClassificationsProductsGlobal_UpsertByMethodProductAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "classificationMethodId", "in": "path", "description": "The ID of the Classification Method.", "required": true, "type": "integer", "format": "int32" }, { "name": "productId", "in": "path", "description": "The ID of the Product.", "required": true, "type": "integer", "format": "int32" }, { "name": "dtos", "in": "body", "description": "The list of DTOs to upsert.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassificationProductGlobalDto" }, "xml": { "name": "SecurityClassificationProductGlobalDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "description": "Token to cancel the operation.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Deletes all weightings for a specific Classification Method and Product.", "description": "Sample Request\r\n DELETE /Portfolio/SecurityClassification/Global/Products/8/20120", "operationId": "SecurityClassificationsProductsGlobal_DeleteOneAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "classificationMethodId", "in": "path", "description": "The ID of the Classification Method.", "required": true, "type": "integer", "format": "int32" }, { "name": "productId", "in": "path", "description": "The ID of the Product.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "description": "Token to cancel the operation.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Global/Products/{classificationMethodId}/AssignedCount": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Gets the count of assigned products for a classification method.", "operationId": "SecurityClassificationsProductsGlobal_GetAssignedCountAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "classificationMethodId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Global/Products/Import/Filter/{classificationMethodId}": { "post": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Allows uploading a list of products to be custom filtered by product ID or download symbol", "operationId": "SecurityClassificationsProductsGlobal_CustomFilterProductsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "classificationMethodId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "fileData", "in": "body", "description": "File containing either Product ID or Download Symbol column", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ImportFileFilterDto" } }, { "name": "token", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Global/Products/Import/Upload/{classificationMethodId}": { "post": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Allows uploading a list of products to be assigned to a classification method.", "operationId": "SecurityClassificationsProductsGlobal_UploadProductsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "classificationMethodId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "fileData", "in": "body", "description": "File containing either Product ID or Download Symbol column", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ImportFileFilterDto" } }, { "name": "token", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Global/Products/View/{view}/Session": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Gets an entity session ID for views that require server-side product list resolution (e.g. Top 1000 by SubType).\r\nUse the returned entitySessionId with the main Products GET when loading that view.", "operationId": "SecurityClassificationsProductsGlobal_GetViewSessionAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "view", "in": "path", "description": "The view type (e.g. Top1000BySubType)", "required": true, "type": "string", "enum": [ "CurrentlyOwnedAssigned", "CurrentlyOwnedInherited", "CurrentlyOwnedAssignedToDefault", "CurrentlyOwnedAll", "EverOwnedAssigned", "EverOwnedInherited", "EverOwnedAssignedToDefault", "EverOwnedAll", "AllAssignedProducts", "CustomList", "Top1000BySubType" ] }, { "name": "token", "in": "header", "description": "Cancellation token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Global/SecurityClasses": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Gets a list of Security classification Security Class Data.\r\nThe return is limited to pages of 100000. Use $top and $skip in the query string to page through the data.", "description": "Sample Request\r\n GET /Portfolio/SecurityClassification/Global/SecurityClasses?$top=1000&$skip=0", "operationId": "SecurityClassesGlobal_GetListAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "manipulator", "in": "header", "description": "The projection manipulator for the query.", "required": true }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true }, { "name": "ids", "in": "query", "description": "Optional. A list of security class IDs to filter the results.", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "securityClassificationMethodIds", "in": "query", "description": "Optional. A list of security classification method IDs to filter the results.", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "Success. Returns the list of security classification security class data.", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassGlobalDto" }, "xml": { "name": "SecurityClassGlobalDto", "wrapped": true }, "type": "array" } }, "400": { "description": "If the request is invalid." } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Global/SecurityClasses/{key}": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Gets a Security classification Security Class by ID.", "description": "The Security Class Global ID\r\n Sample Request\r\n GET /Portfolio/SecurityClassification/Global/SecurityClasses/1", "operationId": "SecurityClassesGlobal_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "Success. Returns the security classification security class data for the specified ID.", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassGlobalDto" } }, "400": { "description": "If the request is invalid." }, "404": { "description": "If the security class with the specified ID is not found." } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Deletes a GLobal Security Class by ID.", "description": "Sample Request\r\n DELETE /Portfolio/SecurityClassification/Global/SecurityClasses/1", "operationId": "SecurityClassesGlobal_DeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The Global Security Class ID.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "Success", "schema": { "type": "object" } }, "400": { "description": "Failed" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Global/SecurityClasses/{key}/AssociatedRecordCounts": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Get's a summary of associated record counts for a GLobal Security Class by ID.", "description": "The Security Class Global ID\r\n Sample Request\r\n GET /Portfolio/SecurityClassification/Global/SecurityClasses/1/AssociatedRecordCounts", "operationId": "SecurityClassesGlobal_GetAssociationCountsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassAssociationCountsDto" } }, "400": { "description": "Failed" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Global/SecurityClasses/DeleteMany": { "put": { "tags": [ "Portfolio/SecurityClassification" ], "operationId": "SecurityClassesGlobal_DeleteManyAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Global/SecurityClasses/Simple": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Gets a list of Security classification Security Class simple entityu data.", "description": "Sample Request\r\n GET /Portfolio/SecurityClassification/Global/SecurityClasses/Simple?searchText=morning&$top=1000&$skip=0", "operationId": "SecurityClassesGlobal_GetSimpleAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "manipulator", "in": "header", "description": "The projection manipulator for the query.", "required": true }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true }, { "name": "searchText", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "Success. Returns the list of security classification security class simple entity data.", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } }, "400": { "description": "If the request is invalid." } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Global/SecurityClasses/Upsert": { "post": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Upsert Create/Edits a list of Global Security Class records.", "description": "Sample Request\r\n POST /Portfolio/SecurityClassification/Global/SecurityClasses/Upsert", "operationId": "SecurityClassesGlobal_UpsertAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "description": "The SecurityClassGlobalDto object.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassGlobalDto" }, "xml": { "name": "SecurityClassGlobalDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "Success. Returns the list of security class data for the given request.", "schema": { "type": "object" } }, "400": { "description": "If the request is invalid." }, "404": { "description": "If the security class with the specified ID is not found." } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Local/Assignments": { "post": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Retrieves security class assignment records", "description": "Sample Request\r\n POST Portfolio/SecurityClassificatio/Local/Assignments\r\n [{\r\n \"RequestId\": 1,\r\n \"SecurityClassificationMethodId\": 231,\r\n \"ReportGroupingEntityEnum\": null,\r\n \"ProductIds\": [1,20120,12615],\r\n \"EntityEnumOverride\": null,\r\n \"EntityEnumOverrideIds\": null\r\n }]", "operationId": "SecurityClassificationAssignmentLocal_GetListAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "description": "SecurityClassificationAssignmentRequestDto[]", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassificationAssignmentRequestDto" }, "xml": { "name": "SecurityClassificationAssignmentRequestDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassificationAssignmentResponseDto" }, "xml": { "name": "SecurityClassificationAssignmentResponseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Local/Derivations": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Gets a list of Local Security Class Derivations.\r\nThe return is limited to pages of 100000. Use $top and $skip in the query string to page through the data.\r\nPass a combination of paremeters to filter the results.", "description": "Sample Request\r\n GET /Portfolio/SecurityClassification/Local/Derivations?$top=1000&$skip=0&baseSecurityClassIds=1&baseSecurityClassIds=2&classificationMethodIds=4", "operationId": "DerivationsLocal_GetAllAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "manipulator", "in": "header", "description": "Projection Manipulator", "required": true }, { "name": "cancellationToken", "in": "header", "description": "Cancellation Token", "required": true }, { "name": "baseSecurityClassIds", "in": "query", "description": "Optional: List of Security Class Base Ids", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "classificationMethodIds", "in": "query", "description": "Optional: List of Classification Method Ids", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "derivedSecurityClassIds", "in": "query", "description": "Optional: List of Derived Security Class Ids", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.DerivationLocalDto" }, "xml": { "name": "DerivationLocalDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Creates a Local Security Class Derivation", "description": "Sample Request\r\n POST /Portfolio/SecurityClassification/Local/Derivations", "operationId": "DerivationsLocal_CreateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "DerivationLocalDto", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.DerivationLocalDto" } }, { "name": "cancellationToken", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Local/Derivations/{securityClassificationMethodId}/{baseSecurityClassId}/{derivedSecurityClassId}": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Gets a single Local Security Class Derivation", "description": "Sample Request\r\n GET /Portfolio/SecurityClassification/Local/Derivations/1/2/3", "operationId": "DerivationsLocal_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "securityClassificationMethodId", "in": "path", "description": "SecurityClassificationMethodId", "required": true, "type": "integer", "format": "int32" }, { "name": "baseSecurityClassId", "in": "path", "description": "BaseSecurityClassId", "required": true, "type": "integer", "format": "int32" }, { "name": "derivedSecurityClassId", "in": "path", "description": "DerivedSecurityClassId", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.DerivationLocalDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Delete a Local Security Class Derivation", "description": "Sample Request\r\n DELETE /Portfolio/SecurityClassification/Local/Derivations/1/2/3", "operationId": "DerivationsLocal_DeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "securityClassificationMethodId", "in": "path", "description": "SecurityClassificationMethodId", "required": true, "type": "integer", "format": "int32" }, { "name": "baseSecurityClassId", "in": "path", "description": "BaseSecurityClassId", "required": true, "type": "integer", "format": "int32" }, { "name": "derivedSecurityClassId", "in": "path", "description": "DerivedSecurityClassId", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Local/MethodRuleDataset": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Returns the method rule data sets for security classification rule configuration", "operationId": "MethodRuleDatasetLocal_GetAllAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "description": "Cancellation token", "required": true }, { "name": "classificationMethodId", "in": "query", "description": "Optional classification method ID to filter out circular dependencies", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodRuleDataSetDto" }, "xml": { "name": "MethodRuleDataSetDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Local/Methods": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Gets a list of Security classification method local data.\r\nThe return is limited to pages of 100000. Use $top and $skip in the query string to page through the data.", "description": "Sample Request\r\n GET /Portfolio/SecurityClassification/Local/Methods?$top=1000&$skip=0", "operationId": "MethodsLocal_GetAllAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "manipulator", "in": "header", "required": true }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "securityClassificationMethodIds", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodLocalDto" }, "xml": { "name": "MethodLocalDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Creates a new Security classification method Local.", "description": "Sample Request\r\n POST /Portfolio/SecurityClassification/Local/Methods", "operationId": "MethodsLocal_CreateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "The MethodLocalDto object.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodLocalDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Local/Methods/{classificationMethodId}/MethodRules": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Get a list of Security Classification Method Rules by Method ID.", "description": "Sample Request\r\n GET /Portfolio/SecurityClassification/Local/Method/1/MethodRules?$top=1000&$skip=0", "operationId": "MethodsLocal_MethodRulesByMethodIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "classificationMethodId", "in": "path", "description": "The classification method ID.", "required": true, "type": "integer", "format": "int32" }, { "name": "manipulator", "in": "header", "description": "The projection manipulator for the query.", "required": true }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true }, { "name": "securityClassIds", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "Success. Returns the list of security classification method rules", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodRuleLocalDto" }, "xml": { "name": "MethodRuleLocalDto", "wrapped": true }, "type": "array" } }, "400": { "description": "If the request is invalid." } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Bulk add/edit/deletes Security Classification Method Rules record by Classification Method ID.", "description": "Sample Request\r\n PUT /Portfolio/SecurityClassification/Local/Method/33/MethodRules", "operationId": "MethodsLocal_VerboseUpdateMethodRuleAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "classificationMethodId", "in": "path", "description": "The classification method ID.", "required": true, "type": "integer", "format": "int32" }, { "name": "dtos", "in": "body", "description": "Security Classification Method Rules.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodRuleLocalDto" }, "xml": { "name": "MethodRuleLocalDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "Success.", "schema": { "type": "object" } }, "400": { "description": "If the request is invalid." } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Create a Security Classification Method Rules record by Classification Method ID.", "description": "Sample Request\r\n POST /Portfolio/SecurityClassification/Local/Method/33/MethodRules", "operationId": "MethodsLocal_CreateMethodRuleAync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "classificationMethodId", "in": "path", "description": "The classification method ID.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodRuleLocalDto" } }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "Success. Returns the created security classification method rule", "schema": { "type": "object" } }, "400": { "description": "If the request is invalid." } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Local/Methods/{classificationMethodId}/MethodRules/{runOrder}": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Get a Security Classification Method Rules record by run order id.", "description": "Sample Request\r\n GET /Portfolio/SecurityClassification/Local/Method/33/MethodRules/1", "operationId": "MethodsLocal_GetMethodRuleByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "classificationMethodId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "runOrder", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "Success. Returns the list of security classification method rules", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodRuleLocalDto" } }, "400": { "description": "If the request is invalid." } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Updates a Security Classification Method Rules record by Classification Method ID.", "description": "Sample Request\r\n PUT /Portfolio/SecurityClassification/Local/Method/33/MethodRules/1", "operationId": "MethodsLocal_UpdateMethodRuleAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "classificationMethodId", "in": "path", "description": "The classification method ID.", "required": true, "type": "integer", "format": "int32" }, { "name": "runOrder", "in": "path", "description": "The run order id.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodRuleLocalDto" } }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "Success. Returns the updated security classification method rule", "schema": { "type": "object" } }, "400": { "description": "If the request is invalid." } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Deletes a Security Classification Method Rules record by Classification Method ID and RunOrder ID.", "description": "Sample Request\r\n DELETE /Portfolio/SecurityClassification/Local/Method/33/MethodRules/3", "operationId": "MethodsLocal_DeleteMethodRuleAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "classificationMethodId", "in": "path", "description": "The classification method ID.", "required": true, "type": "integer", "format": "int32" }, { "name": "runOrder", "in": "path", "description": "The run order id.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "Success.", "schema": { "type": "object" } }, "400": { "description": "If the request is invalid." } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Local/Methods/{classificationMethodId}/MethodRules/Preview/{impactedProducts}": { "post": { "tags": [ "Portfolio/SecurityClassification" ], "operationId": "MethodsLocal_PreviewMethodRulesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "classificationMethodId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodRuleLocalDto" }, "xml": { "name": "MethodRuleLocalDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "impactedProducts", "in": "path", "required": true, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Local/Methods/{key}": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Gets Security classification method Local for a single record by key.", "description": "Sample Request\r\n GET /Portfolio/SecurityClassification/Local/Methods/1", "operationId": "MethodsLocal_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodLocalDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Updates a new Security classification method Local.", "description": "Sample Request\r\n PUT /Portfolio/SecurityClassification/Local/Methods/1234", "operationId": "MethodsLocal_UpdateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The Method ID.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "The MethodLocalDto object.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodLocalDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Deletes a new Security classification method Local.", "description": "Sample Request\r\n DELETE /Portfolio/SecurityClassification/Local/Methods/1234", "operationId": "MethodsLocal_DeleteByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The Method ID.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Local/Methods/{key}/AssociatedRecordCounts": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Get's a summary of associated record counts for a Local Security Classification Method.", "description": "The Security Class Method ID\r\n Sample Request\r\n GET /Portfolio/SecurityClassification/Local/Methods/1/AssociatedRecordCounts", "operationId": "MethodsLocal_GetAssociationCountsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodLocalAssociationCountsDto" } }, "400": { "description": "Failed" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Local/Methods/Actions/Recalculation/{key}": { "post": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Recalculates classification methods on demand", "operationId": "MethodsLocal_LocalRecalculation", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Classification Method Id", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Local/Methods/MigrateSecurityClassification": { "post": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Triggers security classification migration jobs for the specified codes", "operationId": "MethodsLocal_MigrateSecurityClassificationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "description": "Migration codes to execute", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.MigrateSecurityClassificationRequestDto" } }, { "name": "ct", "in": "header", "description": "Cancellation token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Local/Methods/MigrateSecurityClassificationValidation": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "operationId": "MethodsLocal_MigrateSecurityClassificationValidationAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Local/Methods/MigrationStatus": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Returns the list of available security classification migrations and their statuses", "operationId": "MethodsLocal_GetMigrationStatusAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Local/Methods/MigrationStatus/{code}/Reset": { "post": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Resets a migration status back to NotStarted", "operationId": "MethodsLocal_ResetMigrationStatusAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "code", "in": "path", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Local/Methods/ReportGrouping": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "operationId": "MethodsLocal_GetReportGroupingAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "manipulator", "in": "header", "required": true }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Local/Methods/Simple": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Gets a list of Security classification method local simple data.", "description": "Sample Request\r\n GET /Portfolio/SecurityClassification/Local/Methods/Simple?searchText=morning&$top=1000&$skip=0", "operationId": "MethodsLocal_GetSimpleAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "manipulator", "in": "header", "required": true }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "searchText", "in": "query", "required": false, "type": "string" }, { "name": "billingEnabled", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Local/Methods/Verbose/{key}": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "operationId": "MethodsLocal_GetVerboseByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "MethodLocal", "SecurityClassesLocal", "DerivationsLocal", "MethodRulesLocal", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.ClassificationMethodLocalVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Updates a verbose Security classification method local", "description": "Sample Request\r\n PUT /Portfolio/SecurityClassification/Local/Methods/Verbose", "operationId": "MethodsLocal_UpdateVerboseAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Security classification method local ID", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "description": "Security classification method local", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.ClassificationMethodLocalVerboseDto" } }, { "name": "cancellationToken", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Local/ProductOverrides": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Retrieves all Security Classification Product Override Locals based on the provided filters.", "description": "Sample Requests\r\nGet All - GET /Portfolio/SecurityClassification/Local/ProductOverrides\r\nBy Security Class Ids - GET /Portfolio/SecurityClassification/Local/ProductOverrides?securityClassIds=28&securityClassIds=27\r\nBy Classification Methods - GET /Portfolio/SecurityClassification/Local/ProductOverrides?classificationMethodIds=8&classificationMethodIds=9\r\nBy Product Ids - GET /Portfolio/SecurityClassification/Local/ProductOverrides?productIds=20120&productIds=9\r\nBy Entity - GET /Portfolio/SecurityClassification/Local/ProductOverrides?entityEnum=5&entityId=123\r\nEntity Session - GET /Portfolio/SecurityClassification/Local/ProductOverrides?entitySessionId=-2146875255", "operationId": "SecurityClassificationsProductsOverrideLocal_GetAllAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "manipulator", "in": "header", "required": true }, { "name": "cancellationToken", "in": "header", "description": "Token to cancel the operation.", "required": true }, { "name": "securityClassIds", "in": "query", "description": "Optional list of Security Class IDs to filter by.", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "classificationMethodIds", "in": "query", "description": "Optional list of Classification Method IDs to filter by.", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "productIds", "in": "query", "description": "Optional list of Product IDs to filter by.", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "entityEnum", "in": "query", "description": "Optional Entity Enum to filter by.", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "query", "description": "Optional Entity ID to filter by.", "required": false, "type": "integer", "format": "int32" }, { "name": "entitySessionId", "in": "query", "description": "Optional Entity Session ID to filter by.", "required": false, "type": "integer", "format": "int32" }, { "name": "productFilter", "in": "query", "description": "Optional Product Filter to apply.", "required": false, "type": "string", "enum": [ "None", "LocalProducts", "CurrentlyOwnedProducts", "HasEverOwnedProducts", "MissingRiskCategories", "MissingAssetClasses", "Top1000BySubType" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassificationProductOverrideLocalDto" }, "xml": { "name": "SecurityClassificationProductOverrideLocalDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Local/ProductOverrides/{classificationMethodId}": { "put": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Updates or inserts Security Classification Product Override Locals for a specific classification method.", "description": "Sample Request\r\nPUT /Portfolio/SecurityClassification/Local/ProductOverrides/8\r\n[\r\n {\r\n \"securityClassId\": 23,\r\n \"securityClassificationMethodId\": 8,\r\n \"entityEnum\": 5,\r\n \"entityId\": 123,\r\n \"productId\": 20120,\r\n \"classificationWeight\": 0.125\r\n },\r\n {\r\n \"securityClassId\": 25,\r\n \"securityClassificationMethodId\": 8,\r\n \"entityEnum\": 5,\r\n \"entityId\": 123,\r\n \"productId\": 20120,\r\n \"classificationWeight\": 0.875\r\n }\r\n]", "operationId": "SecurityClassificationsProductsOverrideLocal_UpsertByMethodAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "classificationMethodId", "in": "path", "description": "The ID of the Classification Method.", "required": true, "type": "integer", "format": "int32" }, { "name": "dtos", "in": "body", "description": "The list of DTOs to upsert.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassificationProductOverrideLocalDto" }, "xml": { "name": "SecurityClassificationProductOverrideLocalDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "description": "Token to cancel the operation.", "required": true }, { "name": "persistedPayload", "in": "query", "description": "Whether to return the persisted payload.", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Local/ProductOverrides/{classificationMethodId}/{entityEnum}/{entityId}": { "put": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Updates or inserts Security Classification Product Override Locals for a specific method and entity.", "description": "Sample Request\r\nPUT /Portfolio/SecurityClassification/Local/ProductOverrides/8/5/123\r\n[\r\n {\r\n \"securityClassId\": 23,\r\n \"securityClassificationMethodId\": 8,\r\n \"entityEnum\": 5,\r\n \"entityId\": 123,\r\n \"productId\": 20120,\r\n \"classificationWeight\": 0.125\r\n },\r\n {\r\n \"securityClassId\": 25,\r\n \"securityClassificationMethodId\": 8,\r\n \"entityEnum\": 5,\r\n \"entityId\": 123,\r\n \"productId\": 20120,\r\n \"classificationWeight\": 0.875\r\n }\r\n]", "operationId": "SecurityClassificationsProductsOverrideLocal_UpsertByMethodEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "classificationMethodId", "in": "path", "description": "The ID of the Classification Method.", "required": true, "type": "integer", "format": "int32" }, { "name": "entityEnum", "in": "path", "description": "The Entity Enum.", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "description": "The Entity ID.", "required": true, "type": "integer", "format": "int32" }, { "name": "dtos", "in": "body", "description": "The list of DTOs to upsert.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassificationProductOverrideLocalDto" }, "xml": { "name": "SecurityClassificationProductOverrideLocalDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "description": "Token to cancel the operation.", "required": true }, { "name": "persistedPayload", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Deletes all weightings for a specific Classification Method, Entity", "description": "Sample Request\r\n DELETE /Portfolio/SecurityClassification/Local/ProductOverrides/8/5/123/20120", "operationId": "SecurityClassificationsProductsOverrideLocal_DeleteAllForEntityAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "classificationMethodId", "in": "path", "description": "The ID of the Classification Method.", "required": true, "type": "integer", "format": "int32" }, { "name": "entityEnum", "in": "path", "description": "The Entity Enum.", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "description": "The Entity ID.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "description": "Token to cancel the operation.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Local/ProductOverrides/{classificationMethodId}/{entityEnum}/{entityId}/{productId}": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Retrieves the weightings for a specific Classification Method, Entity, and Product.", "description": "Sample Request\r\nGET /Portfolio/SecurityClassification/Local/ProductOverrides/8/5/123/20120", "operationId": "SecurityClassificationsProductsOverrideLocal_GetWeightingsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "classificationMethodId", "in": "path", "description": "The ID of the Classification Method.", "required": true, "type": "integer", "format": "int32" }, { "name": "entityEnum", "in": "path", "description": "The Entity Enum.", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "description": "The Entity ID.", "required": true, "type": "integer", "format": "int32" }, { "name": "productId", "in": "path", "description": "The ID of the Product.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "description": "Token to cancel the operation.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Updates or inserts Security Classification Product Override Locals for a specific method, entity, and product.", "description": "Sample Request\r\nPUT /Portfolio/SecurityClassification/Local/ProductOverrides/8/5/123/20120\r\n[\r\n {\r\n \"securityClassId\": 23,\r\n \"securityClassificationMethodId\": 8,\r\n \"entityEnum\": 5,\r\n \"entityId\": 123,\r\n \"productId\": 20120,\r\n \"classificationWeight\": 0.125\r\n },\r\n {\r\n \"securityClassId\": 25,\r\n \"securityClassificationMethodId\": 8,\r\n \"entityEnum\": 5,\r\n \"entityId\": 123,\r\n \"productId\": 20120,\r\n \"classificationWeight\": 0.875\r\n }\r\n]", "operationId": "SecurityClassificationsProductsOverrideLocal_UpsertByMethodEntityProductAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "classificationMethodId", "in": "path", "description": "The ID of the Classification Method.", "required": true, "type": "integer", "format": "int32" }, { "name": "entityEnum", "in": "path", "description": "The Entity Enum.", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "description": "The Entity ID.", "required": true, "type": "integer", "format": "int32" }, { "name": "productId", "in": "path", "description": "The ID of the Product.", "required": true, "type": "integer", "format": "int32" }, { "name": "dtos", "in": "body", "description": "The list of DTOs to upsert.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassificationProductOverrideLocalDto" }, "xml": { "name": "SecurityClassificationProductOverrideLocalDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "description": "Token to cancel the operation.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Deletes all weightings for a specific Classification Method, Entity, and Product.", "description": "Sample Request\r\n DELETE /Portfolio/SecurityClassification/Local/ProductOverrides/8/5/123/20120", "operationId": "SecurityClassificationsProductsOverrideLocal_DeleteOneAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "classificationMethodId", "in": "path", "description": "The ID of the Classification Method.", "required": true, "type": "integer", "format": "int32" }, { "name": "entityEnum", "in": "path", "description": "The Entity Enum.", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "description": "The Entity ID.", "required": true, "type": "integer", "format": "int32" }, { "name": "productId", "in": "path", "description": "The ID of the Product.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "description": "Token to cancel the operation.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Local/ProductOverrides/Import/Upload/{classificationMethodId}/{entityEnum}/{entityId}": { "post": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Allows uploading a list of products to be assigned to a classification method for a specific entity.", "operationId": "SecurityClassificationsProductsOverrideLocal_UploadProductsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "classificationMethodId", "in": "path", "description": "The ID of the Classification Method.", "required": true, "type": "integer", "format": "int32" }, { "name": "entityEnum", "in": "path", "description": "The Entity Enum.", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "description": "The Entity ID.", "required": true, "type": "integer", "format": "int32" }, { "name": "fileData", "in": "body", "description": "File containing either Product ID or Download Symbol column", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ImportFileFilterDto" } }, { "name": "token", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Local/Products": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Retrieves all Security Classification Product Locals based on the provided filters.", "description": "Sample Requests\r\nGet All - GET /Portfolio/SecurityClassification/Local/Products\r\nBy Security Class Ids - GET /Portfolio/SecurityClassification/Local/Products?securityClassIds=28&securityClassIds=27\r\nBy Classification Methods - GET /Portfolio/SecurityClassification/Local/Products?classificationMethodIds=8&classificationMethodIds=9\r\nBy Product Ids - GET /Portfolio/SecurityClassification/Local/Products?productIds=20120&productIds=9\r\nEntity Session - GET /Portfolio/SecurityClassification/Local/Products?entitySessionId=-2146875255\r\nWith Implicit - GET /Portfolio/SecurityClassification/Local/Products?entitySessionId=-2146875255&includeImplicit=true", "operationId": "SecurityClassificationsProductsLocal_GetAllAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "manipulator", "in": "header", "required": true }, { "name": "cancellationToken", "in": "header", "description": "Token to cancel the operation.", "required": true }, { "name": "securityClassIds", "in": "query", "description": "Optional list of Security Class IDs to filter by.", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "classificationMethodIds", "in": "query", "description": "Optional list of Classification Method IDs to filter by.", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "productIds", "in": "query", "description": "Optional list of Product IDs to filter by.", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "entitySessionId", "in": "query", "description": "Optional Entity Session ID to filter by.", "required": false, "type": "integer", "format": "int32" }, { "name": "productFilter", "in": "query", "required": false, "type": "string", "enum": [ "None", "LocalProducts", "CurrentlyOwnedProducts", "HasEverOwnedProducts", "MissingRiskCategories", "MissingAssetClasses", "Top1000BySubType" ] }, { "name": "view", "in": "query", "required": false, "type": "string", "enum": [ "CurrentlyOwnedAssigned", "CurrentlyOwnedInherited", "CurrentlyOwnedAssignedToDefault", "CurrentlyOwnedAll", "EverOwnedAssigned", "EverOwnedInherited", "EverOwnedAssignedToDefault", "EverOwnedAll", "AllAssignedProducts", "CustomList", "Top1000BySubType" ] }, { "name": "includeImplicit", "in": "query", "description": "Optional flag to include implicit/inherited assignments. If true and entitySessionId is provided, uses productIds from entity session; otherwise uses productIds parameter.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassificationProductLocalDto" }, "xml": { "name": "SecurityClassificationProductLocalDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Local/Products/{classificationMethodId}": { "put": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Updates or inserts Security Classification Product Locals.", "description": "Sample Request\r\nPUT /Portfolio/SecurityClassification/Local/Products/8/20120\r\n[\r\n {\r\n \"securityClassId\": 23,\r\n \"securityClassificationMethodId\": 8,\r\n \"productId\": 20120,\r\n \"classificationWeight\": 0.125,\r\n \"isManual\": true\r\n },\r\n {\r\n \"securityClassId\": 25,\r\n \"securityClassificationMethodId\": 8,\r\n \"productId\": 20120,\r\n \"classificationWeight\": 0.875,\r\n \"isManual\": true\r\n }\r\n]", "operationId": "SecurityClassificationsProductsLocal_UpsertByMethodAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "classificationMethodId", "in": "path", "description": "The ID of the Classification Method.", "required": true, "type": "integer", "format": "int32" }, { "name": "dtos", "in": "body", "description": "The list of DTOs to upsert.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassificationProductLocalDto" }, "xml": { "name": "SecurityClassificationProductLocalDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "description": "Token to cancel the operation.", "required": true }, { "name": "persistedPayload", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Deletes all weightings for a specific Classification Method .", "description": "Sample Request\r\n DELETE /Portfolio/SecurityClassification/Local/Products/8", "operationId": "SecurityClassificationsProductsLocal_DeleteAllAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "classificationMethodId", "in": "path", "description": "The ID of the Classification Method.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "description": "Token to cancel the operation.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Local/Products/{classificationMethodId}/{productId}": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Retrieves the weightings for a specific Classification Method and Product.", "description": "Sample Request\r\nGET /Portfolio/SecurityClassification/Local/Products/8/20120", "operationId": "SecurityClassificationsProductsLocal_GetWeightingsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "classificationMethodId", "in": "path", "description": "The ID of the Classification Method.", "required": true, "type": "integer", "format": "int32" }, { "name": "productId", "in": "path", "description": "The ID of the Product.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "description": "Token to cancel the operation.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Updates or inserts Security Classification Product Locals.", "description": "Sample Request\r\nPUT /Portfolio/SecurityClassification/Local/Products/8/20120\r\n[\r\n {\r\n \"securityClassId\": 23,\r\n \"securityClassificationMethodId\": 8,\r\n \"productId\": 20120,\r\n \"classificationWeight\": 0.125,\r\n \"isManual\": true\r\n },\r\n {\r\n \"securityClassId\": 25,\r\n \"securityClassificationMethodId\": 8,\r\n \"productId\": 20120,\r\n \"classificationWeight\": 0.875,\r\n \"isManual\": true\r\n }\r\n]", "operationId": "SecurityClassificationsProductsLocal_UpsertByMethodProductAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "classificationMethodId", "in": "path", "description": "The ID of the Classification Method.", "required": true, "type": "integer", "format": "int32" }, { "name": "productId", "in": "path", "description": "The ID of the Product.", "required": true, "type": "integer", "format": "int32" }, { "name": "dtos", "in": "body", "description": "The list of DTOs to upsert.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassificationProductLocalDto" }, "xml": { "name": "SecurityClassificationProductLocalDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "description": "Token to cancel the operation.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Deletes all weightings for a specific Classification Method and Product.", "description": "Sample Request\r\n DELETE /Portfolio/SecurityClassification/Local/Products/8/20120", "operationId": "SecurityClassificationsProductsLocal_DeleteOneAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "classificationMethodId", "in": "path", "description": "The ID of the Classification Method.", "required": true, "type": "integer", "format": "int32" }, { "name": "productId", "in": "path", "description": "The ID of the Product.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "description": "Token to cancel the operation.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Local/Products/Import/Filter/{classificationMethodId}": { "post": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Allows uploading a list of products to be custom filtered by product ID or download symbol", "operationId": "SecurityClassificationsProductsLocal_CustomFilterProductsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "classificationMethodId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "fileData", "in": "body", "description": "File containing either Product ID or Download Symbol column", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ImportFileFilterDto" } }, { "name": "token", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Local/SecurityClasses": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Gets a list of Security classification Security Class Data.\r\nThe return is limited to pages of 100000. Use $top and $skip in the query string to page through the data.", "description": "Sample Request\r\n GET /Portfolio/SecurityClassification/Local/SecurityClasses?$top=1000&$skip=0", "operationId": "SecurityClassesLocal_GetListAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "manipulator", "in": "header", "description": "The projection manipulator for the query.", "required": true }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true }, { "name": "ids", "in": "query", "description": "Optional. A list of security class IDs to filter the results.", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "securityClassificationMethodIds", "in": "query", "description": "Optional. A list of security classification method IDs to filter the results.", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "Success. Returns the list of security classification security class data.", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassLocalDto" }, "xml": { "name": "SecurityClassLocalDto", "wrapped": true }, "type": "array" } }, "400": { "description": "If the request is invalid." } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Local/SecurityClasses/{key}": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Gets a Security classification Security Class by ID.", "description": "The Security Class ID\r\n Sample Request\r\n GET /Portfolio/SecurityClassification/Local/SecurityClasses/1", "operationId": "SecurityClassesLocal_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "Success. Returns the security classification security class data for the specified ID.", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassLocalDto" } }, "400": { "description": "If the request is invalid." } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Deletes a Security Class by ID.", "description": "Sample Request\r\n DELETE /Portfolio/SecurityClassification/Local/SecurityClasses/1", "operationId": "SecurityClassesLocal_DeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The Security Class ID.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "Success", "schema": { "type": "object" } }, "400": { "description": "Failed" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Local/SecurityClasses/{key}/AssociatedRecordCounts": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Get's a summary of associated record counts for a Security Class by ID.", "description": "The Security Class ID\r\n Sample Request\r\n GET /Portfolio/SecurityClassification/Local/SecurityClasses/1/AssociatedRecordCounts", "operationId": "SecurityClassesLocal_GetAssociationCountsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassAssociationCountsDto" } }, "400": { "description": "Failed" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Local/SecurityClasses/Action/EstablishColors": { "put": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Upsert the Colors for all Security Class records.", "description": "Sample Request\r\n PUT /Portfolio/SecurityClassification/Local/SecurityClasses/Action/EstablishColors", "operationId": "SecurityClassesLocal_ActionEstablishColorsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "securityClassificationMethodId", "in": "query", "description": "Optional. Security classification method Id to establish colors for method.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "Success. Returns the updated list of all security class data.", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassLocalDto" }, "xml": { "name": "SecurityClassLocalDto", "wrapped": true }, "type": "array" } }, "500": { "description": "Internal Server Error - An error occurred while processing the request." } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Local/SecurityClasses/DeleteMany": { "put": { "tags": [ "Portfolio/SecurityClassification" ], "operationId": "SecurityClassesLocal_DeleteManyAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Local/SecurityClasses/Simple": { "get": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Gets a list of Security classification Security Class simple entity data.", "description": "Sample Request\r\n GET /Portfolio/SecurityClassification/Local/SecurityClasses/Simple?searchText=morning&$top=1000&$skip=0", "operationId": "SecurityClassesLocal_GetSimpleAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "manipulator", "in": "header", "description": "The projection manipulator for the query.", "required": true }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true }, { "name": "searchText", "in": "query", "description": "Optional. Search text to filter the results.", "required": false, "type": "string" }, { "name": "securityClassificationMethodIds", "in": "query", "description": "Optional. A list of security classification method IDs to filter the results.", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "entity", "in": "query", "description": "Optional. Reporting entity to filter the results.", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] } ], "responses": { "200": { "description": "Success. Returns the list of security classification security class simple entity data.", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } }, "400": { "description": "If the request is invalid." } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SecurityClassification/Local/SecurityClasses/Upsert": { "post": { "tags": [ "Portfolio/SecurityClassification" ], "summary": "Upsert Create/Edits a list of Security Class records.", "description": "Sample Request\r\n POST /Portfolio/SecurityClassification/Local/SecurityClasses/Upsert", "operationId": "SecurityClassesLocal_UpsertAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "description": "The SecurityClassLocalDto object.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassLocalDto" }, "xml": { "name": "SecurityClassLocalDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "Success. Returns the list of security class data for the given request.", "schema": { "type": "object" } }, "400": { "description": "If the request is invalid." } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ShareClasses": { "get": { "tags": [ "Portfolio/ShareClasses" ], "summary": "Gets a list of share classes that the logged in user has access to.", "operationId": "ShareClasses_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ShareClassDto" }, "xml": { "name": "ShareClassDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ShareClasses/{key}": { "get": { "tags": [ "Portfolio/ShareClasses" ], "summary": "Gets the share class that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ShareClasses_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ShareClassDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ShareClasses/Simple": { "get": { "tags": [ "Portfolio/ShareClasses" ], "summary": "Gets a simple list of share classes that the logged in user has access to.", "operationId": "ShareClasses_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SleeveTransfer/{entitySessionId}": { "get": { "tags": [ "Portfolio/SleeveTransfer" ], "summary": "Gets a list of SleevedAssets filtered by the correlated entity level inside of the EntitySession table (filered by entitySessionId)", "description": "Sample Request\r\n\tGET /Portfolio/SleeveTransfer/243\r\n [\r\n {\r\n \"assetId\": 15785,\r\n \"accountId\": 437,\r\n \"accountNumber\": \"SAMPLE-295\",\r\n \"productName\": \"Performance Asset\",\r\n \"ticker\": \"PERFORMANCE\",\r\n \"currentQuantity\": 60,\r\n \"transferQuantity\": 0,\r\n \"remainingQuantity\": 0,\r\n \"modelFromAccountId\": 435,\r\n \"modelToAccountId\": -1,\r\n \"transactionDate\": \"2023-08-03T11:56:54.573-05:00\",\r\n \"useNonBilledJournals\": false,\r\n \"assetClass\": \"Security\",\r\n \"riskCategory\": \"Uncategorized\",\r\n \"registrationId\": 253,\r\n \"registrationName\": \"Nancy Fallon\",\r\n \"sleeveType\": \"Custodial account\"\r\n }\r\n ]", "operationId": "PortfolioSleeveTransfer_GetSleeveTransferDataAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entitySessionId", "in": "path", "description": "The key to use for looking up correlated entities inside of dbo.tblEntitySession", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.Sleeve.AssetSleeveDto" }, "xml": { "name": "AssetSleeveDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SleeveTransfer/Action/Transfer/{entitySessionId}": { "put": { "tags": [ "Portfolio/SleeveTransfer" ], "summary": "Executes the transfers for the entered quanties for all the sleeves specified in transfers", "operationId": "PortfolioSleeveTransfer_ExecuteSleeveTransferAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entitySessionId", "in": "path", "description": "EntitySessionId to properly log and correlate the data in datadog", "required": true, "type": "integer", "format": "int32" }, { "name": "transfers", "in": "body", "description": "The data to transfer from one sleeve to another", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.Sleeve.AssetSleeveDto" }, "xml": { "name": "AssetSleeveDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "description": "Cancellation Token", "required": true }, { "name": "syncToEclipse", "in": "query", "description": "Override to False to not sync to eclipse automatically", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SleeveTransfer/Batch/List": { "get": { "tags": [ "Portfolio/SleeveTransfer" ], "summary": "Gets the list of Sleeve Transfer Batches", "description": "Sample Request\r\n\tGET /Portfolio/SleeveTransfer/Batch/List\r\n\t{\r\n\t\t\"startDate\": \"12/31/2009\",\r\n\t\t\"endDate\": \"04/10/2023\"\r\n\t}", "operationId": "PortfolioSleeveTransfer_GetSleeveTransferBatchAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "description": "Start Date to filter from", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "End Date to filter to", "required": false, "type": "string", "format": "date-time" }, { "name": "ct", "in": "header", "description": "Cancellation Token", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.Sleeve.SleeveTransferBatchDto" }, "xml": { "name": "SleeveTransferBatchDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SleeveTransfer/Batch/Transactions/{batchId}": { "get": { "tags": [ "Portfolio/SleeveTransfer" ], "summary": "Gets the list of Sleeve Transfer Batch Transactions", "description": "Sample Request\r\n\tGET /Portfolio/SleeveTransfer/Batch/Transactions/123", "operationId": "PortfolioSleeveTransfer_GetSleeveTransferBatchTransactionAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "batchId", "in": "path", "description": "Batch ID for transactions list", "required": true, "type": "integer", "format": "int64" }, { "name": "ct", "in": "header", "description": "Cancellation Token", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.Sleeve.SleeveTransferBatchTransactionDto" }, "xml": { "name": "SleeveTransferBatchTransactionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SleeveTransfer/EntitySession/{entityType}": { "post": { "tags": [ "Portfolio/SleeveTransfer" ], "summary": "Creates an entity session ID to associate selected ids for sleeve transfer lookup\r\nSample Request\r\nPOST /EntitySession/Account\r\n[1, 2, 3]", "operationId": "PortfolioSleeveTransfer_CreateSleeveTransferEntitySessionAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entityType", "in": "path", "description": "A valid entity type: Registration, Account, Asset", "required": true, "type": "string" }, { "name": "idList", "in": "body", "description": "List of IDs to associate", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SleeveTransfer/SleeveModel/{entitySessionId}": { "get": { "tags": [ "Portfolio/SleeveTransfer" ], "summary": "Returns a full list of all models (really account sleeves) associated with the given EntitySessionId", "description": "{\r\n \"sleeveModels\": [\r\n {\r\n \"assetId\": 11382,\r\n \"accountId\": 290,\r\n \"productId\": 328404,\r\n \"registrationId\": 105,\r\n \"modelAggId\": null,\r\n \"modelName\": null,\r\n \"sleeveType\": \"Custodial account\",\r\n \"displayModelName\": \"Custodial\"\r\n },\r\n {\r\n \"assetId\": 14180,\r\n \"accountId\": 290,\r\n \"productId\": 440869,\r\n \"registrationId\": 105,\r\n \"modelAggId\": null,\r\n \"modelName\": null,\r\n \"sleeveType\": \"Custodial account\",\r\n \"displayModelName\": \"Custodial\"\r\n }],\r\n \"sleeveModelsByRegistrationId\": {\r\n \"105\": [\r\n {\r\n \"modelAggId\": null,\r\n \"modelName\": null,\r\n \"sleeveType\": \"Custodial account\",\r\n \"displayModelName\": \"Custodial\"\r\n },\r\n {\r\n \"modelAggId\": null,\r\n \"modelName\": null,\r\n \"sleeveType\": \"Custodial account\",\r\n \"displayModelName\": \"Custodial\"\r\n }]\r\n },\r\n \"sleeveModelsByProductId\": {\r\n \"1\": [\r\n {\r\n \"modelAggId\": null,\r\n \"modelName\": null,\r\n \"sleeveType\": \"Normal sleeve\",\r\n \"displayModelName\": \"\"\r\n },\r\n {\r\n \"modelAggId\": 1241,\r\n \"modelName\": \"Freedom01\",\r\n \"sleeveType\": \"Normal sleeve\",\r\n \"displayModelName\": \"Freedom01 (Normal)\"\r\n },\r\n {\r\n \"modelAggId\": 1242,\r\n \"modelName\": \"Freedom02\",\r\n \"sleeveType\": \"Normal sleeve\",\r\n \"displayModelName\": \"Freedom02 (Normal)\"\r\n },\r\n {\r\n \"modelAggId\": 1243,\r\n \"modelName\": \"Freedom03\",\r\n \"sleeveType\": \"Normal sleeve\",\r\n \"displayModelName\": \"Freedom03 (Normal)\"\r\n }\r\n ],\r\n \"4\": [\r\n {\r\n \"modelAggId\": null,\r\n \"modelName\": null,\r\n \"sleeveType\": \"Custodial account\",\r\n \"displayModelName\": \"Custodial\"\r\n }\r\n ]\r\n }\r\n }", "operationId": "PortfolioSleeveTransfer_GetAllSleeveModelsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entitySessionId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.Sleeve.SleeveProductModelDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/States": { "get": { "tags": [ "Portfolio/States" ], "summary": "Gets a list of states that the logged in user has access to.", "operationId": "States_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "domesticOnly", "in": "query", "description": "Optional. Default: null. When true returns to only domestic states. When false returns only foriegn states.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.StateDto" }, "xml": { "name": "StateDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/States/{key}": { "get": { "tags": [ "Portfolio/States" ], "summary": "Gets the state that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "States_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.StateDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/States/Simple": { "get": { "tags": [ "Portfolio/States" ], "summary": "Gets a simple list of states that the logged in user has access to.", "operationId": "States_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "returnFullName", "in": "query", "description": "Default: True. When true returns the states' full name. When false returns the states' abbreviation.", "required": false, "type": "boolean", "default": true }, { "name": "domesticOnly", "in": "query", "description": "Optional. Default: null. When true returns to only domestic states. When false returns only foriegn states.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SubAdvisors": { "get": { "tags": [ "Portfolio/SubAdvisors" ], "summary": "Gets a list of sub-advisors that the logged in user has access to.", "operationId": "SubAdvisors_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return sub advisors that have value (true) or don't have value (false).", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SubAdvisorDto" }, "xml": { "name": "SubAdvisorDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SubAdvisors/{key}": { "get": { "tags": [ "Portfolio/SubAdvisors" ], "summary": "Gets the sub-advisor that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "SubAdvisors_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SubAdvisorDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SubAdvisors/{key}/Accounts": { "get": { "tags": [ "Portfolio/SubAdvisors" ], "summary": "Gets a list of accounts that fall below the sub-advisor with the specified key, which the logged in user has access to.", "operationId": "SubAdvisors_GetAccountsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountDto" }, "xml": { "name": "AccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SubAdvisors/{key}/Accounts/Value": { "get": { "tags": [ "Portfolio/SubAdvisors" ], "summary": "Gets a simple list of accounts (including aum for today) that fall below the sub-advisor with the specified key, which the logged in user has access to.", "operationId": "SubAdvisors_GetAccountsValue", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return accounts that have value (true) or don't have value (false).", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SubAdvisors/{key}/Accounts/Value/{asOfDate}": { "get": { "tags": [ "Portfolio/SubAdvisors" ], "summary": "Gets a simple list of accounts (including aum for the end of the date specified) that fall below the sub-advisor with the specified key, which the logged in user has access to.", "operationId": "SubAdvisors_GetAccountsValueAsOfDate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "asOfDate", "in": "path", "required": true, "type": "string", "format": "date-time" }, { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return accounts that have value (true) or don't have value (false).", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue" }, "xml": { "name": "SimpleAccountWithValue", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SubAdvisors/{key}/Documents": { "post": { "tags": [ "Portfolio/SubAdvisors" ], "operationId": "SubAdvisors_CreateBlobAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "file", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SubAdvisorFileDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SubAdvisors/{key}/Documents/{fileId}": { "get": { "tags": [ "Portfolio/SubAdvisors" ], "summary": "Gets a file for the sub-advisor with the specified key and the file with the specified key.", "operationId": "SubAdvisors_GetBlobDto", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "description": "Key of the file to be returned.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/SubAdvisors" ], "operationId": "SubAdvisors_UpdateBlobAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "file", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SubAdvisorFileDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/SubAdvisors" ], "operationId": "SubAdvisors_DeleteBlob", "consumes": [], "produces": [], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SubAdvisors/{key}/Documents/{fileId}/Download": { "get": { "tags": [ "Portfolio/SubAdvisors" ], "summary": "Gets the raw data of the specific file with the blobId provided which is associated to the broker/dealer with the specified key.", "operationId": "SubAdvisors_GetBlobFile", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "description": "Key of the file to be downloaded.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SubAdvisors/Action/Delete": { "put": { "tags": [ "Portfolio/SubAdvisors" ], "operationId": "SubAdvisors_Delete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "groupId", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SubAdvisors/Search": { "get": { "tags": [ "Portfolio/SubAdvisors" ], "summary": "Gets a list of plans that the logged in user has access to where the plan name begins with the search string or Id is exact match.", "operationId": "SubAdvisors_GetSearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "Partial plan name to search for.", "required": true, "type": "string" }, { "name": "top", "in": "query", "description": "Optional. Default: null. The maximum number of plans to return. If null returns all.", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Optional. Default: 0. Defines number of items to skip.", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SubAdvisors/Search/{search}": { "get": { "tags": [ "Portfolio/SubAdvisors" ], "summary": "Gets a list of plans that the logged in user has access to where the plan name begins with the search string or Id is exact match.", "operationId": "SubAdvisors_GetV1PortfolioSubAdvisorsSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "Partial plan name to search for.", "required": true, "type": "string" }, { "name": "top", "in": "query", "description": "Optional. Default: null. The maximum number of plans to return. If null returns all.", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Optional. Default: 0. Defines number of items to skip.", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SubAdvisors/Simple": { "get": { "tags": [ "Portfolio/SubAdvisors" ], "operationId": "SubAdvisors_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "hasValue", "in": "query", "required": false, "type": "boolean" }, { "name": "accountId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "registrationId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "representativeId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "advisorId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "modelType", "in": "query", "required": false, "type": "string" }, { "name": "modelAggType", "in": "query", "required": false, "type": "string" }, { "name": "isActive", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SubAdvisors/Value": { "get": { "tags": [ "Portfolio/SubAdvisors" ], "summary": "Gets a simple list of sub-advisors (including aum for today) that the logged in user has access to.", "operationId": "SubAdvisors_GetValue", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return sub advisors that have value (true) or don't have value (false).", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.SimpleValueDto" }, "xml": { "name": "SimpleValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SubAdvisors/Value/{asOfDate}": { "get": { "tags": [ "Portfolio/SubAdvisors" ], "summary": "Gets a simple list of sub-advisors (including aum for the end of the date specified) that the logged in user has access to.", "operationId": "SubAdvisors_GetValueAsOfDate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "hasValue", "in": "query", "description": "Optional. When provided will only return sub advisors that have value (true) or don't have value (false).", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Simple.SimpleValueDto" }, "xml": { "name": "SimpleValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SubAdvisors/Verbose": { "get": { "tags": [ "Portfolio/SubAdvisors" ], "operationId": "SubAdvisors_GetAllItemsVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Notes", "Logo", "Documents", "Entities", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SubAdvisor.SubAdvisorVerboseDto" }, "xml": { "name": "SubAdvisorVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/SubAdvisors" ], "summary": "Create new sub-advisor", "operationId": "SubAdvisors_CreateVerbose", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SubAdvisor.SubAdvisorVerboseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SubAdvisor.SubAdvisorVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SubAdvisors/Verbose/{key}": { "get": { "tags": [ "Portfolio/SubAdvisors" ], "operationId": "SubAdvisors_GetVerboseByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Notes", "Logo", "Documents", "Entities", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SubAdvisor.SubAdvisorVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/SubAdvisors" ], "summary": "Update sub-advisor", "operationId": "SubAdvisors_UpdateVerbose", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SubAdvisor.SubAdvisorVerboseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SubAdvisor.SubAdvisorVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SubAdvisors/Verbose/New": { "get": { "tags": [ "Portfolio/SubAdvisors" ], "operationId": "SubAdvisors_GenerateNewVerboseDto", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Notes", "Logo", "Documents", "Entities", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SubAdvisor.SubAdvisorVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/SystematicAccount/{systematicAccountId}/Audit": { "get": { "tags": [ "Portfolio/SystematicAccount" ], "summary": "Get audit for systematic account", "operationId": "SystematicAccountAudits_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "systematicAccountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "object" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/TaxLotAssignments": { "get": { "tags": [ "Portfolio/TaxLotAssignments" ], "summary": "Get all of the", "operationId": "TranTaxLots_GetAllTaxLot", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "assetId", "in": "query", "description": "AssetId of the desired return object.", "required": false, "type": "integer", "format": "int32" }, { "name": "transactionId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TranTaxLotDto" }, "xml": { "name": "TranTaxLotDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/TaxLotAssignments" ], "operationId": "TranTaxLots_UpdateTaxLot", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TranTaxLotDto" }, "xml": { "name": "TranTaxLotDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TranTaxLotDto" }, "xml": { "name": "TranTaxLotDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/TaxLotAssignments" ], "operationId": "TranTaxLots_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TranTaxLotDto" }, "xml": { "name": "TranTaxLotDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TranTaxLotDto" }, "xml": { "name": "TranTaxLotDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/TaxLotAssignments/{key}": { "get": { "tags": [ "Portfolio/TaxLotAssignments" ], "summary": "Gets the TranTaxLot that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "TranTaxLots_GetTaxLotByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TranTaxLotDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/TaxLotAssignments" ], "summary": "Deletes the existing TranTaxLot Entry", "operationId": "TranTaxLots_Delete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/TaxLotAssignments/{sellTransactionId}/AssetBuyTransactions/{transDate}": { "get": { "tags": [ "Portfolio/TaxLotAssignments" ], "summary": "Gets a list transactions from the range provided for the asset with the specified key.", "operationId": "TranTaxLots_GetAssetBuyTransactions", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "sellTransactionId", "in": "path", "description": "Id of the Sell Transaction that is to be matched.", "required": true, "type": "integer", "format": "int32" }, { "name": "transDate", "in": "path", "description": "TransDate for the sell transaction. All transaction brought back in this get have to be from before this date.", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetTranLotDto" }, "xml": { "name": "AssetTranLotDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/TaxLotAssignments/GetCostBasis/{assetId}": { "get": { "tags": [ "Portfolio/TaxLotAssignments" ], "summary": "Gets a list Tax Lots from the range provided for the asset with the specified key.", "operationId": "TranTaxLots_GetTaxLotByAsset", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "assetId", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetTaxLotDto" }, "xml": { "name": "AssetTaxLotDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/TaxLotAssignments/List": { "get": { "tags": [ "Portfolio/TaxLotAssignments" ], "summary": "Returns a list of Assets that are found for the list of Id's posted in the message body.", "operationId": "TranTaxLots_GetTaxLotByKeys", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "Keys of the desired return object.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TranTaxLotDto" }, "xml": { "name": "TranTaxLotDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/TaxLotAssignments/List/Id": { "get": { "tags": [ "Portfolio/TaxLotAssignments" ], "summary": "Returns a list of Assets that are found for the list of Id's posted in the message body.", "operationId": "TranTaxLots_GetV1PortfolioTaxLotAssignmentsListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "Keys of the desired return object.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TranTaxLotDto" }, "xml": { "name": "TranTaxLotDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ThirdPartyAdministrators/Simple": { "get": { "tags": [ "Portfolio/ThirdPartyAdministrators" ], "operationId": "ThirdPartyAdministrators_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/TimeHorizons": { "get": { "tags": [ "Portfolio/TimeHorizons" ], "operationId": "TimeHorizons_GetAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.TimeHorizon" }, "xml": { "name": "TimeHorizon", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/TimeHorizons" ], "operationId": "TimeHorizons_UpdateHorizons", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "horizons", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.TimeHorizon" }, "xml": { "name": "TimeHorizon", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.TimeHorizon" }, "xml": { "name": "TimeHorizon", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/TimeHorizons/Simple": { "get": { "tags": [ "Portfolio/TimeHorizons" ], "summary": "Method to get all time horizons", "operationId": "TimeHorizons_GetAllSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Transactions": { "get": { "tags": [ "Portfolio/Transactions" ], "operationId": "Transactions_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "status", "in": "query", "required": false, "type": "string", "enum": [ "Complete", "Pending", "Rejected", "Reversed", "Inactive", "PendingCorpAction", "FutureAip" ] }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "transTypeId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "clientId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "registrationId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "assetId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "transactionId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "hasErrors", "in": "query", "required": false, "type": "boolean" }, { "name": "auditType", "in": "query", "required": false, "items": { "type": "string", "enum": [ "CustodialRealizedSharesDoNotMatch", "CustodialRealizedMissing", "CustodialUnrealizedMissing", "CustodialRealizedUnknownAcquiredDate", "CustodialUnrealizedUnknownAcquiredDate", "CustodialRealizedUnknownCostBasis", "CustodialUnrealizedUnknownCostBasis", "OrionUnknownCostBasis", "MoneyMarketProducts", "OrionMissingCostBasis" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "WithErrors", "Alternative" ] }, { "name": "editedStartDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "editedEndDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "pageQueryId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "alternativeOnly", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "orionVisionPending", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionBaseDto" }, "xml": { "name": "TransactionBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Transactions" ], "summary": "Simple dto update", "operationId": "Transactions_UpdateTransactionsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "modifiedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionDto" }, "xml": { "name": "TransactionDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionBaseDto" }, "xml": { "name": "TransactionBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Transactions/{key}": { "get": { "tags": [ "Portfolio/Transactions" ], "summary": "Gets the transaction that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Transactions_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "WithErrors", "Alternative" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionBaseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Transactions" ], "summary": "Simple dto update", "operationId": "Transactions_UpdateTransactionAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionDto" } }, { "name": "alternativeOnly", "in": "query", "description": "Optional. Default: false.", "required": false, "type": "boolean", "default": false }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionBaseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Transactions/{key}/Action/MoveToAsset/{assetId}": { "put": { "tags": [ "Portfolio/Transactions" ], "summary": "Move transaction to different asset", "operationId": "Transactions_MoveRegistrationAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "assetId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionBaseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Transactions/{key}/UserDefinedFields": { "get": { "tags": [ "Portfolio/Transactions" ], "operationId": "Transactions_GetUserDefinedFields", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "entities", "in": "query", "required": false, "items": { "type": "string", "enum": [ "BrokerDealers", "Wholesalers", "Representatives", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Products", "FundFamilies", "ModelRanges", "PortfolioGroups" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Transactions/Action/DAZLOverride": { "put": { "tags": [ "Portfolio/Transactions" ], "operationId": "Transactions_ActionTransactionDAZLOverride", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Transactions/Action/Delete": { "put": { "tags": [ "Portfolio/Transactions" ], "operationId": "Transactions_ActionDeleteAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Transactions/Action/Delete/{key}": { "put": { "tags": [ "Portfolio/Transactions" ], "summary": "Delete the transaction provided.", "operationId": "Transactions_ActionDeleteEntityAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The transaction key to delete.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Transactions/Action/Delete/Eclipse": { "put": { "tags": [ "Portfolio/Transactions" ], "operationId": "Transactions_ActionDeleteTransactionsFromEclipseAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "eclipseOrderIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Transactions/Alternative": { "post": { "tags": [ "Portfolio/Transactions" ], "summary": "Upsert a single alternative transaction", "operationId": "Transactions_UpsertTransactionActivityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "itemDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionAlternativeDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionAlternativeDto" }, "xml": { "name": "TransactionAlternativeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Transactions/Alternative/Action/StatusChange/{status}": { "put": { "tags": [ "Portfolio/Transactions" ], "operationId": "Transactions_AlternativeActionStatusChange", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "status", "in": "path", "required": true, "type": "string", "enum": [ "Complete", "Pending", "Rejected", "Reversed", "Inactive", "PendingCorpAction", "FutureAip" ] }, { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionAlternativeDto" }, "xml": { "name": "TransactionAlternativeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Transactions/Alternative/List": { "post": { "tags": [ "Portfolio/Transactions" ], "summary": "Upsert many transaction activities", "operationId": "Transactions_UpsertTransactionActivitiesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "items", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionAlternativeDto" }, "xml": { "name": "TransactionAlternativeDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionAlternativeDto" }, "xml": { "name": "TransactionAlternativeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Transactions/CorporateAction/List": { "put": { "tags": [ "Portfolio/Transactions" ], "summary": "Update multiple transactions associated with a Corporate Action.", "operationId": "Transactions_UpdateCorporateActionTransactionsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "items", "in": "body", "description": "corporate action transactions to update", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.CorpAction.CorpActionTransactionV2Dto" }, "xml": { "name": "CorpActionTransactionV2Dto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.CorpAction.CorpActionTransactionV2Dto" }, "xml": { "name": "CorpActionTransactionV2Dto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Transactions/List": { "post": { "tags": [ "Portfolio/Transactions" ], "summary": "Gets a list of transactions that match one of the keys in the provided list.", "operationId": "Transactions_GetListById", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "WithErrors", "Alternative" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionBaseDto" }, "xml": { "name": "TransactionBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Transactions/List/Id": { "post": { "tags": [ "Portfolio/Transactions" ], "summary": "Gets a list of transactions that match one of the keys in the provided list.", "operationId": "Transactions_PostV1PortfolioTransactionsListId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "WithErrors", "Alternative" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionBaseDto" }, "xml": { "name": "TransactionBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Transactions/Simple/Search": { "get": { "tags": [ "Portfolio/Transactions" ], "operationId": "Transactions_Search", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "top", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionSimpleDto" }, "xml": { "name": "TransactionSimpleDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Transactions/ValidationForUnsleeving/{key}": { "get": { "tags": [ "Portfolio/Transactions" ], "summary": "Unsleeving Process validation. Checking for any transaction types other than 171(Internal Account Journal Out), 172(Internal Account Journal In) or orders", "operationId": "Transactions_ValidationForUnsleeving", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "RegistrationId", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Transactions/Verbose": { "get": { "tags": [ "Portfolio/Transactions" ], "operationId": "Transactions_GetVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "status", "in": "query", "required": false, "type": "string", "enum": [ "Complete", "Pending", "Rejected", "Reversed", "Inactive", "PendingCorpAction", "FutureAip" ] }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "transTypeId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Billing", "Portfolio", "CostBasis", "AdditionalInformation", "UserDefinedFields", "EntityOptions", "Alternative", "TransactionFee", "All" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "assetId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionVerboseDto" }, "xml": { "name": "TransactionVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Transactions" ], "summary": "Update multiple transactions", "operationId": "Transactions_UpdateVerboseTransactionsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updatedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionVerboseDto" }, "xml": { "name": "TransactionVerboseDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionVerboseDto" }, "xml": { "name": "TransactionVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/Transactions" ], "summary": "Create transaction", "operationId": "Transactions_CreateVerboseTransactionAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionVerboseDto" } }, { "name": "createOffset", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Transactions/Verbose/{key}": { "get": { "tags": [ "Portfolio/Transactions" ], "operationId": "Transactions_GetVerboseByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Billing", "Portfolio", "CostBasis", "AdditionalInformation", "UserDefinedFields", "EntityOptions", "Alternative", "TransactionFee", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Transactions" ], "summary": "Update single transaction", "operationId": "Transactions_UpdateVerboseTransactionAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionVerboseDto" } }, { "name": "reverseOffset", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Transactions/Verbose/Alternative": { "post": { "tags": [ "Portfolio/Transactions" ], "summary": "Upsert a single alternative transaction and possible activity children", "operationId": "Transactions_UpsertVerboseTransactionActivity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "itemDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionVerboseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionVerboseDto" }, "xml": { "name": "TransactionVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Transactions/Verbose/Alternative/List": { "post": { "tags": [ "Portfolio/Transactions" ], "summary": "Upsert many alternative transaction and their possible activity children", "operationId": "Transactions_UpsertVerboseTransactionActivities", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "items", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionVerboseDto" }, "xml": { "name": "TransactionVerboseDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionVerboseDto" }, "xml": { "name": "TransactionVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Transactions/Verbose/List": { "post": { "tags": [ "Portfolio/Transactions" ], "operationId": "Transactions_GetVerboseListById", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Billing", "Portfolio", "CostBasis", "AdditionalInformation", "UserDefinedFields", "EntityOptions", "Alternative", "TransactionFee", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionVerboseDto" }, "xml": { "name": "TransactionVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Transactions/Verbose/List/Id": { "post": { "tags": [ "Portfolio/Transactions" ], "operationId": "Transactions_PostV1PortfolioTransactionsVerboseListId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Billing", "Portfolio", "CostBasis", "AdditionalInformation", "UserDefinedFields", "EntityOptions", "Alternative", "TransactionFee", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionVerboseDto" }, "xml": { "name": "TransactionVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Transactions/Verbose/New": { "get": { "tags": [ "Portfolio/Transactions" ], "operationId": "Transactions_GetNewVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Billing", "Portfolio", "CostBasis", "AdditionalInformation", "UserDefinedFields", "EntityOptions", "Alternative", "TransactionFee", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/Transactions" ], "summary": "Create transactions.", "operationId": "Transactions_CreateVerboseTransactionsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newDtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionVerboseDto" }, "xml": { "name": "TransactionVerboseDto", "wrapped": true }, "type": "array" } }, { "name": "createOffset", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionVerboseDto" }, "xml": { "name": "TransactionVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/TRInterfaceFormats/Simple": { "get": { "tags": [ "Portfolio/TRInterfaceFormats" ], "operationId": "TRInterfaceFormats_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/Clients": { "post": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportClients_ImportInviteClients", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleClient" }, "xml": { "name": "SimpleClient", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/FinancialPlanningFee": { "post": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportFinancialPlanningFee_ImportClientFPFAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ValidateClientFPFDto" }, "xml": { "name": "ValidateClientFPFDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/FinancialPlanningFee/List": { "post": { "tags": [ "Portfolio/ValidateImport" ], "summary": "Used to create a new composite accounts. Upon successful creation the created data is returned.", "operationId": "PortfolioValidateImportFinancialPlanningFee_CreateListAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancelToken", "in": "header", "required": true }, { "name": "dtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ClientFPF" }, "xml": { "name": "ClientFPF", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ClientFPF" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/FinancialPlanningFee/Templates/Csv": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportFinancialPlanningFee_GetCsvTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/FinancialPlanningFee/Templates/Xls": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportFinancialPlanningFee_GetXlsTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/FinancialPlanningFee/Templates/Xlsx": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportFinancialPlanningFee_GetXlsxTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/HypotheticalMonthlyPerformance": { "post": { "tags": [ "Portfolio/ValidateImport" ], "summary": "", "operationId": "PortfolioValidateImportHypotheticalMonthlyPerformanceValue_PostAsMultipartStreamAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.InvestmentObjectiveVerboseDto" }, "xml": { "name": "InvestmentObjectiveVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/HypotheticalMonthlyPerformance/Templates/Csv": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportHypotheticalMonthlyPerformanceValue_GetCsvTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/HypotheticalMonthlyPerformance/Templates/Xls": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportHypotheticalMonthlyPerformanceValue_GetXlsTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/HypotheticalMonthlyPerformance/Templates/Xlsx": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportHypotheticalMonthlyPerformanceValue_GetXlsxTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/MasterClientListWizard": { "get": { "tags": [ "Portfolio/ValidateImport" ], "summary": "Get all Mcl Wizard Setps Items", "operationId": "PortfolioValidateImportMasterClientListWizard_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ValidateImport.MclWizardInstanceDto" }, "xml": { "name": "MclWizardInstanceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/ValidateImport" ], "summary": "Takes an xlsx, xls, or csv file as multipart content.\r\nThe file will be processed and returned. If the account valid, the \"isValid\" property will be true. \r\nIf it is invalid, the \"isValid\" property will be false and a message about why it is invalid will be provided.", "operationId": "PortfolioValidateImportMasterClientListWizard_MCLWIzardValidationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ValidateImport.MasterClientListValidatorDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ValidateImport.MasterClientListInitialDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/MasterClientListWizard/{key}": { "get": { "tags": [ "Portfolio/ValidateImport" ], "summary": "Gets the Mcl Wizard Instance Item that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "PortfolioValidateImportMasterClientListWizard_GetEntityByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ValidateImport.MclWizardInstanceDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportMasterClientListWizard_DeleteAsync", "consumes": [], "produces": [], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/MasterClientListWizard/{key}/Commit": { "post": { "tags": [ "Portfolio/ValidateImport" ], "summary": "Commit the Mcl Wizard Instance data for provided key", "operationId": "PortfolioValidateImportMasterClientListWizard_CommitMclWizardInstanceAsync", "consumes": [], "produces": [], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/MasterClientListWizard/{key}/Custodian": { "get": { "tags": [ "Portfolio/ValidateImport" ], "summary": "Gets the Custodian errors within Mcl Wizard Instance key provided. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "PortfolioValidateImportMasterClientListWizard_GetCustodianCorrectionAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "description": "Key is the Instance Id of the import that is be checked.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ValidateImport.MclWizardGeneralErrorDto" }, "xml": { "name": "MclWizardGeneralErrorDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/MasterClientListWizard/{key}/EntityUpdate": { "post": { "tags": [ "Portfolio/ValidateImport" ], "summary": "Update the Mcl Wizard RepId, RegistrationTypeId, CustodianId, or FundFamilyId Items for provided key", "operationId": "PortfolioValidateImportMasterClientListWizard_UpdateGeneralErrorsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "corrections", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ValidateImport.MclWizardGeneralErrorDto" }, "xml": { "name": "MclWizardGeneralErrorDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ValidateImport.MclWizardGeneralErrorDto" }, "xml": { "name": "MclWizardGeneralErrorDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/MasterClientListWizard/{key}/Export": { "get": { "tags": [ "Portfolio/ValidateImport" ], "summary": "Gets an xlsx file representation of the composite report.", "operationId": "PortfolioValidateImportMasterClientListWizard_MakeXlsxFileAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/MasterClientListWizard/{key}/FundFamily": { "get": { "tags": [ "Portfolio/ValidateImport" ], "summary": "Gets the Fund Family errors within Mcl Wizard Instance key provided . If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "PortfolioValidateImportMasterClientListWizard_GetFundFamilyCorrectionAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "description": "Key is the Instance Id of the import that is be checked.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ValidateImport.MclWizardGeneralErrorDto" }, "xml": { "name": "MclWizardGeneralErrorDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/MasterClientListWizard/{key}/Household": { "get": { "tags": [ "Portfolio/ValidateImport" ], "summary": "Gets the Mcl Wizard Household Items that that need correction for the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "PortfolioValidateImportMasterClientListWizard_GetHouseholdCorrectionAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ValidateImport.MclWizardGroupErrorDto" }, "xml": { "name": "MclWizardGroupErrorDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/ValidateImport" ], "summary": "Update the Mcl Wizard Household Items for provided key", "operationId": "PortfolioValidateImportMasterClientListWizard_UpdateHouseholdItemsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "corrections", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ValidateImport.MclWizardGroupErrorDto" }, "xml": { "name": "MclWizardGroupErrorDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ValidateImport.MclWizardGroupErrorDto" }, "xml": { "name": "MclWizardGroupErrorDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/MasterClientListWizard/{key}/Registration": { "get": { "tags": [ "Portfolio/ValidateImport" ], "summary": "Gets the Registration errors within Mcl Wizard Instance key provided . If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "PortfolioValidateImportMasterClientListWizard_GetRegistrationCorrectionAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "description": "Key is the Instance Id of the import that is be checked.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ValidateImport.MclWizardValueErrorDto" }, "xml": { "name": "MclWizardValueErrorDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/ValidateImport" ], "summary": "Update the Mcl Wizard Registration data for provided key", "operationId": "PortfolioValidateImportMasterClientListWizard_UpdateValueErrorsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "corrections", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ValidateImport.MclWizardValueErrorDto" }, "xml": { "name": "MclWizardValueErrorDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ValidateImport.MclWizardValueErrorDto" }, "xml": { "name": "MclWizardValueErrorDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/MasterClientListWizard/{key}/RegistrationType": { "get": { "tags": [ "Portfolio/ValidateImport" ], "summary": "Gets the Registration Type errors within Mcl Wizard Instance key provided. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "PortfolioValidateImportMasterClientListWizard_GetRegistrationTypeCorrectionAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "description": "Key is the Instance Id of the import that is be checked.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ValidateImport.MclWizardGeneralErrorDto" }, "xml": { "name": "MclWizardGeneralErrorDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/MasterClientListWizard/{key}/Representative": { "get": { "tags": [ "Portfolio/ValidateImport" ], "summary": "Gets the Representative errors within Mcl Wizard Instance key provided. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "PortfolioValidateImportMasterClientListWizard_GetRepCorrectionAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "description": "Key is the Instance Id of the import that is be checked.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ValidateImport.MclWizardGeneralErrorDto" }, "xml": { "name": "MclWizardGeneralErrorDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/MasterClientListWizard/{key}/Summary": { "get": { "tags": [ "Portfolio/ValidateImport" ], "summary": "Gets the Summary within Mcl Wizard Instance key provided . If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "PortfolioValidateImportMasterClientListWizard_GetSummaryAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "description": "Key is the Instance Id of the import that is be checked.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ValidateImport.ValidateImportMCLWizardSummaryDto" }, "xml": { "name": "ValidateImportMCLWizardSummaryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/MergeAccounts": { "post": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportMergeAccounts_ImportRelatedHouseholdsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountMergeValidationDto" }, "xml": { "name": "AccountMergeValidationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/MergeAccounts/Templates/Csv": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportMergeAccounts_GetCsvTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/MergeAccounts/Templates/Xls": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportMergeAccounts_GetXlsTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/MergeAccounts/Templates/Xlsx": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportMergeAccounts_GetXlsxTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/NewPortfolio": { "post": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportAccounts_ImportAccountsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.NewAccountValidationDto" }, "xml": { "name": "NewAccountValidationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/NewPortfolio/Process": { "post": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportAccounts_ProcessAccountsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "accounts", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.NewAccountValidationDto" }, "xml": { "name": "NewAccountValidationDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.NewAccountValidationDto" }, "xml": { "name": "NewAccountValidationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/Participant": { "post": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportParticipants_ImportParticipantsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } }, { "name": "planId", "in": "query", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ValidateImport.ValidatePortfolioParticipantDto" }, "xml": { "name": "ValidatePortfolioParticipantDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/Participant/Templates/Csv": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportParticipants_GetCsvTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/Participant/Templates/Xls": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportParticipants_GetXlsTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/Participant/Templates/Xlsx": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportParticipants_GetXlsxTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/ProductCategoryWeighted": { "post": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportProductCategoryWeighted_ImportProductCategoryWeightedAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductCategoryWeightedValidationDto" }, "xml": { "name": "ProductCategoryWeightedValidationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/ProductCategoryWeighted/Import": { "put": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportProductCategoryWeighted_ImportProductCategoryWeighted", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "importItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductCategoryWeightedValidationDto" }, "xml": { "name": "ProductCategoryWeightedValidationDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductCategoryWeightedDto" }, "xml": { "name": "ProductCategoryWeightedDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/ProductCategoryWeighted/Templates/Csv": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportProductCategoryWeighted_GetCsvTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/ProductCategoryWeighted/Templates/Xls": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportProductCategoryWeighted_GetXlsTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/ProductCategoryWeighted/Templates/Xlsx": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportProductCategoryWeighted_GetXlsxTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/ProductClassWeighted": { "post": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportProductClassWeighted_ImportProductClassWeightedAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassWeightedValidationDto" }, "xml": { "name": "ProductClassWeightedValidationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/ProductClassWeighted/Import": { "put": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportProductClassWeighted_ImportProductClassWeighted", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "importItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassWeightedValidationDto" }, "xml": { "name": "ProductClassWeightedValidationDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassWeightedDto" }, "xml": { "name": "ProductClassWeightedDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/ProductClassWeighted/Templates/Csv": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportProductClassWeighted_GetCsvTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/ProductClassWeighted/Templates/Xls": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportProductClassWeighted_GetXlsTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/ProductClassWeighted/Templates/Xlsx": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportProductClassWeighted_GetXlsxTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/ProductsPricesLocal": { "post": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportProductsPricesLocal_ImportRelatedHouseholdsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductsPricesLocalValidationDto" }, "xml": { "name": "ProductsPricesLocalValidationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/ProductsPricesLocal/Templates/Csv": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportProductsPricesLocal_GetCsvTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/ProductsPricesLocal/Templates/Xls": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportProductsPricesLocal_GetXlsTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/ProductsPricesLocal/Templates/Xlsx": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportProductsPricesLocal_GetXlsxTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/RMDUpdate": { "post": { "tags": [ "Portfolio/ValidateImport" ], "summary": "Takes an xlsx, xls, or csv file as multipart content. The file needs either an account id column (named \"account id\", \"accountid\", \"pkaccount\", \"acct id\", or \"acctid\")\r\nThe file will be processed and returned as a list signifying the id or number provided. If the account valid, the \"isValid\" property will be true. \r\nIf it is invalid, the \"isValid\" property will be false and a message about why it is invalid will be provided.", "operationId": "PortfolioValidateImportRmdUpdate_RmdUpdateValidationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ValidateImport.ValidatePortfolioRmdUpdateDto" }, "xml": { "name": "ValidatePortfolioRmdUpdateDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/RMDUpdate/Process": { "post": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportRmdUpdate_MassUpdateRMDAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "updates", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ValidateImport.ValidatePortfolioRmdUpdateDto" }, "xml": { "name": "ValidatePortfolioRmdUpdateDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/Sloa": { "post": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportSloa_ImportSloasAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ValidateAccountSloaDto" }, "xml": { "name": "ValidateAccountSloaDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/Sloa/Import": { "put": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportSloa_ImportSloas", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "validateList", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ValidateAccountSloaDto" }, "xml": { "name": "ValidateAccountSloaDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ValidateAccountSloaDto" }, "xml": { "name": "ValidateAccountSloaDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/Sloa/Templates/Csv": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportSloa_GetCsvTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/Sloa/Templates/Xls": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportSloa_GetXlsTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/Sloa/Templates/Xlsx": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportSloa_GetXlsxTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/StoredPerformance": { "post": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportStoredPerformance_ImportStoredPerformanceAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/StoredPerformance/ExportErrors": { "post": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportStoredPerformance_ExportErrorsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "exportItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.StoredPerformanceValidationDto" }, "xml": { "name": "StoredPerformanceValidationDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/StoredPerformance/ExportErrors/{filename}": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportStoredPerformance_RunReportAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "filename", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/StoredPerformance/Import": { "put": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportStoredPerformance_PutV1PortfolioValidateImportStoredPerformanceImport", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "importItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.StoredPerformanceValidationDto" }, "xml": { "name": "StoredPerformanceValidationDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.StoredPerformanceValidationDto" }, "xml": { "name": "StoredPerformanceValidationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/StoredPerformance/Import/{cacheKey}": { "put": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportStoredPerformance_ImportStoredPerformanceByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "cacheKey", "in": "path", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.StoredPerformanceValidationDto" }, "xml": { "name": "StoredPerformanceValidationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/StoredPerformance/Templates/Csv": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportStoredPerformance_GetCsvTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/StoredPerformance/Templates/Xls": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportStoredPerformance_GetXlsTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/StoredPerformance/Templates/Xlsx": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportStoredPerformance_GetXlsxTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/TargetAllocationAccount": { "post": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportTargetAllocationAccount_ImportRelatedHouseholdsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TargetAllocationAccountValidationDto" }, "xml": { "name": "TargetAllocationAccountValidationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/TargetAllocationAccount/Templates/Csv": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportTargetAllocationAccount_GetCsvTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/TargetAllocationAccount/Templates/Xls": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportTargetAllocationAccount_GetXlsTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/TargetAllocationAccount/Templates/Xlsx": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportTargetAllocationAccount_GetXlsxTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/TargetAllocationClient": { "post": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportTargetAllocationClient_ImportRelatedHouseholdsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TargetAllocationClientValidationDto" }, "xml": { "name": "TargetAllocationClientValidationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/TargetAllocationClient/Templates/Csv": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportTargetAllocationClient_GetCsvTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/TargetAllocationClient/Templates/Xls": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportTargetAllocationClient_GetXlsTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/TargetAllocationClient/Templates/Xlsx": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportTargetAllocationClient_GetXlsxTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/TaxSchedules": { "post": { "tags": [ "Portfolio/ValidateImport" ], "summary": "Takes an xlsx, xls, or csv file as multipart content.\r\nThe file will be processed and returned. If the account valid, the \"isValid\" property will be true. \r\nIf it is invalid, the \"isValid\" property will be false and a message about why it is invalid will be provided.", "operationId": "ValidateImportAstroTaxSchedule_TaxScheduleImportValidation", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.ValidateImport.ValidateTaxScheduleDto" }, "xml": { "name": "ValidateTaxScheduleDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/TaxSchedules/ProcessImport": { "post": { "tags": [ "Portfolio/ValidateImport" ], "summary": "The method runs a buld insert to a temp table from the import file then runs a procedure that creates the household, registration, and accounts.", "operationId": "ValidateImportAstroTaxSchedule_ProcessTaxScheduleImport", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "list", "in": "body", "description": "The list of accounts for the import.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.ValidateImport.ValidateTaxScheduleDto" }, "xml": { "name": "ValidateTaxScheduleDto", "wrapped": true }, "type": "array" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/TaxSchedules/Revalidate": { "post": { "tags": [ "Portfolio/ValidateImport" ], "summary": "Takes a List ValidateTaxScheduleDto.\r\nThe dto will be processed and returned. If the account valid, the \"isValid\" property will be true. \r\nIf it is invalid, the \"isValid\" property will be false and a message about why it is invalid will be provided.", "operationId": "ValidateImportAstroTaxSchedule_TaxScheduleDtoValidation", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "list", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.ValidateImport.ValidateTaxScheduleDto" }, "xml": { "name": "ValidateTaxScheduleDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.ValidateImport.ValidateTaxScheduleDto" }, "xml": { "name": "ValidateTaxScheduleDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/Transaction": { "post": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportTransactions_ImportTransactionsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionVerboseValidationDto" }, "xml": { "name": "TransactionVerboseValidationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/Transaction/Templates/Csv": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportTransactions_GetCsvTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/Transaction/Templates/Xls": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportTransactions_GetXlsTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/ValidateImport/Transaction/Templates/Xlsx": { "get": { "tags": [ "Portfolio/ValidateImport" ], "operationId": "PortfolioValidateImportTransactions_GetXlsxTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Wholesalers": { "get": { "tags": [ "Portfolio/Wholesalers" ], "summary": "Gets a list of wholesaler that the logged in user has access to.", "operationId": "Wholesalers_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.WholesalerDto" }, "xml": { "name": "WholesalerDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Wholesalers/{key}": { "get": { "tags": [ "Portfolio/Wholesalers" ], "summary": "Gets the wholesaler that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Wholesalers_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.WholesalerDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Wholesalers/{key}/Documents": { "get": { "tags": [ "Portfolio/Wholesalers" ], "operationId": "Wholesalers_GetBlobs", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "fileType", "in": "query", "required": false, "items": { "type": "string", "enum": [ "CrmDocuments" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" }, "xml": { "name": "BlobBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/Wholesalers" ], "operationId": "Wholesalers_CreateBlobAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "file", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.WholesalerFileDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Wholesalers/{key}/Documents/{fileId}": { "get": { "tags": [ "Portfolio/Wholesalers" ], "summary": "Gets a file for the wholesaler with the specified key and the file with the specified key.", "operationId": "Wholesalers_GetBlobDto", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "description": "Key of the file to be returned.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Wholesalers" ], "operationId": "Wholesalers_UpdateBlobAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "file", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.WholesalerFileDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Portfolio/Wholesalers" ], "operationId": "Wholesalers_DeleteBlob", "consumes": [], "produces": [], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Wholesalers/{key}/Documents/{fileId}/Download": { "get": { "tags": [ "Portfolio/Wholesalers" ], "summary": "Gets the raw data of the specific file with the blobId provided which is associated to the wholesaler with the specified key.", "operationId": "Wholesalers_GetBlobFile", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "description": "Key of the file to be downloaded.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Wholesalers/{key}/UserDefinedFields": { "get": { "tags": [ "Portfolio/Wholesalers" ], "operationId": "Wholesalers_GetUserDefinedFields", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "entities", "in": "query", "required": false, "items": { "type": "string", "enum": [ "BrokerDealers", "Wholesalers", "Representatives", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Products", "FundFamilies", "ModelRanges", "PortfolioGroups" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Wholesalers/Action/Delete": { "put": { "tags": [ "Portfolio/Wholesalers" ], "operationId": "Wholesalers_Delete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "groupId", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Wholesalers/Simple": { "get": { "tags": [ "Portfolio/Wholesalers" ], "summary": "Gets a simple list of wholesaler that the logged in user has access to.", "operationId": "Wholesalers_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Wholesalers/Verbose": { "get": { "tags": [ "Portfolio/Wholesalers" ], "operationId": "Wholesalers_GetVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Regions", "Notes", "Documents", "UserDefinedFields", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.WholesalerVerboseDto" }, "xml": { "name": "WholesalerVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Wholesalers" ], "operationId": "Wholesalers_UpdateVerboseWholesaler", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updatedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.WholesalerVerboseDto" }, "xml": { "name": "WholesalerVerboseDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.WholesalerVerboseDto" }, "xml": { "name": "WholesalerVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Portfolio/Wholesalers" ], "summary": "Create new wholesaler.", "operationId": "Wholesalers_CreateVerboseWholesaler", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.WholesalerVerboseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.WholesalerVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Wholesalers/Verbose/{key}": { "get": { "tags": [ "Portfolio/Wholesalers" ], "operationId": "Wholesalers_GetVerboseByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Regions", "Notes", "Documents", "UserDefinedFields", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.WholesalerVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Portfolio/Wholesalers" ], "operationId": "Wholesalers_PutV1PortfolioWholesalersVerboseByKey", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.WholesalerVerboseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.WholesalerVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Wholesalers/Verbose/{key}/SSNTaxId": { "put": { "tags": [ "Portfolio/Wholesalers" ], "summary": "Retrieve or update SSN for wholesaler.", "description": "If updateInfo.SSN is null => we will just retrieve SSN otherwise we will attempt to update SSN with data in updateInfo.SSN", "operationId": "Wholesalers_UpdateWholesalerSSNTaxId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The personal id of the wholesaler", "required": true, "type": "integer", "format": "int32" }, { "name": "updateInfo", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.UpdateSsnDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Wholesalers/Verbose/List": { "post": { "tags": [ "Portfolio/Wholesalers" ], "operationId": "Wholesalers_GetVerboseListById", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Regions", "Notes", "Documents", "UserDefinedFields", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.WholesalerVerboseDto" }, "xml": { "name": "WholesalerVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Wholesalers/Verbose/List/Id": { "post": { "tags": [ "Portfolio/Wholesalers" ], "operationId": "Wholesalers_PostV1PortfolioWholesalersVerboseListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Regions", "Notes", "Documents", "UserDefinedFields", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.WholesalerVerboseDto" }, "xml": { "name": "WholesalerVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Portfolio/Wholesalers/Verbose/New": { "get": { "tags": [ "Portfolio/Wholesalers" ], "operationId": "Wholesalers_GetNewVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Regions", "Notes", "Documents", "UserDefinedFields", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.WholesalerVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/PortfolioDataSync/DataSharing/Sources": { "get": { "tags": [ "PortfolioDataSync/DataSharing" ], "summary": "Returns all DataSharingSource rows that match our current logged in identity as the source or destination", "description": "Sample Request\r\nGet /DataMaintenance/DataSharing/Sources\r\n[\r\n {\r\n \"id\": 2,\r\n \"alClientSourceId\": 245,\r\n \"alClientDestinationId\": 1379,\r\n \"alClientSourceName\": null,\r\n \"alClientDestinationName\": null,\r\n \"sourceDescription\": \"test2\",\r\n \"isActive\": true,\r\n \"isAccepted\": false,\r\n \"lastProcessedSource\": \"2023-12-30T12:27:09.87+00:00\",\r\n \"lastProcessedDestination\": \"2024-01-18T12:27:09.87+00:00\",\r\n \"syncStatus\": 2,\r\n \"syncErrors\": \"somany\",\r\n \"createdBy\": \"ryan.michel - LT1800-ORION - Microsoft SQL Server Management Studio - Query\",\r\n \"createdDate\": \"2024-01-19T12:27:09.8728687-06:00\",\r\n \"auditedByDisplay\": \"ryan.michel - LT1800-ORION - Microsoft SQL Server Management Studio - Query\",\r\n \"auditedBy\": null,\r\n \"auditedDate\": null\r\n },\r\n {\r\n \"id\": 3,\r\n \"alClientSourceId\": 1379,\r\n \"alClientDestinationId\": 245,\r\n \"alClientSourceName\": null,\r\n \"alClientDestinationName\": null,\r\n \"sourceDescription\": \"test1\",\r\n \"isActive\": false,\r\n \"isAccepted\": true,\r\n \"lastProcessedSource\": \"2024-01-04T12:27:09.87+00:00\",\r\n \"lastProcessedDestination\": \"2024-01-09T12:27:09.87+00:00\",\r\n \"syncStatus\": 1,\r\n \"syncErrors\": null,\r\n \"createdBy\": \"ryan.michel - LT1800-ORION - Microsoft SQL Server Management Studio - Query\",\r\n \"createdDate\": \"2024-01-19T12:27:09.8728687-06:00\",\r\n \"auditedByDisplay\": \"ryan.michel - LT1800-ORION - Microsoft SQL Server Management Studio - Query\",\r\n \"auditedBy\": null,\r\n \"auditedDate\": null\r\n },\r\n]", "operationId": "DataSharing_GetAllByCurrentIdentityAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "PortfolioDataSync/DataSharing" ], "summary": "Creates a new row and adds it to the datasharingsource table", "description": "Sample Request\r\nHttpPut /DataMaintenance/DataSharing/Sources\r\n{\r\n \"id\": 6,\r\n \"alClientSourceId\": 1379,\r\n \"alClientDestinationId\": 986,\r\n \"alClientSourceName\": null,\r\n \"alClientDestinationName\": null,\r\n \"sourceDescription\": \"dfgsdfg\",\r\n \"isActive\": false,\r\n \"isAccepted\": false,\r\n \"lastProcessedSource\": null,\r\n \"lastProcessedDestination\": null,\r\n \"syncStatus\": 0,\r\n \"syncErrors\": \"\",\r\n \"createdBy\": \"Ryan.Michel\",\r\n \"createdDate\": \"2024-01-23T11:49:39.5457063-06:00\",\r\n \"auditedByDisplay\": \"Ryan.Michel\",\r\n \"auditedBy\": null,\r\n \"auditedDate\": null\r\n}", "operationId": "DataSharing_AddRowAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.PortfolioDataSync.DataSharingSourceDto" } }, { "name": "token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/PortfolioDataSync/DataSharing/Sources/{dataSharingSourceId}": { "get": { "tags": [ "PortfolioDataSync/DataSharing" ], "summary": "Gets all DataSharingSources filtered by the DataSharingSourceId", "description": "Sample Request\r\nGet /DataMaintenance/DataSharing/Sources/1379\r\n[\r\n {\r\n \"id\": 1,\r\n \"alClientSourceId\": 90,\r\n \"alClientDestinationId\": 108,\r\n \"alClientSourceName\": null,\r\n \"alClientDestinationName\": null,\r\n \"sourceDescription\": \"random alclients\",\r\n \"isActive\": false,\r\n \"isAccepted\": false,\r\n \"lastProcessedSource\": null,\r\n \"lastProcessedDestination\": null,\r\n \"syncStatus\": 1,\r\n \"syncErrors\": null,\r\n \"createdBy\": \"ryan.michel - LT1800-ORION - Microsoft SQL Server Management Studio - Query\",\r\n \"createdDate\": \"2024-01-19T12:27:09.8728687-06:00\",\r\n \"auditedByDisplay\": \"ryan.michel - LT1800-ORION - Microsoft SQL Server Management Studio - Query\",\r\n \"auditedBy\": null,\r\n \"auditedDate\": null\r\n },\r\n {\r\n \"id\": 2,\r\n \"alClientSourceId\": 245,\r\n \"alClientDestinationId\": 1379,\r\n \"alClientSourceName\": null,\r\n \"alClientDestinationName\": null,\r\n \"sourceDescription\": \"test2\",\r\n \"isActive\": true,\r\n \"isAccepted\": false,\r\n \"lastProcessedSource\": \"2023-12-30T12:27:09.87+00:00\",\r\n \"lastProcessedDestination\": \"2024-01-18T12:27:09.87+00:00\",\r\n \"syncStatus\": 2,\r\n \"syncErrors\": \"somany\",\r\n \"createdBy\": \"ryan.michel - LT1800-ORION - Microsoft SQL Server Management Studio - Query\",\r\n \"createdDate\": \"2024-01-19T12:27:09.8728687-06:00\",\r\n \"auditedByDisplay\": \"ryan.michel - LT1800-ORION - Microsoft SQL Server Management Studio - Query\",\r\n \"auditedBy\": null,\r\n \"auditedDate\": null\r\n }\r\n]", "operationId": "DataSharing_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dataSharingSourceId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/PortfolioDataSync/DataSharing/Sources/{dataSharingSourceId}/Action/Deactivate": { "put": { "tags": [ "PortfolioDataSync/DataSharing" ], "summary": "Marks a source as inactive (active = false)", "description": "Sample Request\r\nHttpPut /DataMaintenance/DataSharing/Sources/1456/Action/Deactivate", "operationId": "DataSharing_DeactivateSourceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dataSharingSourceId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "token", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/PortfolioDataSync/DataSharing/Sources/{dataSharingSourceId}/Action/Description": { "put": { "tags": [ "PortfolioDataSync/DataSharing" ], "summary": "Sets the description", "description": "Sample Request\r\nHttpPut /DataMaintenance/DataSharing/Sources/3453452/Action/Description", "operationId": "DataSharing_UpdateDescriptionAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dataSharingSourceId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.PortfolioDataSync.DataSharingSourceDto" } }, { "name": "token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/PortfolioDataSync/DataSharing/Sources/{dataSharingSourceId}/Action/Reactivate": { "put": { "tags": [ "PortfolioDataSync/DataSharing" ], "summary": "Activates a source", "description": "Sample Request\r\nHttpPut /DataMaintenance/DataSharing/Sources/1456/Action/Reactivate", "operationId": "DataSharing_ReactivateSourceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dataSharingSourceId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "token", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/PortfolioDataSync/DataSharing/Sources/{dataSharingSourceId}/Action/UpdateFromSourceKeyAsync": { "put": { "tags": [ "PortfolioDataSync/DataSharing" ], "summary": "Updates an existing row from a sourcekey", "description": "Sample Request\r\n Put /DataMaintenance/DataSharing/Sources/36/Action/UpdateFromSourceKeyAsync\r\n{\r\n alClientDestinationId:1379\r\n alClientDestinationName:null\r\n alClientSourceId:245\r\n alClientSourceName:\"OrionService (test)\"\r\n auditedByDisplay:\"Ryan.Michel\"\r\n auditedDate:null\r\n createdBy:\"Ryan.Michel\"\r\n createdDate:\"2024-03-12T14:25:08.2912727-05:00\"\r\n dataSharingSourceUID:\"e0f3b6ad-ecc9-406b-b2ff-87d2fe431c8b\"\r\n id:36\r\n isActive:true\r\n isActiveDestination:true\r\n isActiveSource:true\r\n lastProcessedDestination:null\r\n lastProcessedSource:null\r\n sourceDescription:\"give me a key\"\r\n syncErrors:\"\"\r\n syncStatus:0\r\n{", "operationId": "DataSharing_UpdateFromSourceKeyAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dataSharingSourceId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.PortfolioDataSync.DataSharingSourceDto" } }, { "name": "token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/PortfolioDataSync/DataSharing/Sources/{dataSharingSourceId}/Entities": { "get": { "tags": [ "PortfolioDataSync/DataSharing" ], "summary": "Returns all DataSharingSource rows that match our current logged in identity as the source or destination", "description": "Sample Request\r\nGet /DataMaintenance/DataSharing/Sources/23478/Entities\r\n[\r\n {\r\n \"id\": 2,\r\n \"alClientSourceId\": 245,\r\n \"alClientDestinationId\": 1379,\r\n \"alClientSourceName\": null,\r\n \"alClientDestinationName\": null,\r\n \"sourceDescription\": \"test2\",\r\n \"isActive\": true,\r\n \"isAccepted\": false,\r\n \"lastProcessedSource\": \"2023-12-30T12:27:09.87+00:00\",\r\n \"lastProcessedDestination\": \"2024-01-18T12:27:09.87+00:00\",\r\n \"syncStatus\": 2,\r\n \"syncErrors\": \"somany\",\r\n \"createdBy\": \"ryan.michel - LT1800-ORION - Microsoft SQL Server Management Studio - Query\",\r\n \"createdDate\": \"2024-01-19T12:27:09.8728687-06:00\",\r\n \"auditedByDisplay\": \"ryan.michel - LT1800-ORION - Microsoft SQL Server Management Studio - Query\",\r\n \"auditedBy\": null,\r\n \"auditedDate\": null\r\n },\r\n {\r\n \"id\": 3,\r\n \"alClientSourceId\": 1379,\r\n \"alClientDestinationId\": 245,\r\n \"alClientSourceName\": null,\r\n \"alClientDestinationName\": null,\r\n \"sourceDescription\": \"test1\",\r\n \"isActive\": false,\r\n \"isAccepted\": true,\r\n \"lastProcessedSource\": \"2024-01-04T12:27:09.87+00:00\",\r\n \"lastProcessedDestination\": \"2024-01-09T12:27:09.87+00:00\",\r\n \"syncStatus\": 1,\r\n \"syncErrors\": null,\r\n \"createdBy\": \"ryan.michel - LT1800-ORION - Microsoft SQL Server Management Studio - Query\",\r\n \"createdDate\": \"2024-01-19T12:27:09.8728687-06:00\",\r\n \"auditedByDisplay\": \"ryan.michel - LT1800-ORION - Microsoft SQL Server Management Studio - Query\",\r\n \"auditedBy\": null,\r\n \"auditedDate\": null\r\n },\r\n]", "operationId": "DataSharing_GetAllEntitiesForCurrentIdentityAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dataSharingSourceId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/PortfolioDataSync/DataSharing/Sources/{dataSharingSourceId}/Entities/Import": { "post": { "tags": [ "PortfolioDataSync/DataSharing" ], "summary": "Inserts records based on imported file", "description": "Sample Request\r\nPOST /DataMaintenance/DataSharing/Source/32457/Entities/Import\r\nBODY\r\n File:binary", "operationId": "DataSharing_CreateEntitiesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dataSharingSourceId", "in": "path", "description": "The data sharing source Id", "required": true, "type": "integer", "format": "int32" }, { "name": "file", "in": "body", "description": "the import file", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/PortfolioDataSync/DataSharing/Sources/{dataSharingSourceId}/Entities/Upsert": { "put": { "tags": [ "PortfolioDataSync/DataSharing" ], "operationId": "DataSharing_UpdateEntitiesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.PortfolioDataSync.DataSharingEntitySelectionDto" }, "xml": { "name": "DataSharingEntitySelectionDto", "wrapped": true }, "type": "array" } }, { "name": "dataSharingSourceId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/PortfolioDataSync/DataSharing/Sources/{dataSharingSourceId}/Entities/Upsert/Hypothetical": { "put": { "tags": [ "PortfolioDataSync/DataSharing" ], "operationId": "DataSharing_PreviewUpdateEntitiesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.PortfolioDataSync.DataSharingEntitySelectionDto" }, "xml": { "name": "DataSharingEntitySelectionDto", "wrapped": true }, "type": "array" } }, { "name": "dataSharingSourceId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/PortfolioDataSync/DataSharing/Sources/{dataSharingSourceId}/EntityMapOverrides": { "get": { "tags": [ "PortfolioDataSync/DataSharing" ], "operationId": "DataSharing_GetEntityMapOverridesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dataSharingSourceId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "PortfolioDataSync/DataSharing" ], "operationId": "DataSharing_SaveEntityMapOverridesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dataSharingSourceId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "entityMapOverrideJSON", "in": "body", "required": true, "schema": { "type": "string" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/PortfolioDataSync/DataSharing/Sources/{dataSharingSourceId}/EntityMaps": { "get": { "tags": [ "PortfolioDataSync/DataSharing" ], "summary": "Retrieves All entity maps for the current alclientid", "description": "Sample Request\r\nGet /DataMaintenance/DataSharing/Source/2/EntityMaps\r\n [\r\n {\r\n \"dataSharingSourceId\": 2,\r\n \"entityEnum\": 4,\r\n \"entitySource\": 14,\r\n \"entityDescriptionSource\": \"mapping rep recon to service\",\r\n \"entityInfoSourceJSON\": null,\r\n \"entityDestination\": 27,\r\n \"entityDescriptionDestination\": \"RepNo: 123, RepName: Kala1 Wylie\"\r\n },\r\n {\r\n \"dataSharingSourceId\": 2,\r\n \"entityEnum\": 4,\r\n \"entitySource\": 15,\r\n \"entityDescriptionSource\": \"this destination does not exist\",\r\n \"entityInfoSourceJSON\": null,\r\n \"entityDestination\": -11324,\r\n \"entityDescriptionDestination\": null\r\n }\r\n ]", "operationId": "DataSharing_GetAllEntityMapsForCurrentIdentityAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dataSharingSourceId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "PortfolioDataSync/DataSharing" ], "operationId": "DataSharing_UpdateAllEntityMapsForCurrentIdentityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dataSharingSourceId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.PortfolioDataSync.DataSharingEntityMapDto" }, "xml": { "name": "DataSharingEntityMapDto", "wrapped": true }, "type": "array" } }, { "name": "token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/PortfolioDataSync/DataSharing/Sources/{dataSharingSourceId}/NotificationSetting": { "get": { "tags": [ "PortfolioDataSync/DataSharing" ], "operationId": "DataSharingNotification_GetDataSharingNotificationAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dataSharingSourceId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "PortfolioDataSync/DataSharing" ], "operationId": "DataSharingNotification_UpsertDataSharingNotificationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.PortfolioDataSync.DataSharingNotificationDto" } }, { "name": "ct", "in": "header", "required": false }, { "name": "dataSharingSourceId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "PortfolioDataSync/DataSharing" ], "operationId": "DataSharingNotification_DeleteDataSharingNotificationAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dataSharingSourceId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/PortfolioDataSync/DataSharing/Sources/alClientId/{alClientId}": { "get": { "tags": [ "PortfolioDataSync/DataSharing" ], "summary": "Gets all DataSharingSources filtered where the client or destination source match the passed in alClientId", "description": "Sample Request\r\nGet /DataMaintenance/DataSharing/Sources/AlClientId/1379\r\n[\r\n {\r\n \"id\": 1,\r\n \"alClientSourceId\": 90,\r\n \"alClientDestinationId\": 108,\r\n \"alClientSourceName\": null,\r\n \"alClientDestinationName\": null,\r\n \"sourceDescription\": \"random alclients\",\r\n \"isActive\": false,\r\n \"isAccepted\": false,\r\n \"lastProcessedSource\": null,\r\n \"lastProcessedDestination\": null,\r\n \"syncStatus\": 1,\r\n \"syncErrors\": null,\r\n \"createdBy\": \"ryan.michel - LT1800-ORION - Microsoft SQL Server Management Studio - Query\",\r\n \"createdDate\": \"2024-01-19T12:27:09.8728687-06:00\",\r\n \"auditedByDisplay\": \"ryan.michel - LT1800-ORION - Microsoft SQL Server Management Studio - Query\",\r\n \"auditedBy\": null,\r\n \"auditedDate\": null\r\n },\r\n {\r\n \"id\": 2,\r\n \"alClientSourceId\": 245,\r\n \"alClientDestinationId\": 1379,\r\n \"alClientSourceName\": null,\r\n \"alClientDestinationName\": null,\r\n \"sourceDescription\": \"test2\",\r\n \"isActive\": true,\r\n \"isAccepted\": false,\r\n \"lastProcessedSource\": \"2023-12-30T12:27:09.87+00:00\",\r\n \"lastProcessedDestination\": \"2024-01-18T12:27:09.87+00:00\",\r\n \"syncStatus\": 2,\r\n \"syncErrors\": \"somany\",\r\n \"createdBy\": \"ryan.michel - LT1800-ORION - Microsoft SQL Server Management Studio - Query\",\r\n \"createdDate\": \"2024-01-19T12:27:09.8728687-06:00\",\r\n \"auditedByDisplay\": \"ryan.michel - LT1800-ORION - Microsoft SQL Server Management Studio - Query\",\r\n \"auditedBy\": null,\r\n \"auditedDate\": null\r\n }\r\n]", "operationId": "DataSharing_GetByAlClientIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "alClientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/PortfolioDataSync/DataSharing/Sources/AllData": { "get": { "tags": [ "PortfolioDataSync/DataSharing" ], "summary": "Get all rows unfilered for DataSharingSource", "description": "Sample Request\r\nGet /DataMaintenance/DataSharing/Source/AllData\r\n[\r\n {\r\n \"id\": 1,\r\n \"alClientSourceId\": 90,\r\n \"alClientDestinationId\": 108,\r\n \"alClientSourceName\": null,\r\n \"alClientDestinationName\": null,\r\n \"sourceDescription\": \"random alclients\",\r\n \"isActive\": false,\r\n \"isAccepted\": false,\r\n \"lastProcessedSource\": null,\r\n \"lastProcessedDestination\": null,\r\n \"syncStatus\": 1,\r\n \"syncErrors\": null,\r\n \"createdBy\": \"ryan.michel - LT1800-ORION - Microsoft SQL Server Management Studio - Query\",\r\n \"createdDate\": \"2024-01-19T12:27:09.8728687-06:00\",\r\n \"auditedByDisplay\": \"ryan.michel - LT1800-ORION - Microsoft SQL Server Management Studio - Query\",\r\n \"auditedBy\": null,\r\n \"auditedDate\": null\r\n },\r\n {\r\n \"id\": 2,\r\n \"alClientSourceId\": 245,\r\n \"alClientDestinationId\": 1379,\r\n \"alClientSourceName\": null,\r\n \"alClientDestinationName\": null,\r\n \"sourceDescription\": \"test2\",\r\n \"isActive\": true,\r\n \"isAccepted\": false,\r\n \"lastProcessedSource\": \"2023-12-30T12:27:09.87+00:00\",\r\n \"lastProcessedDestination\": \"2024-01-18T12:27:09.87+00:00\",\r\n \"syncStatus\": 2,\r\n \"syncErrors\": \"somany\",\r\n \"createdBy\": \"ryan.michel - LT1800-ORION - Microsoft SQL Server Management Studio - Query\",\r\n \"createdDate\": \"2024-01-19T12:27:09.8728687-06:00\",\r\n \"auditedByDisplay\": \"ryan.michel - LT1800-ORION - Microsoft SQL Server Management Studio - Query\",\r\n \"auditedBy\": null,\r\n \"auditedDate\": null\r\n }\r\n]", "operationId": "DataSharing_GetAllAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/PortfolioDataSync/DataSharing/Sources/dataSharingSourceUID/{dataSharingSourceUID}": { "get": { "tags": [ "PortfolioDataSync/DataSharing" ], "summary": "Gets all DataSharingSources filtered by the dataSharingSourceUid or \"sourcekey\"", "description": "Sample Request\r\nGet /DataMaintenance/DataSharing/Sources/dataSharingSourceUID/E0F3B6AD-ECC9-406B-B2FF-87D2FE431C8B\r\n {\r\n \"id\": 36,\r\n \"alClientSourceId\": null,\r\n \"alClientDestinationId\": 1379,\r\n \"alClientSourceName\": null,\r\n \"alClientDestinationName\": null,\r\n \"sourceDescription\": \"give me a key\",\r\n \"isActive\": false,\r\n \"dataSharingSourceUID\": \"e0f3b6ad-ecc9-406b-b2ff-87d2fe431c8b\",\r\n \"isActiveSource\": true,\r\n \"isActiveDestination\": true,\r\n \"lastProcessedSource\": null,\r\n \"lastProcessedDestination\": null,\r\n \"syncStatus\": 0,\r\n \"syncErrors\": \"\",\r\n \"createdBy\": \"Ryan.Michel\",\r\n \"createdDate\": \"2024-03-12T14:25:08.2912727-05:00\",\r\n \"auditedByDisplay\": \"Ryan.Michel\",\r\n \"auditedDate\": null\r\n }", "operationId": "DataSharing_GetBySourceKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dataSharingSourceUID", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/PortfolioDataSync/DataSharing/Sources/EntityLink/IsActive": { "get": { "tags": [ "PortfolioDataSync/DataSharing" ], "operationId": "DataSharing_IsEntityDataSharedAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "entityType", "in": "query", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Product/CreateProducts": { "post": { "tags": [ "Product/CreateProducts" ], "operationId": "Product_SyncProductToEclipseAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "products", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.CreateProductRequestDto" }, "xml": { "name": "CreateProductRequestDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Public/Database/{dbKey}/ReportImage/{imageKey}": { "get": { "tags": [ "Public/Database" ], "operationId": "Public_GetReportImageAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "dbKey", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "imageKey", "in": "path", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Public/Database/{dbKey}/ReportPdf/{pdfKey}": { "get": { "tags": [ "Public/Database" ], "operationId": "Public_GetReportPdfAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "dbKey", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "pdfKey", "in": "path", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Public/Databases/{dbKey}/AdvisorImage": { "get": { "tags": [ "Public/Databases" ], "summary": "Gets the advisor headshot image for the database with the provided guid.", "operationId": "Public_GetAdvisorImage", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dbKey", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "entity", "in": "query", "description": "Optional. If provided, the Entity and EntityId are used to lookup the logo for that entity (ex. Rep Logo)", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "query", "description": "Optional. If provided, the Entity and EntityId are used to lookup the logo for that entity (ex. Rep Logo)", "required": false, "type": "integer", "format": "int32" }, { "name": "scaleMaxHeight", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "scaleMaxWidth", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Public/Databases/{dbKey}/CustomColorsCss": { "get": { "tags": [ "Public/Databases" ], "summary": "", "operationId": "Public_GetCustomEntityColorsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dbKey", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "sessionId", "in": "query", "required": false, "type": "string", "format": "uuid" }, { "name": "minify", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Public/Databases/{dbKey}/Deliver/{sessionId}/Images/{imageId}": { "get": { "tags": [ "Public/Databases" ], "operationId": "Public_GetDeliverS3ImageAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "dbKey", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "sessionId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "imageId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Public/Databases/{dbKey}/ReportImage": { "get": { "tags": [ "Public/Databases" ], "summary": "", "operationId": "Public_GetV1PublicDatabasesByDbKeyReportImage", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dbKey", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "entity", "in": "query", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Public/Databases/{key}": { "get": { "tags": [ "Public/Databases" ], "summary": "Gets the public information for the database with the provided guid.", "operationId": "Public_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "entity", "in": "query", "description": "Optional. If provided, the Entity and EntityId are used to lookup the logo for that entity (ex. Rep Logo)", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "query", "description": "Optional. If provided, the Entity and EntityId are used to lookup the logo for that entity (ex. Rep Logo)", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Authentication.DatabaseInfo" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Public/Databases/{key}/Image": { "get": { "tags": [ "Public/Databases" ], "summary": "Gets the logo image for the database with the provided guid.", "operationId": "Public_GetImage", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "entity", "in": "query", "description": "Optional. If provided, the Entity and EntityId are used to lookup the logo for that entity (ex. Rep Logo)", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "query", "description": "Optional. If provided, the Entity and EntityId are used to lookup the logo for that entity (ex. Rep Logo)", "required": false, "type": "integer", "format": "int32" }, { "name": "scaleMaxHeight", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "scaleMaxWidth", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Public/Databases/{key}/Simple": { "get": { "tags": [ "Public/Databases" ], "summary": "Gets the name for the database with the provided guid.", "operationId": "Public_GetSimpleAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Public/Partners/{partnerId}": { "get": { "tags": [ "Public/Partners" ], "summary": "Gets public information of partner application, such as partner name, and product name.", "operationId": "Public_GetPartnerInfoAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "partnerId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Security.PartnerAppInfo" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Public/Partners/{partnerId}/Image": { "get": { "tags": [ "Public/Partners" ], "summary": "Gets the partner application image.", "operationId": "Public_GetPartnerImageAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "partnerId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Public/Partners/{partnerId}/SmallImage": { "get": { "tags": [ "Public/Partners" ], "summary": "Gets the partner application image.", "operationId": "Public_GetPartnerSmallImageAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "partnerId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Public/RequestForgotPassword/{key}": { "post": { "tags": [ "Public/RequestForgotPassword" ], "summary": "Posts a request that the user has forgotten their password.", "operationId": "Public_PostRequestForgotPassword", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The username or email of the user who forgot their password.", "required": true, "type": "string" }, { "name": "urlId", "in": "query", "description": "The id for the url to be provided in the user's email message. If not provided, it will just send a code to the user", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Public/SecurityQuestion/{code}": { "get": { "tags": [ "Public/SecurityQuestion" ], "summary": "Obsolete: Security questions and answers are no longer used. An empty string is returned for the security question.", "operationId": "Public_GetSecurityQuestion", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "code", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Public/SMS": { "get": { "tags": [ "Public/SMS" ], "operationId": "Public_ProcessSMS", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "from", "in": "query", "required": true, "type": "string" }, { "name": "body", "in": "query", "required": true, "type": "string" }, { "name": "SmsMessageSid", "in": "query", "required": true, "type": "string" }, { "name": "FromZip", "in": "query", "required": true, "type": "string" }, { "name": "FromCity", "in": "query", "required": true, "type": "string" }, { "name": "SmsSid", "in": "query", "required": true, "type": "string" }, { "name": "AccountSid", "in": "query", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Public/UrlShortener/{slug}": { "get": { "tags": [ "Public/UrlShortener" ], "operationId": "Public_GetUrlShortenerAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "slug", "in": "path", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Public/User/{key}": { "post": { "tags": [ "Public/User" ], "summary": "Used to create a user login.", "operationId": "Public_CreateUserAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.NewClientOrRepUserDto" } }, { "name": "sourceApp", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "OrionConnect", "WordPressClientPortal", "OrionAuthenticationService" ] }, { "name": "urlId", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 1 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Authorization.RecaptchaResponseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/QueryStudio/NaturalLanguage/AWS/CustomFields": { "post": { "tags": [ "QueryStudio/NaturalLanguage" ], "operationId": "QueryTagNaturalLanguage_UploadCustomFieldsS3BucketAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/QueryStudio/NaturalLanguage/AWS/KnowledgeBase/Sync": { "post": { "tags": [ "QueryStudio/NaturalLanguage" ], "operationId": "QueryTagNaturalLanguage_StartKnowledgeBaseSyncJobAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/QueryStudio/NaturalLanguage/AWS/KnowledgeBase/SyncStatus/{jobId}": { "post": { "tags": [ "QueryStudio/NaturalLanguage" ], "operationId": "QueryTagNaturalLanguage_PostV1QueryStudioNaturalLanguageAWSKnowledgeBaseSyncStatusByJobId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/QueryStudio/NaturalLanguage/AWS/QueryTags": { "post": { "tags": [ "QueryStudio/NaturalLanguage" ], "operationId": "QueryTagNaturalLanguage_UploadQueryTagsS3BucketAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/QueryStudio/NaturalLanguage/AWS/QueryTags/Source/{sourceId}": { "post": { "tags": [ "QueryStudio/NaturalLanguage" ], "operationId": "QueryTagNaturalLanguage_PostV1QueryStudioNaturalLanguageAWSQueryTagsSourceBySourceId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "sourceId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/QueryStudio/NaturalLanguage/QueryTags": { "post": { "tags": [ "QueryStudio/NaturalLanguage" ], "operationId": "QueryTagNaturalLanguage_GetQueryTagsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "chat", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.QueryStudio.NaturalLanguage.AwsQueryTagChatMessage" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/QueryStudio/Queries": { "get": { "tags": [ "QueryStudio/Queries" ], "operationId": "Queries_GetQueriesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.QueryStudio.QueryDto" }, "xml": { "name": "QueryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "QueryStudio/Queries" ], "operationId": "Queries_UpdateQueryAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.QueryStudio.QueryDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.QueryStudio.QueryDto" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "QueryStudio/Queries" ], "operationId": "Queries_CreateQueryAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.QueryStudio.QueryDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.QueryStudio.QueryDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/QueryStudio/Queries/{id}/AccessRules": { "get": { "tags": [ "QueryStudio/Queries" ], "operationId": "Queries_GetAccessRulesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.QueryStudio.AccessRules.QueryAccessRuleDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "QueryStudio/Queries" ], "operationId": "Queries_UpdateAccessRulesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "accessRules", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.QueryStudio.AccessRules.QueryAccessRuleDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/QueryStudio/Queries/{queryId}": { "get": { "tags": [ "QueryStudio/Queries" ], "operationId": "Queries_GetQueryAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "queryId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.QueryStudio.QueryDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "QueryStudio/Queries" ], "operationId": "Queries_DeleteQueryAsync", "consumes": [], "produces": [], "parameters": [ { "name": "queryId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/QueryStudio/Queries/{queryId}/Export": { "post": { "tags": [ "QueryStudio/Queries" ], "operationId": "Queries_RunQueryToFileAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "options", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.QueryStudio.QueryGenerate.QueryStudioQueryExportOptions" } }, { "name": "queryId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/QueryStudio/Queries/Download/{filename}": { "get": { "tags": [ "QueryStudio/Queries" ], "operationId": "Queries_DownloadFileAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "filename", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/QueryStudio/Queries/Preview": { "post": { "tags": [ "QueryStudio/Queries" ], "operationId": "Queries_RunPreviewQueryAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "query", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.QueryStudio.QueryDto" } }, { "name": "limit", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/QueryStudio/Queries/Run": { "post": { "tags": [ "QueryStudio/Queries" ], "operationId": "Queries_RunQueryAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "query", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.QueryStudio.QueryDto" } }, { "name": "limit", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/QueryStudio/Queries/Search": { "get": { "tags": [ "QueryStudio/Queries" ], "operationId": "Queries_SearchAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "searchQuery", "in": "query", "required": true, "type": "string" }, { "name": "maxResults", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 30 }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/QueryStudio/QueryTags": { "get": { "tags": [ "QueryStudio/QueryTags" ], "operationId": "QueryTag_GetQueryTagsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "activeOnly", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.QueryStudio.QueryTagDto" }, "xml": { "name": "QueryTagDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "QueryStudio/QueryTags" ], "operationId": "QueryTag_UpdateQueryTagAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "query", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.QueryStudio.QueryTagDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "QueryStudio/QueryTags" ], "operationId": "QueryTag_CreateQueryTagAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.QueryStudio.QueryTagDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/QueryStudio/QueryTags/{queryTagId}": { "get": { "tags": [ "QueryStudio/QueryTags" ], "operationId": "QueryTag_GetQueryTagByIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "queryTagId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.QueryStudio.QueryTagDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/QueryStudio/QueryTags/Action/Category": { "post": { "tags": [ "QueryStudio/QueryTags" ], "operationId": "QueryTag_UpdateCategoryForTagsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "queryTagIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "category", "in": "query", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/QueryStudio/QueryTags/Action/IsActive": { "post": { "tags": [ "QueryStudio/QueryTags" ], "operationId": "QueryTag_UpdateIsActiveForTagsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "queryTagIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "isActive", "in": "query", "required": true, "type": "boolean" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/QueryStudio/QueryTags/CreateTagsFromTable": { "post": { "tags": [ "QueryStudio/QueryTags" ], "operationId": "QueryTag_CreateQueryTagsFromTableAsync", "consumes": [], "produces": [], "parameters": [ { "name": "tableName", "in": "query", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/QueryStudio/QueryTagSources": { "get": { "tags": [ "QueryStudio/QueryTagSources" ], "operationId": "QueryTagSource_GetQueryTagSourcesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.QueryStudio.QueryTagSource" }, "xml": { "name": "QueryTagSource", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "QueryStudio/QueryTagSources" ], "operationId": "QueryTagSource_UpdateQueryTagSourceAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "queryTagSource", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.QueryStudio.QueryTagSourceDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "QueryStudio/QueryTagSources" ], "operationId": "QueryTagSource_CreateQueryTagSourceAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "queryTagSource", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.QueryStudio.QueryTagSourceDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/QueryStudio/QueryTagSources/{id}": { "get": { "tags": [ "QueryStudio/QueryTagSources" ], "operationId": "QueryTagSource_GetQueryTagSourceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.QueryStudio.QueryTagSourceDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "QueryStudio/QueryTagSources" ], "operationId": "QueryTagSource_DeleteQueryTagSourceAsync", "consumes": [], "produces": [], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/QueryStudio/RelatedColumns": { "get": { "tags": [ "QueryStudio/RelatedColumns" ], "operationId": "RelatedColumn_GetRelatedColumnsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.QueryStudio.RelatedColumn" }, "xml": { "name": "RelatedColumn", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "QueryStudio/RelatedColumns" ], "operationId": "RelatedColumn_CreateRelatedColumnAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "relatedColumn", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.QueryStudio.RelatedColumn" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/QueryStudio/RelatedColumns/{id}": { "delete": { "tags": [ "QueryStudio/RelatedColumns" ], "operationId": "RelatedColumn_DeleteRelatedColumnAsync", "consumes": [], "produces": [], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/QueryStudio/RelatedColumns/Columns": { "get": { "tags": [ "QueryStudio/RelatedColumns" ], "operationId": "RelatedColumn_GetColumnsForSourceNameAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "sourceName", "in": "query", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataProcess.QueryStudio.QueryTags.TableColumn" }, "xml": { "name": "TableColumn", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entity}/{entityId}/PortfolioCompare/ModelDeviation": { "post": { "tags": [ "RepExpTrading/{entity}" ], "operationId": "PortfolioCompareModelDeviation_CalculateModelDeviationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "scenarioType", "in": "query", "required": true, "type": "string", "enum": [ "Rebalance", "ChangeAllocation", "RaiseCash", "DepositCash" ] }, { "name": "isSleeved", "in": "query", "required": true, "type": "boolean" }, { "name": "deviationRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.CompareTool.DTO.CompareToolModelDeviationRequestDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/Audit/Nonsleeve": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "Audit_GetNonsleevedHistoryAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true }, { "name": "fromDate", "in": "query", "required": false, "type": "string" }, { "name": "toDate", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/Audit/Sleeve": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "Audit_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "odata", "in": "header", "required": true }, { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/CustomIndexing": { "post": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "CustomIndexing_GetCustomIndexingConfigurationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "clientId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "accountIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" }, { "name": "templateName", "in": "query", "required": false, "type": "string" }, { "name": "isTrading", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "modelAggId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/CustomIndexing/{hashKey}/Proposal": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "CustomIndexing_GetProposalForHashKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "hashKey", "in": "path", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true }, { "name": "entityEnum", "in": "path", "required": true, "type": "string" }, { "name": "entityId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/CustomIndexing/Astro/{templateName}": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "CustomIndexing_GetAstroTemplateAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "templateName", "in": "path", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true }, { "name": "entityEnum", "in": "path", "required": true, "type": "string" }, { "name": "entityId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/CustomIndexing/Astro/Settings": { "post": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "CustomIndexing_UpdateAstroSettingsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true }, { "name": "astroAccounts", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RetAstroAccountDto" }, "xml": { "name": "RetAstroAccountDto", "wrapped": true }, "type": "array" } }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" }, { "name": "alwaysUpdate", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "isTrading", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/CustomIndexing/ModelAgg/Astro/{templateName}": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "CustomIndexing_GetModelAggByAstroTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "templateName", "in": "path", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true }, { "name": "isTrading", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" }, { "name": "includeDetails", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/Eclipse/FirmToken": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "EclipseFirmToken_GetEclipseFirmTokenAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true }, { "name": "repId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "oneTimeToken", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/Entity/Account/{accountId}/Holdings": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "AccountEntity_GetAccountHoldingsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" }, { "name": "entityEnum", "in": "path", "required": true, "type": "string" }, { "name": "entityId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/Entity/ManagementStyles": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "ManagementStyles_GetAvailableManagementStylesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "skip", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "take", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true }, { "name": "search", "in": "query", "required": false, "type": "string" }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" }, { "name": "entityEnum", "in": "path", "required": true, "type": "string" }, { "name": "entityId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/Entity/ManagementStyles/Simple": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "ManagementStyles_GetSimpleManagementStylesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "entityEnum", "in": "path", "required": true, "type": "string" }, { "name": "entityId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/Entity/Model": { "post": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "ModelEntity_CreateModelAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "model", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelFullDto" } }, { "name": "ct", "in": "header", "required": true }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" }, { "name": "repId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/Entity/Model/{modelAggId}": { "put": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "ModelEntity_UpdateModelAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "modelAggId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "model", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelFullDto" } }, { "name": "ct", "in": "header", "required": true }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/Entity/Model/{modelId}": { "delete": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "ModelEntity_DeleteModelAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "modelId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true }, { "name": "isCleanUp", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/Entity/Model/SearchConfig": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "summary": "Returns the configuration for model entity \r\nUsed in Advisor Portal Sleeve Strategies and Account Assignment", "operationId": "ModelEntity_GetModelSearchConfigAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "searchTerm", "in": "query", "required": true, "type": "string" }, { "name": "filterSelfDirected", "in": "query", "required": true, "type": "boolean" }, { "name": "useFullRestrictions", "in": "query", "required": true, "type": "boolean" }, { "name": "subAdvisorModels", "in": "query", "required": true, "type": "boolean" }, { "name": "repId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "custodianId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "registrationTypeId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/Entity/Model/Ticker/{ticker}": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "ModelEntity_GetModelsByTickerAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ticker", "in": "path", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true }, { "name": "excludeSelfDirected", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/Entity/Model/Ticker/{ticker}/Accounts": { "post": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "ModelEntity_GetAccountsWithTickerByModelAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ticker", "in": "path", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true }, { "name": "modelAggIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/Entity/ModelAgg/{modelAggId}/{accountId}/Allocations": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "ModelAggEntity_GetHoldingsForAccountAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "modelAggId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" }, { "name": "isSleeved", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/Entity/ModelAgg/Lookup": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "ModelAggEntity_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "odata", "in": "header", "required": true }, { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true }, { "name": "accountId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "subAdvisorId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "eclipseFirmId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "teamPermissionsRequired", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "filterSelfDirected", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/Entity/SubAdvisor": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "SubAdvisorEntity_GetAvailableSubAdvisorsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "skip", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "take", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true }, { "name": "search", "in": "query", "required": false, "type": "string" }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" }, { "name": "entityEnum", "in": "path", "required": true, "type": "string" }, { "name": "entityId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/Entity/SubAdvisor/Simple": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "SubAdvisorEntity_GetSimpleSubAdvisorsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "entityEnum", "in": "path", "required": true, "type": "string" }, { "name": "entityId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/ModelAssignment": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "ModelAssignment_GetModelAssignmentsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "isSleeved", "in": "query", "required": true, "type": "boolean" }, { "name": "eclipseEnabled", "in": "query", "required": true, "type": "boolean" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "ModelAssignment_UpdateAccountModelsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "modelUpdates", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.ModelAssignment.ModelUpdateDto" }, "xml": { "name": "ModelUpdateDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "repId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/ModelAssignment/Accounts": { "post": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "ModelAssignment_AssignmentAccountsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "accountIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "modelAggId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "subAdvisorId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "repId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/ModelAssignment/Rebalance": { "post": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "ModelAssignment_RebalanceModelAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.Models.RetRebalanceRequestDto" } }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/ModelAssignment/Rebalance/Model": { "post": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "ModelAssignment_RebalanceModelAccountAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "model", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelFullDto" } }, { "name": "skipModelAggCheck", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/ModelAssignment/Update": { "post": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "ModelAssignment_UpdatePortfolioModelAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "modelUpdates", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.ModelAssignment.PortfolioUpdateDto" } }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/PortfolioCompare/ImplementScenario": { "post": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "PortfolioCompareImplementScenario_ImplementCompareToolScenarioAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "scenarioConfig", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.CompareTool.DTO.ImplementScenario.ImplementScenarioConfigurationDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/PortfolioCompare/Info": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "PortfolioCompareInfo_GetCashInfoAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "isSleeved", "in": "query", "required": true, "type": "boolean" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/PortfolioCompare/Rebalancer": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "PortfolioCompareRebalancer_GetRebalanceRequestAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "scenarioType", "in": "query", "required": true, "type": "string", "enum": [ "Rebalance", "ChangeAllocation", "RaiseCash", "DepositCash" ] }, { "name": "ct", "in": "header", "required": true }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "PortfolioCompareRebalancer_RebalanceAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "rebalanceRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.CompareTool.DTO.Rebalance.RebalanceRequestWrapperDto" } }, { "name": "isSleeved", "in": "query", "required": true, "type": "boolean" }, { "name": "ct", "in": "header", "required": true }, { "name": "fetchTradeLogs", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/PortfolioViewSettings": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "PortfolioViewSettings_GetPortfolioViewSettingsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true }, { "name": "useServiceAccount", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/PortfolioViewSettings/EntityData": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "PortfolioViewSettings_GetPortfolioViewEntityDataAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true }, { "name": "originalEntity", "in": "query", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "originalEntityId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/PortfolioViewSettings/EntityIsSleeved": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "PortfolioViewSettings_GetEntityIsSleevedAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true }, { "name": "useServiceAccount", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/Products/Details": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "SearchProducts_GetDetailsForProductsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "productIds", "in": "query", "required": true, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "ct", "in": "header", "required": true }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.SearchProducts.ProductDetailDto" }, "xml": { "name": "ProductDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/Products/RiskScore": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "summary": "Use 'Details' endpoint because it is more accurately named. The process has been changed to get more than just Risk score", "operationId": "SearchProducts_GetRiskScoreForProductsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "productIds", "in": "query", "required": true, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "ct", "in": "header", "required": true }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.SearchProducts.ProductDetailDto" }, "xml": { "name": "ProductDetailDto", "wrapped": true }, "type": "array" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/Products/Search": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "SearchProducts_SearchProductsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "skip", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "take", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Trading.RepExpTrading.CollectionResultOfOAS.WebApi.DTO.Search.SearchProductDto[]" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/Products/Search/Cloud": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "SearchProducts_SearchCloudProductsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true }, { "name": "repId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "subAdvisorId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "resultCount", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 100 }, { "name": "restrictionType", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "None", "Full", "Partial" ] }, { "name": "useAccountEntities", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "isSelfDirected", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/SelfDirected": { "post": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "SelfDirected_CreateSelfDirectedModelAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "model", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.SelfDirected.SelfDirectedDto" } }, { "name": "ct", "in": "header", "required": true }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/SelfDirected/{id}": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "SelfDirected_GetSelfDirectedModelAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.SelfDirected.SelfDirectedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/SelfDirected/{modelAggId}": { "put": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "SelfDirected_UpdateSelfDirectedModelAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "modelAggId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "model", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.SelfDirected.SelfDirectedDto" } }, { "name": "ct", "in": "header", "required": true }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/SelfDirected/DeductFee": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "SelfDirected_GetDeductFeeAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "SelfDirected_UpdateDeductFeeAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ticker", "in": "body", "required": true, "schema": { "type": "string" } }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/SelfDirected/New": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "SelfDirected_GetNewSelfDirectedModelAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true }, { "name": "accountId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.SelfDirected.SelfDirectedDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/SetAsideCash": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "SetAsideCash_GetSetAsideCashAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancelationToken", "in": "header", "required": true }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" }, { "name": "isSleeved", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "SetAsideCash_SaveSetAsideCashAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "setAsideCashRecord", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.SetAsideCash.SetAsideCashRecordDto" } }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" }, { "name": "isSleeved", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/SetAsideCash/{setAsideCashId}": { "delete": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "SetAsideCash_DeleteSetAsideCashAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "setAsideCashId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" }, { "name": "isSleeved", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "eclipseAccountId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/SleeveAssignment": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "SleeveAssignment_GetSleeveAssignmentConfigurationAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" }, { "name": "useServiceAccount", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "switchToSleeves", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "SleeveAssignment_EditSleevesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveAssignmentConfigurationDto" } }, { "name": "ct", "in": "header", "required": true }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/SleeveAssignment/Rebalance": { "post": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "SleeveAssignment_RebalanceSleeveAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.Models.RetRebalanceRequestDto" } }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" }, { "name": "overrideRebalance", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/SleeveAssignment/SleeveStrategy": { "post": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "SleeveAssignment_SleeveStrategyAssignmentAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "accountIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "sleeveStrategyId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" }, { "name": "repId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/SleeveAssignment/SleeveStrategy/{sleeveStrategyAggId}": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "SleeveAssignment_GetSleeveStrategyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "sleeveStrategyAggId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/SleeveAssignment/Validate": { "post": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "SleeveAssignment_ValidateSleeveStrategyAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "registrationIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "sleeveStrategyId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" }, { "name": "repId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/TradeInstances": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "TradeInstances_GetTradeInstancesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "take", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "isSleeved", "in": "query", "required": true, "type": "boolean" }, { "name": "ct", "in": "header", "required": true }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/TradeInstances/{tradeInstanceId}": { "delete": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "TradeInstances_DeleteTradeInstanceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "tradeInstanceId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/TradeInstances/{tradeInstanceId}/Orders": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "TradeInstances_GetTradeInstanceOrdersAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "tradeInstanceId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true }, { "name": "overrides", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/TradeOrders/GlobalTrades": { "post": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "TradeOrders_CreateGlobalTradesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "globalTrade", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.TradeOrder.GlobalTradeDto" } }, { "name": "ct", "in": "header", "required": true }, { "name": "roundValues", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/TradeOrders/GlobalTrades/List": { "post": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "TradeOrders_PostV1RepExpTradingByEntityEnumByEntityIdTradeOrdersGlobalTradesList", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "globalTrades", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.TradeOrder.GlobalTradeDto" }, "xml": { "name": "GlobalTradeDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/TradeOrders/GlobalTrades/Validate": { "post": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "TradeOrders_ValidateGlobalTradesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "globalTrade", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.TradeOrder.GlobalTradeDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/TradeOrders/HasOrders": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "TradeOrders_HasPendingOrdersAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/TradeOrders/TradeDetails": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "TradeOrders_GetTradeDetailsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "TradeOrders_CreateBuySellTradesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "tradeRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.TradeOrder.BuySellRequestDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/TradeOrders/TradeDetails/Nonsleeve": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "TradeOrders_GetNonsleevedHistoryAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "TradeOrders_CreateNonsleeveBuySellTradesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "tradeOrders", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.TradeOrder.NonsleeveTradeOrderProcessDto" }, "xml": { "name": "NonsleeveTradeOrderProcessDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/TradeOrders/TradeDetails/NonSleeve/Rebalance": { "post": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "TradeOrders_RebalanceNonSleeveAccountAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "holdings", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.TradeOrder.TradeOrderAccountHoldings" }, "xml": { "name": "TradeOrderAccountHoldings", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/TradeOrders/TradeDetails/Nonsleeve/Validate": { "post": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "TradeOrders_ValidateNonsleeveBuySellTradesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "tradeOrders", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.TradeOrder.NonsleeveTradeOrderProcessDto" }, "xml": { "name": "NonsleeveTradeOrderProcessDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/TradeOrders/TradeDetails/Validate": { "post": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "TradeOrders_ValidateBuySellTradesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "tradeRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.TradeOrder.BuySellRequestDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/RepExpTrading/{entityEnum}/{entityId}/TradingPreferences": { "get": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "TradingPreferences_GetEclipseTradingPreferencesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "RepExpTrading/{entityEnum}" ], "operationId": "TradingPreferences_UpdateEclipseTradingPreferencesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityEnum", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "preferences", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Models.IndividualSecurityPreference" }, "xml": { "name": "IndividualSecurityPreference", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/ReportAdministration/Reports/{key}": { "get": { "tags": [ "ReportAdministration/Reports" ], "summary": "Gets the full report that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ReportsAdmin_GetFullReportByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ReportAdministration.ReportListFullDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "ReportAdministration/Reports" ], "summary": "Used to update an existing report. Upon successful modification a 200 will be returned.", "operationId": "ReportsAdmin_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ReportAdministration.ReportListFullDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ReportAdministration.ReportListFullDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/ReportBuilder/CoverPages": { "get": { "tags": [ "ReportBuilder/CoverPages" ], "operationId": "CoverPages_GetCoverPages", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "width", "in": "query", "required": true, "items": { "type": "string", "enum": [ "PortraitFull", "LandscapeFull", "LandscapeHalf" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "templateType", "in": "query", "required": false, "type": "string", "enum": [ "All", "Standard", "FooterImage", "Disclaimer", "WiderLogo", "HeaderSlim" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.ReportAdministration.ReportSectionDto" }, "xml": { "name": "ReportSectionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/ReportBuilder/CoverPages/{key}": { "get": { "tags": [ "ReportBuilder/CoverPages" ], "summary": "Gets the cover page that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "CoverPages_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ReportAdministration.ReportSectionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/ReportBuilder/CoverPages/{key}/Image": { "get": { "tags": [ "ReportBuilder/CoverPages" ], "summary": "Gets the image of the cover page that has the provided key formatted as an image response regaurdless of mime type requested.", "operationId": "CoverPages_GetImage", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/ReportBuilder/CoverPages/Landscape": { "get": { "tags": [ "ReportBuilder/CoverPages" ], "summary": "Gets a list of cover pages that are landscape oriented.", "operationId": "CoverPages_GetLandscapeCoverPages", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "templateType", "in": "query", "required": false, "type": "string", "enum": [ "All", "Standard", "FooterImage", "Disclaimer", "WiderLogo", "HeaderSlim" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.ReportAdministration.ReportSectionDto" }, "xml": { "name": "ReportSectionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/ReportBuilder/CoverPages/Portrait": { "get": { "tags": [ "ReportBuilder/CoverPages" ], "summary": "Gets a list of cover pages that are portrait oriented.", "operationId": "CoverPages_GetPortraitCoverPages", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "templateType", "in": "query", "required": false, "type": "string", "enum": [ "All", "Standard", "FooterImage", "Disclaimer", "WiderLogo", "HeaderSlim" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.ReportAdministration.ReportSectionDto" }, "xml": { "name": "ReportSectionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/ReportBuilder/Reports": { "post": { "tags": [ "ReportBuilder/Reports" ], "summary": "Used to create a new report builder report. Upon successful creation a 201 will be returned with the location of the nearly created report.", "operationId": "Reports_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ReportAdministration.ReportListFullDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/ReportBuilder/Reports/{key}": { "get": { "tags": [ "ReportBuilder/Reports" ], "summary": "Gets the full report builder report that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Reports_GetFullReportByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ReportAdministration.ReportListFullDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "ReportBuilder/Reports" ], "summary": "Used to update an existing report builder report. Upon successful modification a 200 will be returned.", "operationId": "Reports_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ReportAdministration.ReportListFullDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ReportAdministration.ReportListFullDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "ReportBuilder/Reports" ], "summary": "Used to delete an existing report builder report. Upon successful deletion a 204 will be returned.", "operationId": "Reports_Delete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/ReportBuilder/Reports/Simple": { "get": { "tags": [ "ReportBuilder/Reports" ], "summary": "Gets a simple list of report builder reports that the logged in user has access to. Versioned reports appear at the top level with their parent report.", "operationId": "Reports_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.ReportAdministration.ReportListDto" }, "xml": { "name": "ReportListDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/ReportBuilder/Reports/Simple/{key}": { "get": { "tags": [ "ReportBuilder/Reports" ], "summary": "Gets the simple report builder report that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Reports_GetSimpleByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ReportAdministration.ReportListDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/ReportBuilder/Reports/Simple/Search": { "get": { "tags": [ "ReportBuilder/Reports" ], "summary": "Gets the simple report builder report list that contains the search text in the report name", "operationId": "Reports_GetReportSimpleSearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "Search text to search the report name.", "required": true, "type": "string" }, { "name": "top", "in": "query", "description": "returns the top n number of records", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "skips the first n number of records", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/ReportBuilder/Reports/Simple/Search/{search}": { "get": { "tags": [ "ReportBuilder/Reports" ], "summary": "Gets the simple report builder report list that contains the search text in the report name", "operationId": "Reports_GetV1ReportBuilderReportsSimpleSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "Search text to search the report name.", "required": true, "type": "string" }, { "name": "top", "in": "query", "description": "returns the top n number of records", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "skips the first n number of records", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/ReportBuilder/Reports/Simple/Tree": { "get": { "tags": [ "ReportBuilder/Reports" ], "summary": "Gets a simple tree of report builder reports that the logged in user has access to. Versioned reports appear below their parent report.", "operationId": "Reports_GetSimpleTree", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.ReportAdministration.ReportListDto" }, "xml": { "name": "ReportListDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/ReportBuilder/Reports/Templates": { "get": { "tags": [ "ReportBuilder/Reports" ], "operationId": "Reports_GetTemplates", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string", "enum": [ "All", "Standard", "FooterImage", "Disclaimer", "WiderLogo", "HeaderSlim" ] }, "xml": { "name": "ReportBuilderTemplateType", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/ReportBuilder/Sections": { "get": { "tags": [ "ReportBuilder/Sections" ], "summary": "Gets a list of report builder sections that the logged in user has access to.", "operationId": "Sections_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.ReportAdministration.ReportSectionDto" }, "xml": { "name": "ReportSectionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/ReportBuilder/Sections/{key}": { "get": { "tags": [ "ReportBuilder/Sections" ], "summary": "Gets the report builder section that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Sections_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ReportAdministration.ReportSectionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/ReportBuilder/Sections/{key}/Image": { "get": { "tags": [ "ReportBuilder/Sections" ], "summary": "Gets the image of the report builder section that has the provided key formatted as an image response regaurdless of mime type requested.", "operationId": "Sections_GetImage", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/ReportBuilder/Sections/Landscape": { "get": { "tags": [ "ReportBuilder/Sections" ], "summary": "Gets a list of report builder sections that are landscape oriented.", "operationId": "Sections_GetLandscape", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.ReportAdministration.ReportSectionDto" }, "xml": { "name": "ReportSectionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/ReportBuilder/Sections/Landscape/Grouped": { "get": { "tags": [ "ReportBuilder/Sections" ], "summary": "Gets a list of report builder sections that are landscape oriented grouped by category.", "operationId": "Sections_GetLandscapeGrouped", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.ReportAdministration.ReportSectionCategoryDto" }, "xml": { "name": "ReportSectionCategoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/ReportBuilder/Sections/Parameters": { "get": { "tags": [ "ReportBuilder/Sections" ], "summary": "Gets a dictionary of all the parameters used in all sections that the logged in user has access to. The dictionary key is the section key. The dictionary value is a list of parameters for the section.", "operationId": "Sections_GetParameter", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "additionalProperties": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RunReport.ReportSectionOptionDto" }, "xml": { "name": "ReportSectionOptionDto", "wrapped": true }, "type": "array" }, "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/ReportBuilder/Sections/Portrait": { "get": { "tags": [ "ReportBuilder/Sections" ], "summary": "Gets a list of report builder sections that are portrait oriented.", "operationId": "Sections_GetPortrait", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.ReportAdministration.ReportSectionDto" }, "xml": { "name": "ReportSectionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/ReportBuilder/Sections/Portrait/Grouped": { "get": { "tags": [ "ReportBuilder/Sections" ], "summary": "Gets a list of report builder sections that are portrait oriented grouped by category.", "operationId": "Sections_GetPortraitGrouped", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.ReportAdministration.ReportSectionCategoryDto" }, "xml": { "name": "ReportSectionCategoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/ReportBuilder/Themes": { "get": { "tags": [ "ReportBuilder/Themes" ], "summary": "Gets a list of report builder themes that the logged in user has access to.", "operationId": "Themes_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "object" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "ReportBuilder/Themes" ], "operationId": "Themes_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "postedJson", "in": "body", "required": true, "schema": { "type": "object" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/ReportBuilder/Themes/{key}": { "get": { "tags": [ "ReportBuilder/Themes" ], "summary": "Gets the report builder theme that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Themes_GetV1ReportBuilderThemesByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "ReportBuilder/Themes" ], "operationId": "Themes_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "postedJson", "in": "body", "required": true, "schema": { "type": "object" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "ReportBuilder/Themes" ], "operationId": "Themes_Delete", "consumes": [], "produces": [], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/ReportBuilder/Themes/Default": { "get": { "tags": [ "ReportBuilder/Themes" ], "summary": "Gets the default report builder theme that has the provided key.", "operationId": "Themes_GetDefault", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/ReportBuilder/Themes/Simple": { "get": { "tags": [ "ReportBuilder/Themes" ], "summary": "Gets a simple list of report builder themes that the logged in user has access to.", "operationId": "Themes_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.ReportAdministration.SimpleReportBuilderTheme" }, "xml": { "name": "SimpleReportBuilderTheme", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/ReportBuilder/Themes/Simple/{key}": { "get": { "tags": [ "ReportBuilder/Themes" ], "summary": "Gets the simple report builder theme that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Themes_GetV1ReportBuilderThemesSimpleByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.ReportAdministration.SimpleReportBuilderTheme" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/ReportBuilder/WebMenuOptions": { "get": { "tags": [ "ReportBuilder/WebMenuOptions" ], "summary": "Gets a list of web menu options.", "operationId": "ReportBuilder_OptionGroups_GetWebMenuOptions", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Activity/{entity}/{entityId}/Value": { "get": { "tags": [ "Reporting/Activity" ], "summary": "Method to get value for the entity specified.", "operationId": "Activity_GetValueByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "required": true, "type": "string", "enum": [ "RiskCategories", "BrokerDealers", "Representatives", "AssetClasses", "AssetCategories", "Platforms", "Models", "AggregateModels", "IndexBlends", "FundFamilies", "Database", "Custodians", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Product", "PortfolioGroups", "SleeveStrategyAggregates", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10" ] }, { "name": "entityId", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "includeCash", "in": "query", "description": "Optional. Default: false. When true the cash value will be returned along with the client value.", "required": false, "type": "boolean", "default": false }, { "name": "clientPerformanceInclude", "in": "query", "description": "Optional. Default: Default. When set only accounts/registrations that have value/are active will be returned.", "required": false, "type": "string", "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, { "name": "includeBondAccrual", "in": "query", "description": "Optional. Default: Default. Determines if bond accrual will be included in the values. If not specified the database's default setting will be used.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Activity/{entity}/{entityId}/Value/{asOfDate}": { "get": { "tags": [ "Reporting/Activity" ], "summary": "Method to get value for the entity specified.", "operationId": "Activity_GetValueAsOfDateByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "required": true, "type": "string", "enum": [ "RiskCategories", "BrokerDealers", "Representatives", "AssetClasses", "AssetCategories", "Platforms", "Models", "AggregateModels", "IndexBlends", "FundFamilies", "Database", "Custodians", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Product", "PortfolioGroups", "SleeveStrategyAggregates", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10" ] }, { "name": "entityId", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "includeCash", "in": "query", "description": "Optional. Default: false. When true the cash value will be returned along with the client value.", "required": false, "type": "boolean", "default": false }, { "name": "clientPerformanceInclude", "in": "query", "description": "Optional. Default: Default. When set only accounts/registrations that have value/are active will be returned.", "required": false, "type": "string", "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, { "name": "includeBondAccrual", "in": "query", "description": "Optional. Default: Default. Determines if bond accrual will be included in the values. If not specified the database's default setting will be used.", "required": false, "type": "boolean" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Activity/CostBasis": { "get": { "tags": [ "Reporting/Activity" ], "summary": "Returns aggregated cost basis information for each asset in the requested entity / entityid", "operationId": "Activity_GetCostBasisForAssetsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "query", "description": "Entity to run for (Household, Registration, Account, Asset)", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "query", "description": "Entity Id", "required": true, "type": "integer", "format": "int32" }, { "name": "asOfDate", "in": "query", "description": "As Of Date for the costbasis calculation (use todays date for current.)", "required": true, "type": "string", "format": "date-time" }, { "name": "reportType", "in": "query", "description": "Optional. Default is Unrealized. You can request \"Realized\" or \"Unrealized\"", "required": false, "type": "string", "default": 1, "enum": [ "Realized", "Unrealized", "RealizedAndUnrealized" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.CostBasis.CostBasisPayload" }, "xml": { "name": "CostBasisPayload", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Activity/DrillDownSummary": { "post": { "tags": [ "Reporting/Activity" ], "summary": "Used to return a drill down summary of activity. Has the ability to return activity heirarchically as desired.", "operationId": "Activity_GetActivityDrillDownSummaryAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "settings", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.DrillDownSummaryActivitySettingsDto" } }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.DrillDownSummaryActivityBase" }, "xml": { "name": "DrillDownSummaryActivityBase", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Activity/EstimatedIncome": { "post": { "tags": [ "Reporting/Activity" ], "summary": "Method to retrieve estimated income yields and other values for the provided entity, detailed out by the specified settings", "operationId": "Activity_GetIncomeDataAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "settings", "in": "body", "description": "Object containing the specifications we need for this request, including entity level and ID, entity groupings, and the end date.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.EstimatedIncomeSettingsDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.EstimatedIncomeDto" }, "xml": { "name": "EstimatedIncomeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Activity/FixedIncome": { "post": { "tags": [ "Reporting/Activity" ], "summary": "Method to retrieve fixed income yields and other values for the provided entity", "operationId": "Activity_GetFixedIncomeDataAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "settings", "in": "body", "description": "Object containing the specifications we need for this request, including entity level and ID, entity groupings, and the end date.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.EstimatedIncomeSettingsDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.FixedIncomeSummaryDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Activity/FixedIncome/Detail": { "post": { "tags": [ "Reporting/Activity" ], "summary": "Method to retrieve fixed income yields and other values for the provided entity, detailed out by the specified settings", "operationId": "Activity_GetFixedIncomeDetailedDataAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "settings", "in": "body", "description": "Object containing the specifications we need for this request, including entity level and ID, entity groupings, and the end date.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.EstimatedIncomeSettingsDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.FixedIncomeDetailSummaryDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Activity/Holdings": { "post": { "tags": [ "Reporting/Activity" ], "summary": "Returns holding (asset level) data for a specified \"run for entity\" grouped by some other entity.\r\nAllowed \"run for entities\": Representative, Client, Registration, Account, and Asset.\r\nAllowed grouping entities: Representative, Client, Registration, Account, AssetClass, ProductType, Platform, RiskCategory, Product, AssetCategory, AssetLevelStrategy, AggregateModel, and AccountType.", "operationId": "Activity_GetHoldingsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "settings", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.HoldingsSettingsDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.HoldingsReturnDtoBase" }, "xml": { "name": "HoldingsReturnDtoBase", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Activity/Holdings/Unmanaged": { "post": { "tags": [ "Reporting/Activity" ], "summary": "Returns unmanaged holding (asset level) data for a specified \"run for entity\" grouped by some other entity.\r\nAllowed \"run for entities\": Representative, Client, Registration, Account, and Asset.\r\nAllowed grouping entities: Representative, Client, Registration, Account, AssetClass, ProductType, Platform, RiskCategory, Product, AssetCategory, AssetLevelStrategy, AggregateModel, and AccountType.", "operationId": "Activity_GetUnmanagedHoldingsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "settings", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.HoldingsSettingsDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.HoldingsReturnDtoBase" }, "xml": { "name": "HoldingsReturnDtoBase", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Activity/TargetAndActual": { "post": { "tags": [ "Reporting/Activity" ], "summary": "Used to return the comparison of Actual allocations to the target allocation detailed at the household, registration, account, or portfolio group level.", "operationId": "Activity_GetTargetAndActualAllocationInformationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "settings", "in": "body", "description": "Object containing the three items we need for this request; entity type and entity ID of the object to evaluate (household, registration, account, or portfolio group), and the as-of date to return data by.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.TargetAndActualAllocationSettingsDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.TargetAndActualAllocationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Activity/TransactionBreakdown": { "post": { "tags": [ "Reporting/Activity" ], "summary": "Used to verbosely return activity. Has the ability to return activity grouped as desired for the groups over a number of date ranges.", "operationId": "Activity_GetTransactionBreakdownActivityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "settings", "in": "body", "description": "An object used to set many different parameters for activity calculation.\r\n \t\tEntity: Defines what entity/entities to return activity for.\r\n \r\n \t\tEntityIds: Defines the specific ids of the entities to return activity for.\r\n \r\n \t\tStartDate: Optional. The start of the range to report.\r\n \t\t\r\n \t\tEndDate: Optional. Default: Today. The end of the range to report.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.SimpleTransactionBreakdownActivitySettingsDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.SimpleTransactionBreakdownActivityDto" }, "xml": { "name": "SimpleTransactionBreakdownActivityDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Activity/Verbose": { "post": { "tags": [ "Reporting/Activity" ], "summary": "Used to verbosely return activity. Has the ability to return activity grouped as desired for the groups over a number of date ranges.", "operationId": "Activity_GetActivityVerboseAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "settings", "in": "body", "description": "An object used to set many different parameters for activity calculation.\r\n \t\tEntity: Defines what entity/entities to return activity for.\r\n \r\n \t\tEntityIds: Defines the specific ids of the entities to return activity for.\r\n \r\n \t\tGroupings: Defines how the assets are grouped for the activity return. Can be set to any of the follow: \r\n \t\t\tClient, Registration, Account, Asset, AssetClass, ProductType, MgmntStyle, RiskCategory, AssetCategory, or AssetLevelStrategy.\r\n \r\n \t\tStartDate: Optional. The start of the range to report.\r\n \t\t\r\n \t\tEndDate: Optional. Default: Today. The end of the range to report.\r\n \t\t\r\n \t\tReturnStyle:\r\n \t\tOptional. Default: 1 Activity Summary\r\n \t\t1 = Activity Summary\r\n \t\t2 = Activity Daily\r\n \t\t4 = Activity Transaction Breakdown\r\n \t\t\r\n \t\tInterval:\r\n \t\tOptional. Default: \"A\" Automatic. Options are:\r\n \t\t\"A\" Automatic\r\n \t\t\"M\" Monthly\r\n \t\t\"W\" Weekly\r\n \t\t\"D\" Daily\r\n \t\t\r\n \t\tPeriods:\r\n \t\tOptional. Bitwise parameter for requesting commonly used date ranges.\r\n \t\t1 = MTD\r\n \t\t2 = QTD\r\n \t\t4 = YTD\r\n \t\t8 = 1yr\r\n \t\t16 = 3yr\r\n \t\t32 = 5yr\r\n \t\t64 = 10yr\r\n \t\t128 = inception\r\n \t\t256 = day\r\n \t\t\r\n \t\tCalendarYears: Optional. List of calendar years for which activity should be calculated.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VerboseActivitySettingsDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.ActivityPortfolio" }, "xml": { "name": "ActivityPortfolio", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Admin/Compares": { "get": { "tags": [ "Reporting/Admin" ], "operationId": "AdminCompares_GetListAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.Domains.Reporting.RegressionSessionDto" }, "xml": { "name": "RegressionSessionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Admin/Compares/{sessionId}": { "get": { "tags": [ "Reporting/Admin" ], "operationId": "AdminCompares_GetSessionDetailsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.Domains.Reporting.RegressionInstanceDto" }, "xml": { "name": "RegressionInstanceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Admin/Compares/Assign/{sessionId}": { "post": { "tags": [ "Reporting/Admin" ], "operationId": "AdminCompares_AssignReportsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Reporting.AssignReportsDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.Domains.Reporting.RegressionInstanceDto" }, "xml": { "name": "RegressionInstanceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Admin/Compares/Data/{sessionId}/{instanceId}": { "get": { "tags": [ "Reporting/Admin" ], "operationId": "AdminCompares_GetDataFileAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "instanceId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Admin/Compares/Instance/{instanceId}/{category}": { "put": { "tags": [ "Reporting/Admin" ], "operationId": "AdminCompares_UpdateInstanceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "instanceId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "category", "in": "path", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Admin/Compares/Visual/{sessionId}/{instanceId}": { "get": { "tags": [ "Reporting/Admin" ], "operationId": "AdminCompares_GetVisualDifferenceOutputAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "instanceId", "in": "path", "required": true, "type": "integer", "format": "int64" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Assistant/ControlList": { "get": { "tags": [ "Reporting/Assistant" ], "operationId": "ReportAssistant_GetControlListAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "additionalProperties": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportingAi.ReportAssistant.ReportAssistantControlListResponse" }, "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Assistant/DataDefinitions/Update/Run": { "post": { "tags": [ "Reporting/Assistant" ], "operationId": "ReportAssistant_RunReportAssistantDataDefinitionsSyncJob", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "useLocalService", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Assistant/Index/Update/Run": { "post": { "tags": [ "Reporting/Assistant" ], "operationId": "ReportAssistant_RunReportAssistantReferenceSyncJob", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "useLocalService", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Assistant/prompt": { "post": { "tags": [ "Reporting/Assistant" ], "operationId": "ReportAssistant_SendPromptAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportingAi.ReportAssistant.ReportAssistantRequest" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportingAi.ReportAssistant.ReportAssistantResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Assistant/PromptSystemList": { "get": { "tags": [ "Reporting/Assistant" ], "operationId": "ReportAssistant_PromptSystemListAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "code", "in": "query", "required": false, "type": "string" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportingAi.ReportAssistant.PromptSystemResponse" }, "xml": { "name": "PromptSystemResponse", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/AutomatedCompares/TestBaseline": { "post": { "tags": [ "Reporting/AutomatedCompares" ], "operationId": "AutomatedCompares_TestBaseline", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Reporting.Compares.AutomatedComparesTestDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/AutomatedCompares/TestClone/{previousRegressionId}": { "get": { "tags": [ "Reporting/AutomatedCompares" ], "operationId": "AutomatedCompares_TestClone", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "previousRegressionId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/AutomatedCompares/TestReport": { "get": { "tags": [ "Reporting/AutomatedCompares" ], "operationId": "AutomatedCompares_TestBaselineReportAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "regressionId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "alClientId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "hhId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "reportGuid", "in": "query", "required": true, "type": "string", "format": "uuid" }, { "name": "previousRegressionId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/AutomatedCompares/TestVisual": { "post": { "tags": [ "Reporting/AutomatedCompares" ], "operationId": "AutomatedCompares_TestVisualAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Reporting.TestVisualDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Batch": { "get": { "tags": [ "Reporting/Batch" ], "summary": "Gets a list of report batches that the logged in user has access to.", "operationId": "ReportBatch_GetAllAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "qpeItemId", "in": "query", "description": "Optional. Default: null. If provided only batches for the qpeItemId specified will be returned.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportBatchDto" }, "xml": { "name": "ReportBatchDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Batch/{batchId}/Action/SendTestEmail": { "post": { "tags": [ "Reporting/Batch" ], "operationId": "ReportBatch_SendTestBatchEmailAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "batchId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "toAddress", "in": "body", "required": true, "schema": { "type": "string" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Batch/{batchId}/Action/ToggleLockDown": { "post": { "tags": [ "Reporting/Batch" ], "summary": "Used to generate the stored PDFs for either the whole batch or only those specified. Entities that are onHold or already have a document generated will be ignored.\r\nRemoved entities will be ignored.", "operationId": "ReportBatch_ToggleBatchLockdown", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "batchId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "lockdown", "in": "query", "description": "Required. Specifies whether the batch should be locked down (true) or not locked down (false).", "required": true, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportBatchDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Batch/{batchId}/Entities": { "get": { "tags": [ "Reporting/Batch" ], "operationId": "ReportBatchEntities_GetAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "batchId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "generationStatus", "in": "query", "required": false, "items": { "type": "string", "enum": [ "NotGenerated", "ErroredReport", "OnHold", "Generated", "PendingGeneration", "WillNotBeGenerated" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "syncStatus", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Added", "Removed" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "viewableBy", "in": "query", "required": false, "items": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportBatchEntityDto" }, "xml": { "name": "ReportBatchEntityDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Batch/{batchId}/Entities/{key}": { "get": { "tags": [ "Reporting/Batch" ], "summary": "Gets the report batch entity with the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ReportBatchEntities_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "batchId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportBatchEntityDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Batch/{batchId}/Entities/{key}/Action/Download": { "get": { "tags": [ "Reporting/Batch" ], "summary": "Used to generate the stored PDF for this entity in the batch. Error will be returned if the entity is on hold or report has already been generated.", "operationId": "ReportBatchEntities_DownloadReportAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "batchId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Batch/{batchId}/Entities/Action/DetectErrors": { "post": { "tags": [ "Reporting/Batch" ], "summary": "Used to generate the stored PDFs for either the whole batch or only those specified. Entities that are onHold or already have a document generated will be ignored.\r\nRemoved entities will be ignored.", "operationId": "ReportBatchEntities_DetectErrorsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "batchId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "Required. If provided only the entities included will be updated. If omitted all entities in the batch will be updated.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportBatchDetectErrorDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Batch/{batchId}/Entities/Action/Download": { "post": { "tags": [ "Reporting/Batch" ], "operationId": "ReportBatchEntities_PrepareDownloadReportsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "batchId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "status", "in": "query", "required": false, "items": { "type": "string", "enum": [ "NotGenerated", "ErroredReport", "OnHold", "Generated", "PendingGeneration", "WillNotBeGenerated" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "manifestFileType", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "None", "Legacy", "Short" ] }, { "name": "combinationMethod", "in": "query", "required": false, "type": "string", "default": 1, "enum": [ "None", "Aggregate", "Zip", "Merge", "MergeSimplex", "MergeDuplex", "TarGzip" ] } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Batch/{batchId}/Entities/Action/Download/{sessionId}": { "get": { "tags": [ "Reporting/Batch" ], "summary": "Used to actually download a group of reports that was requested using POST Action/Download.", "operationId": "ReportBatchEntities_DownloadReportsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "batchId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "sessionId", "in": "path", "description": "The identifier for a specific batch download session.", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Batch/{batchId}/Entities/Action/DownloadAll/{combinationMethod}": { "get": { "tags": [ "Reporting/Batch" ], "operationId": "ReportBatchEntities_DownloadAllReportsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "batchId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "status", "in": "query", "required": false, "items": { "type": "string", "enum": [ "NotGenerated", "ErroredReport", "OnHold", "Generated", "PendingGeneration", "WillNotBeGenerated" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "manifestFileType", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "None", "Legacy", "Short" ] }, { "name": "combinationMethod", "in": "path", "required": true, "type": "integer", "format": "int32", "default": 1 } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Batch/{batchId}/Entities/Action/Generate": { "post": { "tags": [ "Reporting/Batch" ], "summary": "Used to generate the stored PDFs for either the whole batch or only those specified. Entities that are onHold or already have a document generated will be ignored.\r\nRemoved entities will be ignored.", "operationId": "ReportBatchEntities_GenerateReportsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "batchId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ids", "in": "body", "description": "Optional. If provided only the entities included will be updated. If omitted all entities in the batch will be updated.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/Batch" ], "summary": "Used to stop report generation.", "operationId": "ReportBatchEntities_CancelGenerateReportsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "batchId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Batch/{batchId}/Entities/Action/OnHold": { "post": { "tags": [ "Reporting/Batch" ], "summary": "Used to update the OnHold property on some or all entities in the batch.\r\nRemoved entities will be ignored.", "operationId": "ReportBatchEntities_UpdateOnHoldAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "batchId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ids", "in": "body", "description": "Optional. If provided only the entities included will be updated. If omitted all entities in the batch will be updated.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "onHold", "in": "query", "description": "Whether to place the selected entities on hold (true) or remove them from hold (false).", "required": true, "type": "boolean" }, { "name": "generate", "in": "query", "description": "Optional. If provided and removing hold a generation batch will be created for all entities specified. If provided and adding hold an error will be generated since you cannot generate reports for entities that are on hold.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Batch/{batchId}/Entities/Action/ResetElectronicStatement": { "post": { "tags": [ "Reporting/Batch" ], "summary": "Used to reset the electronic statement status of some of the entities in the batch.\r\nRemoved entities will be ignored.", "operationId": "ReportBatchEntities_ResetElectronicStatementEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "batchId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ids", "in": "body", "description": "Only the entities included will be reset. If omitted an error will be returned.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Batch/{batchId}/Entities/Action/ResetGeneration": { "post": { "tags": [ "Reporting/Batch" ], "summary": "Used to reset the generation status of some of the entities in the batch.\r\nRemoved entities will be ignored.", "operationId": "ReportBatchEntities_ResetGenerationEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "batchId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ids", "in": "body", "description": "Only the entities included will be reset. If omitted an error will be returned.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Batch/{batchId}/Entities/Action/ResetPrintVendor": { "post": { "tags": [ "Reporting/Batch" ], "summary": "Used to reset the print vendor status of some of the entities in the batch.\r\nRemoved entities will be ignored.", "operationId": "ReportBatchEntities_ResetPrintVendorEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "batchId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ids", "in": "body", "description": "Only the entities included will be reset. If omitted an error will be returned.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Batch/{batchId}/Entities/Action/SendElectronicStatement": { "post": { "tags": [ "Reporting/Batch" ], "summary": "Used to send e-statement notification for either the whole batch or only those specified.\r\nRemoved entities will be ignored.", "operationId": "ReportBatchEntities_SendElectronicStatementAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "batchId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ids", "in": "body", "description": "Optional. If provided only the entities included will be updated. If omitted all entities in the batch will be updated.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Batch/{batchId}/Entities/Action/SendToPrintVendor": { "post": { "tags": [ "Reporting/Batch" ], "summary": "Used to generate the stored PDFs for either the whole batch or only those specified. Entities that are onHold or already have a document generated will be ignored.\r\nRemoved entities will be ignored.", "operationId": "ReportBatchEntities_SendReportsToPrintVendorAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "batchId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ids", "in": "body", "description": "Optional. If provided only the entities included will be updated. If omitted all entities in the batch will be updated.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Batch/{batchId}/Entities/Action/Sync": { "post": { "tags": [ "Reporting/Batch" ], "summary": "If the provided batch has a dynamic group associated this will sync the list of entities with the list from that dynamic group. If it does not an unsupported exception is raised.", "operationId": "ReportBatchEntities_SyncDynamicGroupEntitiesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "batchId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "syncDeliveryMethods", "in": "query", "description": "Optional. Default: true. If true the email and print vendor status will be updated to what is appropriate given batch settings. NOTE: Only items marked as either WillNotBeSent or HasNotBeenSent will be updated.", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Batch/{batchId}/Entities/Action/SyncList": { "post": { "tags": [ "Reporting/Batch" ], "summary": "If the provided batch does not have a dynamic group associated this will sync the list of entities with the list provided. If it does not an unsupported exception is raised.", "operationId": "ReportBatchEntities_SyncEntityListAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "batchId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "entities", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } }, { "name": "addOnly", "in": "query", "description": "Default: False. When true the sync will only add new entities. It will not remove unspecified entities.", "required": false, "type": "boolean", "default": false }, { "name": "syncDeliveryMethods", "in": "query", "description": "Optional. Default: true. If true the email and print vendor status will be updated to what is appropriate given batch settings. NOTE: Only items marked as either WillNotBeSent or HasNotBeenSent will be updated.", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Batch/{batchId}/Entities/Action/ViewableBy": { "post": { "tags": [ "Reporting/Batch" ], "summary": "Used to update the viewableBy property on some or all entities in the batch.\r\nRemoved entities will be ignored.", "operationId": "ReportBatchEntities_UpdateViewableByAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "batchId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ids", "in": "body", "description": "Optional. If provided only the entities included will be updated. If omitted all entities in the batch that are generated will be updated.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "viewableBy", "in": "query", "description": "Whether to place the selected entities on hold (true) or remove them from hold (false).", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Batch/{batchId}/Inserts": { "get": { "tags": [ "Reporting/Batch" ], "summary": "Gets a list of inserts for the provided report batch id that the logged in user has access to.", "operationId": "ReportBatchInserts_GetInsertsForBatch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "batchId", "in": "path", "description": "Key of the batch.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportBatchInsertDto" }, "xml": { "name": "ReportBatchInsertDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Batch" ], "summary": "Updates the list of inserts for the provided report batch id that the logged in user has access to.", "operationId": "ReportBatchInserts_UpdateInsertsForBatch", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "batchId", "in": "path", "description": "Key of the batch.", "required": true, "type": "integer", "format": "int32" }, { "name": "dtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportBatchInsertDto" }, "xml": { "name": "ReportBatchInsertDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportBatchInsertDto" }, "xml": { "name": "ReportBatchInsertDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Batch/{batchId}/Inserts/{key}": { "get": { "tags": [ "Reporting/Batch" ], "summary": "Gets the report batch entity with the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ReportBatchInserts_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "batchId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportBatchInsertDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Batch/{batchId}/Inserts/{key}/Action/Upload": { "post": { "tags": [ "Reporting/Batch" ], "operationId": "ReportBatchInserts_UploadFileForInsertAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "batchId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "file", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportBatchInsertFileDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportBatchInsertDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Batch/{batchId}/Inserts/{key}/Download": { "get": { "tags": [ "Reporting/Batch" ], "summary": "Gets the raw data of the specific insert with the key provided which is associated to the batch with the specified key.", "operationId": "ReportBatchInserts_GetInsertBlobFile", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "batchId", "in": "path", "description": "Key of the batch.", "required": true, "type": "integer", "format": "int32" }, { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Batch/{key}": { "get": { "tags": [ "Reporting/Batch" ], "summary": "Gets the report batches with the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ReportBatch_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportBatchDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Batch/Action/ConcurrentReportExecutionInfo": { "get": { "tags": [ "Reporting/Batch" ], "operationId": "ReportBatch_GetConcurrentReportExecutionInfo", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clear", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Caching.IDistributedSemaphoreInfo" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Batch/Action/RefreshConcurrentReportExecutionLimit": { "post": { "tags": [ "Reporting/Batch" ], "operationId": "ReportBatch_RefreshConcurrentReportExecutionLimit", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Batch/Reports/{reportId}": { "get": { "tags": [ "Reporting/Batch" ], "summary": "Endpoint to get report information needed for the batch wizard.", "operationId": "ReportBatch_GetBatchSpecificReportInfoAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportBatchReportInfoDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Batch/Reports/{reportListId}": { "get": { "tags": [ "Reporting/Batch" ], "summary": "Endpoint to get report information needed for the batch wizard.", "operationId": "ReportBatch_GetBatchSpecificReportInfo", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "reportListId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportBatchReportInfoDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Batch/Verbose": { "get": { "tags": [ "Reporting/Batch" ], "operationId": "ReportBatch_GetVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Batch", "Inserts", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportBatchVerboseDto" }, "xml": { "name": "ReportBatchVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Batch" ], "summary": "Creates a new report batch.", "operationId": "ReportBatch_CreateVerboseReportBatchAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "newDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportBatchVerboseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportBatchVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Batch/Verbose/{key}": { "get": { "tags": [ "Reporting/Batch" ], "operationId": "ReportBatch_GetVerboseByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Batch", "Inserts", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportBatchVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Batch" ], "summary": "Updates a report batch.", "operationId": "ReportBatch_UpdateReportBatchAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "reportBatch", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportBatchVerboseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportBatchVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/Batch" ], "summary": "Deletes a report batch.", "operationId": "ReportBatch_DeleteReportBatchAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/BI/AccountHistory": { "get": { "tags": [ "Reporting/BI" ], "operationId": "BI_AccountHistory", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.Domains.Reporting.BIController.BIAccountHistory" }, "xml": { "name": "BIAccountHistory", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/BI/AccountTable": { "get": { "tags": [ "Reporting/BI" ], "operationId": "BI_AccountTable", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.Domains.Reporting.BIController.BIAccountDto" }, "xml": { "name": "BIAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/BI/AssetTable": { "get": { "tags": [ "Reporting/BI" ], "operationId": "BI_AssetTable", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.Domains.Reporting.BIController.BIAssetDto" }, "xml": { "name": "BIAssetDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/BI/HouseholdTable": { "get": { "tags": [ "Reporting/BI" ], "operationId": "BI_HouseholdTable", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.Domains.Reporting.BIController.BIHouseholdDto" }, "xml": { "name": "BIHouseholdDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/BI/Performance": { "get": { "tags": [ "Reporting/BI" ], "operationId": "BI_GetPerformanceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "groupEntity", "in": "query", "required": true, "type": "string", "enum": [ "Undefined", "Representative", "Client", "Registration", "Account", "Asset", "AssetClass", "ProductType", "Platform", "RiskCategory", "Product", "IndexBlend", "AssetCategory", "AssetLevelStrategy", "AggregateModel", "AccountType", "PortfolioGroup" ] }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.Domains.Reporting.BIController.BIPerformanceDto" }, "xml": { "name": "BIPerformanceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/BI/ProductHistory": { "get": { "tags": [ "Reporting/BI" ], "operationId": "BI_GetProductHistory", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.Domains.Reporting.BIController.BIProductHistory" }, "xml": { "name": "BIProductHistory", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/BI/ProductTable": { "get": { "tags": [ "Reporting/BI" ], "operationId": "BI_ProuctTable", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.Domains.Reporting.BIController.BIProductDto" }, "xml": { "name": "BIProductDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/BI/RepTable": { "get": { "tags": [ "Reporting/BI" ], "operationId": "BI_RepTable", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.Domains.Reporting.BIController.BIRepDto" }, "xml": { "name": "BIRepDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/BI/SisenseBaseAddress": { "get": { "tags": [ "Reporting/BI" ], "operationId": "BI_SisenseBaseAddress", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/BI/SisenseSSO": { "get": { "tags": [ "Reporting/BI" ], "operationId": "BI_SisenseSSOAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dashboardId", "in": "query", "required": false, "type": "string" }, { "name": "returnTo", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Billing/AdvisoryFeeNotification/Reports/Action/{key}/Run/{sessionId}": { "get": { "tags": [ "Reporting/Billing" ], "summary": "Runs the report generation process for the Advisory Fee Notification.", "description": "Sample Request\r\nGET /v1/Reporting/Billing/AdvisoryFeeNotification/Reports/01-07-2024_07-07-2024/Run/36f385c9-ddc9-4798-8104-498573d1809a?hud=Basic&Authorization=sample_auth_token", "operationId": "AdvisoryFeeNotificationReport_RunReport", "consumes": [], "produces": [ "text/html", "application/xhtml", "application/xhtml+xml", "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The unique key for the report generation request.", "required": true, "type": "string" }, { "name": "sessionId", "in": "path", "description": "The unique session identifier for the report.", "required": true, "type": "string", "format": "uuid" }, { "name": "hud", "in": "query", "description": "The HUD (Heads-Up Display) option for the report.", "required": false, "type": "string", "default": 0, "enum": [ "None", "Basic", "Debug" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.Billing.Reports.AdvisoryFeeNotification.AdvisoryFeeNotificationReportModel" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Billing/AdvisoryFeeNotification/Reports/Action/{key}/Run/{sessionId}/Pdf": { "get": { "tags": [ "Reporting/Billing" ], "summary": "Retrieves a previously generated Advisory Fee Notification report PDF.", "description": "Sample Request\r\nGET /v1/Reporting/Billing/AdvisoryFeeNotification/Reports/01-07-2024_07-07-2024/Run/36f385c9-ddc9-4798-8104-498573d1809a/PDF", "operationId": "AdvisoryFeeNotificationReport_GetGeneratedReportPdfAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The unique key for the report generation request.", "required": true, "type": "string" }, { "name": "sessionId", "in": "path", "description": "The unique session identifier for the report.", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "description": "CancellationToken object for managing cancellation of the request.", "required": true } ], "responses": { "201": { "description": "Report generated successfully", "schema": { "type": "object" } }, "404": { "description": "Not Found - The requested report does not exist." }, "500": { "description": "Internal Server Error - An error occurred while processing the request." } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Billing/AdvisoryFeeNotification/Reports/Action/Generate": { "post": { "tags": [ "Reporting/Billing" ], "summary": "Generates an Advisory Fee Notification Report", "description": "Sample Request\r\nPOST v1/Reporting/Billing/AdvisoryFeeNotification/Reports", "operationId": "AdvisoryFeeNotificationReport_GenerateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "description": "The AdvisoryFeeNotificationDTO containing the details for generating the report.", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Billing.Reports.AdvisoryFeeNotification.AdvisoryFeeNotificationDTO" } }, { "name": "cancellationToken", "in": "header", "description": "CancellationToken object", "required": true } ], "responses": { "201": { "description": "Report generated successfully", "schema": { "type": "object" } }, "400": { "description": "Invalid request" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Billing/PayeePayable/Reports/Action/{key}/Run/{sessionId}": { "get": { "tags": [ "Reporting/Billing" ], "summary": "Retrieves a previously generated Bill Cancellation By Payee Payable report", "description": "Sample Request\r\nGET /v1/Reporting/Billing/PayeePayable/Reports/01-07-2024_07-07-2024/Run/36f385c9-ddc9-4798-8104-498573d1809a?hud=Basic&Authorization=sample_auth_token", "operationId": "PayeePayableReport_RunReport", "consumes": [], "produces": [ "text/html", "application/xhtml", "application/xhtml+xml", "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string" }, { "name": "sessionId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "hud", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "None", "Basic", "Debug" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.Billing.Reports.PayeePayable.PayeePayableReportModel" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Billing/PayeePayable/Reports/Action/{key}/Run/{sessionId}/Pdf": { "get": { "tags": [ "Reporting/Billing" ], "summary": "Retrieves a previously generated Bill Cancellation By Payee Payable report PDF", "description": "Sample Request\r\nGET /v1/Reporting/Billing/PayeePayable/Reports/01-07-2024_07-07-2024/Run/36f385c9-ddc9-4798-8104-498573d1809a/PDF", "operationId": "PayeePayableReport_GetGeneratedReportPdfAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string" }, { "name": "sessionId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Billing/PayeePayable/Reports/Action/Generate": { "post": { "tags": [ "Reporting/Billing" ], "summary": "Generates a Bill Cancellation By Payee Payable Report", "description": "Sample Request\r\nPOST v1/Reporting/Billing/PayeePayable/Reports/Generate", "operationId": "PayeePayableReport_GenerateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Billing.Reports.PayeePayble.PayeePayableDTO" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Billing/Reports/BillCancellationByAccount/Action/{key}/Run/{sessionId}": { "get": { "tags": [ "Reporting/Billing" ], "summary": "Retrieves a previously generated Bill Cancellation By Account report", "description": "Sample Request\r\nGET /v1/Reporting/Billing/Reports/BillCancellationByAccount/01-07-2024_07-07-2024/Run/36f385c9-ddc9-4798-8104-498573d1809a?hud=Basic&Authorization=sample_auth_token", "operationId": "BillCancellationByAccountReport_RunReport", "consumes": [], "produces": [ "text/html", "application/xhtml", "application/xhtml+xml", "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string" }, { "name": "sessionId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "hud", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "None", "Basic", "Debug" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.Billing.Reports.BillCancellationByAccount.BillCancellationByAccountReportModel" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Billing/Reports/BillCancellationByAccount/Action/{key}/Run/{sessionId}/Pdf": { "get": { "tags": [ "Reporting/Billing" ], "summary": "Retrieves a previously generated Bill Cancellation By Account report PDF", "description": "Sample Request\r\nGET /v1/Reporting/Billing/Reports/BillCancellationByAccount/01-07-2024_07-07-2024/Run/36f385c9-ddc9-4798-8104-498573d1809a/PDF", "operationId": "BillCancellationByAccountReport_GetGeneratedReportPdfAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string" }, { "name": "sessionId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Billing/Reports/BillCancellationByAccount/Action/Generate": { "post": { "tags": [ "Reporting/Billing" ], "summary": "Generates a Bill Cancellation By Account Report", "description": "Sample Request\r\nPOST v1/Reporting/Billing/Reports/BillCancellationByAccount/Generate\r\n{\r\n \"startDate\": \"2024-03-01\",\r\n \"endDate\": \"2024-06-28\",\r\n \"reportFormat\": \"Html\"\r\n}", "operationId": "BillCancellationByAccountReport_GenerateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Billing.Reports.BillCancellationByAccount.BillCancellationByAccountDTO" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Billing/Reports/LegacyAdvisoryFeeReport/Action/{key}/Run/{sessionId}": { "get": { "tags": [ "Reporting/Billing" ], "summary": "Runs the report generation process for the Legacy Advisory Fee Notification.", "description": "Sample Request\r\nGET /v1/Reporting/Billing/Reports/LegacyAdvisoryFeeReport/Action/{key:guid}/Run/{sessionId:guid}?hud=Basic&Authorization=sample_auth_token", "operationId": "LegacyAdvisoryFeeReport_RunReport", "consumes": [], "produces": [ "text/html", "application/xhtml", "application/xhtml+xml", "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The unique key for the report generation request.", "required": true, "type": "string" }, { "name": "sessionId", "in": "path", "description": "The unique session identifier for the report.", "required": true, "type": "string", "format": "uuid" }, { "name": "hud", "in": "query", "description": "The HUD (Heads-Up Display) option for the report.", "required": false, "type": "string", "default": 0, "enum": [ "None", "Basic", "Debug" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.Billing.Reports.LegacyAdvisoryFeeReport.LegacyAdvisoryFeeReportModel" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Billing/Reports/LegacyAdvisoryFeeReport/Action/{key}/Run/{sessionId}/Pdf": { "get": { "tags": [ "Reporting/Billing" ], "summary": "Retrieves a previously generated Legacy Advisory Fee Notification report PDF.", "description": "Sample Request\r\nGET /v1/Reporting/Billing/Reports/LegacyAdvisoryFeeReport/Action/{key:guid}/Run/{sessionId:guid}/Pdf", "operationId": "LegacyAdvisoryFeeReport_GetGeneratedReportPdfAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The unique key for the report generation request.", "required": true, "type": "string" }, { "name": "sessionId", "in": "path", "description": "The unique session identifier for the report.", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "description": "CancellationToken object for managing cancellation of the request.", "required": true } ], "responses": { "201": { "description": "Report generated successfully", "schema": { "type": "object" } }, "404": { "description": "Not Found - The requested report does not exist." }, "500": { "description": "Internal Server Error - An error occurred while processing the request." } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Billing/Reports/LegacyAdvisoryFeeReport/Action/Generate": { "post": { "tags": [ "Reporting/Billing" ], "summary": "Generates a Legacy Advisory Fee Report", "description": "Sample Request\r\nPOST v1/Reporting/Billing/AdvisoryFeeNotification/Reports\r\nPOST /v1/Reporting/Billing/Reports/LegacyAdvisoryFeeReport/Action/Generate", "operationId": "LegacyAdvisoryFeeReport_GenerateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "description": "The AdvisoryFeeNotificationDTO containing the details for generating the report.", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Billing.Reports.LegacyAdvisoryFeeReport.LegacyAdvisoryFeeReportDto" } }, { "name": "cancellationToken", "in": "header", "description": "CancellationToken object", "required": true } ], "responses": { "201": { "description": "Report generated successfully", "schema": { "type": "object" } }, "400": { "description": "Invalid request" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Billing/Reports/LegacyAdvisoryFeeReport/Action/Generate/Preview": { "get": { "tags": [ "Reporting/Billing" ], "operationId": "LegacyAdvisoryFeeReport_GeneratePreviewAsync", "consumes": [], "produces": [ "text/html", "application/xhtml", "application/xhtml+xml", "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "entity", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "entityId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "paymentIds", "in": "query", "required": false, "type": "string", "default": "" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.Billing.Reports.LegacyAdvisoryFeeReport.LegacyAdvisoryFeeReportModel" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Billing/Reports/RevenuePayout/Action/{key}/Run/{sessionId}": { "get": { "tags": [ "Reporting/Billing" ], "operationId": "BillRevenuePayoutReport_RunReport", "consumes": [], "produces": [ "text/html", "application/xhtml", "application/xhtml+xml", "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string" }, { "name": "sessionId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "hud", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "None", "Basic", "Debug" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.Billing.Reports.RevenuePayout.RevenuePayoutReportModel" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Billing/Reports/RevenuePayout/Action/{key}/Run/{sessionId}/Pdf": { "get": { "tags": [ "Reporting/Billing" ], "operationId": "BillRevenuePayoutReport_GetGeneratedReportPdfAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string" }, { "name": "sessionId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Billing/Reports/RevenuePayout/Action/{revenuePayoutId}/{revenuePayoutPaymentId}/Generate": { "get": { "tags": [ "Reporting/Billing" ], "operationId": "BillRevenuePayoutReport_GenerateReportAsync", "consumes": [], "produces": [ "text/html", "application/xhtml", "application/xhtml+xml", "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "revenuePayoutId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "revenuePayoutPaymentId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "hud", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "None", "Basic", "Debug" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.Billing.Reports.RevenuePayout.RevenuePayoutReportModel" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Billing/Reports/RevenuePayout/Action/Generate": { "post": { "tags": [ "Reporting/Billing" ], "operationId": "BillRevenuePayoutReport_GenerateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Billing.Reports.RevenuePayout.RevenuePayoutDTO" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Calculate/DateRanges": { "get": { "tags": [ "Reporting/Calculate" ], "operationId": "Calculate_GetDateRangesForToday", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isDefault", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VerboseCalculationDateRangeFullDto" }, "xml": { "name": "VerboseCalculationDateRangeFullDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Calculate/DateRanges/{asOfDate}": { "get": { "tags": [ "Reporting/Calculate" ], "operationId": "Calculate_GetDateRangesForDate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "required": true, "type": "string", "format": "date-time" }, { "name": "isDefault", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VerboseCalculationDateRangeFullDto" }, "xml": { "name": "VerboseCalculationDateRangeFullDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Calculate/Verbose": { "post": { "tags": [ "Reporting/Calculate" ], "operationId": "Calculate_CreateCalculationVeboseAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "settings", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VerboseCalculationSettingsDto" } }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "SessionOnly" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculate.BatchCalculated" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Calculate/Verbose/New": { "get": { "tags": [ "Reporting/Calculate" ], "operationId": "Calculate_CreateEmptyVerboseCalculationSettingsDtoAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "asOfDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VerboseCalculationSettingsDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Compares/Batch": { "post": { "tags": [ "Reporting/Compares" ], "operationId": "ReportingCompares_CreateComparesRun", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "settings", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Reporting.Compares.ReportDataCompareBatchDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Compares/BatchExcelReport": { "post": { "tags": [ "Reporting/Compares" ], "operationId": "ReportingCompares_CreateExcelReportComparesRun", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "settings", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Reporting.Compares.ReportDataCompareBatchDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Accounts": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Gets a list of composite accounts that the logged in user has access to.\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "ReportingCompositeAccounts_GetCompositeAccountsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "asOfDate", "in": "query", "description": "Optional. Default null. If provided will limit the return to only composite accounts with a beginning date that matches the date povided.", "required": false, "type": "string", "format": "date-time" }, { "name": "type", "in": "query", "description": "Optional. Default null. If provided will limit the return to only composite accounts in the provided state. Can be set to either of the following:\r\n Live, Preliminary.", "required": false, "type": "string", "enum": [ "Live", "Preliminary" ] }, { "name": "hasMergeInOut", "in": "query", "description": "Optional. Default null. Requires asOfDate to be set. Used to further limit return to only those that had or didn't have merge in/out transactions within the month.", "required": false, "type": "boolean" }, { "name": "cashFlowTolerancePercent", "in": "query", "description": "Optional. Default null. Requires asOfDate to be set. Used to further limit to only those that had a beginning value and the total cashflows / beginning value * 100 >= cashFlowTolerancePercent.", "required": false, "type": "number", "format": "double" }, { "name": "allInMoneyMarket", "in": "query", "description": "Optional. Default null. Requires asOfDate to be set. Used to futher limit to only those where all/none of the value on the beginning and ending is in money market assets.", "required": false, "type": "boolean" }, { "name": "outlierScore", "in": "query", "description": "Optional. Default null. Requires asOfDate to be set. Used to further limit to only those where the gross or net of fees performance is exceptional. Defined as where ABS((performance - mean) / StDev) > ABS(outlierScore).", "required": false, "type": "number", "format": "double" }, { "name": "accountId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "portfolioGroupId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "regName", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeAccountDto" }, "xml": { "name": "CompositeAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Composite" ], "summary": "Used to create a new composite account. Upon successful creation the created data is returned.", "operationId": "ReportingCompositeAccounts_CreateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeAccountDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeAccountDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Accounts/{key}": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Gets the composite account that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ReportingCompositeAccounts_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeAccountDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Composite" ], "operationId": "ReportingCompositeAccounts_UpdateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "update", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeAccountDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeAccountDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Accounts/Action/Delete": { "put": { "tags": [ "Reporting/Composite" ], "operationId": "ReportingCompositeAccounts_ActionDeleteAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Accounts/Action/Delete/All": { "put": { "tags": [ "Reporting/Composite" ], "summary": "Deletes composite accounts by date and type", "operationId": "ReportingCompositeAccounts_ActionDeleteAllAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "query", "description": "The beginning date of the desired return objects.", "required": true, "type": "string", "format": "date-time" }, { "name": "type", "in": "query", "description": "Defines how which set of composite accounts to return. Can be set to either of the following: Live, Preliminary.", "required": true, "type": "string", "enum": [ "Live", "Preliminary" ] }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "modelId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "fundFamilyId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeAccountDto" }, "xml": { "name": "CompositeAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Accounts/Action/Exclude": { "put": { "tags": [ "Reporting/Composite" ], "operationId": "ReportingCompositeAccounts_ActionExcludeAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "type", "in": "query", "required": true, "type": "string", "enum": [ "Live", "Preliminary" ] }, { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeAccountDto" }, "xml": { "name": "CompositeAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Accounts/Action/Exclude/AccountIds": { "put": { "tags": [ "Reporting/Composite" ], "operationId": "ReportingCompositeAccounts_ActionExcludeByAccountIdAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "type", "in": "query", "required": true, "type": "string", "enum": [ "Live", "Preliminary" ] }, { "name": "accountIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeAccountDto" }, "xml": { "name": "CompositeAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Accounts/Action/Include": { "put": { "tags": [ "Reporting/Composite" ], "operationId": "ReportingCompositeAccounts_ActionIncludeAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "type", "in": "query", "required": true, "type": "string", "enum": [ "Live", "Preliminary" ] }, { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeAccountDto" }, "xml": { "name": "CompositeAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Accounts/Action/Include/AccountIds": { "put": { "tags": [ "Reporting/Composite" ], "operationId": "ReportingCompositeAccounts_ActionIncludeByAccountIdAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "type", "in": "query", "required": true, "type": "string", "enum": [ "Live", "Preliminary" ] }, { "name": "accountIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeAccountDto" }, "xml": { "name": "CompositeAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Accounts/Action/MakeLive": { "put": { "tags": [ "Reporting/Composite" ], "summary": "Marks all preliminary composite accounts, on the date provided, live.", "operationId": "ReportingCompositeAccounts_ActionMakeLive", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "query", "description": "The beginning date of the desired composite to make live.", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeAccountDto" }, "xml": { "name": "CompositeAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Accounts/Action/MakeLiveForSelected": { "put": { "tags": [ "Reporting/Composite" ], "operationId": "ReportingCompositeAccounts_MakeLiveSelectedKeys", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "query", "required": true, "type": "string" }, { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Accounts/Action/OCISync": { "post": { "tags": [ "Reporting/Composite" ], "operationId": "ReportingCompositeAccounts_ProcessOrionCustomIndexingCompositeSync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "forcedAccountIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "startDate", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Accounts/Action/OCISync/ByDateRange": { "post": { "tags": [ "Reporting/Composite" ], "operationId": "ReportingCompositeAccounts_ProcessOrionCustomIndexingCompositeSyncByDateRange", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "forcedAccountIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "startDate", "in": "query", "required": false, "type": "string" }, { "name": "endDate", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Accounts/Action/Sync": { "put": { "tags": [ "Reporting/Composite" ], "summary": "Mark rows for the selected preliminary node as not include if they are not included in the corresponding saved node. This finds account IDs in the preliminary list in a saved list for the same \r\nmonth and year and copies the \"Included\" data from the saved list to the preliminary list for the matching account ID. If it is marked not included in saved, then it updates preliminary to not include for the account ID. \r\n(requires that a preliminary and saved list exist for the same month and year)", "operationId": "ReportingCompositeAccounts_ActionSync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "beginDate", "in": "query", "description": "The beginning date of the desired composite to make live.", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeAccountDto" }, "xml": { "name": "CompositeAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Accounts/Action/UpdateList": { "put": { "tags": [ "Reporting/Composite" ], "summary": "Used to create a new composite accounts. Upon successful creation the created data is returned.", "operationId": "ReportingCompositeAccounts_UpdateListAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeAccountDto" }, "xml": { "name": "CompositeAccountDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeAccountDto" }, "xml": { "name": "CompositeAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Accounts/Action/UpdateNote": { "put": { "tags": [ "Reporting/Composite" ], "operationId": "ReportingCompositeAccounts_UpdateNoteAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "note", "in": "query", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeAccountDto" }, "xml": { "name": "CompositeAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Accounts/Archive": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Gets a list of composite archived reports.", "operationId": "ReportingCompositeAccounts_GetCompositeArchivedReports", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "description": "Optional.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeArchivedReportDto" }, "xml": { "name": "CompositeArchivedReportDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Accounts/Archive/{key}": { "delete": { "tags": [ "Reporting/Composite" ], "summary": "Used to download an archived report file.", "operationId": "ReportingCompositeAccounts_DeleteReportAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Accounts/Archive/{key}/Download": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Used to download an archived report file.", "operationId": "ReportingCompositeAccounts_DownloadArchivedReport", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Accounts/CompositeFilter": { "get": { "tags": [ "Reporting/Composite" ], "operationId": "ReportingCompositeAccounts_GetCompositeAccountKeysByCompositeFilterAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "compositeFilter", "in": "query", "required": true, "type": "string" }, { "name": "beginDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "isPreliminary", "in": "query", "required": true, "type": "boolean" }, { "name": "value", "in": "query", "required": true, "type": "number", "format": "double" }, { "name": "outOfToleranceValue", "in": "query", "required": true, "type": "number", "format": "double" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Accounts/List": { "post": { "tags": [ "Reporting/Composite" ], "summary": "Used to create a new composite accounts. Upon successful creation the created data is returned.", "operationId": "ReportingCompositeAccounts_CreateListAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeAccountDto" }, "xml": { "name": "CompositeAccountDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeAccountDto" }, "xml": { "name": "CompositeAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Accounts/Logs": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Gets a list of composite account logs that the logged in user has access to.\r\nThe return is limited to pages of 1000. Use $top and $skip in the query string to page through the data.", "operationId": "ReportingCompositeAccountsLogs_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeAccountLogDto" }, "xml": { "name": "CompositeAccountLogDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Accounts/Logs/{key}": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Gets the composite account log that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ReportingCompositeAccountsLogs_GetV1ReportingCompositeAccountsLogsByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeAccountLogDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Accounts/Missing": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Gets a list of accounts that are missing from this period's composites.", "operationId": "ReportingCompositeAccounts_GetMissingAccountList", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "query", "description": "The beginning date of the desired return objects.", "required": true, "type": "string", "format": "date-time" }, { "name": "type", "in": "query", "description": "Defines how which set of composite accounts to return. Can be set to either of the following:\r\n Live, Preliminary.", "required": true, "type": "string", "enum": [ "Live", "Preliminary" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.MissingCompositeAccountDto" }, "xml": { "name": "MissingCompositeAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Accounts/Summary": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Gets a summary list of composite accounts. Specifies the month beginning dates and how many accounts are in each period as well as other information.", "operationId": "ReportingCompositeAccounts_GetSummary", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeAccountSummaryDto" }, "xml": { "name": "CompositeAccountSummaryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/AdHocAccounts": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Gets a list of composite ad-hoc accounts that the logged in user has access to.\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "ReportingCompositeAdHocAccounts_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "query", "description": "Optional. Default null. If provided will limit the return to only composite accounts with a beginning date that matches the date povided.", "required": false, "type": "string", "format": "date-time" }, { "name": "type", "in": "query", "description": "Optional. Default null. If provided will limit the return to only composite accounts in the provided state. Can be set to either of the following:\r\n Live, Preliminary.", "required": false, "type": "string", "enum": [ "Live", "Preliminary" ] }, { "name": "hasMergeInOut", "in": "query", "description": "Optional. Default null. Requires asOfDate to be set. Used to further limit return to only those that had or didn't have merge in/out transactions within the month.", "required": false, "type": "boolean" }, { "name": "cashFlowTolerancePercent", "in": "query", "description": "Optional. Default null. Requires asOfDate to be set. Used to further limit to only those that had a beginning value and the total cashflows / beginning value * 100 >= cashFlowTolerancePercent.", "required": false, "type": "number", "format": "double" }, { "name": "allInMoneyMarket", "in": "query", "description": "Optional. Default null. Requires asOfDate to be set. Used to futher limit to only those where all/none of the value on the beginning and ending is in money market assets.", "required": false, "type": "boolean" }, { "name": "outlierScore", "in": "query", "description": "Optional. Default null. Requires asOfDate to be set. Used to further limit to only those where the gross or net of fees performance is exceptional. Defined as where ABS((performance - mean) / StDev) > ABS(outlierScore).", "required": false, "type": "number", "format": "double" }, { "name": "instanceId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeAdHocAccountDto" }, "xml": { "name": "CompositeAdHocAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Composite" ], "summary": "Used to create a new composite account. Upon successful creation the created data is returned.", "operationId": "ReportingCompositeAdHocAccounts_Create", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeAdHocAccountDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeAdHocAccountDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/AdHocAccounts/{key}": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Gets the composite account that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ReportingCompositeAdHocAccounts_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeAdHocAccountDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Composite" ], "operationId": "ReportingCompositeAdHocAccounts_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "update", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeAdHocAccountDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeAdHocAccountDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/AdHocAccounts/List": { "post": { "tags": [ "Reporting/Composite" ], "summary": "Used to create a new composite accounts. Upon successful creation the created data is returned.", "operationId": "ReportingCompositeAdHocAccounts_CreateList", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeAdHocAccountDto" }, "xml": { "name": "CompositeAdHocAccountDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeAdHocAccountDto" }, "xml": { "name": "CompositeAdHocAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/AdHocInstances": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Return list of composite ad-hoc instances", "operationId": "ReportingCompositeAdHocInstances_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeAdHocInstanceDto" }, "xml": { "name": "CompositeAdHocInstanceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/AdHocInstances/{key}": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Return list of composite ad-hoc instances", "operationId": "ReportingCompositeAdHocInstances_GetV1ReportingCompositeAdHocInstancesByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeAdHocInstanceDto" }, "xml": { "name": "CompositeAdHocInstanceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/AdHocInstances/{key}/CompositeAdHocAccount": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Return list of composite accounts", "operationId": "ReportingCompositeAdHocInstances_GetCompositeAdHocAccounts", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Required.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Composite.CompositeAdHocAccount" }, "xml": { "name": "CompositeAdHocAccount", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/AdHocInstances/Action/Delete": { "put": { "tags": [ "Reporting/Composite" ], "operationId": "ReportingCompositeAdHocInstances_DeleteAdHocInstances", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "instanceIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/AdHocInstances/Action/Instance": { "post": { "tags": [ "Reporting/Composite" ], "operationId": "ReportingCompositeAdHocInstances_CreateCompositeAdHocInstanceAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "adHocDefinition", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Reporting.Composite.CompositeAdHocDefinition" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/AdHocInstances/Running": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Return list of compositeAdHocInstanceIds that are currently running in hangfire", "operationId": "ReportingCompositeAdHocInstances_GetRunningCompositeAdHocInstances", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/AdHocInstances/Simple": { "get": { "tags": [ "Reporting/Composite" ], "operationId": "ReportingCompositeAdHocInstances_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Dashboard": { "post": { "tags": [ "Reporting/Composite" ], "operationId": "ReportingCompositeDashboard_GetCompositeDashboard", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeDashboardRequestDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Charts.DashboardChartDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Dashboard/Details/{businessLineId}/{repAccountManagerId}/{brokerDealerId}/{branchId}/{fundFamilyId}/{platformId}/{modelAggId}/{custodianId}/{planId}/{repId}/{crsrId}/{crrbId}/{crrtId}": { "post": { "tags": [ "Reporting/Composite" ], "operationId": "ReportingCompositeDashboard_GetCompositeDashboardDetails", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "businessLineId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "repAccountManagerId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "brokerDealerId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "branchId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "fundFamilyId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "platformId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "modelAggId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "custodianId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "planId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "repId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "crsrId", "in": "path", "description": "CompositeRangeStockRatioId", "required": true, "type": "integer", "format": "int32" }, { "name": "crrbId", "in": "path", "description": "CompositeRangeRiskBudgetId", "required": true, "type": "integer", "format": "int32" }, { "name": "crrtId", "in": "path", "description": "CompositeRangeRiskToleranceId", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeDashboardRequestDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Charts.PerformanceChartDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Dashboard/ModelFactSheet": { "get": { "tags": [ "Reporting/Composite" ], "operationId": "ReportingCompositeDashboard_CalculateCompositeModelFactSheetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "asOfDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataProcess.Reporting.Composite.ModelReturns.FactSheetModelAgg" }, "xml": { "name": "FactSheetModelAgg", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Dashboard/ModelRollingReturns": { "post": { "tags": [ "Reporting/Composite" ], "operationId": "ReportingCompositeDashboard_CalculateCompositeModelRollingReturnsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Reporting.Composite.ModelReturns.CalculateRollingReturnsRequest" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataProcess.Reporting.Composite.ModelReturns.CompositeModelRollingReturnDto" }, "xml": { "name": "CompositeModelRollingReturnDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Dashboard/MonthlyModelReturns": { "post": { "tags": [ "Reporting/Composite" ], "operationId": "ReportingCompositeDashboard_CalculateMonthlyCompositeModelReturnsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Reporting.Composite.ModelReturns.CalculateRollingReturnsRequest" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.CompositeModelReturn" }, "xml": { "name": "CompositeModelReturn", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Dashboard/Performance/ModelAgg": { "post": { "tags": [ "Reporting/Composite" ], "operationId": "ReportingCompositeDashboard_GetPerformanceForModelAggAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Reporting.Composite.ModelReturns.CompositeModelAggRequest" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataProcess.Reporting.Composite.ModelReturns.CompositeModelAggDto" }, "xml": { "name": "CompositeModelAggDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Disclosures": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Get the disclosures with their associated reports", "operationId": "Disclosure_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.DisclosureDto" }, "xml": { "name": "DisclosureDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Disclosures/{key}": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Get disclosures by id", "operationId": "Disclosure_GetV1ReportingCompositeDisclosuresByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "disclosure id: use -1 to get empty DisclosureDto result", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.DisclosureDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/Composite" ], "summary": "Delete the disclosure with matching id", "operationId": "Disclosure_DeleteAsync", "consumes": [], "produces": [], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Disclosures/Create": { "post": { "tags": [ "Reporting/Composite" ], "summary": "Create a new disclosure", "operationId": "Disclosure_CreateDisclosureAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "Disclosure form", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.DisclosureDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Disclosures/Reorder": { "put": { "tags": [ "Reporting/Composite" ], "summary": "Reorder disclosures", "operationId": "Disclosure_ReorderDisclosuresAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dtoList", "in": "body", "description": "Disclosure data from form", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.DisclosureDto" }, "xml": { "name": "DisclosureDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.DisclosureDto" }, "xml": { "name": "DisclosureDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Disclosures/Update/{id}": { "put": { "tags": [ "Reporting/Composite" ], "summary": "Update an existing disclosure", "operationId": "Disclosure_UpdateDisclosureAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updateDto", "in": "body", "description": "Disclosure data from form", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.DisclosureDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.DisclosureDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/FirmAssets": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Gets a list of composite firm assets that the logged in user has access to.", "operationId": "ReportingCompositeFirmAssets_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "description": "Optional. When set, only assets With an AsOfDate >= the passed in startdate are returned. When null, no start date filter is used.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. When set, only assets With an AsOfDate <= the passed in enddate are returned. When null, no end date filter is used.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeFirmAssetDto" }, "xml": { "name": "CompositeFirmAssetDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Composite" ], "summary": "Used to create a new composite firm asset. Upon successful creation a 201 will be returned with the location of the nearly created firm asset.", "operationId": "ReportingCompositeFirmAssets_Create", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeFirmAssetDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/FirmAssets/{asOfDate}": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Gets a list of composite firm assets that start on the date provided.", "operationId": "ReportingCompositeFirmAssets_GetV1ReportingCompositeFirmAssetsByAsOfDate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "The beginning date of the desired return objects.", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeFirmAssetDto" }, "xml": { "name": "CompositeFirmAssetDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/FirmAssets/{key}": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Gets the composite firm assets that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ReportingCompositeFirmAssets_GetV1ReportingCompositeFirmAssetsByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeFirmAssetDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Composite" ], "summary": "Used to update an existing composite firm asset. Upon successful modification a 200 will be returned.", "operationId": "ReportingCompositeFirmAssets_Update", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeFirmAssetDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeFirmAssetDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/Composite" ], "summary": "Used to delete an existing composite firm asset. Upon successful deletion a 204 will be returned.", "operationId": "ReportingCompositeFirmAssets_Delete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/GIPS": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Gets a list of GIPS queries\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "ReportingCompositeGIPS_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeGIPSDto" }, "xml": { "name": "CompositeGIPSDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Instances/{key}": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Return list of composite accounts", "operationId": "ReportingCompositeInstances_GetCompositeInstanceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Required.", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeInstanceDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Instances/Running": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Return list of compositeInstanceIds that are currently running in hangfire", "operationId": "ReportingCompositeInstances_GetRunningCompositeInstancesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Ranges": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Gets a list of composite ranges that the logged in user has access to.", "operationId": "ReportingCompositeRanges_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Composite.SimpleCompositeRange" }, "xml": { "name": "SimpleCompositeRange", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Composite" ], "summary": "Used to create a new composite range. Upon successful creation a 201 will be returned with the location of the nearly created range.", "operationId": "ReportingCompositeRanges_Create", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Reporting.Composite.SimpleCompositeRange" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Ranges/{key}": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Gets the composite ranges that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ReportingCompositeRanges_GetV1ReportingCompositeRangesByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Reporting.Composite.SimpleCompositeRange" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Composite" ], "summary": "Used to update an existing composite range. Upon successful modification a 200 will be returned.", "operationId": "ReportingCompositeRanges_Update", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Reporting.Composite.SimpleCompositeRange" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Reporting.Composite.SimpleCompositeRange" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/Composite" ], "summary": "Used to delete an existing composite range. Upon successful deletion a 204 will be returned.", "operationId": "ReportingCompositeRanges_Delete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Ranges/{range}": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Gets a list of composite ranges that the logged in user has access to.", "operationId": "ReportingCompositeRanges_GetByRangeType", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "range", "in": "path", "description": "Defines how which set of composite ranges to return. Can be set to any one of the following:\r\n StockRange, RiskToleranceRange, RiskBudgetRange.", "required": true, "type": "string", "enum": [ "StockRange", "RiskToleranceRange", "RiskBudgetRange" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Ranges/Options/RangeType": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Used to get a list of available values for the range type property.", "operationId": "ReportingCompositeRanges_RangeTypeOptions", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Ranges/Simple": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Gets a simple list of composite ranges that the logged in user has access to.", "operationId": "ReportingCompositeRanges_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "rangeType", "in": "query", "description": "Optional.", "required": false, "type": "string", "enum": [ "StockRange", "RiskToleranceRange", "RiskBudgetRange" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Ranges/Simple/{range}": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Gets a simple list of composite ranges that the logged in user has access to.", "operationId": "ReportingCompositeRanges_GetSimpleByRangeType", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "range", "in": "path", "description": "Defines how which set of composite ranges to return. Can be set to any one of the following:\r\n StockRange, RiskToleranceRange, RiskBudgetRange.", "required": true, "type": "string", "enum": [ "StockRange", "RiskToleranceRange", "RiskBudgetRange" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Reports": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Gets a list of composite reports that the logged in user has access to.", "operationId": "ReportingCompositeReports_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "expandGroups", "in": "query", "description": "Optional. Default: true. If true, each composite group of the composite group will be parsed through to provide additional data to the screen.", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeReportDto" }, "xml": { "name": "CompositeReportDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Composite" ], "summary": "Used to create a new composite report. Upon successful creation a 201 will be returned with the location of the nearly created report.", "operationId": "ReportingCompositeReports_Create", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeReportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Reports/{key}": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Gets the composite report that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ReportingCompositeReports_GetV1ReportingCompositeReportsByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeReportDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Composite" ], "summary": "Used to update an existing composite report. Upon successful modification a 200 will be returned.", "operationId": "ReportingCompositeReports_Update", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeReportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeReportDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/Composite" ], "summary": "Used to delete an existing composite report. Upon successful deletion a 204 will be returned.", "operationId": "ReportingCompositeReports_Delete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Reports/{key}/Run": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Gets a data file representation of the composite report. \r\nIf the accept header has \"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet\" the return will be xlsx.\r\nIf the accept header has \"application/vnd.ms-excel\" the return will be xls.\r\nIf the accept header has \"text/csv\" the return will be csv.", "operationId": "ReportingCompositeReports_MakeExcelFileAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Reports/{key}/Run/{sessionId}": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Used to get a retrieved a previously generated composite report.", "operationId": "ReportingCompositeReports_RunReport", "consumes": [], "produces": [ "text/html", "application/xhtml", "application/xhtml+xml", "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "sessionId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "hud", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "None", "Basic", "Debug" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Reporting.Composites.CompositeReportModel" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Reports/{key}/Run/{sessionId}/Pdf": { "get": { "tags": [ "Reporting/Composite" ], "operationId": "ReportingCompositeReports_GetGeneratedReportPdfAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "sessionId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Reports/{key}/Run/csv": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Gets a csv file representation of the composite report.", "operationId": "ReportingCompositeReports_MakeCsvFileAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Reports/{key}/Run/xls": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Gets an xls file representation of the composite report.", "operationId": "ReportingCompositeReports_MakeXlsFileAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Reports/{key}/Run/xlsx": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Gets an xlsx file representation of the composite report.", "operationId": "ReportingCompositeReports_MakeXlsxFileAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Reports/Generate": { "post": { "tags": [ "Reporting/Composite" ], "summary": "Used to generate a composite report. Upon success a location header is returned where the file can be retrieved.", "operationId": "ReportingCompositeReports_GenerateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Reporting.Composite.Reports.Models.CompositeReportGenerateDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Reports/Generate/Json": { "post": { "tags": [ "Reporting/Composite" ], "summary": "Used to generate a composite report. Upon success a json object is returned", "operationId": "ReportingCompositeReports_GenerateJsonAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Reporting.Composite.Reports.Models.CompositeReportGenerateDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataProcess.Reporting.Composite.Reports.Models.InternalCompositeGroupResponse" }, "xml": { "name": "InternalCompositeGroupResponse", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Reports/Group/{groupId}/Description": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Gets the composite report group description that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ReportingCompositeReports_GetGroupDescription", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "groupId", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeReportGroupDescriptionDto" }, "xml": { "name": "CompositeReportGroupDescriptionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Composite" ], "summary": "", "operationId": "ReportingCompositeReports_AddGroupDescription", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "groupId", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeReportGroupDescriptionDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeReportGroupDescriptionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Reports/Options/CompositeGroupType": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Used to get a list of available values for the group type property.", "operationId": "ReportingCompositeReports_CompositeGroupTypeOptions", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "includeAsterickedOptions", "in": "query", "description": "Optional Default false. When true all options are returned, when false only the options that apply to all reports are returned.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Reports/Simple": { "get": { "tags": [ "Reporting/Composite" ], "operationId": "ReportingCompositeReports_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Rules": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Gets all composite rules.", "operationId": "ReportingCompositeRules_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeRuleDto" }, "xml": { "name": "CompositeRuleDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Composite" ], "summary": "Used to create a new composite rule. Upon successful creation the created data is returned.", "operationId": "ReportingCompositeRules_CreateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeRuleDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeRuleDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Rules/{key}": { "get": { "tags": [ "Reporting/Composite" ], "summary": "Gets the composite rule that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ReportingCompositeRules_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeRuleDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Composite" ], "operationId": "ReportingCompositeRules_UpdateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "update", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeRuleDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeRuleDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Rules/Action/Delete/{key}": { "delete": { "tags": [ "Reporting/Composite" ], "summary": "Deletes composite rules provided in the key.", "operationId": "ReportingCompositeRules_DeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Summary": { "get": { "tags": [ "Reporting/Composite" ], "operationId": "ReportingCompositeSummary_GetSummaryAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "compositeReportId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Charts.ChartDto" }, "xml": { "name": "ChartDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Summary/Performance": { "get": { "tags": [ "Reporting/Composite" ], "operationId": "ReportingCompositeSummary_GetPerformanceSummaryAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "compositeReportId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "feeOption", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "annualizePerformance", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Charts.PerformanceChartDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Summary/Performance/{key}/Details": { "get": { "tags": [ "Reporting/Composite" ], "operationId": "ReportingCompositeSummary_GetPerformanceSummaryDetailsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "reportName", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Charts.PerformanceChartDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Summary/Performance/Growth": { "get": { "tags": [ "Reporting/Composite" ], "operationId": "ReportingCompositeSummary_GetGrowthChartAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "growthOf", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 10000 }, { "name": "showBenchmarks", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "period", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "Monthly", "Quarterly", "Annualy" ] }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "compositeReportId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Charts.GrowthChartDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Summary/Performance/Histogram": { "get": { "tags": [ "Reporting/Composite" ], "operationId": "ReportingCompositeSummary_GetHistoChartAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "compositeReportId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "performanceAxisRange", "in": "query", "required": false, "type": "number", "format": "double" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Charts.HistogramDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Summary/Performance/Scatter": { "get": { "tags": [ "Reporting/Composite" ], "operationId": "ReportingCompositeSummary_GetScatterPlot", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "compositeReportId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Charts.ScatterDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Texts": { "get": { "tags": [ "Reporting/Composite" ], "operationId": "ReportingCompositeText_GetCompositeTextViews", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "mismatchedTexts", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeTextViewDto" }, "xml": { "name": "CompositeTextViewDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Composite" ], "operationId": "ReportingCompositeText_CreateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeTextViewDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeTextViewDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Texts/{key}": { "get": { "tags": [ "Reporting/Composite" ], "operationId": "ReportingCompositeText_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeTextViewDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Composite" ], "operationId": "ReportingCompositeText_UpdateCompositeText", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeTextViewDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeTextViewDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/ValidateImport/HistoricalCompositeAccount": { "post": { "tags": [ "Reporting/Composite" ], "operationId": "CompositeValidateImportHistoricalCompositeAccounts_ImportCompositesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.ValidateHistoricalCompositeAccountDto" }, "xml": { "name": "ValidateHistoricalCompositeAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/ValidateImport/HistoricalCompositeAccount/Templates/Csv": { "get": { "tags": [ "Reporting/Composite" ], "operationId": "CompositeValidateImportHistoricalCompositeAccounts_GetCsvTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/ValidateImport/HistoricalCompositeAccount/Templates/Xls": { "get": { "tags": [ "Reporting/Composite" ], "operationId": "CompositeValidateImportHistoricalCompositeAccounts_GetXlsTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/ValidateImport/HistoricalCompositeAccount/Templates/Xlsx": { "get": { "tags": [ "Reporting/Composite" ], "operationId": "CompositeValidateImportHistoricalCompositeAccounts_GetXlsxTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/ValidateImport/HistoricalCompositeAccountUpdate": { "post": { "tags": [ "Reporting/Composite" ], "operationId": "CompositeValidateImportHistoricalCompositeAccountUpdates_ImportCompositesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.ValidateHistoricalCompositeAccountDto" }, "xml": { "name": "ValidateHistoricalCompositeAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/ValidateImport/HistoricalCompositeAccountUpdate/Templates/Csv": { "get": { "tags": [ "Reporting/Composite" ], "operationId": "CompositeValidateImportHistoricalCompositeAccountUpdates_GetCsvTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/ValidateImport/HistoricalCompositeAccountUpdate/Templates/Xls": { "get": { "tags": [ "Reporting/Composite" ], "operationId": "CompositeValidateImportHistoricalCompositeAccountUpdates_GetXlsTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/ValidateImport/HistoricalCompositeAccountUpdate/Templates/Xlsx": { "get": { "tags": [ "Reporting/Composite" ], "operationId": "CompositeValidateImportHistoricalCompositeAccountUpdates_GetXlsxTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Wizard/Action/Instance": { "post": { "tags": [ "Reporting/Composite" ], "summary": "Creates composite instance, kicks off hangfire job on new instance for generating all composite accounts for selected values", "operationId": "ReportingCompositeWizard_CreateCompositeInstanceAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "definiton", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Remote.Composites.CompositeDefinition" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Wizard/Action/Recalc": { "post": { "tags": [ "Reporting/Composite" ], "operationId": "ReportingCompositeWizard_RecalcCompositeAccountsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "definition", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Remote.Composites.CompositeDefinition" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Wizard/CompositeDefinition": { "get": { "tags": [ "Reporting/Composite" ], "summary": "This generates a generic composite definition loaded with the database default settings. This object can be retrieved, filled in with composite calculation instructions, and sent to the Calculate Composites Routines.", "operationId": "ReportingCompositeWizard_GetCompositeDefinition", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Remote.Composites.CompositeDefinition" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Composite/Wizard/ValidateImport/{validationType}": { "post": { "tags": [ "Reporting/Composite" ], "operationId": "ReportingCompositeWizard_ValidImportableIdsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "validationType", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.AccountDto" }, "xml": { "name": "AccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/{key}": { "get": { "tags": [ "Reporting/Custom" ], "summary": "Gets the custom report that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "CustomReports_GetFullByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "interpolate", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportFullDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/{key}/ConfirmGroup/{confirmGroupId}": { "get": { "tags": [ "Reporting/Custom" ], "summary": "Gets the custom report with the provided reportId, with prompts populated based on info from the confirm group. \r\nIf the ConfirmGroup or the Query don't exist or aren't accessible to the logged in user, a 404 will be thrown", "operationId": "CustomReports_GetFullByKeyForConfirmGroupAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired report", "required": true, "type": "integer", "format": "int32" }, { "name": "confirmGroupId", "in": "path", "description": "Key of the desired Confirm Group", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true }, { "name": "interpolate", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportFullDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/{key}/CustomImportTypes": { "get": { "tags": [ "Reporting/Custom" ], "summary": "Gets a list of custom import types associated to a dataquery", "operationId": "CustomReports_GetCustomImportTypesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "description": "CancellationToken of the request", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportCustomImportDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/{key}/Description": { "put": { "tags": [ "Reporting/Custom" ], "summary": "Updates custom report description", "operationId": "CustomReports_UpdateCustomReportDescription", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Id of the desired custom report", "required": true, "type": "integer", "format": "int32" }, { "name": "reportDescription", "in": "body", "description": "Custom report description", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/{key}/Generate": { "post": { "tags": [ "Reporting/Custom" ], "summary": "Used to generate a custom report to the format and location based on the CustomReport.RunTo.StorageType (\"DirectDownload\" or \"ReportInbox\") and the CustomReport.RunTo.ReportFormat (\"Excel\" or \"Csv\") with the provided parameters. The successful return will be 201 Created \r\nwith the location set to the url of the newly generated file. If ReportInbox is selected, then a blank accepted response is returned.", "operationId": "CustomReports_GenerateReportAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "run", "in": "body", "description": "The custom report with paramaters to run.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportFullDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/{key}/Generate/csv": { "post": { "tags": [ "Reporting/Custom" ], "summary": "Used to generate a custom report csv with the provided parameters. The successful return will be 201 Created \r\nwith the location set to the url of the newly generated file.", "operationId": "CustomReports_GenerateReportCsvAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "run", "in": "body", "description": "The custom report with paramaters to run.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportFullDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/{key}/Generate/CustomImport": { "post": { "tags": [ "Reporting/Custom" ], "summary": "Used to generate a custom import from a provided dataquery", "operationId": "CustomReports_GenerateReportCustomImportAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "run", "in": "body", "description": "The custom report with paramaters to run.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportFullDto" } }, { "name": "ct", "in": "header", "description": "CancellationToken of the request", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.Reporting.CustomReportProcess.CustomReportCustomImportResponseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/{key}/Generate/SlickGrid": { "post": { "tags": [ "Reporting/Custom" ], "summary": "Generates the result of the custom report, using the parameters passed in.", "operationId": "CustomReports_GenerateReportSlickGridAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "run", "in": "body", "description": "The custom report with parameters to run.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportFullDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/{key}/Generate/SlickGrid/{cacheKey}": { "get": { "tags": [ "Reporting/Custom" ], "summary": "Retrieve the previously generated slick grid result.", "operationId": "CustomReports_GetDataQueryTableByReportIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "cacheKey", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "top", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/{key}/Generate/Table": { "post": { "tags": [ "Reporting/Custom" ], "summary": "Generates the result of the custom report, using the parameters passed in.", "operationId": "CustomReports_GenerateReportDataTableAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "run", "in": "body", "description": "The custom report with paramaters to run.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportFullDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/{key}/Generate/xls": { "post": { "tags": [ "Reporting/Custom" ], "summary": "Used to generate a custom report xls with the provided parameters. The successful return will be 201 Created \r\nwith the location set to the url of the newly generated file.", "operationId": "CustomReports_GenerateReportXlsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "run", "in": "body", "description": "The custom report with paramaters to run.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportFullDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/{key}/Generate/xlsx": { "post": { "tags": [ "Reporting/Custom" ], "summary": "Used to generate a custom report xlsx with the provided parameters. The successful return will be 201 Created \r\nwith the location set to the url of the newly generated file.", "operationId": "CustomReports_GenerateReportXlsxAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "run", "in": "body", "description": "The custom report with parameters to run.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportFullDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/{key}/Run/{filename}": { "get": { "tags": [ "Reporting/Custom" ], "summary": "Used to download a previously generated custom report.", "operationId": "CustomReports_RunReportAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "filename", "in": "path", "description": "The filename provided by the generate endpoint.", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/Category": { "get": { "tags": [ "Reporting/Custom" ], "summary": "Gets a list of categories used by the custom reports", "operationId": "CustomReports_GetCategories", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/Full/List": { "post": { "tags": [ "Reporting/Custom" ], "operationId": "CustomReports_GetFullByKeyListAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "interpolate", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportFullDto" }, "xml": { "name": "CustomReportFullDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/List": { "post": { "tags": [ "Reporting/Custom" ], "summary": "Gets a simple list of custom reports that match one of the keys in the provided list.", "operationId": "CustomReports_GetSimpleListById", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "includeQuerySmith", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportDto" }, "xml": { "name": "CustomReportDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/Notes": { "get": { "tags": [ "Reporting/Custom" ], "summary": "Get custom report notes", "operationId": "CustomReportNotes_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "customReportId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportNoteDto" }, "xml": { "name": "CustomReportNoteDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Custom" ], "summary": "Create custom report note", "operationId": "CustomReportNotes_CreateItem", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "newItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportNoteDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportNoteDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/Notes/{key}": { "get": { "tags": [ "Reporting/Custom" ], "summary": "Get custom report note by key", "operationId": "CustomReportNotes_GetItemByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportNoteDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Custom" ], "summary": "Update custom report note", "operationId": "CustomReportNotes_UpdateItem", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportNoteDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportNoteDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/Schedules": { "get": { "tags": [ "Reporting/Custom" ], "summary": "Get all custom report schedules", "operationId": "CustomReportSchedules_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isActive", "in": "query", "description": "Optional. Default: null. If provided only active (true) or inactive (false) schedules are returned.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportScheduleDto" }, "xml": { "name": "CustomReportScheduleDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Custom" ], "summary": "Create new schedule", "operationId": "CustomReportSchedules_CreateItem", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportScheduleDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportScheduleDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/Schedules/{key}": { "get": { "tags": [ "Reporting/Custom" ], "summary": "Get custom report schedule by key", "operationId": "CustomReportSchedules_GetItemByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportScheduleDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Custom" ], "summary": "Update schedule", "operationId": "CustomReportSchedules_UpdateItem", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportScheduleDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportScheduleDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/Custom" ], "summary": "Delete schedule", "operationId": "CustomReportSchedules_DeleteItem", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/Schedules/{key}/Download/csv/{resultId}": { "get": { "tags": [ "Reporting/Custom" ], "summary": "Get data query results as Csv", "operationId": "CustomReportSchedules_DownloadReportCsvAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "resultId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/Schedules/{key}/Download/psv/{resultId}": { "get": { "tags": [ "Reporting/Custom" ], "summary": "Get data query results as pipe-delimited", "operationId": "CustomReportSchedules_DownloadReportPsvAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "resultId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/Schedules/{key}/Download/xls/{resultId}": { "get": { "tags": [ "Reporting/Custom" ], "summary": "Get data query results as data Xls", "operationId": "CustomReportSchedules_DownloadReportXlsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "resultId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/Schedules/{key}/Download/xlsx/{resultId}": { "get": { "tags": [ "Reporting/Custom" ], "summary": "Get data query results as Xlsx", "operationId": "CustomReportSchedules_DownloadReportXlsxAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "resultId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/Schedules/{key}/Generate/SlickGrid/{resultId}": { "get": { "tags": [ "Reporting/Custom" ], "summary": "Get data query results as slick grid", "operationId": "CustomReportSchedules_GenerateReportSlickGrid", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "resultId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/Schedules/{key}/Generate/Table/{resultId}": { "get": { "tags": [ "Reporting/Custom" ], "summary": "Get data query results as data table", "operationId": "CustomReportSchedules_GenerateReportDataTable", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "resultId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/Schedules/{key}/Run/{filename}": { "get": { "tags": [ "Reporting/Custom" ], "summary": "Used to download a scheduled generated custom report.", "operationId": "CustomReportSchedules_RunReportAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "filename", "in": "path", "description": "The filename provided by the generate endpoint.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/Schedules/New": { "get": { "tags": [ "Reporting/Custom" ], "summary": "Returns a new schedule object", "operationId": "CustomReportSchedules_GetNewItem", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "frequencyType", "in": "query", "required": true, "type": "string", "enum": [ "Daily", "Weekly", "Monthly", "Once" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportScheduleDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/Schedules/ReportId/{key}": { "get": { "tags": [ "Reporting/Custom" ], "summary": "Get custom report schedules by CustomReportId", "operationId": "CustomReportSchedules_GetItemsByCustomReportId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportScheduleDto" }, "xml": { "name": "CustomReportScheduleDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/Simple": { "get": { "tags": [ "Reporting/Custom" ], "summary": "Gets a list of custom reports that the logged in user has access to.\r\nThe return is limited to pages of 10000. Use $top and $skip in the query string to page through the data.", "operationId": "CustomReports_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "category", "in": "query", "required": false, "type": "string" }, { "name": "reportType", "in": "query", "required": false, "type": "string", "enum": [ "Query", "CustomImport", "Scrub" ] }, { "name": "isGlobal", "in": "query", "required": false, "type": "boolean" }, { "name": "includeQuerySmith", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportDto" }, "xml": { "name": "CustomReportDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/Simple/{key}": { "get": { "tags": [ "Reporting/Custom" ], "summary": "Gets the custom report that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "CustomReports_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/Simple/ConfirmGroup/{confirmGroupId}": { "get": { "tags": [ "Reporting/Custom" ], "summary": "Gets a list of Custom Reports associated to the provided Confirm Group Id. \r\nIf the Confirm Group specified doesn't exist or isn't accessible to the logged in user an empty list will be returned.", "operationId": "CustomReports_GetByConfirmGroupAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "confirmGroupId", "in": "path", "description": "Key of the Confirm Group", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportRankedDto" }, "xml": { "name": "CustomReportRankedDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/Simple/DefaultQueryList": { "get": { "tags": [ "Reporting/Custom" ], "summary": "Gets the default list of data queries that the logged in user has access to and/or set up for themself.\r\nThe return is limited to pages of 10000. Use $top and $skip in the query string to page through the data.", "operationId": "CustomReports_GetDefaultDataQueryList", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "includeQuerySmith", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportDto" }, "xml": { "name": "CustomReportDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/Simple/List": { "post": { "tags": [ "Reporting/Custom" ], "summary": "Gets a simple list of custom reports that match one of the keys in the provided list.", "operationId": "CustomReports_PostV1ReportingCustomSimpleList", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "includeQuerySmith", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportDto" }, "xml": { "name": "CustomReportDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/Simple/Search": { "get": { "tags": [ "Reporting/Custom" ], "summary": "Gets a simple list of custom reports that the logged in user has access to where the custom report name begins with the search string or Id is exact match.", "operationId": "CustomReports_GetSimpleCustomReportSearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "Partial custom report name to search for.", "required": true, "type": "string" }, { "name": "includeQuerySmith", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/Simple/Search/{search}": { "get": { "tags": [ "Reporting/Custom" ], "summary": "Gets a simple list of custom reports that the logged in user has access to where the custom report name begins with the search string or Id is exact match.", "operationId": "CustomReports_GetV1ReportingCustomSimpleSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "Partial custom report name to search for.", "required": true, "type": "string" }, { "name": "includeQuerySmith", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/UploadTargets": { "get": { "tags": [ "Reporting/Custom" ], "operationId": "CustomReportUploadTarget_GetFullListAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.UploadTargetDto" }, "xml": { "name": "UploadTargetDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Custom" ], "operationId": "CustomReportUploadTarget_CreateItemAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.UploadTargetDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.UploadTargetDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/UploadTargets/{key}": { "get": { "tags": [ "Reporting/Custom" ], "operationId": "CustomReportUploadTarget_GetFullItemByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.UploadTargetDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Custom" ], "operationId": "CustomReportUploadTarget_UpdateItemAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.UploadTargetDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.UploadTargetDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/UploadTargets/Simple": { "get": { "tags": [ "Reporting/Custom" ], "operationId": "CustomReportUploadTarget_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/Verbose": { "get": { "tags": [ "Reporting/Custom" ], "operationId": "CustomReportsVerbose_GetVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Report", "Prompts", "AlClients", "ImportTypes", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportVerboseDto" }, "xml": { "name": "CustomReportVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Custom" ], "summary": "Creates a new custom report.", "operationId": "CustomReportsVerbose_CreateVerboseCustomReport", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportVerboseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/Verbose/{key}": { "get": { "tags": [ "Reporting/Custom" ], "operationId": "CustomReportsVerbose_GetVerboseByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Report", "Prompts", "AlClients", "ImportTypes", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Custom" ], "summary": "Updates a custom report.", "operationId": "CustomReportsVerbose_UpdateVerboseCustomReport", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "customReport", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportVerboseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/Custom" ], "summary": "Deletes a custom report.", "operationId": "CustomReportsVerbose_DeleteVerboseCustomReport", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/Verbose/New": { "get": { "tags": [ "Reporting/Custom" ], "operationId": "CustomReportsVerbose_GetNewVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Report", "Prompts", "AlClients", "ImportTypes", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/Verbose/QuerySmith": { "post": { "tags": [ "Reporting/Custom" ], "summary": "QuerySmith variant of {M:OAS.WebApi.Domains.Reporting.Custom.CustomReportsVerboseController.CreateVerboseCustomReport(OAS.WebApi.DTO.Reporting.Custom.CustomReportVerboseDto)} that persists the session-cached SQL read-only and scoped to the current firm.", "operationId": "CustomReportsVerbose_CreateVerboseForQuerySmith", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "customReport", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportQuerySmithSaveDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/Verbose/QuerySmith/{key}": { "get": { "tags": [ "Reporting/Custom" ], "operationId": "CustomReportsVerbose_GetVerboseForQuerySmith", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Report", "Prompts", "AlClients", "ImportTypes", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Custom" ], "summary": "QuerySmith variant of {M:OAS.WebApi.Domains.Reporting.Custom.CustomReportsVerboseController.UpdateVerboseCustomReport(System.Int32,OAS.WebApi.DTO.Reporting.Custom.CustomReportVerboseDto)} that persists the session-cached SQL read-only while leaving firm associations (ALC) unchanged.", "operationId": "CustomReportsVerbose_UpdateVerboseForQuerySmith", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "customReport", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportQuerySmithSaveDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/Custom" ], "summary": "QuerySmith variant of {M:OAS.WebApi.Domains.Reporting.Custom.CustomReportsVerboseController.DeleteVerboseCustomReport(System.Int32)}. Only QuerySmith-authored queries may be deleted here.", "operationId": "CustomReportsVerbose_DeleteVerboseForQuerySmith", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/Verbose/QuerySmith/Test": { "post": { "tags": [ "Reporting/Custom" ], "summary": "QuerySmith variant of {M:OAS.WebApi.Domains.Reporting.Custom.CustomReportsVerboseController.GenerateTestReportAsync(OAS.WebApi.DTO.Reporting.Custom.CustomReportVerboseDto,System.Threading.CancellationToken)} that runs the session-cached SQL read-only.", "operationId": "CustomReportsVerbose_GenerateTestReportForQuerySmithAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "testData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportVerboseDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Custom/Verbose/Test": { "post": { "tags": [ "Reporting/Custom" ], "operationId": "CustomReportsVerbose_GenerateTestReportAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "testData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportVerboseDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Dashboards": { "get": { "tags": [ "Reporting/Dashboards" ], "summary": "", "operationId": "Dashboards_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dashboardLevel", "in": "query", "required": false, "type": "string", "enum": [ "Portfolio", "Representative", "Advisor" ] }, { "name": "defaultOnly", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Widgets.DashboardDto" }, "xml": { "name": "DashboardDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Dashboards" ], "operationId": "Dashboards_Create", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Widgets.DashboardDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Widgets.DashboardDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Dashboards/{key}": { "get": { "tags": [ "Reporting/Dashboards" ], "operationId": "Dashboards_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Widgets.DashboardDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Dashboards" ], "operationId": "Dashboards_Update", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Widgets.DashboardDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Widgets.DashboardDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/Dashboards" ], "operationId": "Dashboards_Delete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Dashboards/DashboardSystemType/{dashboardSystemType}": { "get": { "tags": [ "Reporting/Dashboards" ], "summary": "", "operationId": "Dashboards_GetByDashboardSystemType", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dashboardSystemType", "in": "path", "required": true, "type": "string", "enum": [ "None", "Composites", "Portfolio" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Widgets.DashboardDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Dashboards/DashboardSystemType/{dashboardSystemType}/Edit": { "get": { "tags": [ "Reporting/Dashboards" ], "summary": "", "operationId": "Dashboards_GetByDashboardSystemType2", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dashboardSystemType", "in": "path", "required": true, "type": "string", "enum": [ "None", "Composites", "Portfolio" ] }, { "name": "startDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Data/Cache": { "get": { "tags": [ "Reporting/Data" ], "operationId": "ScopeCache_GetScopeCacheResultAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cacheName", "in": "query", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.Performance.ScopeCache.ScopeCacheResult" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Data/Cache/Refresh": { "post": { "tags": [ "Reporting/Data" ], "operationId": "ScopeCache_RunScopeCacheJob", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "contextChange", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Reporting.Engine.ContextChange" } }, { "name": "asOfDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver": { "get": { "tags": [ "Reporting/Deliver" ], "summary": "Gets a list of Deliver templates that the logged in user has access to.", "operationId": "Deliver_GetAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.DeliverDto" }, "xml": { "name": "DeliverDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/{databaseName}/AdvisorEmail/{filepath}": { "get": { "tags": [ "Reporting/Deliver" ], "operationId": "Deliver_GetAdvisorEmailImageAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "databaseName", "in": "path", "required": true, "type": "string" }, { "name": "filepath", "in": "path", "required": true, "type": "string" }, { "name": "preview", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/{key}": { "get": { "tags": [ "Reporting/Deliver" ], "summary": "Gets the Deliver template with the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Deliver_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.DeliverDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/{key}/Action/Download/{sentEmailId}": { "get": { "tags": [ "Reporting/Deliver" ], "operationId": "Deliver_DownloadSentEmailAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "sentEmailId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "preview", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/{key}/Action/Render/{entityId}": { "get": { "tags": [ "Reporting/Deliver" ], "operationId": "Deliver_RenderTemplateForEntityAsync", "consumes": [], "produces": [ "text/html", "application/xhtml", "application/xhtml+xml", "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "preview", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Reporting.Deliver.AdvisorRenderedEmailDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/{key}/Action/SendTestEmail/{entityId}": { "post": { "tags": [ "Reporting/Deliver" ], "operationId": "Deliver_SendTestEmailAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "toAddress", "in": "body", "required": true, "schema": { "type": "string" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/Email/{blobId}": { "get": { "tags": [ "Reporting/Deliver" ], "operationId": "DeliverEmail_GetEmailSent", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "blobId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/Email/{dateSent}/ByDate": { "get": { "tags": [ "Reporting/Deliver" ], "operationId": "DeliverEmail_GetSendEmailsByDate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dateSent", "in": "path", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "object" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/Email/{emailId}/Sent": { "get": { "tags": [ "Reporting/Deliver" ], "summary": "Get all emails that have been sent given an emailId", "operationId": "DeliverEmail_GetSentEmails", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "emailId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Deliver.AdvisorEmailSentDto" }, "xml": { "name": "AdvisorEmailSentDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/Email/ByDate": { "get": { "tags": [ "Reporting/Deliver" ], "summary": "", "operationId": "DeliverEmail_GetSentEmailsGroupedByDate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "object" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/Email/Groups": { "get": { "tags": [ "Reporting/Deliver" ], "operationId": "DeliverEmailGroups_GetEmailGroups", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "query", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.WebEntityGroupDto" }, "xml": { "name": "WebEntityGroupDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Deliver" ], "operationId": "DeliverEmailGroups_AddEmailGroup", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.WebEntityGroupDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.WebEntityGroupDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/Email/Groups/{key}": { "get": { "tags": [ "Reporting/Deliver" ], "operationId": "DeliverEmailGroups_GetEmailGroupById", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.WebEntityGroupDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Deliver" ], "operationId": "DeliverEmailGroups_UpdateEmailGroup", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.WebEntityGroupDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.WebEntityGroupDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/Deliver" ], "operationId": "DeliverEmailGroups_DeleteEmailGroup", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/Email/Groups/{key}/Selected": { "get": { "tags": [ "Reporting/Deliver" ], "operationId": "DeliverEmailGroups_GetSelectedEmails", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "object" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/Emails": { "get": { "tags": [ "Reporting/Deliver" ], "summary": "Get all Deliver Sents", "operationId": "DeliverInstanceEmails_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "deliverId", "in": "query", "description": "Optional. Default is null. When specified, the results will be filtered by deliverId", "required": false, "type": "integer", "format": "int32" }, { "name": "triggerId", "in": "query", "description": "Optional. Default is null. When specified, the results will be filtered by triggerId", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Deliver.DeliverEmailDto" }, "xml": { "name": "DeliverEmailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/Emails/{key}": { "get": { "tags": [ "Reporting/Deliver" ], "summary": "Gets the Deliver Sent that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "DeliverInstanceEmails_GetEntityByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Deliver.DeliverEmailDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/Emails/{key}/Action/Download/Html": { "get": { "tags": [ "Reporting/Deliver" ], "operationId": "DeliverInstanceEmails_DownloadEmailHtmlAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/Emails/{key}/Action/Download/Pdf": { "get": { "tags": [ "Reporting/Deliver" ], "operationId": "DeliverInstanceEmails_DownloadEmailPdfAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/Emails/Action/Download": { "post": { "tags": [ "Reporting/Deliver" ], "summary": "Used to set up a download request to get the stored deliver sent items specified.\r\nReturns a 201 Created response that includes a location header where the request can be completed.", "operationId": "DeliverInstanceEmails_PrepareDownloadSentsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "description": "Cancellation token", "required": true }, { "name": "ids", "in": "body", "description": "Only the deliver sent items included will be prepared for download.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "format", "in": "query", "description": "Optional. Default: PDF. Whether the download should contain Pdf or Html files.", "required": false, "type": "string", "default": 4, "enum": [ "Xml", "Null", "Csv", "Image", "PDF", "Html", "Html40", "Html32", "Mhtml", "Excel", "ExcelX", "HtmlOwc", "Json", "CustomImport" ] } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/Emails/Action/Download/{sessionId}": { "get": { "tags": [ "Reporting/Deliver" ], "summary": "Used to actually download the group of deliver sent items (as a zip file) that was requested using POST Action/Download.", "operationId": "DeliverInstanceEmails_DownloadReportsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "sessionId", "in": "path", "description": "The identifier for a specific deliver sent download session.", "required": true, "type": "string", "format": "uuid" }, { "name": "ct", "in": "header", "description": "Cancellation token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/Emails/Action/Regenerate": { "post": { "tags": [ "Reporting/Deliver" ], "summary": "Used to regenerate [successfully generated], [not generated], and [errored] emails. In all cases an email must not have been sent yet.", "operationId": "DeliverInstanceEmails_RegenerateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "description": "The deliver sent items included will be updated.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/Emails/Action/Resend": { "post": { "tags": [ "Reporting/Deliver" ], "summary": "Used to resend any email that previosly failed when it attempted to send.", "operationId": "DeliverInstanceEmails_ResendAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "description": "The deliver sent items included will be updated.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/Emails/Action/Reviewed": { "post": { "tags": [ "Reporting/Deliver" ], "summary": "Used to update a set of emails in pending review status to either allow them to send or prevent them from sending.", "operationId": "DeliverInstanceEmails_ReviewedAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "description": "The deliver sent items included will be updated.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "allowSend", "in": "query", "description": "Whether the items should be allowed to send or not.", "required": true, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/Emails/List": { "post": { "tags": [ "Reporting/Deliver" ], "summary": "Returns a list of Deliver Sents that are found for the list of Id's posted in the message body.", "operationId": "DeliverInstanceEmails_GetListByIdAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "keys", "in": "body", "description": "Array of Deliver Sent ID's", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Deliver.DeliverEmailDto" }, "xml": { "name": "DeliverEmailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/Emails/List/Id": { "post": { "tags": [ "Reporting/Deliver" ], "summary": "Returns a list of Deliver Sents that are found for the list of Id's posted in the message body.", "operationId": "DeliverInstanceEmails_PostV1ReportingDeliverEmailsListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "keys", "in": "body", "description": "Array of Deliver Sent ID's", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Deliver.DeliverEmailDto" }, "xml": { "name": "DeliverEmailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/Instances": { "get": { "tags": [ "Reporting/Deliver" ], "summary": "Get all Deliver Templates", "operationId": "DeliverInstances_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "isActive", "in": "query", "description": "Optional. Default is null. When specified, the results will be filtered be isActive", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Deliver.DeliverInstanceDto" }, "xml": { "name": "DeliverInstanceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/Instances/{key}": { "get": { "tags": [ "Reporting/Deliver" ], "summary": "Gets the Deliver Template that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "DeliverInstances_GetEntityByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Deliver.DeliverInstanceDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/Instances/{key}/Action/EmailPreview": { "post": { "tags": [ "Reporting/Deliver" ], "summary": "Used to preview an email version of a report based on the selected Deliver instance", "operationId": "DeliverInstances_GetReportEmailPreviewAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired Deliver instance.", "required": true, "type": "integer", "format": "int32" }, { "name": "payload", "in": "body", "description": "A payload used to generate the test report.", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Reporting.Deliver.DeliverTestPayload" } }, { "name": "cancellationToken", "in": "header", "description": "CancellationToken for async", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/Instances/{key}/Action/EmailTestSend": { "post": { "tags": [ "Reporting/Deliver" ], "summary": "Used to send a test email of a report based on the selected Deliver instance", "operationId": "DeliverInstances_SendReportTestEmailAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired Deliver instance.", "required": true, "type": "integer", "format": "int32" }, { "name": "payload", "in": "body", "description": "A payload used to generate the test report.", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Reporting.Deliver.DeliverTestPayload" } }, { "name": "cancellationToken", "in": "header", "description": "CancellationToken for async", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/Instances/List": { "post": { "tags": [ "Reporting/Deliver" ], "summary": "Returns a list of Deliver Templates that are found for the list of Id's posted in the message body.", "operationId": "DeliverInstances_GetListByIdAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "keys", "in": "body", "description": "Array of Deliver Template ID's", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Deliver.DeliverInstanceDto" }, "xml": { "name": "DeliverInstanceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/Instances/List/Id": { "post": { "tags": [ "Reporting/Deliver" ], "summary": "Returns a list of Deliver Templates that are found for the list of Id's posted in the message body.", "operationId": "DeliverInstances_PostV1ReportingDeliverInstancesListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "keys", "in": "body", "description": "Array of Deliver Template ID's", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Deliver.DeliverInstanceDto" }, "xml": { "name": "DeliverInstanceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/Instances/Verbose": { "get": { "tags": [ "Reporting/Deliver" ], "operationId": "DeliverInstances_GetVerboseAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "isActive", "in": "query", "required": false, "type": "boolean" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Template", "Email", "ReportOptions", "Triggers", "Groups", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Deliver.DeliverInstanceVerboseDto" }, "xml": { "name": "DeliverInstanceVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Deliver" ], "summary": "Inserts a Deliver template.", "operationId": "DeliverInstances_CreateVerboseDeliverInstanceAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Deliver.DeliverInstanceVerboseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Deliver.DeliverInstanceVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/Instances/Verbose/{key}": { "get": { "tags": [ "Reporting/Deliver" ], "operationId": "DeliverInstances_GetVerboseByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Template", "Email", "ReportOptions", "Triggers", "Groups", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Deliver.DeliverInstanceVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Deliver" ], "summary": "Updates a Deliver template.", "operationId": "DeliverInstances_UpdateVerboseDeliverInstanceAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Deliver.DeliverInstanceVerboseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Deliver.DeliverInstanceVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/Deliver" ], "summary": "Deletes an existing Deliver Instance", "operationId": "DeliverInstances_DeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/Instances/Verbose/New": { "get": { "tags": [ "Reporting/Deliver" ], "summary": "Returns a blank Deliver template.", "operationId": "DeliverInstances_GetNewVerboseAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Deliver.DeliverInstanceVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/Sections": { "get": { "tags": [ "Reporting/Deliver" ], "operationId": "Deliver_GetAvailableSections", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "query", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Deliver.AdvisorEmailSectionDto" }, "xml": { "name": "AdvisorEmailSectionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/Triggers": { "get": { "tags": [ "Reporting/Deliver" ], "summary": "Get all Deliver Triggers", "operationId": "DeliverTriggers_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "isActive", "in": "query", "description": "Optional. Default is null. When specified, the results will be filtered by isActive", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Deliver.DeliverTriggerDto" }, "xml": { "name": "DeliverTriggerDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/Triggers/{key}": { "get": { "tags": [ "Reporting/Deliver" ], "summary": "Gets the Deliver Trigger that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "DeliverTriggers_GetEntityByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Deliver.DeliverTriggerDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/Triggers/Display": { "get": { "tags": [ "Reporting/Deliver" ], "summary": "Get all Deliver Triggers.", "operationId": "DeliverTriggers_GetTriggersAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "isActive", "in": "query", "description": "Optional. Default is null. When specified, the results will be filtered by isActive", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Deliver.DeliverTriggersDisplayDto" }, "xml": { "name": "DeliverTriggersDisplayDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/Triggers/List": { "post": { "tags": [ "Reporting/Deliver" ], "summary": "Returns a list of Deliver Triggers that are found for the list of Id's posted in the message body.", "operationId": "DeliverTriggers_GetListByIdAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "keys", "in": "body", "description": "Array of Deliver Trigger ID's", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Deliver.DeliverTriggerDto" }, "xml": { "name": "DeliverTriggerDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/Triggers/List/Id": { "post": { "tags": [ "Reporting/Deliver" ], "summary": "Returns a list of Deliver Triggers that are found for the list of Id's posted in the message body.", "operationId": "DeliverTriggers_PostV1ReportingDeliverTriggersListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "keys", "in": "body", "description": "Array of Deliver Trigger ID's", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Deliver.DeliverTriggerDto" }, "xml": { "name": "DeliverTriggerDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/Verbose": { "get": { "tags": [ "Reporting/Deliver" ], "operationId": "Deliver_GetVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Template", "Sections", "EmailSent", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.AdvisorEmailVerboseDto" }, "xml": { "name": "AdvisorEmailVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Deliver" ], "summary": "Creates a new Deliver template.", "operationId": "Deliver_CreateVerboseAdvisorEmail", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.AdvisorEmailVerboseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.AdvisorEmailVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Deliver/Verbose/{key}": { "get": { "tags": [ "Reporting/Deliver" ], "operationId": "Deliver_GetVerboseByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Template", "Sections", "EmailSent", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.AdvisorEmailVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Deliver" ], "summary": "Updates a Deliver template.", "operationId": "Deliver_UpdateVerboseAdvisorEmail", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "advisorEmail", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.AdvisorEmailVerboseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.AdvisorEmailVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/Deliver" ], "operationId": "Deliver_DeleteVerboseAdvisorEmail", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Element/FactSheets/Analytical/Rep/{orionRepId}": { "post": { "tags": [ "Reporting/Element" ], "operationId": "FactSheets_GetAnalyticalFactSheetAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "orionRepId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "factSheetParametersDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Element.FactSheetParametersDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Element/FactSheets/Analytical/Rep/{orionRepId}/{modelAggId}": { "get": { "tags": [ "Reporting/Element" ], "operationId": "FactSheets_GetAnalyticalFactSheetForModelAggAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "orionRepId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "modelAggId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Element/FactSheets/Blended/{prospectId}/account/{accountId}/rep/{repId}/{isOatTenant}": { "post": { "tags": [ "Reporting/Element" ], "operationId": "FactSheets_GetBlendedFactsheetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "prospectId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "repId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "isOatTenant", "in": "path", "required": true, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Element/FactSheets/Cloud/Blended/{prospectId}/{accountId}/{fragmentGuid}": { "get": { "tags": [ "Reporting/Element" ], "operationId": "CloudFactSheets_GenerateProposalAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "prospectId", "in": "path", "required": true, "type": "string" }, { "name": "fragmentGuid", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Element.Proposal.Dto.Responses.ProposalResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Element/FactSheets/Cloud/ModelAgg": { "post": { "tags": [ "Reporting/Element" ], "operationId": "CloudFactSheets_GenerateFactSheetAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Element.Proposal.Dto.FactSheet.FactSheetDataDto" } }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "fragmentGuid", "in": "query", "required": false, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Element.Proposal.Dto.Responses.FactSheetResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Element/FactSheets/Cloud/ModelAgg/{modelAggId}": { "get": { "tags": [ "Reporting/Element" ], "operationId": "CloudFactSheets_GenerateFactSheetByModelAggIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "modelAggId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "fragmentGuid", "in": "query", "required": false, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Element.Proposal.Dto.Responses.FactSheetResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Element/Proposals": { "post": { "tags": [ "Reporting/Element" ], "operationId": "Proposals_CreateNewProposalAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "proposalParametersDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Element.ProposalParametersDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Element/Proposals/Cloud": { "post": { "tags": [ "Reporting/Element" ], "operationId": "CloudProposals_GenerateProposal", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Element.Proposal.Dto.Requests.ProposalRequest" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Element.Proposal.Dto.Responses.ProposalResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Element/Proposals/Cloud/blob": { "post": { "tags": [ "Reporting/Element" ], "operationId": "CloudProposals_GenerateProposalBlob", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Element.Proposal.Dto.Requests.ProposalRequest" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string", "format": "byte" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Element/Proposals/Cloud/CustomIndex/{key}": { "get": { "tags": [ "Reporting/Element" ], "operationId": "CloudProposals_GenerateProposalForCustomIndexingKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Element.Proposal.Dto.Responses.ProposalResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Element/Proposals/Cloud/CustomIndex/{key}/blob": { "get": { "tags": [ "Reporting/Element" ], "operationId": "CloudProposals_GenerateProposalForCustomIndexingKeyBlob", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string", "format": "byte" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Element/Proposals/Cloud/Templates": { "get": { "tags": [ "Reporting/Element" ], "operationId": "CloudProposals_GetProposalTemplates", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleGuidKeyEntity" }, "xml": { "name": "SimpleGuidKeyEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Element/Proposals/Cloud/Themes": { "get": { "tags": [ "Reporting/Element" ], "operationId": "CloudProposals_GetProposalThemes", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleGuidKeyEntity" }, "xml": { "name": "SimpleGuidKeyEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Element/Proposals/data/{newHouseholdId}": { "get": { "tags": [ "Reporting/Element" ], "operationId": "Proposals_GetPreGenProposalData", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "newHouseholdId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Element/Proposals/FlushCache": { "get": { "tags": [ "Reporting/Element" ], "operationId": "Proposals_FlushCache", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Element/Proposals/Fragments": { "get": { "tags": [ "Reporting/Element" ], "operationId": "Proposals_GetProposalFragmentsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.FragmentVerboseDto" }, "xml": { "name": "FragmentVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Element/Proposals/PerformanceData": { "get": { "tags": [ "Reporting/Element" ], "operationId": "Proposals_GetRiskStatistics", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entityIds", "in": "query", "required": true, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Performance.PerformancePortfolio" }, "xml": { "name": "PerformancePortfolio", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Element/Prospects": { "get": { "tags": [ "Reporting/Element" ], "operationId": "Prospects_GetProspectsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Prospects.ProspectDto" }, "xml": { "name": "ProspectDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Element/Prospects/{id}": { "get": { "tags": [ "Reporting/Element" ], "operationId": "Prospects_GetProposalDataByProspectIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalProspectDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Element/Prospects/{id}/Accounts": { "get": { "tags": [ "Reporting/Element" ], "operationId": "Prospects_GetProposalAccountDataByProspectIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalAccountDto" }, "xml": { "name": "ProposalAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Element/Prospects/{id}/CustomIndexing": { "get": { "tags": [ "Reporting/Element" ], "operationId": "Prospects_GetCustomIndexingForProspectAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.TaxOptimizationDataDto" }, "xml": { "name": "TaxOptimizationDataDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Element/Prospects/Search": { "get": { "tags": [ "Reporting/Element" ], "operationId": "Prospects_GetV1ReportingElementProspectsSearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Prospects.ProspectDto" }, "xml": { "name": "ProspectDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Element/Prospects/Search/{search}": { "get": { "tags": [ "Reporting/Element" ], "operationId": "Prospects_GetV1ReportingElementProspectsSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Prospects.ProspectDto" }, "xml": { "name": "ProspectDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/CoverPages": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionCoverPage_GetCoverPagesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "canEdit", "in": "query", "required": false, "type": "boolean" }, { "name": "canDelete", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportCoverPageDto" }, "xml": { "name": "ReportCoverPageDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/CoverPages/{key}": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionCoverPage_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportCoverPageDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/CoverPages/Simple": { "get": { "tags": [ "Reporting/Envision" ], "summary": "Gets a simple list of reports that the logged in user has access to.", "operationId": "EnvisionCoverPage_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntityWithOrientationOfSystem.Guid" }, "xml": { "name": "SimpleEntityWithOrientation`1", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/CoverPages/Verbose": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionCoverPage_GetVerboseAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "expand", "in": "query", "required": true, "items": { "type": "string", "enum": [ "None", "Portfolio", "Schema", "AdditionalOptions", "DatabaseGroupAccessRules", "DatabaseAccessRules", "LoginAccessRules", "RoleAccessRules", "UserAccessRules", "All" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "canEdit", "in": "query", "required": false, "type": "boolean" }, { "name": "canDelete", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportCoverPageVerboseDto" }, "xml": { "name": "ReportCoverPageVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionCoverPage_CreateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportCoverPageVerboseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportCoverPageVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/CoverPages/Verbose/{key}": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionCoverPage_GetV1ReportingEnvisionCoverPagesVerboseByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Schema", "AdditionalOptions", "DatabaseGroupAccessRules", "DatabaseAccessRules", "LoginAccessRules", "RoleAccessRules", "UserAccessRules", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportCoverPageVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionCoverPage_UpdateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportCoverPageVerboseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportCoverPageVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionCoverPage_DeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/CoverPages/Verbose/New": { "get": { "tags": [ "Reporting/Envision" ], "summary": "", "operationId": "EnvisionCoverPage_GetNewVerboseAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportCoverPageVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/ExcelReports": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionExcelReports_GetExcelReportsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "canEdit", "in": "query", "required": false, "type": "boolean" }, { "name": "canDelete", "in": "query", "required": false, "type": "boolean" }, { "name": "type", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Custom", "Excel", "All" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "favoritesOnly", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.DataQueryBaseDto" }, "xml": { "name": "DataQueryBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/ExcelReports/{key}": { "get": { "tags": [ "Reporting/Envision" ], "summary": "Get excel report by Id", "operationId": "EnvisionExcelReports_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ExcelReportDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/ExcelReports/{key}/Favorite": { "put": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionExcelReports_UpdateFavoriteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ExcelReportDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/ExcelReports/{key}/Generate": { "post": { "tags": [ "Reporting/Envision" ], "summary": "Generate", "operationId": "EnvisionExcelReportsGenerate_GenerateReportAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "run", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ExcelReportFullDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/ExcelReports/{key}/Generate/csv": { "post": { "tags": [ "Reporting/Envision" ], "summary": "Used to generate a custom report csv with the provided parameters. The successful return will be 201 Created \r\nwith the location set to the url of the newly generated file.", "operationId": "EnvisionExcelReportsGenerate_GenerateReportCsvAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "string", "format": "uuid" }, { "name": "run", "in": "body", "description": "The custom report with paramaters to run.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ExcelReportFullDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/ExcelReports/{key}/Generate/SlickGrid": { "post": { "tags": [ "Reporting/Envision" ], "summary": "Generates the result of the custom report, using the parameters passed in.", "operationId": "EnvisionExcelReportsGenerate_GenerateReportSlickGridAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "string", "format": "uuid" }, { "name": "run", "in": "body", "description": "The custom report with paramaters to run.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ExcelReportFullDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/ExcelReports/{key}/Generate/SlickGrid/{cacheKey}": { "get": { "tags": [ "Reporting/Envision" ], "summary": "Retrieve the previously generated slick grid result.", "operationId": "EnvisionExcelReportsGenerate_GetDataQueryTableByReportId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "string", "format": "uuid" }, { "name": "cacheKey", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "top", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/ExcelReports/{key}/Generate/Table": { "post": { "tags": [ "Reporting/Envision" ], "summary": "Generates the result of the custom report, using the parameters passed in.", "operationId": "EnvisionExcelReportsGenerate_GenerateReportDataTableAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "string", "format": "uuid" }, { "name": "run", "in": "body", "description": "The custom report with paramaters to run.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ExcelReportFullDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/ExcelReports/{key}/Generate/xlsx": { "post": { "tags": [ "Reporting/Envision" ], "summary": "Used to generate a custom report xlsx with the provided parameters. The successful return will be 201 Created \r\nwith the location set to the url of the newly generated file.", "operationId": "EnvisionExcelReportsGenerate_GenerateReportXlsxAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "string", "format": "uuid" }, { "name": "run", "in": "body", "description": "The custom report with paramaters to run.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ExcelReportFullDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/ExcelReports/{key}/Parameters": { "get": { "tags": [ "Reporting/Envision" ], "summary": "Gets the custom report that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "EnvisionExcelReportsGenerate_GetFullByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "string", "format": "uuid" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ExcelReportFullDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/ExcelReports/{key}/Run/{filename}": { "get": { "tags": [ "Reporting/Envision" ], "summary": "Used to download a previously generated custom report.", "operationId": "EnvisionExcelReportsGenerate_RunReportAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "string", "format": "uuid" }, { "name": "filename", "in": "path", "description": "The filename provided by the generate endpoint.", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/ExcelReports/Categories": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionExcelReports_GetQueryCategoriesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/ExcelReports/Simple": { "get": { "tags": [ "Reporting/Envision" ], "summary": "Gets a simple list of excel reports that the logged in user has access to.", "operationId": "EnvisionExcelReports_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntityOfSystem.Guid" }, "xml": { "name": "SimpleEntity`1", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/ExcelReports/Verbose": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionExcelReportsVerbose_GetVerboseAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "expand", "in": "query", "required": true, "items": { "type": "string", "enum": [ "None", "Portfolio", "Schema", "RequiredOptions", "AdditionalOptions", "DatabaseGroupAccessRules", "DatabaseAccessRules", "LoginAccessRules", "RoleAccessRules", "UserAccessRules", "All" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "canEdit", "in": "query", "required": false, "type": "boolean" }, { "name": "canDelete", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ExcelReportVerboseDto" }, "xml": { "name": "ExcelReportVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionExcelReportsVerbose_CreateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ExcelReportVerboseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ExcelReportVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/ExcelReports/Verbose/{key}": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionExcelReportsVerbose_GetV1ReportingEnvisionExcelReportsVerboseByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Schema", "RequiredOptions", "AdditionalOptions", "DatabaseGroupAccessRules", "DatabaseAccessRules", "LoginAccessRules", "RoleAccessRules", "UserAccessRules", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ExcelReportVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionExcelReportsVerbose_UpdateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ExcelReportVerboseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ExcelReportVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionExcelReportsVerbose_DeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/ExcelReports/Verbose/New": { "get": { "tags": [ "Reporting/Envision" ], "summary": "Creates a blank verbose report that will be used as a starting template to create a new excel report.", "operationId": "EnvisionExcelReportsVerbose_GetNewVerboseAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ExcelReportVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/ExcelReportSchedules": { "get": { "tags": [ "Reporting/Envision" ], "summary": "Get all excel report schedules", "operationId": "EnvisionExcelReportSchedules_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isActive", "in": "query", "description": "Optional. Default: null. If provided only active (true) or inactive (false) schedules are returned.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ExcelReportScheduleDto" }, "xml": { "name": "ExcelReportScheduleDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Envision" ], "summary": "Create new schedule", "operationId": "EnvisionExcelReportSchedules_CreateItemAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ExcelReportScheduleDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ExcelReportScheduleDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/ExcelReportSchedules/{key}": { "get": { "tags": [ "Reporting/Envision" ], "summary": "Get excel report schedule by key", "operationId": "EnvisionExcelReportSchedules_GetItemByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ExcelReportScheduleDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Envision" ], "summary": "Update schedule", "operationId": "EnvisionExcelReportSchedules_UpdateItemAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ExcelReportScheduleDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ExcelReportScheduleDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/Envision" ], "summary": "Delete schedule", "operationId": "EnvisionExcelReportSchedules_DeleteItem", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/ExcelReportSchedules/{key}/Download/csv/{resultId}": { "get": { "tags": [ "Reporting/Envision" ], "summary": "Get data query results as Csv", "operationId": "EnvisionExcelReportSchedules_DownloadReportCsvAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "resultId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/ExcelReportSchedules/{key}/Download/psv/{resultId}": { "get": { "tags": [ "Reporting/Envision" ], "summary": "Get data query results as pipe-delimited", "operationId": "EnvisionExcelReportSchedules_DownloadReportPsvAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "resultId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/ExcelReportSchedules/{key}/Download/xls/{resultId}": { "get": { "tags": [ "Reporting/Envision" ], "summary": "Get data query results as data Xls", "operationId": "EnvisionExcelReportSchedules_DownloadReportXlsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "resultId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/ExcelReportSchedules/{key}/Download/xlsx/{resultId}": { "get": { "tags": [ "Reporting/Envision" ], "summary": "Get data query results as Xlsx", "operationId": "EnvisionExcelReportSchedules_DownloadReportXlsxAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "resultId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/ExcelReportSchedules/{key}/Generate/SlickGrid/{resultId}": { "get": { "tags": [ "Reporting/Envision" ], "summary": "Get data query results as slick grid", "operationId": "EnvisionExcelReportSchedules_GenerateReportSlickGrid", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "resultId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/ExcelReportSchedules/{key}/Generate/Table/{resultId}": { "get": { "tags": [ "Reporting/Envision" ], "summary": "Get data query results as data table", "operationId": "EnvisionExcelReportSchedules_GenerateReportDataTable", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "resultId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/ExcelReportSchedules/{key}/Run/{filename}": { "get": { "tags": [ "Reporting/Envision" ], "summary": "Used to download a scheduled generated excel report.", "operationId": "EnvisionExcelReportSchedules_RunReportAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "string", "format": "uuid" }, { "name": "filename", "in": "path", "description": "The filename provided by the generate endpoint.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/ExcelReportSchedules/New": { "get": { "tags": [ "Reporting/Envision" ], "summary": "Returns a new schedule object", "operationId": "EnvisionExcelReportSchedules_GetNewItem", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "frequencyType", "in": "query", "required": true, "type": "string", "enum": [ "Daily", "Weekly", "Monthly", "Once" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ExcelReportScheduleDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Fragments": { "get": { "tags": [ "Reporting/Envision" ], "summary": "List all report fragments accessible by current user", "operationId": "EnvisionFragments_GetFragmentsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "canEdit", "in": "query", "required": false, "type": "boolean" }, { "name": "canDelete", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.FragmentDto" }, "xml": { "name": "FragmentDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Fragments/{fragmentId}": { "get": { "tags": [ "Reporting/Envision" ], "summary": "Get report fragment by Id", "operationId": "EnvisionFragments_GetFragmentAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "fragmentId", "in": "path", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.FragmentDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Fragments/Categories": { "get": { "tags": [ "Reporting/Envision" ], "summary": "List all report fragment categories accessible by current user", "operationId": "EnvisionFragments_GetCategoriesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Fragments/FragmentReportCount/{fragmentId}": { "get": { "tags": [ "Reporting/Envision" ], "summary": "Get the count if subreport to parent reports", "operationId": "EnvisionFragments_GetFragmentReportCountAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "fragmentId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Fragments/Simple": { "get": { "tags": [ "Reporting/Envision" ], "summary": "Gets a simple list of report fragments that the logged in user has access to.", "operationId": "EnvisionFragments_GetSimpleFragementsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "category", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntityWithDescriptionOfSystem.Guid" }, "xml": { "name": "SimpleEntityWithDescription`1", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Fragments/Verbose": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionFragmentsVerbose_GetVerboseAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Schema", "ConfigurationData", "RequiredOptions", "AdditionalOptions", "ReferencedOptions", "DatabaseGroupAccessRules", "DatabaseAccessRules", "LoginAccessRules", "RoleAccessRules", "UserAccessRules", "RepresentativeAccessRules", "RepresentativesClientsAccessRules", "ClientAccessRules", "BrokerDealerAccessRules", "BrokerDealersRepresentativesAccessRules", "All", "AllOptions", "AllAccessRules" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "canEdit", "in": "query", "required": false, "type": "boolean" }, { "name": "canDelete", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.FragmentVerboseDto" }, "xml": { "name": "FragmentVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionFragmentsVerbose_UpdateVerboseFragmentsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updatedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.FragmentVerboseDto" }, "xml": { "name": "FragmentVerboseDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.FragmentVerboseDto" }, "xml": { "name": "FragmentVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Envision" ], "summary": "Create new report", "operationId": "EnvisionFragmentsVerbose_CreateVerboseFragmentAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.FragmentVerboseDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.FragmentVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Fragments/Verbose/{fragmentId}": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionFragmentsVerbose_GetVerboseFragmentAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "fragmentId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Schema", "ConfigurationData", "RequiredOptions", "AdditionalOptions", "ReferencedOptions", "DatabaseGroupAccessRules", "DatabaseAccessRules", "LoginAccessRules", "RoleAccessRules", "UserAccessRules", "RepresentativeAccessRules", "RepresentativesClientsAccessRules", "ClientAccessRules", "BrokerDealerAccessRules", "BrokerDealersRepresentativesAccessRules", "All", "AllOptions", "AllAccessRules" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.FragmentVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionFragmentsVerbose_UpdateVerboseReportAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "fragmentId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.FragmentVerboseDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.FragmentVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionFragmentsVerbose_DeleteVerboseReportAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "fragmentId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Fragments/Verbose/Edit/{fragmentId}": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionFragmentsVerbose_GetVerboseFragmentForEditAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "fragmentId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Schema", "ConfigurationData", "RequiredOptions", "AdditionalOptions", "ReferencedOptions", "DatabaseGroupAccessRules", "DatabaseAccessRules", "LoginAccessRules", "RoleAccessRules", "UserAccessRules", "RepresentativeAccessRules", "RepresentativesClientsAccessRules", "ClientAccessRules", "BrokerDealerAccessRules", "BrokerDealersRepresentativesAccessRules", "All", "AllOptions", "AllAccessRules" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.FragmentVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Fragments/Verbose/Edit/New": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionFragmentsVerbose_GetNewEditVerboseAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.FragmentVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Fragments/Verbose/New": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionFragmentsVerbose_GetNewVerboseAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.FragmentVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/GroupingOptions": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "Envision_GetGroupingOptionsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataAccess.Domains.Reporting.Envision.CalculationGroupingOption" }, "xml": { "name": "CalculationGroupingOption", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/PlaceholderHeirarchy": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "Envision_GetPlaceholderHeirarchyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Engine.ContextTagResult" }, "xml": { "name": "ContextTagResult", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/PlaceholderHeirarchy/Action/Format": { "post": { "tags": [ "Reporting/Envision" ], "operationId": "Envision_GetRandomValue", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "placeHolder", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Reporting.Engine.ContextTagResult" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Reporting.Engine.ContextTagResultFormatted" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/PlaceholderHeirarchy/Action/Format/List": { "post": { "tags": [ "Reporting/Envision" ], "operationId": "Envision_GetRandomValueListAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "placeHolders", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Engine.ContextTagResult" }, "xml": { "name": "ContextTagResult", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Engine.ContextTagResultFormatted" }, "xml": { "name": "ContextTagResultFormatted", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/ReportImages": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "ReportImages_GetAllAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportImageDto" }, "xml": { "name": "ReportImageDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Envision" ], "summary": "Create new Report Image", "operationId": "ReportImages_CreateReportImageAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportImageDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportImageDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/ReportImages/{key}": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "ReportImages_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportImageDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Envision" ], "summary": "Update Report Image", "operationId": "ReportImages_UpdateReportImageAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportImageDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportImageDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/Envision" ], "operationId": "ReportImages_DeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/ReportImages/{key}/Action/Upload": { "post": { "tags": [ "Reporting/Envision" ], "operationId": "ReportImages_UploadFileForImageAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "file", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportImageFileDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportImageDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/ReportPdfs": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "ReportPdfs_GetAllAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportPdfDto" }, "xml": { "name": "ReportPdfDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Envision" ], "summary": "Create new Report Pdf", "operationId": "ReportPdfs_CreateReportPdfAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportPdfDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportPdfDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/ReportPdfs/{key}": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "ReportPdfs_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportPdfDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Envision" ], "summary": "Update Report Pdf", "operationId": "ReportPdfs_UpdateReportPdfAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportPdfDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportPdfDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/Envision" ], "operationId": "ReportPdfs_DeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/ReportPdfs/{key}/Action/Upload": { "post": { "tags": [ "Reporting/Envision" ], "operationId": "ReportPdfs_UploadFileForPdfAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "file", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportPdfFileDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportPdfDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Reports": { "get": { "tags": [ "Reporting/Envision" ], "summary": "List all reports accessible by current user", "operationId": "EnvisionReports_GetReportsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "canEdit", "in": "query", "required": false, "type": "boolean" }, { "name": "canDelete", "in": "query", "required": false, "type": "boolean" }, { "name": "isDeleted", "in": "query", "description": "Optional. Default: false. When false, returns only not deleted reports. When true, returns only deleted reports. When null, all reports are returned.", "required": false, "type": "boolean", "default": false }, { "name": "isFavorite", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportDto" }, "xml": { "name": "ReportDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Reports/{key}/Favorite": { "put": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionReports_UpdateFavoriteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Reports/{key}/History": { "get": { "tags": [ "Reporting/Envision" ], "summary": "Gets the list of history for this given report", "operationId": "EnvisionReports_GetHistoryOfReportAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Report Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Envision.Dtos.ReportHistoryDto" }, "xml": { "name": "ReportHistoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Reports/{key}/History/{historyId}": { "get": { "tags": [ "Reporting/Envision" ], "summary": "Gets the point in time for the given report and the provided historyId", "operationId": "EnvisionReports_GetVerboseByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Report Guid", "required": true, "type": "string", "format": "uuid" }, { "name": "historyId", "in": "path", "description": "primaryKey for Report History Record", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Reports/{reportId}": { "get": { "tags": [ "Reporting/Envision" ], "summary": "Get report by Id", "operationId": "EnvisionReports_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Reports/{reportId}/Generate": { "post": { "tags": [ "Reporting/Envision" ], "summary": "Generate", "operationId": "EnvisionReports_GenerateReportAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "runFor", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportProtoRunForDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Reports/{reportId}/Generate/{sessionId}": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionReports_GetPreviouslyCalculatedBatchAsync", "consumes": [], "produces": [ "text/html", "application/xhtml", "application/xhtml+xml", "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "sessionId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "hud", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "None", "Basic", "Debug" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Reporting.DataEngine.EnvisionReportModel" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Reports/{reportId}/Generate/{sessionId}/Html": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionReports_GetGeneratedReportHtmlAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "sessionId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Reports/{reportId}/Generate/{sessionId}/Json": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionReports_GetGeneratedReportJsonAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "sessionId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Reports/{reportId}/Generate/{sessionId}/Pdf": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionReports_GetGeneratedReportPdfAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "sessionId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Reports/{reportId}/HasThumbnail": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionReports_HasThumbnailAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Reports/{reportId}/Thumbnail": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionReports_GetReportThumbnailAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionReports_DeleteReportThumbnailAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Reports/{reportId}/Thumbnail/Upload": { "post": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionReports_UploadReportThumbnailAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "file", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportTemplates.ReportThumbnailFileDto" } }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Reports/Categories": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionReports_GetCategoriesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Reports/GetReportVersionAssignment/{entity}/{reportGuid}": { "post": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionReports_GetReportVersionAssignmentAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "required": true, "type": "string" }, { "name": "reportGuid", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "entityIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Reports/Recent": { "get": { "tags": [ "Reporting/Envision" ], "summary": "Returns the reports the user has run over the last 30 days ordered by how often each was run.", "operationId": "EnvisionReports_GetRecentAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "top", "in": "query", "description": "Default: 10. The maximum number of reports to return", "required": false, "type": "integer", "format": "int32", "default": 10 }, { "name": "forHomepageDashboard", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Reports/Settings": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionReportSettings_GetGlobalSettings", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportSettingsDto" }, "xml": { "name": "ReportSettingsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Reports/Settings/{optionGuid}": { "delete": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionReportSettings_DeleteOption", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "optionGuid", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportSettingsDto" }, "xml": { "name": "ReportSettingsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Reports/Settings/AdHoc": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionReportSettings_GetAdHocSettings", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportSettingsDto" }, "xml": { "name": "ReportSettingsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Reports/Settings/CheckDuplicates/Batch/{workerCount}": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionReportSettings_CheckDuplicatesBatch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "workerCount", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Reports/Settings/CheckDuplicates/Single": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionReportSettings_CheckDuplicatesSingleAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Reports/Settings/Defaults": { "put": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionReportSettings_SaveGlobalDefaults", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "defaults", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/System.ValueTupleOfSystem.StringAndSystem.Int32AndSystem.Guid" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Reports/Settings/Option": { "post": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionReportSettings_SaveOptionByType", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "option", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportSettingsDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Reports/Settings/Options/{typeOption}": { "post": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionReportSettings_SaveOptionsByType", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "typeOption", "in": "path", "required": true, "type": "string" }, { "name": "options", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportSettingsDto" }, "xml": { "name": "ReportSettingsDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportSettingsDto" }, "xml": { "name": "ReportSettingsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Reports/Settings/UpdateSpecificReportsGlobalOptionGuids": { "post": { "tags": [ "Reporting/Envision" ], "summary": "This method can be removed after it is run in production", "operationId": "EnvisionReportSettings_UpdateSpecificReportsGlobalOptionGuids", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reports", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/System.ValueTupleOfSystem.GuidAndSystem.Int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Reports/Settings/UpdateSpecificSubReportsGlobalOptionGuids": { "post": { "tags": [ "Reporting/Envision" ], "summary": "This method can be removed after it is run in production", "operationId": "EnvisionReportSettings_UpdateSpecificSubReportsGlobalOptionGuids", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "subReports", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/System.ValueTupleOfSystem.GuidAndSystem.Int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Reports/Settings/Validate/{typeOption}": { "post": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionReportSettings_ValidateOptionsByType", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "typeOption", "in": "path", "required": true, "type": "string" }, { "name": "options", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportSettingsDto" }, "xml": { "name": "ReportSettingsDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Reports/Simple": { "get": { "tags": [ "Reporting/Envision" ], "summary": "Gets a simple list of reports that the logged in user has access to.", "operationId": "EnvisionReports_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntityOfSystem.Guid" }, "xml": { "name": "SimpleEntity`1", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Reports/Validate": { "get": { "tags": [ "Reporting/Envision" ], "summary": "Goes through all the reports and checks for any errors.", "operationId": "EnvisionReports_GetValidate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "page", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "pageSize", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 1 } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Reports/Verbose": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionReportsVerbose_GetVerboseReportsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Schema", "Versions", "RequiredOptions", "AdditionalOptions", "ReferencedOptions", "DatabaseGroupAccessRules", "DatabaseAccessRules", "LoginAccessRules", "RoleAccessRules", "UserAccessRules", "RepresentativeAccessRules", "RepresentativesClientsAccessRules", "ClientAccessRules", "BrokerDealerAccessRules", "BrokerDealersRepresentativesAccessRules", "BrokerDealerVersionAssignments", "PortfolioGroupVersionAssignments", "RepresentativeVersionAssignments", "ClientVersionAssignments", "All", "AllOptions", "AllAccessRules", "AllVersionAssignments" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "canEdit", "in": "query", "required": false, "type": "boolean" }, { "name": "canDelete", "in": "query", "required": false, "type": "boolean" }, { "name": "isDeleted", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportVerboseDto" }, "xml": { "name": "ReportVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionReportsVerbose_UpdateVerboseReportsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "updatedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportVerboseDto" }, "xml": { "name": "ReportVerboseDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportVerboseDto" }, "xml": { "name": "ReportVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Envision" ], "summary": "Create new report", "operationId": "EnvisionReportsVerbose_CreateVerboseReportAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "newDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportVerboseDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Reports/Verbose/{reportId}": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionReportsVerbose_GetVerboseReportAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "reportId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Schema", "Versions", "RequiredOptions", "AdditionalOptions", "ReferencedOptions", "DatabaseGroupAccessRules", "DatabaseAccessRules", "LoginAccessRules", "RoleAccessRules", "UserAccessRules", "RepresentativeAccessRules", "RepresentativesClientsAccessRules", "ClientAccessRules", "BrokerDealerAccessRules", "BrokerDealersRepresentativesAccessRules", "BrokerDealerVersionAssignments", "PortfolioGroupVersionAssignments", "RepresentativeVersionAssignments", "ClientVersionAssignments", "All", "AllOptions", "AllAccessRules", "AllVersionAssignments" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionReportsVerbose_UpdateVerboseReportAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportVerboseDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionReportsVerbose_DeleteVerboseReportAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Reports/Verbose/Action/RestoreReport/{reportId}": { "put": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionReportsVerbose_UpdateVerboseRestoreReportAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportVerboseDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Reports/Verbose/New": { "get": { "tags": [ "Reporting/Envision" ], "summary": "Gets a blank verbose report that will be used as a starting template to create a new report.", "operationId": "EnvisionReportsVerbose_GetNewVerboseAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "useGlobals", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Themes": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionThemes_GetThemesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "canEdit", "in": "query", "required": false, "type": "boolean" }, { "name": "canDelete", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportThemeDto" }, "xml": { "name": "ReportThemeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Themes/{key}": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionThemes_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportThemeDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Themes/{key}/Css": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionPublicThemes_GetCss", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "minify", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Themes/Default": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionThemes_GetDefaultThemeAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportThemeDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Themes/Render/Css": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionPublicThemes_GetRenderCss", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "minify", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Themes/Selection": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionThemes_GetThemesForSelectionAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportThemeSelectionDto" }, "xml": { "name": "ReportThemeSelectionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Themes/Standard/Css": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionPublicThemes_GetStandardCss", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "minify", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Themes/ValidateImport": { "post": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionThemes_PostMultipartStream", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Themes/ValidateImport/Template": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionThemes_GetTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Themes/Verbose": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionThemes_GetVerboseAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "expand", "in": "query", "required": true, "items": { "type": "string", "enum": [ "None", "Css", "Import", "Options", "LoginAccessRules", "DatabaseGroupAccessRules", "DatabaseAccessRules", "RoleAccessRules", "UserAccessRules", "All" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "canEdit", "in": "query", "required": false, "type": "boolean" }, { "name": "canDelete", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportThemeVerboseDto" }, "xml": { "name": "ReportThemeVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionThemes_CreateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportThemeVerboseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportThemeVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Themes/Verbose/{key}": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionThemes_GetV1ReportingEnvisionThemesVerboseByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Css", "Import", "Options", "LoginAccessRules", "DatabaseGroupAccessRules", "DatabaseAccessRules", "RoleAccessRules", "UserAccessRules", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportThemeVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionThemes_UpdateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportThemeVerboseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportThemeVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionThemes_DeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Envision/Themes/Verbose/New": { "get": { "tags": [ "Reporting/Envision" ], "operationId": "EnvisionThemes_GetNewVerboseAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportThemeVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Extracts/PerformanceData": { "get": { "tags": [ "Reporting/Extracts" ], "summary": "", "operationId": "Extracts_GetPerformanceData", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "entityId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "entity", "in": "query", "description": "Only allows Client, Registration, Account, and Asset", "required": false, "type": "string", "default": 0, "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "clientId", "in": "query", "description": "Optional. Default: null. When provided limits the return to only the performance data that belong to the provided clientId.", "required": false, "type": "integer", "format": "int32" }, { "name": "registrationId", "in": "query", "description": "Optional. Default: null. When provided limits the return to only the performance data that belong to the provided registrationId.", "required": false, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "query", "description": "Optional. Default: null. When provided limits the return to only the performance data that belong to the provided accountId.", "required": false, "type": "integer", "format": "int32" }, { "name": "assetId", "in": "query", "description": "Optional. Default: null. When provided limits the return to only the performance data that belong to the provided assetId.", "required": false, "type": "integer", "format": "int32" }, { "name": "includeCash", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "hasValue", "in": "query", "description": "Optional. Default: null. When provided will return only data for assets that have value (true) or do not have value (false) for today.", "required": false, "type": "boolean" }, { "name": "editedStartDate", "in": "query", "description": "Optional. Default: null. If provided only records that were edited after the date provided will be returned.", "required": false, "type": "string", "format": "date-time" }, { "name": "editedEndDate", "in": "query", "description": "Optional. Default: null. If provided only records that were edited before the date provided will be returned.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Extracts.AssetValueChangeDto" }, "xml": { "name": "AssetValueChangeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Extracts/UnrealizedTaxLots": { "get": { "tags": [ "Reporting/Extracts" ], "summary": "", "operationId": "Extracts_GetUnrealizedTaxLots", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entityId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "entity", "in": "query", "description": "Only allows Representative, Client, Registration, Account, and Asset", "required": false, "type": "string", "default": 0, "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "representativeId", "in": "query", "description": "Optional. Default: null. When provided limits the return to only those lots that belong to the provided representativeId.", "required": false, "type": "integer", "format": "int32" }, { "name": "clientId", "in": "query", "description": "Optional. Default: null. When provided limits the return to only those lots that belong to the provided clientId.", "required": false, "type": "integer", "format": "int32" }, { "name": "registrationId", "in": "query", "description": "Optional. Default: null. When provided limits the return to only those lots that belong to the provided registrationId.", "required": false, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "query", "description": "Optional. Default: null. When provided limits the return to only those lots that belong to the provided accountId.", "required": false, "type": "integer", "format": "int32" }, { "name": "assetId", "in": "query", "description": "Optional. Default: null. When provided limits the return to only those lots that belong to the provided assetId.", "required": false, "type": "integer", "format": "int32" }, { "name": "includeCash", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "hasValue", "in": "query", "required": false, "type": "boolean" }, { "name": "editedStartDate", "in": "query", "description": "Optional. Default: null. If provided only records that were edited after the date provided will be returned.", "required": false, "type": "string", "format": "date-time" }, { "name": "editedEndDate", "in": "query", "description": "Optional. Default: null. If provided only records that were edited before the date provided will be returned.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Extracts.UnrealizedTaxLotsDto" }, "xml": { "name": "UnrealizedTaxLotsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Extracts/UnrealizedTaxLots/List/AccountId": { "post": { "tags": [ "Reporting/Extracts" ], "summary": "", "operationId": "Extracts_GetUnrealizedTaxLotsByAccountIds", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "includeCash", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "hasValue", "in": "query", "required": false, "type": "boolean" }, { "name": "editedStartDate", "in": "query", "description": "Optional. Default: null. If provided only records that were edited after the date provided will be returned.", "required": false, "type": "string", "format": "date-time" }, { "name": "editedEndDate", "in": "query", "description": "Optional. Default: null. If provided only records that were edited before the date provided will be returned.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Extracts.UnrealizedTaxLotsDto" }, "xml": { "name": "UnrealizedTaxLotsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Extracts/UnrealizedTaxLots/List/AssetId": { "post": { "tags": [ "Reporting/Extracts" ], "summary": "", "operationId": "Extracts_GetUnrealizedTaxLotsByAssetIds", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "assetIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "includeCash", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "hasValue", "in": "query", "required": false, "type": "boolean" }, { "name": "editedStartDate", "in": "query", "description": "Optional. Default: null. If provided only records that were edited after the date provided will be returned.", "required": false, "type": "string", "format": "date-time" }, { "name": "editedEndDate", "in": "query", "description": "Optional. Default: null. If provided only records that were edited before the date provided will be returned.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Extracts.UnrealizedTaxLotsDto" }, "xml": { "name": "UnrealizedTaxLotsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFund": { "get": { "tags": [ "Reporting/FundPerformance" ], "summary": "", "operationId": "GeminiFunds_GetFunds", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundDto" }, "xml": { "name": "GeminiFundDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/FundPerformance" ], "operationId": "GeminiFunds_CreateNewFund", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFund/{key}": { "get": { "tags": [ "Reporting/FundPerformance" ], "summary": "Gets the fund that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "GeminiFunds_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/FundPerformance" ], "operationId": "GeminiFunds_UpdateFund", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/FundPerformance" ], "summary": "", "operationId": "GeminiFunds_Delete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFund/BackLoad": { "post": { "tags": [ "Reporting/FundPerformance" ], "operationId": "GeminiFunds_CreateNewLoad", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundBackLoadDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundBackLoadDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFund/BackLoad/{key}/{forYear}/{effectiveDate}": { "get": { "tags": [ "Reporting/FundPerformance" ], "summary": "Gets the fund that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "GeminiFunds_GetFundBackLoadByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "string" }, { "name": "forYear", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "effectiveDate", "in": "path", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundBackLoadDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/FundPerformance" ], "operationId": "GeminiFunds_UpdateBackLoad", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string" }, { "name": "forYear", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "effectiveDate", "in": "path", "required": true, "type": "string", "format": "date-time" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundBackLoadDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundBackLoadDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFund/BackLoad/Action/Delete": { "put": { "tags": [ "Reporting/FundPerformance" ], "summary": "Deletes every gemini fund backload provided in the list of ids.", "operationId": "GeminiFunds_BackLoadActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "description": "The list ids to delete.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundBackLoadKeyDto" }, "xml": { "name": "GeminiFundBackLoadKeyDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundBackLoadKeyDto" }, "xml": { "name": "GeminiFundBackLoadKeyDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFund/Data": { "get": { "tags": [ "Reporting/FundPerformance" ], "summary": "Gets the fund data that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "GeminiFunds_GetData", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "fundKey", "in": "query", "required": false, "type": "string" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundDataDto" }, "xml": { "name": "GeminiFundDataDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/FundPerformance" ], "operationId": "GeminiFunds_CreateNewData", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundDataDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundDataDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFund/Data/{key}/{rateDate}": { "get": { "tags": [ "Reporting/FundPerformance" ], "summary": "Gets the fund data that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "GeminiFunds_GetFundDataByKeyAndDate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "string" }, { "name": "rateDate", "in": "path", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundDataDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/FundPerformance" ], "operationId": "GeminiFunds_UpdateFundData", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string" }, { "name": "rateDate", "in": "path", "required": true, "type": "string", "format": "date-time" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundDataDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundDataDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/FundPerformance" ], "summary": "", "operationId": "GeminiFunds_DeleteFundData", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string" }, { "name": "rateDate", "in": "path", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFund/Data/Action/Delete": { "put": { "tags": [ "Reporting/FundPerformance" ], "summary": "Deletes every gemini fund data provided in the list of ids.", "operationId": "GeminiFunds_DataActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "description": "The list of fund data to delete.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundDataKeyDto" }, "xml": { "name": "GeminiFundDataKeyDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundDataKeyDto" }, "xml": { "name": "GeminiFundDataKeyDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFund/Div": { "get": { "tags": [ "Reporting/FundPerformance" ], "summary": "Gets the fund div that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "GeminiFunds_GetFundDivs", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "fundKey", "in": "query", "required": false, "type": "string" }, { "name": "divYear", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 2000 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundDivDto" }, "xml": { "name": "GeminiFundDivDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/FundPerformance" ], "operationId": "GeminiFunds_CreateNewDiv", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundDivDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundDivDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFund/Div/{key}/{divYear}": { "get": { "tags": [ "Reporting/FundPerformance" ], "summary": "Gets the fund that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "GeminiFunds_GetFundDivByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "string" }, { "name": "divYear", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundDivDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/FundPerformance" ], "operationId": "GeminiFunds_PutV1ReportingFundPerformanceGeminiFundDivByKeyByDivYear", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string" }, { "name": "divYear", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundDivDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundDivDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFund/Div/Action/Delete": { "put": { "tags": [ "Reporting/FundPerformance" ], "summary": "Deletes every fund backload provided in the list of ids.", "operationId": "GeminiFunds_DivActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "description": "The list of backload ids to delete.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundDivKeyDto" }, "xml": { "name": "GeminiFundDivKeyDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundDivKeyDto" }, "xml": { "name": "GeminiFundDivKeyDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFund/DivDetail": { "get": { "tags": [ "Reporting/FundPerformance" ], "summary": "Gets the fund data that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "GeminiFunds_GetDivData", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "fundKey", "in": "query", "required": false, "type": "string" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundDivDetailDto" }, "xml": { "name": "GeminiFundDivDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/FundPerformance" ], "operationId": "GeminiFunds_CreateNewDivDetail", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundDivDetailDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundDivDetailDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFund/DivDetail/{key}/{rateDate}": { "get": { "tags": [ "Reporting/FundPerformance" ], "summary": "Gets the fund that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "GeminiFunds_GetFundDivDetailByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "string" }, { "name": "rateDate", "in": "path", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundDivDetailDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/FundPerformance" ], "operationId": "GeminiFunds_UpdateDivDetail", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string" }, { "name": "rateDate", "in": "path", "required": true, "type": "string", "format": "date-time" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundDivDetailDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundDivDetailDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFund/DivDetail/Action/Delete": { "put": { "tags": [ "Reporting/FundPerformance" ], "summary": "Deletes every gemini fund backload provided in the list of ids.", "operationId": "GeminiFunds_DivDetailActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "description": "The list ids to delete.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundDataKeyDto" }, "xml": { "name": "GeminiFundDataKeyDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundDataKeyDto" }, "xml": { "name": "GeminiFundDataKeyDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFund/FrontLoad": { "post": { "tags": [ "Reporting/FundPerformance" ], "summary": "Create new front load record.", "operationId": "GeminiFunds_CreateFrontLoad", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "Dto object.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundFrontLoadDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundFrontLoadDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFund/FrontLoad/{key}/{effectiveDate}/{starting}": { "get": { "tags": [ "Reporting/FundPerformance" ], "summary": "Gets the fund that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "GeminiFunds_GetFundFrontLoadByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "string" }, { "name": "effectiveDate", "in": "path", "description": "effectiveDate of the desired return object.", "required": true, "type": "string", "format": "date-time" }, { "name": "starting", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundFrontLoadDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/FundPerformance" ], "summary": "Update the front load record that has the provided key.", "operationId": "GeminiFunds_UpdateFrontLoad", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "FundKey of the front load to delete.", "required": true, "type": "string" }, { "name": "effectiveDate", "in": "path", "description": "F of the front load to delete.", "required": true, "type": "string", "format": "date-time" }, { "name": "starting", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "description": "Key of the desired return object.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundFrontLoadDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundFrontLoadDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFund/FrontLoad/Action/Delete": { "put": { "tags": [ "Reporting/FundPerformance" ], "summary": "Deletes front load records provided the list of keys.", "operationId": "GeminiFunds_FrontLoadBatchDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "description": "The list keys to delete.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundFrontLoadKeyDto" }, "xml": { "name": "GeminiFundFrontLoadKeyDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundFrontLoadKeyDto" }, "xml": { "name": "GeminiFundFrontLoadKeyDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFund/GeminiImport": { "post": { "tags": [ "Reporting/FundPerformance" ], "operationId": "GeminiFunds_ImportAccountReferralSchedules", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFund/Inception/{key}": { "get": { "tags": [ "Reporting/FundPerformance" ], "summary": "Get the inception date of fund that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "GeminiFunds_GetFundInception", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundInceptionDto" }, "xml": { "name": "GeminiFundInceptionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFund/Index": { "post": { "tags": [ "Reporting/FundPerformance" ], "operationId": "GeminiFunds_CreateIndex", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundIndexDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundIndexDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFund/Index/{key}": { "get": { "tags": [ "Reporting/FundPerformance" ], "summary": "Gets the index that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "GeminiFunds_GetIndex", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundIndexDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFund/Index/{key}/Links": { "get": { "tags": [ "Reporting/FundPerformance" ], "summary": "Gets the fund that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "GeminiFunds_GetFundIndexByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundIndexLinkDto" }, "xml": { "name": "GeminiFundIndexLinkDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFund/Index/Simple/Search": { "get": { "tags": [ "Reporting/FundPerformance" ], "operationId": "GeminiFunds_GetSimpleIndexSearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataAccess.Domains.Portfolio.SimpleStringKeyEntityIndex" }, "xml": { "name": "SimpleStringKeyEntityIndex", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFund/Index/Simple/Search/{search}": { "get": { "tags": [ "Reporting/FundPerformance" ], "operationId": "GeminiFunds_GetV1ReportingFundPerformanceGeminiFundIndexSimpleSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataAccess.Domains.Portfolio.SimpleStringKeyEntityIndex" }, "xml": { "name": "SimpleStringKeyEntityIndex", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFund/IndexLink": { "get": { "tags": [ "Reporting/FundPerformance" ], "summary": "Gets the fund div that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "GeminiFunds_GetFundIndexLinks", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "fundKey", "in": "query", "required": true, "type": "string" }, { "name": "indexNumber", "in": "query", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundIndexLinkDto" }, "xml": { "name": "GeminiFundIndexLinkDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/FundPerformance" ], "operationId": "GeminiFunds_CreateIndexLink", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundIndexLinkDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundIndexLinkDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFund/IndexLink/{key}/{indexNumber}": { "get": { "tags": [ "Reporting/FundPerformance" ], "summary": "Gets the fund that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "GeminiFunds_GetFundIndexLinkByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "string" }, { "name": "indexNumber", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundIndexLinkDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/FundPerformance" ], "operationId": "GeminiFunds_UpdateIndexLink", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string" }, { "name": "indexNumber", "in": "path", "required": true, "type": "string" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundIndexLinkDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundIndexLinkDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFund/IndexLink/Action/Delete": { "put": { "tags": [ "Reporting/FundPerformance" ], "summary": "Deletes every fund backload provided in the list of ids.", "operationId": "GeminiFunds_IndexLinkActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "description": "The list of backload ids to delete.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundIndexLinkKeyDto" }, "xml": { "name": "GeminiFundIndexLinkKeyDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundIndexLinkKeyDto" }, "xml": { "name": "GeminiFundIndexLinkKeyDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFund/Loads": { "get": { "tags": [ "Reporting/FundPerformance" ], "summary": "Gets the fund data that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "GeminiFunds_GetBackLoad", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "fundKey", "in": "query", "required": false, "type": "string" }, { "name": "forYear", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "effectiveDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "starting", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundLoadDto" }, "xml": { "name": "GeminiFundLoadDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFund/Performance": { "post": { "tags": [ "Reporting/FundPerformance" ], "operationId": "GeminiFunds_GetPerformance", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "settings", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.PerformanceSettingsDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundPerformanceDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFund/Simple": { "get": { "tags": [ "Reporting/FundPerformance" ], "summary": "", "operationId": "GeminiFunds_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleStringKeyEntity" }, "xml": { "name": "SimpleStringKeyEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFund/Simple/Search": { "get": { "tags": [ "Reporting/FundPerformance" ], "operationId": "GeminiFunds_GetSimpleFundSearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleStringKeyEntity" }, "xml": { "name": "SimpleStringKeyEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFund/Simple/Search/{search}": { "get": { "tags": [ "Reporting/FundPerformance" ], "operationId": "GeminiFunds_GetV1ReportingFundPerformanceGeminiFundSimpleSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleStringKeyEntity" }, "xml": { "name": "SimpleStringKeyEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFund/StartPrice/{key}": { "get": { "tags": [ "Reporting/FundPerformance" ], "summary": "Get the start date price of fund that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "GeminiFunds_GetFundStartPrice", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object", "required": true, "type": "string" }, { "name": "asOfDate", "in": "query", "description": "Optional. Default null for start price on inception. If provided, returns price of the provided date.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundStartPriceDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFundCalendar": { "get": { "tags": [ "Reporting/FundPerformance" ], "summary": "Get the list of calendar dates.", "operationId": "GeminiFundCalendars_GetCalendars", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "year", "in": "query", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundCalendarDto" }, "xml": { "name": "GeminiFundCalendarDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFundCalendar/{key}": { "get": { "tags": [ "Reporting/FundPerformance" ], "summary": "Gets the fund data that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "GeminiFundCalendars_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundCalendarDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/FundPerformance" ], "operationId": "GeminiFundCalendars_UpdateCalendar", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string", "format": "date-time" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundCalendarDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundCalendarDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFundCalendar/Add": { "post": { "tags": [ "Reporting/FundPerformance" ], "operationId": "GeminiFundCalendars_CreateNewCalendar", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundCalendarDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundCalendarDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFundGroup": { "get": { "tags": [ "Reporting/FundPerformance" ], "summary": "Gets the fund that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "GeminiFundGroups_GetGroups", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundGroupDto" }, "xml": { "name": "GeminiFundGroupDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/FundPerformance" ], "operationId": "GeminiFundGroups_CreateNewGroup", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundGroupDto" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFundGroup/{key}": { "get": { "tags": [ "Reporting/FundPerformance" ], "summary": "Gets the fund data that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "GeminiFundGroups_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundGroupDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/FundPerformance" ], "operationId": "GeminiFundGroups_UpdateGroup", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundGroupDto" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFundGroup/Action/Delete": { "put": { "tags": [ "Reporting/FundPerformance" ], "operationId": "GeminiFundGroups_ActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFundGroup/GetByGroupName": { "get": { "tags": [ "Reporting/FundPerformance" ], "summary": "Gets the fund data that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "GeminiFundGroups_GetEntityByKeyAndGroupName", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "groupName", "in": "query", "description": "Key of the desired return object.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundGroupDto" }, "xml": { "name": "GeminiFundGroupDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFundGroup/Simple/{fundKey}": { "get": { "tags": [ "Reporting/FundPerformance" ], "summary": "Gets the fund groups.", "operationId": "GeminiFundGroups_GetFundGroups", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "fundKey", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFundTax": { "get": { "tags": [ "Reporting/FundPerformance" ], "operationId": "GeminiFundTaxes_GetTaxRates", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundTaxDto" }, "xml": { "name": "GeminiFundTaxDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/FundPerformance" ], "operationId": "GeminiFundTaxes_CreateNewTax", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundTaxDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundTaxDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFundTax/{key}": { "get": { "tags": [ "Reporting/FundPerformance" ], "summary": "Gets the tax data that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "GeminiFundTaxes_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundTaxDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/FundPerformance" ], "summary": "Update Tax information.", "operationId": "GeminiFundTaxes_UpdateTax", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The Start Date", "required": true, "type": "string", "format": "date-time" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundTaxDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundTaxDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/GeminiFundTax/Action/Delete": { "put": { "tags": [ "Reporting/FundPerformance" ], "operationId": "GeminiFundTaxes_ActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "string", "format": "date-time" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/Reports/YardstickAllPerf": { "get": { "tags": [ "Reporting/FundPerformance" ], "summary": "Returns the results of spimGeminiFundPerfAllInd report.", "operationId": "GeminiFundReports_YardstickAllPerfAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "query", "description": "End Date of the desired return object.", "required": true, "type": "string", "format": "date-time" }, { "name": "portfolioNumber", "in": "query", "description": "Portfolio Number ID for Fund requested.", "required": false, "type": "string" }, { "name": "groupName", "in": "query", "description": "Group Name for Fund requested.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/FundPerformance/Reports/YardstickHypothetical": { "get": { "tags": [ "Reporting/FundPerformance" ], "summary": "Returns the results of pimGeminiFundPerfHypothetical report.", "operationId": "GeminiFundReports_YardstickHypotheticalAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "fundKey", "in": "query", "description": "Fund Key of the desired return object.", "required": true, "type": "string" }, { "name": "endDate", "in": "query", "description": "End Date of the desired return object.", "required": true, "type": "string", "format": "date-time" }, { "name": "initialInvestment", "in": "query", "description": "Dollar amount for hypothetical.", "required": true, "type": "number", "format": "double" }, { "name": "returnAsXML", "in": "query", "description": "Should be returned as XML.", "required": true, "type": "boolean" }, { "name": "beginDate", "in": "query", "description": "Start Date of the desired return object.", "required": true, "type": "string", "format": "date-time" }, { "name": "interval", "in": "query", "description": "Interval of the desired return object. 0-Daily, 1-Monthly, 2-Yearly", "required": true, "type": "integer", "format": "int32" }, { "name": "groupName", "in": "query", "description": "Group Name of the desired return object", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Fuse/Notifications": { "get": { "tags": [ "Reporting/Fuse" ], "operationId": "FuseNotification_GetNotificationsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "status", "in": "query", "required": false, "items": { "type": "string", "enum": [ "Unread", "Read", "Deleted" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "currentFirmOnly", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "byLastDays", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 14 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Fuse.NotificationDto" }, "xml": { "name": "NotificationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Fuse/Notifications/{notificationId}": { "get": { "tags": [ "Reporting/Fuse" ], "operationId": "FuseNotification_GetNotificationByIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "notificationId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Fuse.NotificationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Fuse/Notifications/Subscriptions": { "get": { "tags": [ "Reporting/Fuse" ], "operationId": "FuseNotification_GetSubscriptionsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "canSubscribe", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Fuse.NotificationTypeSubscriptionDto" }, "xml": { "name": "NotificationTypeSubscriptionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Fuse" ], "operationId": "FuseNotification_UpdateSubscriptionsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "notificationTypeSubscriptionDtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Fuse.NotificationTypeSubscriptionDto" }, "xml": { "name": "NotificationTypeSubscriptionDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Fuse.NotificationTypeSubscriptionDto" }, "xml": { "name": "NotificationTypeSubscriptionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Fuse/Notifications/SummaryCount": { "get": { "tags": [ "Reporting/Fuse" ], "operationId": "FuseNotification_GetSummaryCountAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Notification.NotificationCountSummaryDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/GainLoss/Realized/DrillDownSummary": { "post": { "tags": [ "Reporting/GainLoss" ], "summary": "Returns gain loss information for each asset in the requested entity / entityid", "operationId": "GainLoss_GetRealizedDrillDownAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "settings", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.RealizedDrillDownSettingsDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.GainLossDrillDownSummaryBase" }, "xml": { "name": "GainLossDrillDownSummaryBase", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/GainLoss/Unrealized/DrillDownSummary": { "post": { "tags": [ "Reporting/GainLoss" ], "summary": "Returns gain loss information for each asset in the requested entity / entityid", "operationId": "GainLoss_GetUnrealizedDrillDownAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "settings", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.UnrealizedDrillDownSettingsDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.GainLossDrillDownSummaryBase" }, "xml": { "name": "GainLossDrillDownSummaryBase", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Implementation": { "get": { "tags": [ "Reporting/Implementation" ], "operationId": "ImplementationPlan_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Implementation.ImplementationPlanDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Implementation/{key}": { "put": { "tags": [ "Reporting/Implementation" ], "operationId": "ImplementationPlan_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Implementation.ImplementationPlanDto" } }, { "name": "signOff", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Implementation.ImplementationPlanDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Implementation/GenerateNew": { "post": { "tags": [ "Reporting/Implementation" ], "summary": "Generate a new dashboard", "operationId": "ImplementationPlan_GenerateNew", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Implementation.ImplementationPlanDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/InterfaceSetup": { "get": { "tags": [ "Reporting/InterfaceSetup" ], "operationId": "InterfaceSetup_GetAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Qpe.QpeItemDto" }, "xml": { "name": "QpeItemDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/InterfaceSetup/{key}/DashboardNewsletter": { "get": { "tags": [ "Reporting/InterfaceSetup" ], "operationId": "InterfaceSetup_DownloadNewsletter", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/InterfaceSetup" ], "operationId": "InterfaceSetup_UploadDashboardNewsletterAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/InterfaceSetup/{qpeItemId}": { "get": { "tags": [ "Reporting/InterfaceSetup" ], "operationId": "InterfaceSetup_GetItemDetails", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "qpeItemId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Qpe.QpeItemDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/InterfaceSetup/{qpeItemId}/Dashboard": { "get": { "tags": [ "Reporting/InterfaceSetup" ], "summary": "", "operationId": "InterfaceSetup_GetDashboardDetails", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "qpeItemId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "storeSnapshotData", "in": "query", "description": "Determins if data should be stored in the QpeDetailstbl", "required": false, "type": "boolean", "default": false }, { "name": "getStoredData", "in": "query", "description": "Determins if data is retrived in real time or from QpeDashboardDtl table", "required": false, "type": "boolean", "default": false }, { "name": "resetCache", "in": "query", "description": "Optional. Default: false. The result is cached for one hour. To force the cache to refresh call with resetCache = true.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/InterfaceSetup/{qpeItemId}/DrillDown": { "get": { "tags": [ "Reporting/InterfaceSetup" ], "operationId": "InterfaceSetup_GetQpeDashboardDtlDrillDown", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "qpeItemId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "linkCode", "in": "query", "required": true, "type": "string", "enum": [ "FeeSchFlat", "FeeSchTiered", "FeeSchLinear", "PaySched" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.QpeDashboard.SpimQpeDashboardDtlGetDrillDown" }, "xml": { "name": "SpimQpeDashboardDtlGetDrillDown", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/NotificationGroups": { "get": { "tags": [ "Reporting/NotificationGroups" ], "operationId": "ReportingNotificationGroups_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Notification.NotificationGroupDto" }, "xml": { "name": "NotificationGroupDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/NotificationGroups" ], "operationId": "ReportingNotificationGroups_CreateNewGroup", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Notification.NotificationGroupFullDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/NotificationGroups/{key}": { "get": { "tags": [ "Reporting/NotificationGroups" ], "operationId": "ReportingNotificationGroups_GetGroupByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Notification.NotificationGroupFullDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/NotificationGroups" ], "operationId": "ReportingNotificationGroups_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Notification.NotificationGroupFullDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Notification.NotificationGroupFullDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/NotificationGroups" ], "summary": "Used to delete an existing notification group. Upon successful deletion a 204 will be returned.", "operationId": "ReportingNotificationGroups_Delete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/NotificationGroups/AvailableUsers": { "get": { "tags": [ "Reporting/NotificationGroups" ], "summary": "Returns a list of user profiles for the specified UserType that the currently logged in user is allowed to setup notifications for.", "operationId": "ReportingNotificationGroups_GetAvailableUsers", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "userType", "in": "query", "description": "The users returned are for this entity..", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.UserDetailDto" }, "xml": { "name": "UserDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/NotificationGroups/Simple": { "get": { "tags": [ "Reporting/NotificationGroups" ], "summary": "Gets a simple list of notification groups that the logged in user has access to.", "operationId": "ReportingNotificationGroups_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/NotificationGroups/UserTypes": { "get": { "tags": [ "Reporting/NotificationGroups" ], "summary": "Returns User Types that the currently logged in user is allowed to setup notification groups for.", "operationId": "ReportingNotificationGroups_GetUserTypes", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "xml": { "name": "Entity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Notifications": { "get": { "tags": [ "Reporting/Notifications" ], "operationId": "ReportingNotifications_GetForDestination", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "destination", "in": "query", "required": false, "type": "string", "enum": [ "ClientPortal", "OrionApp", "Email", "Rss", "AdvisorMail", "Zapier", "NotificationInbox", "SMSText", "MobilePush" ] }, { "name": "state", "in": "query", "required": false, "items": { "type": "string", "enum": [ "Created", "Processed", "Viewed", "Archived" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Notification.NotificationDto" }, "xml": { "name": "NotificationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Notifications/{key}": { "get": { "tags": [ "Reporting/Notifications" ], "summary": "Gets the notification that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ReportingNotifications_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Notification.NotificationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Notifications/Action/UpdateState": { "put": { "tags": [ "Reporting/Notifications" ], "operationId": "ReportingNotifications_UpdateState", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "notificationIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "state", "in": "query", "required": true, "type": "string", "enum": [ "Created", "Processed", "Viewed", "Archived" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Notifications/Destinations": { "get": { "tags": [ "Reporting/Notifications" ], "summary": "Get all notification destinations by notification type", "operationId": "NotificationDestinations_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "notificationTypeId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Notifications/SubscriptionWithDestination": { "get": { "tags": [ "Reporting/Notifications" ], "summary": "Get all notification subscriptions", "operationId": "NotificationSubscriptionWithDestinations_GetAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Notification.NotificationSubscriptionWithDestinationDto" }, "xml": { "name": "NotificationSubscriptionWithDestinationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Notifications" ], "summary": "Create new notification subscription", "operationId": "NotificationSubscriptionWithDestinations_CreateItem", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "newItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Notification.NotificationSubscriptionWithDestinationDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Notification.NotificationSubscriptionWithDestinationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Notifications/SubscriptionWithDestination/{key}": { "get": { "tags": [ "Reporting/Notifications" ], "summary": "Get notification subscription by key", "operationId": "NotificationSubscriptionWithDestinations_GetItemByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Notification.NotificationSubscriptionWithDestinationDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Notifications" ], "summary": "Update notification subscription", "operationId": "NotificationSubscriptionWithDestinations_UpdateItem", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Notification.NotificationSubscriptionWithDestinationDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Notification.NotificationSubscriptionWithDestinationDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/Notifications" ], "summary": "Delete notification subscription", "operationId": "NotificationSubscriptionWithDestinations_DeleteItem", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Notifications/SubscriptionWithDestination/NotificationSubscriptions": { "get": { "tags": [ "Reporting/Notifications" ], "summary": "Flattens notification type and destinations to easily assign enabled notifications by destionation.", "operationId": "NotificationSubscriptionWithDestinations_UserSubscriptions", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Notification.NotificationSubscriptionsForUserDto" }, "xml": { "name": "NotificationSubscriptionsForUserDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Notifications" ], "operationId": "NotificationSubscriptionWithDestinations_UserSubscriptionsUpdate", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Notification.NotificationSubscriptionsForUserDto" }, "xml": { "name": "NotificationSubscriptionsForUserDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Notification.NotificationSubscriptionsForUserDto" }, "xml": { "name": "NotificationSubscriptionsForUserDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Notifications/SummaryCount": { "get": { "tags": [ "Reporting/Notifications" ], "operationId": "ReportingNotifications_GetSummaryCount", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Notification.NotificationCountSummaryDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/NotificationTypes/Simple": { "get": { "tags": [ "Reporting/NotificationTypes" ], "summary": "Gets a simple list of notification types that the logged in user has access to.", "operationId": "ReportingNotificationTypes_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Performance/Action/UpdateAstroTaxData": { "post": { "tags": [ "Reporting/Performance" ], "operationId": "Performance_RunSpecificUpdateAstroTaxData", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Performance/Action/UpdateAstroTaxData/All": { "post": { "tags": [ "Reporting/Performance" ], "operationId": "Performance_RunUpdateAstroTaxData", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Performance/DrillDownSummary": { "post": { "tags": [ "Reporting/Performance" ], "summary": "Used to return a drill down summary of performance. Has the ability to return performance heirarchically as desired. The return will include one benchmark for comparison.", "operationId": "Performance_GetPerformanceDrillDownSummaryAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "settings", "in": "body", "description": "An object used to set many different parameters for performance calculation.\r\n \t\tEntity: Defines what entity/entities to return performance for.\r\n \r\n \t\tEntityIds: Defines the specific ids of the entities to return performance for.\r\n \r\n \t\tGroupings: Defines the order of the drilldown to perform. The following are the grouping options: \r\n \t\t\tClient, Registration, Account, Asset, AssetClass, ProductType, MgmntStyle, RiskCategory, AssetCategory, or AssetLevelStrategy.\r\n \r\n \t\tStartDate: Optional. The start of the range to report.\r\n \t\t\r\n \t\tEndDate: Optional. Default: Today. The end of the range to report.\r\n \t\t\r\n \t\tPeriods:\r\n \t\tOptional. Bitwise parameter for requesting commonly used date ranges.\r\n \t\t1 = MTD\r\n \t\t2 = QTD\r\n \t\t4 = YTD\r\n \t\t8 = 1yr\r\n \t\t16 = 3yr\r\n \t\t32 = 5yr\r\n \t\t64 = 10yr\r\n \t\t128 = inception\r\n \t\t256 = day\r\n \t\t\r\n \t\tBenchmark:\r\n \t\tOptional. Default: \"191531_P\" (S&P 500). The key of the benchmark to use for comparison.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.DrillDownSummaryPerformanceSettingsDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Performance.DrillDownSummaryDto" }, "xml": { "name": "DrillDownSummaryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Performance/DrillDownSummary/ActiveFilters": { "post": { "tags": [ "Reporting/Performance" ], "operationId": "Performance_DrillDownFilters", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "settings", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.DrillDownSummaryPerformanceSettingsDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ActiveFilterListDto" }, "xml": { "name": "ActiveFilterListDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Performance/Overview": { "post": { "tags": [ "Reporting/Performance" ], "summary": "Returns Overview Performance. Overview performance is \"stored\" performance. It is updated once per day with pre-defined periods and settings.", "operationId": "Performance_GetOverviewPerformanceAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Reporting.PerformanceController.OverviewPerformanceRequestParameters" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Reporting.BIController.BIPerformanceWithDateRangeInfoDto" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Performance/ProductStatistics/Run": { "post": { "tags": [ "Reporting/Performance" ], "operationId": "Performance_RunProductStatistics", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Performance/Run/{filename}": { "get": { "tags": [ "Reporting/Performance" ], "summary": "Used to download a previously generated Performance Export.", "operationId": "Performance_RunReportAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "filename", "in": "path", "description": "The filename provided by the generate endpoint.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Performance/Verbose": { "post": { "tags": [ "Reporting/Performance" ], "summary": "Used to verbosely return performance. Has the ability to return performance grouped as desired, benchmark performance, and statistical data for the groups over a number of date ranges.", "operationId": "Performance_GetPerformanceVerboseAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "settings", "in": "body", "description": "An object used to set many different parameters for performance calculation.\r\n \t\tEntity: Defines what entity/entities to return performance for.\r\n \r\n \t\tEntityIds: Defines the specific ids of the entities to return performance for.\r\n \r\n \t\tGroupings: Defines how the assets are grouped for the performance return. Can be set to any of the follow: \r\n \t\t\tClient, Registration, Account, Asset, AssetClass, ProductType, MgmntStyle, RiskCategory, AssetCategory, or AssetLevelStrategy.\r\n \r\n \t\tStartDate: Optional. The start of the range to report.\r\n \t\t\r\n \t\tEndDate: Optional. Default: Today. The end of the range to report.\r\n \t\t\r\n \t\tReturnStyle:\r\n \t\tOptional. Default: 3 PortfolioSummary & PortfolioDaily\r\n \t\t1 = Returns Portfolio Performance Summary\r\n \t\t2 = Returns Portfolio Daily Factors\r\n \t\t4 = Modifies return style 1 to include beginning and ending market value. Also includes accrued interest if performance was calculated including accrued interest.\r\n \t\t8 = Returns Benchmark Performance Summary\r\n \t\t16 = Returns Benchmark Daily Factors\r\n \t\t32 = **does nothing\r\n \t\t64 = Returns Statistical Summary\r\n \t\t\r\n \t\tInterval:\r\n \t\tOptional. Default: \"A\" Automatic. Options are:\r\n \t\t\"A\" Automatic\r\n \t\t\"M\" Monthly\r\n \t\t\"W\" Weekly\r\n \t\t\"D\" Daily\r\n \t\t\r\n \t\tPeriods:\r\n \t\tOptional. Bitwise parameter for requesting commonly used date ranges.\r\n \t\t1 = MTD\r\n \t\t2 = QTD\r\n \t\t4 = YTD\r\n \t\t8 = 1yr\r\n \t\t16 = 3yr\r\n \t\t32 = 5yr\r\n \t\t64 = 10yr\r\n \t\t128 = inception\r\n \t\t256 = day\r\n \t\t\r\n \t\tCalendarYears: Optional. List of calendar years for which performance should be calculated.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VerbosePerformanceSettingsDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Performance.PerformancePortfolio" }, "xml": { "name": "PerformancePortfolio", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Performance/Verbose/Export/xls": { "post": { "tags": [ "Reporting/Performance" ], "operationId": "Performance_GetPerformanceVerboseExportXlsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "settings", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VerbosePerformanceSettingsDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Performance/Verbose/Export/xlsx": { "post": { "tags": [ "Reporting/Performance" ], "operationId": "Performance_GetPerformanceVerboseExportXlsxAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "settings", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VerbosePerformanceSettingsDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/PortalProtoType/Activity": { "post": { "tags": [ "Reporting/PortalProtoType" ], "summary": "", "operationId": "Portal_GetActivity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "setting", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.ActivitySimpleRequestDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/PortalProtoType/Allocation": { "get": { "tags": [ "Reporting/PortalProtoType" ], "summary": "Get a List of Assets with properties that can be used to show allocation by groupings.", "operationId": "Portal_GetAllocation", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "clientId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "displayName", "in": "query", "required": false, "type": "string" }, { "name": "showAccountNumberCharacters", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 4 }, { "name": "includeInActive", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "includeNonIncepted", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "enableBondPriceMultiplier", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/PortalProtoType/Client/{clientId}/NetAmountInvested": { "get": { "tags": [ "Reporting/PortalProtoType" ], "summary": "", "operationId": "Portal_GetClientNetAmountInvested", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/PortalProtoType/DisplayNames": { "get": { "tags": [ "Reporting/PortalProtoType" ], "summary": "Get a List of Display Names for all accounts under the given household ID.", "operationId": "Portal_GetDisplayNames", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "displayName", "in": "query", "required": false, "type": "string" }, { "name": "includeInActive", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/PortalTask": { "get": { "tags": [ "Reporting/PortalTask" ], "operationId": "PortalTask_GetAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "status", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Accepted", "Completed", "Confirmed", "Closed", "Declined", "InProcess", "New", "Pending", "Rejected", "UnAssigned" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.UserTasks.PortalTaskDto" }, "xml": { "name": "PortalTaskDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/PortalTask" ], "operationId": "PortalTask_UpdatePortalTasks", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updatedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.UserTasks.PortalTaskDto" }, "xml": { "name": "PortalTaskDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.UserTasks.PortalTaskDto" }, "xml": { "name": "PortalTaskDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/PortalTask" ], "operationId": "PortalTask_CreateItem", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.UserTasks.PortalTaskDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.UserTasks.PortalTaskDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/PortalTask/{key}": { "get": { "tags": [ "Reporting/PortalTask" ], "summary": "Gets the portal task with the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "PortalTask_GetItemByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.UserTasks.PortalTaskDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/PortalTask" ], "operationId": "PortalTask_UpdatePortalTask", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.UserTasks.PortalTaskDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.UserTasks.PortalTaskDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/PortalTask" ], "operationId": "PortalTask_DeletePortalTask", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/PortalTask/EStatementEmail": { "post": { "tags": [ "Reporting/PortalTask" ], "operationId": "PortalTask_EmailToClient", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "setting", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Reporting.PortalTaskController.EStatementDto" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/PortalTask/Simple": { "get": { "tags": [ "Reporting/PortalTask" ], "summary": "Gets a simple list of portal tasks that the logged in user has access to.", "operationId": "PortalTask_GetAllSimpleEntities", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "object" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Preview": { "post": { "tags": [ "Reporting/Preview" ], "operationId": "Preview_GeneratePreview", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "preview", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.PreviewDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Preview/Calculate/InceptionDate/{entity}/{entityId}": { "get": { "tags": [ "Reporting/Preview" ], "operationId": "Preview_GetPreviewInceptionDate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "required": true, "type": "string" }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RunReport.InceptionDateDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ProcessManager/ActionTypes": { "get": { "tags": [ "Reporting/ProcessManager" ], "operationId": "ProcessManagers_GetActionTypes", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "typeId", "in": "query", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ProcessManager/Dashboard": { "get": { "tags": [ "Reporting/ProcessManager" ], "operationId": "ProcessManagers_GetAllDashboardsOfType", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "workflowTypeId", "in": "query", "required": true, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataProcess.DTO.Reporting.ProcessManagerSimpleDto" }, "xml": { "name": "ProcessManagerSimpleDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/ProcessManager" ], "operationId": "ProcessManagers_CreateNewDashboardAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "newItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.DTO.Reporting.ProcessManagerDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.DTO.Reporting.ProcessManagerDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ProcessManager/Dashboard/{key}": { "get": { "tags": [ "Reporting/ProcessManager" ], "operationId": "ProcessManagers_GetDashboardAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.DTO.Reporting.ProcessManagerDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/ProcessManager" ], "operationId": "ProcessManagers_UpdateWorkflowAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dashboard", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.DTO.Reporting.ProcessManagerDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.DTO.Reporting.ProcessManagerDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/ProcessManager" ], "operationId": "ProcessManagers_Delete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ProcessManager/Dashboard/{key}/Action/Lockdown": { "put": { "tags": [ "Reporting/ProcessManager" ], "operationId": "ProcessManagers_LockdownDashboardAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.DTO.Reporting.ProcessManagerDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ProcessManager/Dashboard/{key}/WorkflowAction/{workflowActionId}/Action/SignOff": { "put": { "tags": [ "Reporting/ProcessManager" ], "operationId": "ProcessManagers_Signoff", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "workflowActionId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.DTO.Reporting.ProcessWorkflowDetailsDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ProcessManager/Dashboard/{key}/WorkflowAction/{workflowActionId}/Action/SignOff/Lock": { "put": { "tags": [ "Reporting/ProcessManager" ], "operationId": "ProcessManagers_LockSignoff", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "workflowActionId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "isLocked", "in": "query", "required": true, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.DTO.Reporting.ProcessWorkflowDetailsDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ProcessManager/Dashboard/{key}/WorkflowAction/{workflowActionId}/Action/SignOff/Revoke": { "put": { "tags": [ "Reporting/ProcessManager" ], "operationId": "ProcessManagers_RewokeSignoff", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "workflowActionId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.DTO.Reporting.ProcessWorkflowDetailsDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ProcessManager/Dashboard/tasks": { "get": { "tags": [ "Reporting/ProcessManager" ], "operationId": "ProcessManagers_GetDashboardTasksAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "period", "in": "query", "required": true, "type": "string", "enum": [ "Quarterly", "Monthly", "TriAnnually" ] }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ProcessManager/Phases": { "get": { "tags": [ "Reporting/ProcessManager" ], "operationId": "ProcessManagers_GetPhases", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "typeId", "in": "query", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ProcessManager/Types": { "get": { "tags": [ "Reporting/ProcessManager" ], "operationId": "ProcessManagers_GetTypes", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ProcessManager/Workflows": { "get": { "tags": [ "Reporting/ProcessManager" ], "operationId": "ProcessManagers_GetWorkflows", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "typeId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Qpe.WorkflowItemDto" }, "xml": { "name": "WorkflowItemDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Proto/Controls": { "get": { "tags": [ "Reporting/Proto" ], "operationId": "ReportProto_GetReportControls", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportControlDto" }, "xml": { "name": "ReportControlDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Qpe": { "get": { "tags": [ "Reporting/Qpe" ], "operationId": "Qpe_GetAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Qpe.QpeItemDto" }, "xml": { "name": "QpeItemDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Qpe/{key}/DashboardNewsletter": { "get": { "tags": [ "Reporting/Qpe" ], "operationId": "Qpe_DownloadNewsletter", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Qpe" ], "operationId": "Qpe_UploadDashboardNewsletterAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Qpe/{qpeItemId}": { "get": { "tags": [ "Reporting/Qpe" ], "operationId": "Qpe_GetItemDetails", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "qpeItemId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Qpe.QpeItemDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Qpe/{qpeItemId}/Dashboard": { "get": { "tags": [ "Reporting/Qpe" ], "summary": "", "operationId": "Qpe_GetDashboardDetails", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "qpeItemId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "storeSnapshotData", "in": "query", "description": "Determins if data should be stored in the QpeDetailstbl", "required": false, "type": "boolean", "default": false }, { "name": "getStoredData", "in": "query", "description": "Determins if data is retrived in real time or from QpeDashboardDtl table", "required": false, "type": "boolean", "default": false }, { "name": "resetCache", "in": "query", "description": "Optional. Default: false. The result is cached for one hour. To force the cache to refresh call with resetCache = true.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Qpe/{qpeItemId}/DrillDown": { "get": { "tags": [ "Reporting/Qpe" ], "operationId": "Qpe_GetQpeDashboardDtlDrillDown", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "qpeItemId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "linkCode", "in": "query", "required": true, "type": "string", "enum": [ "FeeSchFlat", "FeeSchTiered", "FeeSchLinear", "PaySched" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.QpeDashboard.SpimQpeDashboardDtlGetDrillDown" }, "xml": { "name": "SpimQpeDashboardDtlGetDrillDown", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ReportGroups": { "get": { "tags": [ "Reporting/ReportGroups" ], "summary": "List all report groups accessible by current user", "operationId": "ReportGroups_GetReportGroupsForUser", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportGroupDto" }, "xml": { "name": "ReportGroupDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/ReportGroups" ], "summary": "Insert a report group", "operationId": "ReportGroups_CreateReportGroup", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "reportGroup", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportGroupDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportGroupDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ReportGroups/{reportGroupId}": { "get": { "tags": [ "Reporting/ReportGroups" ], "summary": "Get report group info by Id", "operationId": "ReportGroups_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "reportGroupId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportGroupDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/ReportGroups" ], "summary": "Update report group", "operationId": "ReportGroups_UpdateReportGroup", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "reportGroupId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "reportGroup", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportGroupDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportGroupDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/ReportGroups" ], "summary": "Delete a report group", "operationId": "ReportGroups_DeleteReportGroup", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reportGroupId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ReportGroups/Simple": { "get": { "tags": [ "Reporting/ReportGroups" ], "summary": "Gets a simple list of report groups that the logged in user has access to.", "operationId": "ReportGroups_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "object" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ReportInbox": { "get": { "tags": [ "Reporting/ReportInbox" ], "summary": "Gets a list of report inboxs that the logged in user has access to.", "operationId": "ReportInbox_GetAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportInboxDto" }, "xml": { "name": "ReportInboxDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ReportInbox/{key}": { "get": { "tags": [ "Reporting/ReportInbox" ], "summary": "Gets the report inbox with the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ReportInbox_GetItemByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportInboxDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/ReportInbox" ], "operationId": "ReportInbox_Delete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ReportInbox/{key}/Download": { "get": { "tags": [ "Reporting/ReportInbox" ], "summary": "Used to download a file from report inbox.", "operationId": "ReportInbox_DownloadReportInbox", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ReportPackages": { "get": { "tags": [ "Reporting/ReportPackages" ], "operationId": "ReportPackages_GetReportPackagesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ReportPackages/{reportPackageId}": { "get": { "tags": [ "Reporting/ReportPackages" ], "operationId": "ReportPackages_GetV1ReportingReportPackagesByReportPackageId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reportPackageId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ReportPackages/{reportPackageId}/Favorite": { "put": { "tags": [ "Reporting/ReportPackages" ], "operationId": "ReportPackages_UpdateFavoriteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reportPackageId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ReportPackages/AdHocSettings": { "post": { "tags": [ "Reporting/ReportPackages" ], "operationId": "ReportPackages_GetAdHocSettingsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportPackages.ReportPackageAdHocSettingsRequestDto" } }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ReportPackages/run": { "post": { "tags": [ "Reporting/ReportPackages" ], "operationId": "ReportPackages_PostReportPackageAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportPackages.ReportPackageRunRequest" } }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ReportPackages/run/{downloadId}": { "get": { "tags": [ "Reporting/ReportPackages" ], "operationId": "ReportPackages_DownloadPdfAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "downloadId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ReportPackages/Verbose": { "get": { "tags": [ "Reporting/ReportPackages" ], "operationId": "ReportPackagesVerbose_GetReportPackagesForUserAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Schema", "DatabaseGroupAccessRules", "DatabaseAccessRules", "LoginAccessRules", "RoleAccessRules", "UserAccessRules", "RepresentativeAccessRules", "All", "AllAccessRules" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/ReportPackages" ], "operationId": "ReportPackagesVerbose_AddReportPackageAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportPackages.ReportPackageVerboseDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ReportPackages/Verbose/{key}": { "get": { "tags": [ "Reporting/ReportPackages" ], "operationId": "ReportPackagesVerbose_GetReportPackageAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "ct", "in": "header", "required": true }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Schema", "DatabaseGroupAccessRules", "DatabaseAccessRules", "LoginAccessRules", "RoleAccessRules", "UserAccessRules", "RepresentativeAccessRules", "All", "AllAccessRules" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/ReportPackages" ], "operationId": "ReportPackagesVerbose_UpdateReportPackageAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportPackages.ReportPackageVerboseDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/ReportPackages" ], "operationId": "ReportPackagesVerbose_DeleteReportPackageAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ReportPackages/Verbose/{key}/ReportReferenceReportPackage": { "get": { "tags": [ "Reporting/ReportPackages" ], "operationId": "ReportPackagesVerbose_GetReportReferenceReportPackageAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Reports": { "get": { "tags": [ "Reporting/Reports" ], "operationId": "RunReports_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "menu", "in": "query", "required": false, "type": "string" }, { "name": "orionConnectMenu", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "parentCategory", "in": "query", "required": false, "type": "string" }, { "name": "type", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Ssrs", "Envision", "All" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "isDeleted", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RunReport.ReportBaseDto" }, "xml": { "name": "ReportBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Reports/{key}/Calculate/InceptionDate": { "post": { "tags": [ "Reporting/Reports" ], "summary": "Used to calculate the appropriate inception date for the provided report. The unstorable parameters \"EntityEnum\" and \r\n\"pkEntity\" must be provided. Together they dictate the entity that the defaults are being saved for. The successful return \r\nwill be 201 Created with the location set to the url of the newly generated file.", "operationId": "RunReports_PostV1ReportingReportsByKeyCalculateInceptionDate", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "report", "in": "body", "description": "An object that contains the parameters for this report run.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RunReport.RunReportDto" } }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RunReport.InceptionDateDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Reports/{key}/Generate": { "post": { "tags": [ "Reporting/Reports" ], "summary": "Used to generate a report pdf with the provided report parameters. The successful return will be 201 Created \r\nwith the location set to the url of the newly generated file.\r\n\r\nWhen the Entities array is populated this will generate one report per entity in that array.", "operationId": "RunReports_GenerateRb2ReportAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "report", "in": "body", "description": "An object that contains the parameters for this report run.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RunReport.RunReportDto" } }, { "name": "waitForReport", "in": "query", "description": "Optional. Default: false. If true the response will be sent when the file has finished generating. If false a response will be generated immediately unless directly downloading the report.", "required": false, "type": "boolean", "default": false }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Reports/{key}/Generate/{session}/Status": { "get": { "tags": [ "Reporting/Reports" ], "summary": "Used to get the status of a previously requested report generation.", "operationId": "RunReports_GenerateStatus", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "session", "in": "path", "description": "The session provided by the generate endpoint.", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RunReport.BatchReportGenerationStatus" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Reports/{key}/Parameters/EntityDefaults": { "put": { "tags": [ "Reporting/Reports" ], "summary": "Used to save the entity level default parameters for a the provided report. The unstorable parameters \"EntityEnum\" and \r\n\"pkEntity\" must be provided. Together they dictate the entity that the defaults are being saved for. The successful return \r\nwill be 201 Created with the location set to the url of the newly generated file.", "operationId": "RunReports_PutV1ReportingReportsByKeyParametersEntityDefaults", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "report", "in": "body", "description": "An object that contains the parameters for this report run.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RunReport.RunReportDto" } }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Reports" ], "summary": "Used to save the entity level default parameters for a the provided report. The unstorable parameters \"EntityEnum\" and \r\n\"pkEntity\" must be provided. Together they dictate the entity that the defaults are being saved for. The successful return \r\nwill be 201 Created with the location set to the url of the newly generated file.", "operationId": "RunReports_SaveEntityDefaultParametersAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "report", "in": "body", "description": "An object that contains the parameters for this report run.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RunReport.RunReportDto" } }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Reports/{key}/Parameters/EntityDefaults/Delete/{entity}/{entityId}": { "post": { "tags": [ "Reporting/Reports" ], "summary": "Used to delete the entity level default parameters for a the provided report. The successful return will be 204 No Content.", "operationId": "RunReports_DeleteEntityDefaultParametersAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "entity", "in": "path", "description": "The kind of entity that the parameters will be saved for.", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "path", "description": "The key of the entity that the parameters will be saved for.", "required": true, "type": "integer", "format": "int32" }, { "name": "runAssignedVersion", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Reports/{key}/Parameters/ReportDefaults": { "put": { "tags": [ "Reporting/Reports" ], "summary": "Used to save the report level default parameters for a the provided report. The successful return will be 201 Created.", "operationId": "RunReports_PutV1ReportingReportsByKeyParametersReportDefaults", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "report", "in": "body", "description": "An object that contains the parameters for this report run.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RunReport.RunReportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Reports" ], "summary": "Used to save the report level default parameters for a the provided report. The successful return will be 201 Created.", "operationId": "RunReports_SaveReportDefaultParametersAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "report", "in": "body", "description": "An object that contains the parameters for this report run.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RunReport.RunReportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Reports/{key}/Parameters/ReportDefaults/Delete": { "post": { "tags": [ "Reporting/Reports" ], "summary": "Used to delete the report level default parameters for a the provided report. The successful return will be 204 No Content.", "operationId": "RunReports_DeleteReportDefaultParametersAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "report", "in": "body", "description": "An object that contains the parameters for this report run.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RunReport.RunReportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Reports/{key}/Parameters/UserDefaults": { "put": { "tags": [ "Reporting/Reports" ], "summary": "Used to save the user level default parameters for a the provided report. The successful return will be 201 Created.", "operationId": "RunReports_PutV1ReportingReportsByKeyParametersUserDefaults", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "report", "in": "body", "description": "An object that contains the parameters for this report run.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RunReport.RunReportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Reports" ], "summary": "Used to save the user level default parameters for a the provided report. The successful return will be 201 Created.", "operationId": "RunReports_SaveUserDefaultParametersAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "report", "in": "body", "description": "An object that contains the parameters for this report run.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RunReport.RunReportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Reports/{key}/Parameters/UserDefaults/Delete": { "post": { "tags": [ "Reporting/Reports" ], "summary": "Used to delete the user level default parameters for a the provided report. The successful return will be 204 No Content.", "operationId": "RunReports_DeleteUserDefaultParametersAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "report", "in": "body", "description": "An object that contains the parameters for this report run.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RunReport.RunReportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Reports/{reportId}": { "get": { "tags": [ "Reporting/Reports" ], "summary": "Gets a dictionary of all the parameters used in all sections that the logged in user has access to. The dictionary key is the section key. The dictionary value is a list of parameters for the section.", "operationId": "RunReports_GetParametersAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reportId", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "string", "format": "uuid" }, { "name": "ct", "in": "header", "required": true }, { "name": "runAssignedVersion", "in": "query", "description": "Optional. Default: true. If true a version look up will occur where any entity assigned to a version will run that version instead of the provided report. If false the report specified will always ben run regaurdless of version assignment.", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.EnvisionReportDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Reports" ], "summary": "Fills in the storable paramaters (if any) for the provided report that has the entity filled in.", "operationId": "RunReports_PutV1ReportingReportsByReportId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reportId", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "string", "format": "uuid" }, { "name": "report", "in": "body", "description": "The report that storable entities will be added into.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.EnvisionReportDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.EnvisionReportDto" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Reports" ], "summary": "Fills in the storable paramaters (if any) for the provided report that has the entity filled in.", "operationId": "RunReports_PostV1ReportingReportsByReportId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reportId", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "string", "format": "uuid" }, { "name": "report", "in": "body", "description": "The report that storable entities will be added into.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.EnvisionReportDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.EnvisionReportDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Reports/{reportId}/Calculate/InceptionDate": { "post": { "tags": [ "Reporting/Reports" ], "summary": "Used to calculate the appropriate inception date for the provided report. The unstorable parameters \"EntityEnum\" and \r\n\"pkEntity\" must be provided. Together they dictate the entity that the defaults are being saved for. The successful return \r\nwill be 201 Created with the location set to the url of the newly generated file.", "operationId": "RunReports_CalculateInceptionDateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "reportId", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "string", "format": "uuid" }, { "name": "report", "in": "body", "description": "An object that contains the parameters for this report run.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.EnvisionReportDto" } }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RunReport.InceptionDateDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Reports/{reportId}/Generate": { "post": { "tags": [ "Reporting/Reports" ], "summary": "Used to generate a report pdf with the provided report parameters. The successful return will be 201 Created \r\nwith the location set to the url of the newly generated file.\r\n\r\nWhen the Entities array is populated this will generate one report per entity in that array.", "operationId": "RunReports_GenerateRb3ReportAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reportId", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "string", "format": "uuid" }, { "name": "report", "in": "body", "description": "An object that contains the parameters for this report run.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.EnvisionReportDto" } }, { "name": "waitForReport", "in": "query", "description": "Optional. Default: false. If true the response will be sent when the file has finished generating. If false a response will be generated immediately unless directly downloading the report.", "required": false, "type": "boolean", "default": false }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Reports/{reportId}/Parameters": { "get": { "tags": [ "Reporting/Reports" ], "summary": "Gets a dictionary of all the parameters used in all sections that the logged in user has access to. The dictionary key is the section key. The dictionary value is a list of parameters for the section.", "operationId": "RunReports_GetV1ReportingReportsByReportIdParameters", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reportId", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "string", "format": "uuid" }, { "name": "ct", "in": "header", "required": true }, { "name": "runAssignedVersion", "in": "query", "description": "Optional. Default: true. If true a version look up will occur where any entity assigned to a version will run that version instead of the provided report. If false the report specified will always ben run regaurdless of version assignment.", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.EnvisionReportDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Reports" ], "summary": "Fills in the storable paramaters (if any) for the provided report that has the entity filled in.", "operationId": "RunReports_PutV1ReportingReportsByReportIdParameters", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reportId", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "string", "format": "uuid" }, { "name": "report", "in": "body", "description": "The report that storable entities will be added into.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.EnvisionReportDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.EnvisionReportDto" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Reports" ], "summary": "Fills in the storable paramaters (if any) for the provided report that has the entity filled in.", "operationId": "RunReports_PostV1ReportingReportsByReportIdParameters", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reportId", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "string", "format": "uuid" }, { "name": "report", "in": "body", "description": "The report that storable entities will be added into.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.EnvisionReportDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.EnvisionReportDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Reports/{reportId}/Parameters/{parentParameterName}/{parentParameterValue}/ChildOptions": { "get": { "tags": [ "Reporting/Reports" ], "summary": "For a given parent parameter/value, it returns options fo rthe child parameter. This is used for a pair of report paramaters that have a parent - child relationship. Where when the user chooses a parent, the child combo needs to be reloaded.", "operationId": "RunReports_GetChildOptionsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reportId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "parentParameterName", "in": "path", "required": true, "type": "string" }, { "name": "parentParameterValue", "in": "path", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Reports/{reportId}/ReportInboxes": { "put": { "tags": [ "Reporting/Reports" ], "summary": "Gets a list of the valid report inbox options.", "operationId": "RunReports_PutV1ReportingReportsByReportIdReportInboxes", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "reportId", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "report", "in": "body", "description": "The report that storable entities will be added into.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RunReport.RunReportDto" } }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Reports" ], "summary": "Gets a list of the valid report inbox options.", "operationId": "RunReports_GetReportInboxesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "reportId", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "report", "in": "body", "description": "The report that storable entities will be added into.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RunReport.RunReportDto" } }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Reports/{reportId}/Run/{fileGuid}": { "get": { "tags": [ "Reporting/Reports" ], "summary": "Used to download a previously generated report pdf.", "operationId": "RunReports_RunReportAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reportId", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "string", "format": "uuid" }, { "name": "fileGuid", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "head": { "tags": [ "Reporting/Reports" ], "summary": "Used to download a previously generated report pdf.", "operationId": "RunReports_HeadV1ReportingReportsByReportIdRunByFileGuid", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reportId", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "string", "format": "uuid" }, { "name": "fileGuid", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Reports/Code/{code}": { "get": { "tags": [ "Reporting/Reports" ], "summary": "Gets a dictionary of all the parameters used in all sections that the logged in user has access to. The dictionary key is the section key. The dictionary value is a list of parameters for the section.", "operationId": "RunReports_GetReportByCodeAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "code", "in": "path", "description": "Code of the desired report.", "required": true, "type": "string" }, { "name": "runAssignedVersion", "in": "query", "description": "Optional. Default: true. If true a version look up will occur where any entity assigned to a version will run that version instead of the provided report. If false the report specified will always ben run regaurdless of version assignment.", "required": false, "type": "boolean", "default": true }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RunReport.RunReportDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Reports/Simple/Search": { "get": { "tags": [ "Reporting/Reports" ], "operationId": "RunReports_GetReportSimpleSearchAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "menu", "in": "query", "required": false, "type": "string" }, { "name": "orionConnectMenu", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "parentCategory", "in": "query", "required": false, "type": "string" }, { "name": "type", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Ssrs", "Envision", "All" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "isDeleted", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "top", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntityBase" }, "xml": { "name": "SimpleEntityBase", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Reports/Simple/Search/{search}": { "get": { "tags": [ "Reporting/Reports" ], "operationId": "RunReports_GetV1ReportingReportsSimpleSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "search", "in": "path", "required": true, "type": "string" }, { "name": "menu", "in": "query", "required": false, "type": "string" }, { "name": "orionConnectMenu", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "parentCategory", "in": "query", "required": false, "type": "string" }, { "name": "type", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Ssrs", "Envision", "All" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "isDeleted", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "top", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntityBase" }, "xml": { "name": "SimpleEntityBase", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ReportTemplates": { "get": { "tags": [ "Reporting/ReportTemplates" ], "operationId": "ReportTemplates_GetReportTemplatesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "canEdit", "in": "query", "required": false, "type": "boolean" }, { "name": "canDelete", "in": "query", "required": false, "type": "boolean" }, { "name": "isStandardTemplate", "in": "query", "required": false, "type": "boolean" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ReportTemplates/{reportTemplateId}": { "get": { "tags": [ "Reporting/ReportTemplates" ], "operationId": "ReportTemplates_GetReportTemplateAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reportTemplateId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ReportTemplates/{reportTemplateId}/Favorite": { "put": { "tags": [ "Reporting/ReportTemplates" ], "operationId": "ReportTemplates_UpdateFavoriteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reportTemplateId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ReportTemplates/{reportTemplateId}/HasThumbnail": { "get": { "tags": [ "Reporting/ReportTemplates" ], "operationId": "ReportTemplates_HasThumbnailAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reportTemplateId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ReportTemplates/{reportTemplateId}/Outline": { "get": { "tags": [ "Reporting/ReportTemplates" ], "operationId": "ReportTemplates_GetReportTemplateOutlineAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reportTemplateId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ReportTemplates/{reportTemplateId}/Thumbnail": { "get": { "tags": [ "Reporting/ReportTemplates" ], "operationId": "ReportTemplates_GetTemplateThumbnailAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reportTemplateId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/ReportTemplates" ], "operationId": "ReportTemplates_DeleteTemplateThumbnailAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reportTemplateId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ReportTemplates/{reportTemplateId}/Thumbnail/Upload": { "post": { "tags": [ "Reporting/ReportTemplates" ], "operationId": "ReportTemplates_UploadThumbnailAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "reportTemplateId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "file", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportTemplates.ReportThumbnailFileDto" } }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ReportTemplates/Categories": { "get": { "tags": [ "Reporting/ReportTemplates" ], "operationId": "ReportTemplates_GetCategoriesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ReportTemplates/Verbose": { "get": { "tags": [ "Reporting/ReportTemplates" ], "operationId": "ReportTemplatesVerbose_GetVerboseTemplatesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Schema", "RequiredOptions", "AdditionalOptions", "DatabaseGroupAccessRules", "DatabaseAccessRules", "LoginAccessRules", "RoleAccessRules", "UserAccessRules", "All", "AllOptions", "AllAccessRules" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/ReportTemplates" ], "operationId": "ReportTemplatesVerbose_CreateReportTemplateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportTemplates.ReportTemplateVerboseDto" } }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ReportTemplates/Verbose/{key}": { "get": { "tags": [ "Reporting/ReportTemplates" ], "operationId": "ReportTemplatesVerbose_GetVerboseTemplateAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Portfolio", "Schema", "RequiredOptions", "AdditionalOptions", "DatabaseGroupAccessRules", "DatabaseAccessRules", "LoginAccessRules", "RoleAccessRules", "UserAccessRules", "All", "AllOptions", "AllAccessRules" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/ReportTemplates" ], "operationId": "ReportTemplatesVerbose_UpdateReportTemplateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportTemplates.ReportTemplateVerboseDto" } }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/ReportTemplates" ], "operationId": "ReportTemplatesVerbose_DeleteReportTemplateAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ReportTemplates/Verbose/{key}/Actions/Clone": { "post": { "tags": [ "Reporting/ReportTemplates" ], "operationId": "ReportTemplatesVerbose_CloneReportTemplateAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cloneIntoNonStandard", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ReportTemplates/Verbose/New": { "get": { "tags": [ "Reporting/ReportTemplates" ], "operationId": "ReportTemplatesVerbose_GetNewVerboseAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "useGlobals", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportTemplates.ReportTemplateVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/RequiredMinimumDistribution/Accounts": { "get": { "tags": [ "Reporting/RequiredMinimumDistribution" ], "operationId": "RequiredMinimumDistribution_GetRmdAccountCalculationsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "filter", "in": "query", "required": false, "type": "string", "enum": [ "OffTrack", "OnTrack", "RmdSatisfied" ] }, { "name": "clientId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataAccess.Reporting.RequiredMinimumDistribution.RmdDashboardBaseDto" }, "xml": { "name": "RmdDashboardBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/RequiredMinimumDistribution/Accounts/{accountId}/notes": { "put": { "tags": [ "Reporting/RequiredMinimumDistribution" ], "operationId": "RequiredMinimumDistribution_UpdateRmdAccountRMDNotesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "rmdNotes", "in": "body", "required": true, "schema": { "type": "string" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataAccess.Reporting.RequiredMinimumDistribution.RmdDashboardBaseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/RequiredMinimumDistribution/Accounts/{accountId}/RmdAmountOverride": { "put": { "tags": [ "Reporting/RequiredMinimumDistribution" ], "operationId": "RequiredMinimumDistribution_UpdateRmdAccountRmdAmountOverrideAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "value", "in": "query", "required": true, "type": "number", "format": "double" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataAccess.Reporting.RequiredMinimumDistribution.RmdDashboardBaseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/RequiredMinimumDistribution/Accounts/{accountId}/satisfied/{isSatisfied}": { "put": { "tags": [ "Reporting/RequiredMinimumDistribution" ], "operationId": "RequiredMinimumDistribution_UpdateRmdAccountIsSatisfiedAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "isSatisfied", "in": "path", "required": true, "type": "boolean" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataAccess.Reporting.RequiredMinimumDistribution.RmdDashboardBaseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/RequiredMinimumDistribution/Accounts/{accountId}/YearEnd": { "put": { "tags": [ "Reporting/RequiredMinimumDistribution" ], "operationId": "RequiredMinimumDistribution_UpdateRmdAccountYearEndValueAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "value", "in": "query", "required": true, "type": "number", "format": "double" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataAccess.Reporting.RequiredMinimumDistribution.RmdDashboardBaseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/RequiredMinimumDistribution/Accounts/Custom": { "get": { "tags": [ "Reporting/RequiredMinimumDistribution" ], "operationId": "RequiredMinimumDistribution_GetRmdAccountCustomFieldsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataProcess.Reporting.RequiredMinimumDistribution.CustomFieldColumn" }, "xml": { "name": "CustomFieldColumn", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/RequiredMinimumDistribution/Action/RunSchwabRmd": { "post": { "tags": [ "Reporting/RequiredMinimumDistribution" ], "operationId": "RequiredMinimumDistribution_RunSchwabRmdDataRetrievalProcess", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/RequiredMinimumDistribution/Calculate": { "post": { "tags": [ "Reporting/RequiredMinimumDistribution" ], "operationId": "RequiredMinimumDistribution_CalculateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "includeZeroValue", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataAccess.Domains.Reporting.RequiredMinimumDistribution.RmdDetail" }, "xml": { "name": "RmdDetail", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/RequiredMinimumDistribution/CalculateAccountsSave": { "post": { "tags": [ "Reporting/RequiredMinimumDistribution" ], "operationId": "RequiredMinimumDistribution_CalculateAccountsSaveAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "accountIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "includeZeroValue", "in": "query", "required": false, "type": "boolean" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/RequiredMinimumDistribution/CalculateRegistrationsSave": { "post": { "tags": [ "Reporting/RequiredMinimumDistribution" ], "operationId": "RequiredMinimumDistribution_CalculateRegistrationsSaveAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "registrationIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "includeZeroValue", "in": "query", "required": false, "type": "boolean" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/RequiredMinimumDistribution/Registrations": { "get": { "tags": [ "Reporting/RequiredMinimumDistribution" ], "operationId": "RequiredMinimumDistribution_GetRmdRegistrationCalculationsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "filter", "in": "query", "required": false, "type": "string", "enum": [ "OffTrack", "OnTrack", "RmdSatisfied" ] }, { "name": "clientId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataAccess.Reporting.RequiredMinimumDistribution.RmdDashboardBaseDto" }, "xml": { "name": "RmdDashboardBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/RequiredMinimumDistribution/Registrations/{registrationId}/notes": { "put": { "tags": [ "Reporting/RequiredMinimumDistribution" ], "operationId": "RequiredMinimumDistribution_UpdateRmdRegistrationRMDNotesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "registrationId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "rmdNotes", "in": "body", "required": true, "schema": { "type": "string" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataAccess.Reporting.RequiredMinimumDistribution.RmdDashboardBaseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/RequiredMinimumDistribution/Registrations/{registrationId}/satisfied/{isSatisfied}": { "put": { "tags": [ "Reporting/RequiredMinimumDistribution" ], "operationId": "RequiredMinimumDistribution_UpdateRmdRegistrationIsSatisfiedAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "registrationId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "isSatisfied", "in": "path", "required": true, "type": "boolean" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataAccess.Reporting.RequiredMinimumDistribution.RmdDashboardBaseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/RequiredMinimumDistribution/RmdCalculationCounts": { "get": { "tags": [ "Reporting/RequiredMinimumDistribution" ], "operationId": "RequiredMinimumDistribution_GetRmdCalculationCountsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "additionalProperties": { "type": "object" }, "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Scope": { "post": { "tags": [ "Reporting/Scope" ], "summary": "Used to create a reporting scope", "operationId": "Scope_CreateScopeAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "settings", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Calculate.ScopeSettingsDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Calculate.ScopeDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ScrubSchedules": { "get": { "tags": [ "Reporting/ScrubSchedules" ], "summary": "Gets a list of scrub schedule that the logged in user has access to.\r\nThe return is limited to pages of 1000. Use $top and $skip in the query string to page through the data.", "operationId": "ScrubSchedules_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RunReport.ScrubScheduleDto" }, "xml": { "name": "ScrubScheduleDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/ScrubSchedules" ], "summary": "Used to create a new scrub schedule. Upon successful creation a 201 will be returned with the location of the nearly created scrub schedule.", "operationId": "ScrubSchedules_Create", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RunReport.ScrubScheduleDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ScrubSchedules/{key}": { "get": { "tags": [ "Reporting/ScrubSchedules" ], "summary": "Gets the scrub schedule that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ScrubSchedules_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RunReport.ScrubScheduleDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/ScrubSchedules" ], "summary": "Used to update an existing Scrub Schedule. Upon successful modification a 200 will be returned.", "operationId": "ScrubSchedules_Update", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RunReport.ScrubScheduleDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RunReport.ScrubScheduleDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/ScrubSchedules" ], "summary": "Used to delete an existing Scrub Schedule. Upon successful deletion a 204 will be returned.", "operationId": "ScrubSchedules_Delete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/ScrubSchedules/Simple": { "get": { "tags": [ "Reporting/ScrubSchedules" ], "summary": "Gets a simple list of scrub schedule that the logged in user has access to.", "operationId": "ScrubSchedules_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/StaticFiles": { "post": { "tags": [ "Reporting/StaticFiles" ], "operationId": "StaticFiles_PostV1ReportingStaticFiles", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "file", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientPortalStaticFileDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/StaticFiles/{fileType}": { "get": { "tags": [ "Reporting/StaticFiles" ], "summary": "Gets a list of specific static documents.", "operationId": "StaticFiles_GetBlobs", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "fileType", "in": "path", "required": true, "type": "string", "enum": [ "ClientPortalStatic", "RmdDashboard", "RmdMailMerge", "RmdMailMergeTemplate", "BillingAuditFile", "InsightDocument" ] }, { "name": "startDate", "in": "query", "description": "Optional. Default null. If provided only documents that come after the start date will be returned.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default null. If provided only documents that come before the end date will be returned.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" }, "xml": { "name": "BlobBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/StaticFiles" ], "summary": "Adds a new advisor file.", "operationId": "StaticFiles_CreateBlobAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "fileType", "in": "path", "description": "The type of file to add. Can be set to any of the following:\r\n ClientPortalStatic", "required": true, "type": "string", "enum": [ "ClientPortalStatic", "RmdDashboard", "RmdMailMerge", "RmdMailMergeTemplate", "BillingAuditFile", "InsightDocument" ] } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/StaticFiles/{fileType}/{fileId}": { "get": { "tags": [ "Reporting/StaticFiles" ], "summary": "Gets the raw data of the specific file with the blobId provided which is an advisor file.", "operationId": "StaticFiles_GetBlob", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "fileType", "in": "path", "description": "The type of file to return. Can be set to any of the following:\r\n ClientPortalStatic", "required": true, "type": "string", "enum": [ "ClientPortalStatic", "RmdDashboard", "RmdMailMerge", "RmdMailMergeTemplate", "BillingAuditFile", "InsightDocument" ] }, { "name": "fileId", "in": "path", "description": "Key of the file to be downloaded.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/StaticFiles" ], "summary": "Deletes the specific file with the blobId provided which is an advisor file.", "operationId": "StaticFiles_DeleteBlob", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "fileType", "in": "path", "description": "The type of file to delete. Can be set to any of the following:\r\n ClientPortalStatic", "required": true, "type": "string", "enum": [ "ClientPortalStatic", "RmdDashboard", "RmdMailMerge", "RmdMailMergeTemplate", "BillingAuditFile", "InsightDocument" ] }, { "name": "fileId", "in": "path", "description": "Key of the file to be deleted.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/StaticFiles/{key}": { "get": { "tags": [ "Reporting/StaticFiles" ], "operationId": "StaticFiles_GetBlobDto", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/VideoStatements": { "get": { "tags": [ "Reporting/VideoStatements" ], "operationId": "VideoStatements_GetAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VideoStatements.VideoStatementDto" }, "xml": { "name": "VideoStatementDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/VideoStatements" ], "operationId": "VideoStatements_UpdateVideoStatement", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VideoStatements.VideoStatementDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VideoStatements.VideoStatementDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/VideoStatements/{videoStatementId}": { "get": { "tags": [ "Reporting/VideoStatements" ], "operationId": "VideoStatements_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "videoStatementId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VideoStatements.VideoStatementDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/VideoStatements" ], "operationId": "VideoStatements_UpdateVideoStatementAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "videoStatementId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VideoStatements.VideoStatementDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VideoStatements.VideoStatementDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/VideoStatements/{videoStatementId}/Clients": { "get": { "tags": [ "Reporting/VideoStatements" ], "operationId": "VideoStatements_GetVideoStatementClients", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "videoStatementId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleClient" }, "xml": { "name": "SimpleClient", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/VideoStatements/{videoStatementId}/Clients/{clientId}": { "get": { "tags": [ "Reporting/VideoStatements" ], "operationId": "VideoStatements_GetVideoStatementData", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "videoStatementId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/VideoStatements/{videoStatementId}/Video": { "get": { "tags": [ "Reporting/VideoStatements" ], "summary": "This is a redirect endpoint that would auto-redirect users to the videostatements endpoint and log the api call", "operationId": "VideoStatements_RedirectToVideo", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "videoStatementId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/VideoStatements/Mock/{entityId}": { "get": { "tags": [ "Reporting/VideoStatements" ], "operationId": "VideoStatements_GetMockData", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets": { "get": { "tags": [ "Reporting/Widgets" ], "summary": "", "operationId": "Widgets_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dashboardLevel", "in": "query", "description": "Optional. Default: null. When provided only Dashboard Level specified are returned.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Widgets.WidgetDto" }, "xml": { "name": "WidgetDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/{key}/Download/{filename}": { "get": { "tags": [ "Reporting/Widgets" ], "operationId": "DashboardDataEngine_DownloadPdfAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "filename", "in": "path", "required": true, "type": "string", "format": "uuid" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/Accounts/{accountId}/beneficiaries": { "get": { "tags": [ "Reporting/Widgets" ], "summary": "Method to get registration beneficiaries for a account", "operationId": "DashboardDataEngine_GetAccountBeneficiaries", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationBeneficiaryDto" }, "xml": { "name": "RegistrationBeneficiaryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/Accounts/{accountId}/IndexedAnnuities": { "get": { "tags": [ "Reporting/Widgets" ], "summary": "", "operationId": "DashboardDataEngine_GetAccountIndexedAnnuitiesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "asOfDate", "in": "query", "required": true, "type": "string" }, { "name": "cancelationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Widgets.AssetIndexedAnnuityDto" }, "xml": { "name": "AssetIndexedAnnuityDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/Accounts/{accountId}/InsightDocuments": { "get": { "tags": [ "Reporting/Widgets" ], "summary": "Method to get insight documents for the account. Returns advisor level documents if none assigned to the account.", "operationId": "DashboardDataEngine_GetAccountInsightDocuments", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" }, "xml": { "name": "BlobBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Widgets" ], "summary": "Method to create insight documents for the account.", "operationId": "DashboardDataEngine_UploadAccountInsightDocumentAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "file", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.StaticFileDto" } }, { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/Accounts/{accountId}/InsightDocuments/{fileId}": { "get": { "tags": [ "Reporting/Widgets" ], "summary": "Method to get insight document for the account. Looks for an advisor level document with the provided key if none found that match on the account.", "operationId": "DashboardDataEngine_DownloadAccountInsightDocuments", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Widgets" ], "summary": "Method to update insight document for the account.", "operationId": "DashboardDataEngine_PutV1ReportingWidgetsDataEngineAccountsByAccountIdInsightDocumentsByFileId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "file", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.StaticFileDto" } }, { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/Widgets" ], "summary": "Method to delete insight document for the account.", "operationId": "DashboardDataEngine_DeleteAccountInsightDocument", "consumes": [], "produces": [], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/Accounts/{accountId}/RmdCalculations": { "get": { "tags": [ "Reporting/Widgets" ], "summary": "Method to get RMD calculation for the account", "operationId": "DashboardDataEngine_GetAccountRmdCalculations", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RmdDashboardDto" }, "xml": { "name": "RmdDashboardDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/Accounts/{accountId}/Suitabilitys": { "get": { "tags": [ "Reporting/Widgets" ], "summary": "Method to get suitabilitys for the account", "operationId": "DashboardDataEngine_GetAccountSuitabilitys", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Widgets.AccountAndSuitabilityDto" }, "xml": { "name": "AccountAndSuitabilityDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/Accounts/{accountId}/Systematics": { "get": { "tags": [ "Reporting/Widgets" ], "summary": "", "operationId": "DashboardDataEngine_GetAccountSystematics", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Widgets.AccountAndSystematicsDto" }, "xml": { "name": "AccountAndSystematicsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/Action/SaveToPDF": { "post": { "tags": [ "Reporting/Widgets" ], "operationId": "DashboardDataEngine_SaveToPDFAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "settings", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Reporting.DashboardDataEngineController.SaveDashboardToPdfDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/Advisor/AUM": { "get": { "tags": [ "Reporting/Widgets" ], "summary": "", "operationId": "DashboardDataEngine_GetAdvisorAUM", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "runForEntity", "in": "query", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "asOfDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Portfolio.SpimAumInsight" }, "xml": { "name": "SpimAumInsight", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/Advisor/AUM/Detail": { "get": { "tags": [ "Reporting/Widgets" ], "summary": "", "operationId": "DashboardDataEngine_GetAdvisorAUMDetail", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "runForEntity", "in": "query", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "runForEntityId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "runForChildEntity", "in": "query", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "asOfDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Portfolio.SpimAumInsight" }, "xml": { "name": "SpimAumInsight", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/Advisor/InsightDocuments": { "get": { "tags": [ "Reporting/Widgets" ], "summary": "Method to get insight documents for the advisor.", "operationId": "DashboardDataEngine_GetAdvisorInsightDocuments", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" }, "xml": { "name": "BlobBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Widgets" ], "summary": "Method to create insight document for the advisor.", "operationId": "DashboardDataEngine_UploadAdvisorInsightDocumentAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "file", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.StaticFileDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/Advisor/InsightDocuments/{fileId}": { "get": { "tags": [ "Reporting/Widgets" ], "summary": "Method to get insight document for the advisor.", "operationId": "DashboardDataEngine_DownloadAdvisorInsightDocument", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "fileId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Widgets" ], "summary": "Method to update insight document for the advisor.", "operationId": "DashboardDataEngine_PutV1ReportingWidgetsDataEngineAdvisorInsightDocumentsByFileId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "file", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.StaticFileDto" } }, { "name": "fileId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/Widgets" ], "summary": "Method to delete insight document for the advisor.", "operationId": "DashboardDataEngine_DeleteAdvisorInsightDocument", "consumes": [], "produces": [], "parameters": [ { "name": "fileId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/AUM": { "get": { "tags": [ "Reporting/Widgets" ], "summary": "", "operationId": "DashboardDataEngine_GetAum", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "aumGrouping", "in": "query", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "asOfDate", "in": "query", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Widgets.SpimDashboardAumList" }, "xml": { "name": "SpimDashboardAumList", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/Clients/{clientId}/beneficiaries": { "get": { "tags": [ "Reporting/Widgets" ], "summary": "Method to get registration beneficiaries for aclient", "operationId": "DashboardDataEngine_GetClientBeneficiaries", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationBeneficiaryDto" }, "xml": { "name": "RegistrationBeneficiaryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/Clients/{clientId}/IndexedAnnuities": { "get": { "tags": [ "Reporting/Widgets" ], "summary": "", "operationId": "DashboardDataEngine_GetClientIndexedAnnuitiesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "asOfDate", "in": "query", "required": true, "type": "string" }, { "name": "cancelationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Widgets.AssetIndexedAnnuityDto" }, "xml": { "name": "AssetIndexedAnnuityDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/Clients/{clientId}/InsightDocuments": { "get": { "tags": [ "Reporting/Widgets" ], "summary": "Method to get insight document for the client. Returns advisor level documents if none assigned to the client.", "operationId": "DashboardDataEngine_GetClientInsightDocuments", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" }, "xml": { "name": "BlobBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Widgets" ], "summary": "Method to create insight document for the client.", "operationId": "DashboardDataEngine_UploadClientInsightDocumentAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "file", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.StaticFileDto" } }, { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/Clients/{clientId}/InsightDocuments/{fileId}": { "get": { "tags": [ "Reporting/Widgets" ], "summary": "Method to get insight document for the client. Looks for an advisor level document with the provided key if none found that match on the client.", "operationId": "DashboardDataEngine_DownloadClientInsightDocument", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Widgets" ], "summary": "Method to update insight document for the client.", "operationId": "DashboardDataEngine_PutV1ReportingWidgetsDataEngineClientsByClientIdInsightDocumentsByFileId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "file", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.StaticFileDto" } }, { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/Widgets" ], "summary": "Method to delete insight document for the client.", "operationId": "DashboardDataEngine_DeleteClientInsightDocument", "consumes": [], "produces": [], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/Clients/{clientId}/RmdCalculations": { "get": { "tags": [ "Reporting/Widgets" ], "summary": "Method to get RMD calculation for each account of a client", "operationId": "DashboardDataEngine_GetClientRmdCalculationsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RmdDashboardDto" }, "xml": { "name": "RmdDashboardDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/Clients/{clientId}/Suitabilitys": { "get": { "tags": [ "Reporting/Widgets" ], "summary": "Method to get suitabilitys for each account of a client", "operationId": "DashboardDataEngine_GetClientSuitabilitys", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Widgets.AccountAndSuitabilityDto" }, "xml": { "name": "AccountAndSuitabilityDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/Clients/{clientId}/Systematics": { "get": { "tags": [ "Reporting/Widgets" ], "summary": "", "operationId": "DashboardDataEngine_GetClientSystematics", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Widgets.AccountAndSystematicsDto" }, "xml": { "name": "AccountAndSystematicsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/NewClosedAccounts": { "get": { "tags": [ "Reporting/Widgets" ], "summary": "", "operationId": "DashboardDataEngine_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "groupEntity", "in": "query", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "repId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/Registrations/{registrationId}/beneficiaries": { "get": { "tags": [ "Reporting/Widgets" ], "summary": "Method to get registration beneficiaries for a registration", "operationId": "DashboardDataEngine_GetRegistrationBeneficiaries", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "registrationId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationBeneficiaryDto" }, "xml": { "name": "RegistrationBeneficiaryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/Registrations/{registrationId}/IndexedAnnuities": { "get": { "tags": [ "Reporting/Widgets" ], "summary": "", "operationId": "DashboardDataEngine_GetRegistrationIndexedAnnuitiesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "registrationId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "asOfDate", "in": "query", "required": true, "type": "string" }, { "name": "cancelationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Widgets.AssetIndexedAnnuityDto" }, "xml": { "name": "AssetIndexedAnnuityDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/Registrations/{registrationId}/InsightDocuments": { "get": { "tags": [ "Reporting/Widgets" ], "summary": "Method to get insight documents for the registration. Returns advisor level documents if none assigned to the registration.", "operationId": "DashboardDataEngine_GetRegistrationInsightDocuments", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "registrationId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" }, "xml": { "name": "BlobBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Reporting/Widgets" ], "summary": "Method to create insight document for the registration.", "operationId": "DashboardDataEngine_UploadRegistrationInsightDocumentAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "file", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.StaticFileDto" } }, { "name": "registrationId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/Registrations/{registrationId}/InsightDocuments/{fileId}": { "get": { "tags": [ "Reporting/Widgets" ], "summary": "Method to get insight document for the registration. Looks for an advisor level document with the provided key if none found that match on the registration.", "operationId": "DashboardDataEngine_DownloadRegistrationInsightDocument", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "registrationId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Reporting/Widgets" ], "summary": "Method to update insight document for the registration.", "operationId": "DashboardDataEngine_PutV1ReportingWidgetsDataEngineRegistrationsByRegistrationIdInsightDocumentsByFileId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "file", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.StaticFileDto" } }, { "name": "registrationId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlobBaseDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Reporting/Widgets" ], "summary": "Method to delete insight document for the registration.", "operationId": "DashboardDataEngine_DeleteRegistrationInsightDocument", "consumes": [], "produces": [], "parameters": [ { "name": "registrationId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "fileId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/Registrations/{registrationId}/RmdCalculations": { "get": { "tags": [ "Reporting/Widgets" ], "summary": "Method to get RMD calculation for each account of a registration", "operationId": "DashboardDataEngine_GetRegistrationRmdCalculationsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "registrationId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RmdDashboardDto" }, "xml": { "name": "RmdDashboardDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/Registrations/{registrationId}/Suitabilitys": { "get": { "tags": [ "Reporting/Widgets" ], "summary": "Method to get suitabilitys for each account of a registration", "operationId": "DashboardDataEngine_GetRegistrationSuitabilitys", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "registrationId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Widgets.AccountAndSuitabilityDto" }, "xml": { "name": "AccountAndSuitabilityDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/Registrations/{registrationId}/Systematics": { "get": { "tags": [ "Reporting/Widgets" ], "summary": "", "operationId": "DashboardDataEngine_GetRegistrationSystematics", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "registrationId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Widgets.AccountAndSystematicsDto" }, "xml": { "name": "AccountAndSystematicsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/Rep/{repId}/AUM": { "get": { "tags": [ "Reporting/Widgets" ], "summary": "", "operationId": "DashboardDataEngine_GetRepAUM", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "repId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "runForEntity", "in": "query", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "asOfDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Portfolio.SpimAumInsight" }, "xml": { "name": "SpimAumInsight", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/Rep/{repId}/AUM/Detail": { "get": { "tags": [ "Reporting/Widgets" ], "summary": "", "operationId": "DashboardDataEngine_GetRepAUMDetail", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "repId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "runForEntity", "in": "query", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "runForEntityId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "runForChildEntity", "in": "query", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "asOfDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Portfolio.SpimAumInsight" }, "xml": { "name": "SpimAumInsight", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/Representative/AccountStatusSummary": { "post": { "tags": [ "Reporting/Widgets" ], "operationId": "DashboardDataEngine_GetDataForAccountStatusSummaryTile", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "representativeTileDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Widgets.RepTiles.RepresentativeTileDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/Representative/AdvisoryFeeReport": { "post": { "tags": [ "Reporting/Widgets" ], "operationId": "DashboardDataEngine_GetRepAdvisoryFeeReportsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "representativeTileDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Widgets.RepTiles.RepresentativeTileDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RepresentativeBlobDto" }, "xml": { "name": "RepresentativeBlobDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/Representative/AUM": { "post": { "tags": [ "Reporting/Widgets" ], "operationId": "DashboardDataEngine_GetRepAUMOverTime", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "representativeTileDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Widgets.RepTiles.RepresentativeAumDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/Representative/Holding/Group/{group}": { "post": { "tags": [ "Reporting/Widgets" ], "operationId": "DashboardDataEngine_GetRepHolding", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "representativeTileDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Widgets.RepTiles.RepresentativeTileDto" } }, { "name": "group", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "top", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 100 } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/Representative/Payout": { "post": { "tags": [ "Reporting/Widgets" ], "operationId": "DashboardDataEngine_GetRepPayoutAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "representativeTileDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Widgets.RepTiles.RepresentativeTileDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "object" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/Representative/Performance/Group/{group}": { "post": { "tags": [ "Reporting/Widgets" ], "operationId": "DashboardDataEngine_GetTopTenPerformance", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "representativeTileDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Widgets.RepTiles.RepresentativeTileDto" } }, { "name": "dateRangeName", "in": "query", "required": true, "type": "string" }, { "name": "group", "in": "path", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "annualizePerformance", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "bottom", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/DataEngine/Reps/{repId}/RmdSummary": { "get": { "tags": [ "Reporting/Widgets" ], "operationId": "DashboardDataEngine_GetRepRmdSummary", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "repId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RmdDashboardDto" }, "xml": { "name": "RmdDashboardDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Reporting/Widgets/Grouped": { "get": { "tags": [ "Reporting/Widgets" ], "summary": "", "operationId": "Widgets_GetGrouped", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dashboardLevel", "in": "query", "description": "Optional. Default: null. When provided only Dashboard Level specified are returned.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "object" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Rollups/AssetValueDaily/Run": { "post": { "tags": [ "Rollups/AssetValueDaily" ], "operationId": "Rollups_ProcessAssetValueDaily", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Rollups/InvalidateTodaysStoredPerformanceCheck": { "post": { "tags": [ "Rollups/InvalidateTodaysStoredPerformanceCheck" ], "operationId": "Rollups_RunInvalidateTodaysStoredPerformanceCheck", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Rollups/RollupCompares": { "get": { "tags": [ "Rollups/RollupCompares" ], "operationId": "RollupCompare_GetRollupComparesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Rollups.RollupCompareDto" }, "xml": { "name": "RollupCompareDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Rollups/RollupCompares" ], "operationId": "RollupCompare_UpdateRollupCompareAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Rollups.RollupCompareDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Rollups.RollupCompareDto" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Rollups/RollupCompares" ], "operationId": "RollupCompare_CreateRollupCompareAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Rollups.RollupCompareDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Rollups.RollupCompareDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Rollups/RollupCompares/{rollupCompareId}": { "get": { "tags": [ "Rollups/RollupCompares" ], "operationId": "RollupCompare_GetRollupCompareAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "rollupCompareId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Rollups.RollupCompareDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Rollups/RollupCompares" ], "operationId": "RollupCompare_DeleteRollupCompareAsync", "consumes": [], "produces": [], "parameters": [ { "name": "rollupCompareId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Rollups/RollupCompares/{rollupCompareId}/AssetValueChangeDifferences": { "get": { "tags": [ "Rollups/RollupCompares" ], "operationId": "RollupCompare_GetRollupCompareAssetValueChangeDifferencesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "rollupCompareId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Rollups.RollupCompareAssetValueChangeDifference" }, "xml": { "name": "RollupCompareAssetValueChangeDifference", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Rollups/RollupCompares/{rollupCompareId}/AssetValueDifferences": { "get": { "tags": [ "Rollups/RollupCompares" ], "operationId": "RollupCompare_GetRollupCompareAssetValueDifferencesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "rollupCompareId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Rollups.RollupCompareAssetValueDifference" }, "xml": { "name": "RollupCompareAssetValueDifference", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Rollups/RollupCompares/CheckPending": { "post": { "tags": [ "Rollups/RollupCompares" ], "operationId": "RollupCompare_CheckPendingComparesAsync", "consumes": [], "produces": [], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Rollups/RollupCompares/Differences/AssetValueChangeDifferences/{rollupCompareId}": { "get": { "tags": [ "Rollups/RollupCompares" ], "operationId": "RollupCompareDifferences_GetAssetValueChangeDifferencesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "rollupCompareId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Rollups.RollupCompareAssetValueChangeDifference" }, "xml": { "name": "RollupCompareAssetValueChangeDifference", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Rollups/RollupCompares/Differences/AssetValueDifferences/{rollupCompareId}": { "get": { "tags": [ "Rollups/RollupCompares" ], "operationId": "RollupCompareDifferences_GetAssetValueDifferencesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "rollupCompareId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Rollups.RollupCompareAssetValueDifference" }, "xml": { "name": "RollupCompareAssetValueDifference", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Rollups/RollupCompares/Differences/UpdateNotes/{rollupCompareId}": { "post": { "tags": [ "Rollups/RollupCompares" ], "operationId": "RollupCompareDifferences_UpdateDifferenceNotesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "rollupCompareId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "note", "in": "query", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Rollups/RollupCompares/Process/{rollupCompareId}": { "post": { "tags": [ "Rollups/RollupCompares" ], "operationId": "RollupCompare_ProcessRollupCompareAsync", "consumes": [], "produces": [], "parameters": [ { "name": "rollupCompareId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Scheduler/Jobs": { "get": { "tags": [ "Scheduler/Jobs" ], "summary": "Gets a list of job schedules that the logged in user has access to.", "operationId": "Job_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Scheduler.JobDto" }, "xml": { "name": "JobDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Scheduler/Jobs/{key}": { "get": { "tags": [ "Scheduler/Jobs" ], "summary": "Gets the job schedules that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Job_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Scheduler.JobDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Scheduler/JobSchedules": { "get": { "tags": [ "Scheduler/JobSchedules" ], "summary": "Gets a list of job schedules that the logged in user has access to.", "operationId": "JobSchedules_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Scheduler.JobScheduleDto" }, "xml": { "name": "JobScheduleDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Scheduler/JobSchedules/{key}": { "get": { "tags": [ "Scheduler/JobSchedules" ], "summary": "Gets the job schedules that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "JobSchedules_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Scheduler.JobScheduleDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Scheduler/JobSchedules/{key}/LastResultMessage": { "get": { "tags": [ "Scheduler/JobSchedules" ], "summary": "Gets the last result message for the job schedule that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "JobSchedules_GetLastResultMessageByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Scheduler.JobResultDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Scheduler/JobSchedules/Action/Reschedule": { "put": { "tags": [ "Scheduler/JobSchedules" ], "operationId": "JobSchedules_CreateBlocks", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "jobScheduleIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Scheduler/NotificationGroup": { "get": { "tags": [ "Scheduler/NotificationGroup" ], "summary": "Gets a list of notification groups that the logged in user has access to.", "operationId": "NotificationGroup_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Scheduler.NotificationGroupDto" }, "xml": { "name": "NotificationGroupDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Scheduler/NotificationGroup/{key}": { "get": { "tags": [ "Scheduler/NotificationGroup" ], "summary": "Gets the notification groups that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "NotificationGroup_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Scheduler.NotificationGroupDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Databases": { "get": { "tags": [ "Security/Databases" ], "summary": "Gets a list of databases the logged in user has access to.", "operationId": "ObsoleteDatabases_GetAvailableDatabasesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "token", "in": "header", "required": true }, { "name": "isActive", "in": "query", "description": "Optional. Default: null. If provided limits the return to only those database", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.DatabaseDto" }, "xml": { "name": "DatabaseDto", "wrapped": true }, "type": "array" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Databases/{key}": { "get": { "tags": [ "Security/Databases" ], "summary": "Gets the database that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ObsoleteDatabases_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "token", "in": "header", "required": true }, { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.DatabaseDto" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Security/Databases" ], "summary": "Use v1/Authorization/User/Databases/{key:int}", "operationId": "ObsoleteDatabases_UpdateDatabaseAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "token", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.DatabaseDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.DatabaseDto" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Databases/FirmTypes": { "get": { "tags": [ "Security/Databases" ], "operationId": "DatabaseLockdowns_GetFirmTypes", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "includeNoneOption", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Databases/LockdownTypes": { "get": { "tags": [ "Security/Databases" ], "operationId": "DatabaseLockdowns_GetLockdownTypes", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "includeNoneOption", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/EndpointDetails": { "get": { "tags": [ "Security/EndpointDetails" ], "summary": "Gets a list of endpoints with details that the api has exposed.", "operationId": "Endpoints_GetDetails", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Endpoints": { "get": { "tags": [ "Security/Endpoints" ], "summary": "Gets a list of endpoints the api has exposed.", "operationId": "Endpoints_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Endpoints2": { "get": { "tags": [ "Security/Endpoints2" ], "summary": "Gets a list of endpoints the api has exposed.", "operationId": "Endpoints_Get2", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/FirmContacts": { "get": { "tags": [ "Security/FirmContacts" ], "operationId": "FirmContact_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.FirmContactDto" }, "xml": { "name": "FirmContactDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Security/FirmContacts" ], "operationId": "FirmContact_UpdateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "contactDtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.FirmContactDto" }, "xml": { "name": "FirmContactDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Formatters": { "get": { "tags": [ "Security/Formatters" ], "summary": "Gets a list of formatters the api accepts.", "operationId": "Endpoints_GetFormatters", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Login": { "get": { "tags": [ "Security/Login" ], "operationId": "Login_GetPersonalData", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "loginLevel", "in": "query", "required": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "excludeUsersWithLogin", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PersonalDto" }, "xml": { "name": "PersonalDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/LoginEntities": { "get": { "tags": [ "Security/LoginEntities" ], "operationId": "LoginEntities_GetLoginEntities", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "object" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/LoginEntities/UserCanUpdate": { "get": { "tags": [ "Security/LoginEntities" ], "operationId": "LoginEntities_GetLoginEntitiesUpdatableByUser", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "object" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/PartnerAppAdvisors": { "post": { "tags": [ "Security/PartnerAppAdvisors" ], "summary": "Create a partner app advisor", "operationId": "PartnerAppAdvisors_CreateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "partnerAppAdvisor", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Security.PartnerAppAdvisor" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Security.PartnerAppAdvisor" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/PartnerAppAdvisors/{key}": { "put": { "tags": [ "Security/PartnerAppAdvisors" ], "operationId": "PartnerAppAdvisors_UpdateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "partnerAppAdvisor", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Security.PartnerAppAdvisor" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Security.PartnerAppAdvisor" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/PartnerAppAdvisors/PartnerApps/{partnerAppId}/AlClients/{alClientId}": { "get": { "tags": [ "Security/PartnerAppAdvisors" ], "summary": "Gets the partner app advisor of a partner app and alclient.", "operationId": "PartnerAppAdvisors_GetByPartnerAppIdAndAlClientId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "partnerAppId", "in": "path", "description": "The partnerAppId.", "required": true, "type": "integer", "format": "int32" }, { "name": "alClientId", "in": "path", "description": "The alClientId.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Security.PartnerAppAdvisor" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/PartnerAppAdvisors/PartnerApps/Clients/{partnerAppId}": { "get": { "tags": [ "Security/PartnerAppAdvisors" ], "summary": "List all clients a partner is allowed to access", "operationId": "PartnerAppAdvisors_GetClientAccessByPartnerIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "partnerAppId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/PartnerAppAdvisors/PartnerApps/Partners/{alClientId}": { "get": { "tags": [ "Security/PartnerAppAdvisors" ], "operationId": "PartnerAppAdvisors_GetPartnerAccessByAlCientIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "alClientId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/PartnerApps": { "get": { "tags": [ "Security/PartnerApps" ], "summary": "Gets a list of partner apps that the logged in user has access to. \r\nThe return is limited to pages of 1000. Use $top and $skip in the query string to page through the data.", "operationId": "PartnerApps_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.PartnerAppReadDto" }, "xml": { "name": "PartnerAppReadDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Security/PartnerApps" ], "operationId": "PartnerApps_CreatePartnerapp", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "partnerApp", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Security.PartnerApp" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Security.PartnerApp" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/PartnerApps/{key}": { "put": { "tags": [ "Security/PartnerApps" ], "operationId": "PartnerApps_UpdateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.PartnerAppUpdateDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.PartnerAppFullReadDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/PartnerApps/{key}/Full": { "get": { "tags": [ "Security/PartnerApps" ], "summary": "Gets the partner app that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "PartnerApps_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.PartnerAppFullReadDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/PartnerApps/{key}/Simple": { "get": { "tags": [ "Security/PartnerApps" ], "summary": "Gets a simple version of the partner app that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "PartnerApps_GetSimpleByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.PartnerAppSimpleDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/PartnerApps/{key}/SimplePlus": { "get": { "tags": [ "Security/PartnerApps" ], "summary": "Gets the partner app that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "PartnerApps_GetSimplePlusByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.PartnerAndAppSimpleDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/PartnerApps/{key}/TermsOfService/{acceptTOS}": { "post": { "tags": [ "Security/PartnerApps" ], "summary": "The process to add a partner app includes saving the TOS acceptance (in IntegrationProcess).\r\nDoes this still need to be done separately?", "operationId": "PartnerApps_UpdateTermsOfServiceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "acceptTOS", "in": "path", "required": true, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.PartnerAndAppSimpleDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/PartnerApps/{partnerappId}": { "get": { "tags": [ "Security/PartnerApps" ], "operationId": "PartnerApps_GetPartnerapp", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "partnerappId", "in": "path", "required": true, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Security.PartnerApp" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Security/PartnerApps" ], "operationId": "PartnerApps_DeletePartnerapp", "consumes": [], "produces": [], "parameters": [ { "name": "partnerappId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/PartnerApps/{partnerAppId}/TrustedPrompt": { "get": { "tags": [ "Security/PartnerApps" ], "operationId": "PartnerApps_GetTrustedPromptAppLink", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "partnerAppId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.PartnerAppLinkDto" }, "xml": { "name": "PartnerAppLinkDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Security/PartnerApps" ], "operationId": "PartnerApps_CreateTrustedPromptAppLinkAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "partnerAppId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "partnerAppLinkDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.PartnerAppLinkDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.PartnerAppLinkDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/PartnerApps/{partnerId}/SsoRedirect": { "get": { "tags": [ "Security/PartnerApps" ], "summary": "", "operationId": "PartnerApps_PartnerRedirectAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "routeUrl", "in": "query", "description": "The partner's absolute SSO url", "required": true, "type": "string" }, { "name": "partnerId", "in": "path", "description": "Partner App Id", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/PartnerApps/Simple": { "get": { "tags": [ "Security/PartnerApps" ], "summary": "Gets a list of simple versions of the partner apps that the logged in user has access to. \r\nThe return is limited to pages of 1000. Use $top and $skip in the query string to page through the data.", "operationId": "PartnerApps_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.PartnerAppSimpleDto" }, "xml": { "name": "PartnerAppSimpleDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Privileges": { "get": { "tags": [ "Security/Privileges" ], "operationId": "Privileges_GetPrivileges", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "loginEntityId", "in": "query", "required": false, "type": "string", "enum": [ "BrokerDealer", "Wholesaler", "Representative", "Client", "RIA", "Administrator", "SubAdvisor", "ThirdPartyAdministrator", "Custodian", "PlanSponsor", "ThirdParty", "ServiceAccount", "Participant", "RepAccountManager", "Payee", "RIATable", "Cotenant" ] }, { "name": "type", "in": "query", "required": false, "type": "string", "enum": [ "Unknown", "Apps", "Records", "Actions", "Advanced", "Applinks", "FeatureFlags" ] }, { "name": "categoryId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.PrivilegeDto" }, "xml": { "name": "PrivilegeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Security/Privileges" ], "operationId": "Privileges_CreatePrivlegeAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "privilegeDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.PrivilegeDetailsDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.PrivilegeDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Privileges/{code}": { "get": { "tags": [ "Security/Privileges" ], "operationId": "Privileges_GetByCodeAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "code", "in": "path", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.PrivilegeDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Security/Privileges" ], "operationId": "Privileges_UpdatePrivlegeAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "code", "in": "path", "required": true, "type": "string" }, { "name": "privilegeDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.PrivilegeDetailsDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.PrivilegeDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Privileges/{code}/Roles": { "get": { "tags": [ "Security/Privileges" ], "summary": "Gets details about the privilege specified by the {code}, along with the Roles used by the firm.", "operationId": "Privileges_GetByCodeWithFirmRoles", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "code", "in": "path", "description": "The code uniquely identifying the privilege.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.RoleDetailsDto" }, "xml": { "name": "RoleDetailsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Privileges/{key}": { "get": { "tags": [ "Security/Privileges" ], "operationId": "Privileges_GetPrivilege", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.PrivilegeDetailsDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Privileges/{key}/AllowedEntitiesHistory": { "get": { "tags": [ "Security/Privileges" ], "operationId": "Privileges_GetPrivilegeAllowedEntitiesHistory", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.PrivilegeAllowEntityHistoryDto" }, "xml": { "name": "PrivilegeAllowEntityHistoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Privileges/{key}/Histories": { "get": { "tags": [ "Security/Privileges" ], "operationId": "Privileges_GetPrivilegeHistory", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.PrivilegeHistoryDto" }, "xml": { "name": "PrivilegeHistoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Privileges/{key}/Roles": { "get": { "tags": [ "Security/Privileges" ], "summary": "Gets details about the privilege specified by the {key}, along with the Roles used by the firm.", "operationId": "Privileges_GetByKeyWithFirmRoles", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The ID of the privilege.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.RoleDetailsDto" }, "xml": { "name": "RoleDetailsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Privileges/Categories": { "get": { "tags": [ "Security/Privileges" ], "operationId": "Privileges_GetCategories", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Profiles": { "get": { "tags": [ "Security/Profiles" ], "summary": "Gets a list of profiles that the logged in user has access to.\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "Profiles_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "query", "description": "Optional. Default: null. If provided returns only the profiles for the entity level specified.", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "isActive", "in": "query", "description": "Optional. Default: True. If true only the profiles associated to active users are returned.", "required": false, "type": "boolean", "default": true }, { "name": "populateEntityName", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "entityId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "includeInactiveHouseHolds", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.UserDetailDto" }, "xml": { "name": "UserDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Profiles/Search": { "get": { "tags": [ "Security/Profiles" ], "summary": "Gets a list of profiles that the logged in user has access to where the UserName or UserId contains the search string.", "operationId": "Profiles_SearchAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "UserName, UserId, or EntityName to search for", "required": true, "type": "string" }, { "name": "entity", "in": "query", "description": "Optional. Default: null. If provided returns only the profiles for the entity level specified.", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "isActive", "in": "query", "description": "Optional. Default: True. If true only the profiles associated to active users are returned.", "required": false, "type": "boolean", "default": true }, { "name": "populateEntityName", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.UserDetailDto" }, "xml": { "name": "UserDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Profiles/Search/{search}": { "get": { "tags": [ "Security/Profiles" ], "summary": "Gets a list of profiles that the logged in user has access to where the UserName or UserId contains the search string.", "operationId": "Profiles_GetV1SecurityProfilesSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "UserName, UserId, or EntityName to search for", "required": true, "type": "string" }, { "name": "entity", "in": "query", "description": "Optional. Default: null. If provided returns only the profiles for the entity level specified.", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "isActive", "in": "query", "description": "Optional. Default: True. If true only the profiles associated to active users are returned.", "required": false, "type": "boolean", "default": true }, { "name": "populateEntityName", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.UserDetailDto" }, "xml": { "name": "UserDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Rights": { "get": { "tags": [ "Security/Rights" ], "summary": "Gets a list of rights that the logged in user has.", "operationId": "ObsoleteRights_GetRights", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "resetCache", "in": "query", "description": "Optional. Default: false. The result is cached for fifteen minutes. To force the cache to refresh call with resetCache = true.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.RightDto" }, "xml": { "name": "RightDto", "wrapped": true }, "type": "array" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Rights/{securitycode}": { "get": { "tags": [ "Security/Rights" ], "summary": "Gets the right that the logged in user has that matches the security code provided.", "operationId": "ObsoleteRights_GetRight", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "securitycode", "in": "path", "description": "The security code for", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.RightDto" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Rights/Groups": { "get": { "tags": [ "Security/Rights" ], "summary": "Gets the groups that the logged in user has access to.", "operationId": "ObsoleteRights_GetGroups", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Rights/ObjectTypeCode/{code}": { "get": { "tags": [ "Security/Rights" ], "summary": "Gets the rights that the logged in user has that fall within the object type code provided.", "operationId": "ObsoleteRights_GetRightsByObjectTypeCode", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "code", "in": "path", "description": "The object type code to return the rights of.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.RightDto" }, "xml": { "name": "RightDto", "wrapped": true }, "type": "array" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Roles": { "get": { "tags": [ "Security/Roles" ], "operationId": "Roles_GetRoles", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "loginEntityId", "in": "query", "required": false, "type": "string", "enum": [ "BrokerDealer", "Wholesaler", "Representative", "Client", "RIA", "Administrator", "SubAdvisor", "ThirdPartyAdministrator", "Custodian", "PlanSponsor", "ThirdParty", "ServiceAccount", "Participant", "RepAccountManager", "Payee", "RIATable", "Cotenant" ] }, { "name": "excludeLoginEntityId", "in": "query", "required": false, "items": { "type": "string", "enum": [ "BrokerDealer", "Wholesaler", "Representative", "Client", "RIA", "Administrator", "SubAdvisor", "ThirdPartyAdministrator", "Custodian", "PlanSponsor", "ThirdParty", "ServiceAccount", "Participant", "RepAccountManager", "Payee", "RIATable", "Cotenant" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "id", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.RoleDto" }, "xml": { "name": "RoleDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Security/Roles" ], "summary": "", "operationId": "Roles_UpdateRoles", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dtos", "in": "query", "required": true, "items": {}, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.RoleDto" }, "xml": { "name": "RoleDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Security/Roles" ], "summary": "", "operationId": "Roles_AddRole", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.RoleDetailsDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.RoleDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Roles/{key}": { "get": { "tags": [ "Security/Roles" ], "summary": "", "operationId": "Roles_GetRoleByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.RoleDetailsDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Security/Roles" ], "summary": "", "operationId": "Roles_UpdateRole", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.RoleDetailsDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.RoleDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Security/Roles" ], "summary": "", "operationId": "Roles_DeleteRole", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Roles/{key}/Action/AssignUsers": { "put": { "tags": [ "Security/Roles" ], "operationId": "Roles_AssignUsersAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "profileIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Roles/{key}/Users": { "get": { "tags": [ "Security/Roles" ], "summary": "", "operationId": "Roles_GetUsersForRole", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.RoleUserProfileDto" }, "xml": { "name": "RoleUserProfileDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Roles/{loginEntityId}/{name}": { "get": { "tags": [ "Security/Roles" ], "summary": "", "operationId": "Roles_GetRoleByLoginEntityAndName", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "loginEntityId", "in": "path", "required": true, "type": "string", "enum": [ "BrokerDealer", "Wholesaler", "Representative", "Client", "RIA", "Administrator", "SubAdvisor", "ThirdPartyAdministrator", "Custodian", "PlanSponsor", "ThirdParty", "ServiceAccount", "Participant", "RepAccountManager", "Payee", "RIATable", "Cotenant" ] }, { "name": "name", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.RoleDetailsDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Roles/AvailableDashboards": { "get": { "tags": [ "Security/Roles" ], "summary": "", "operationId": "Roles_GetAvailableDashboards", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isPortfolioView", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Roles/Simple": { "get": { "tags": [ "Security/Roles" ], "summary": "", "operationId": "Roles_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "includeGlobalRoles", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Roles/Update": { "put": { "tags": [ "Security/Roles" ], "summary": "Updates Roles and details using list of updated roles. Identical to the UpdateRoles method, but sending data in the body instead of the Uri.", "operationId": "Roles_UpdateRolesFromBody", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updatedRoles", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.RoleDetailsDto" }, "xml": { "name": "RoleDetailsDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.RoleDto" }, "xml": { "name": "RoleDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Token": { "get": { "tags": [ "Security/Token" ], "summary": "Authorizes Credentials, and returns a token", "operationId": "Token_GetTokenAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "useCurrentProfile", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Security/Token" ], "summary": "Authorizes Credentials, and returns a token", "operationId": "Token_GetTokenForOAuthAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "oauthdata", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Security.TokenController.OauthBody" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Security.TokenController.JwtToken" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Security/Token" ], "operationId": "Token_Delete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Token/CheckPassword": { "post": { "tags": [ "Security/Token" ], "summary": "Checks whether the provided string is known to be a compromised password.", "operationId": "Token_CheckPasswordAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "password", "in": "body", "required": true, "schema": { "type": "string" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Token/element": { "get": { "tags": [ "Security/Token" ], "summary": "Authorizes Credentials, and returns a token", "operationId": "Token_GetElementTokenAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "useCurrentProfile", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Token/SendTwoFactorCode": { "post": { "tags": [ "Security/Token" ], "summary": "Sends a registration code to email or sms", "operationId": "Token_SendTwoFactorCode", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "deliveryType", "in": "query", "description": "Specify if the code should be sent to email or sms", "required": true, "type": "string", "enum": [ "Email", "Sms" ] } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Users": { "get": { "tags": [ "Security/Users" ], "operationId": "Users_GetUsersForEntity", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "currentDbOnly", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "loginEntityId", "in": "query", "required": false, "type": "string", "enum": [ "BrokerDealer", "Wholesaler", "Representative", "Client", "RIA", "Administrator", "SubAdvisor", "ThirdPartyAdministrator", "Custodian", "PlanSponsor", "ThirdParty", "ServiceAccount", "Participant", "RepAccountManager", "Payee", "RIATable", "Cotenant" ] }, { "name": "isActive", "in": "query", "required": false, "type": "boolean" }, { "name": "userId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.UserInfoDto" }, "xml": { "name": "UserInfoDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Security/Users" ], "operationId": "Users_CreateUserAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.UserInfoDetailsDto" } }, { "name": "sendEmail", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.UserInfoDetailsDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Users/{entity}/{key}": { "get": { "tags": [ "Security/Users" ], "operationId": "Users_NewUser", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "required": true, "type": "string", "enum": [ "BrokerDealer", "Wholesaler", "Representative", "Client", "RIA", "Administrator", "SubAdvisor", "ThirdPartyAdministrator", "Custodian", "PlanSponsor", "ThirdParty", "ServiceAccount", "Participant", "RepAccountManager", "Payee", "RIATable", "Cotenant" ] }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.UserInfoDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Users/{entity}/ContactTypes": { "get": { "tags": [ "Security/Users" ], "operationId": "Users_GetAvailableContactTypesForEntity", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "required": true, "type": "string", "enum": [ "BrokerDealer", "Wholesaler", "Representative", "Client", "RIA", "Administrator", "SubAdvisor", "ThirdPartyAdministrator", "Custodian", "PlanSponsor", "ThirdParty", "ServiceAccount", "Participant", "RepAccountManager", "Payee", "RIATable", "Cotenant" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Users/{key}": { "get": { "tags": [ "Security/Users" ], "operationId": "Users_GetUser", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.UserInfoDetailsDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Security/Users" ], "operationId": "Users_UpdateUserAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.UserInfoDetailsDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.UserInfoDetailsDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Security/Users" ], "operationId": "Users_DeleteUserAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Users/{key}/Action/Password/Reset": { "put": { "tags": [ "Security/Users" ], "operationId": "Users_ResetUserPassword", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "sendEmail", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.UserInfoDetailsDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Users/{key}/Action/Password/Set": { "put": { "tags": [ "Security/Users" ], "operationId": "Users_SetUserPassword", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "reqBody", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.ActionPasswordSetRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.UserInfoDetailsDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Users/{key}/Action/SecurityQuestion/Delete": { "put": { "tags": [ "Security/Users" ], "summary": "Obsolete: Security questions and answers are no longer used. This endpoint no longer does anything.", "operationId": "Users_ResetSecurityQuestion", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Users/{key}/LoginActivity": { "get": { "tags": [ "Security/Users" ], "operationId": "Users_GetUserActivity", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.LoginActivityDto" }, "xml": { "name": "LoginActivityDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Security/Users" ], "operationId": "Users_LoginActivity", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Users/Action/Activate": { "put": { "tags": [ "Security/Users" ], "operationId": "Users_ToggleUsersActiveAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "activate", "in": "query", "required": true, "type": "boolean" }, { "name": "userIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Users/Action/Import": { "post": { "tags": [ "Security/Users" ], "operationId": "Users_CreateUsersAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "newItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.UserInfoDetailsDto" }, "xml": { "name": "UserInfoDetailsDto", "wrapped": true }, "type": "array" } }, { "name": "sendEmails", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.UserInfoDetailsDto" }, "xml": { "name": "UserInfoDetailsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Users/DeactivationPolicies": { "get": { "tags": [ "Security/Users" ], "summary": "", "operationId": "Users_GetDeactivationPoliciesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Security/Users" ], "summary": "", "operationId": "Users_UpdateDeactivationPoliciesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "policySet", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.DeactivationPolicySet" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Users/Import/LoginActivity": { "post": { "tags": [ "Security/Users" ], "operationId": "Users_PostV1SecurityUsersImportLoginActivity", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "userLogins", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Security.UserLogin" }, "xml": { "name": "UserLogin", "wrapped": true }, "type": "array" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Users/RepUsers": { "get": { "tags": [ "Security/Users" ], "operationId": "Users_GetRepUsersWithProfiles", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "take", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "isActive", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.UserInfoDetailsDto" }, "xml": { "name": "UserInfoDetailsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Users/Search": { "get": { "tags": [ "Security/Users" ], "operationId": "Users_Search", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "userid", "in": "query", "required": false, "type": "string" }, { "name": "email", "in": "query", "required": false, "type": "string" }, { "name": "lastname", "in": "query", "required": false, "type": "string" }, { "name": "firstname", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.UserInfoDetailsDto" }, "xml": { "name": "UserInfoDetailsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Users/Search/ByEmail": { "post": { "tags": [ "Security/Users" ], "operationId": "Users_LookupByEmailAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "emailList", "in": "body", "required": true, "schema": { "items": { "type": "string" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.UserInfoDetailsDto" }, "xml": { "name": "UserInfoDetailsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/Users/SendNewUserEmails": { "put": { "tags": [ "Security/Users" ], "operationId": "Users_SendNewUserEmail", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "userIds", "in": "query", "required": true, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Security/ValidateImport/Users/{entity}": { "post": { "tags": [ "Security/ValidateImport" ], "operationId": "SecurityValidateImportUsers_ProcessFileAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "entity", "in": "path", "required": true, "type": "string", "enum": [ "BrokerDealer", "Wholesaler", "Representative", "Client", "RIA", "Administrator", "SubAdvisor", "ThirdPartyAdministrator", "Custodian", "PlanSponsor", "ThirdParty", "ServiceAccount", "Participant", "RepAccountManager", "Payee", "RIATable", "Cotenant" ] }, { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } }, { "name": "prepopulateUseInformationFromProfile", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.UserInfoDetailsValidationDto" }, "xml": { "name": "UserInfoDetailsValidationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/Apps": { "get": { "tags": [ "Settings/Apps" ], "summary": "Gets a list of apps that the logged in user has access to. \r\nThe return is limited to pages of 1000. Use $top and $skip in the query string to page through the data.", "operationId": "Apps_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "hasOptions", "in": "query", "description": "Optional. Default: null. If true return only the apps that have options, when false return only the apps that do not have options.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.AppDto" }, "xml": { "name": "AppDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Settings/Apps" ], "summary": "Used to create a new app. Upon successful creation a 201 will be returned with the location of the nearly created app.", "operationId": "Apps_CreateApp", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.AppFullDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/Apps/{appCode}": { "get": { "tags": [ "Settings/Apps" ], "summary": "Gets the app that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Apps_GetV1SettingsAppsByAppCode", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "appCode", "in": "path", "description": "AppCode of the desired return object.", "required": true, "type": "string" }, { "name": "showAllPages", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.AppFullDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Settings/Apps" ], "summary": "Used to update an existing app. Upon successful modification a 200 will be returned.", "operationId": "Apps_UpdateApp", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "appCode", "in": "path", "required": true, "type": "string" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.AppFullDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.AppFullDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Settings/Apps" ], "summary": "Used to delete an existing app. Upon successful deletion a 204 will be returned.", "operationId": "Apps_DeleteApp", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "appCode", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/Apps/{appCode}/Options": { "get": { "tags": [ "Settings/Apps" ], "summary": "Gets all app options for the app with the provided appCode. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "AppOptions_GetOptions", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "appCode", "in": "path", "description": "AppCode of the desired return object.", "required": true, "type": "string" }, { "name": "level", "in": "query", "description": "Optional. Default: User. The level to return a value for can be User, Advisor, or Default.", "required": false, "type": "string", "default": 102, "enum": [ "User", "Advisor", "Default" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.AppOptionDto" }, "xml": { "name": "AppOptionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Settings/Apps" ], "summary": "Updates an array of AppOptions.", "operationId": "AppOptions_UpdateList", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "appCode", "in": "path", "description": "Application Code", "required": true, "type": "string" }, { "name": "dtoList", "in": "body", "description": "Body contains the list of options for update.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.AppOptionDto" }, "xml": { "name": "AppOptionDto", "wrapped": true }, "type": "array" } }, { "name": "level", "in": "query", "description": "The level the options will be stored (Default, User, or Advisor)", "required": false, "type": "string", "default": 102, "enum": [ "User", "Advisor", "Default" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.AppOptionDto" }, "xml": { "name": "AppOptionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/Apps/{appCode}/Options/{optionName}": { "get": { "tags": [ "Settings/Apps" ], "summary": "Gets the app option that has the provided name. If the item specified doesn't exist or isn't \r\naccessible to the logged in user, a mocked object with the option name and default value will be returned.", "operationId": "AppOptions_GetByOptionName", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "appCode", "in": "path", "description": "The AppCode form tblApp that indicates what application the app option is for.", "required": true, "type": "string" }, { "name": "optionName", "in": "path", "description": "Name of the option to return.", "required": true, "type": "string" }, { "name": "level", "in": "query", "description": "Optional. Default: User. The level to return a value for can be User, Advisor, or Default.", "required": false, "type": "string", "default": 102, "enum": [ "User", "Advisor", "Default" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.AppOptionDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Settings/Apps" ], "summary": "Used to update an existing app option value. Upon successful modification a 200 will be returned. Returns the app option value with appropriate value after the update occured.", "operationId": "AppOptions_Update", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "appCode", "in": "path", "description": "The AppCode form tblApp that indicates what application the app option is for.", "required": true, "type": "string" }, { "name": "optionName", "in": "path", "description": "Name of the option to return.", "required": true, "type": "string" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.AppOptionDto" } }, { "name": "level", "in": "query", "description": "Optional. Default: User. The level to return a value for can be User or Advisor.", "required": false, "type": "string", "default": 102, "enum": [ "User", "Advisor", "Default" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.AppOptionDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Settings/Apps" ], "summary": "Used to delete an existing app option value. Returns the app option value with approviate value after the delete occured.", "operationId": "AppOptions_Delete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "appCode", "in": "path", "required": true, "type": "string" }, { "name": "optionName", "in": "path", "description": "Name of the option to return.", "required": true, "type": "string" }, { "name": "level", "in": "query", "description": "Optional. Default: User. The level to return a value for can be User or Advisor.", "required": false, "type": "string", "default": 102, "enum": [ "User", "Advisor", "Default" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.AppOptionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/Apps/ContextualLinks": { "get": { "tags": [ "Settings/Apps" ], "operationId": "Apps_GetContextualLinks", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.AppContextualLinkDto" }, "xml": { "name": "AppContextualLinkDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/Apps/Pages/{search}": { "get": { "tags": [ "Settings/Apps" ], "operationId": "Apps_GetPagesForApp", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "required": true, "type": "string" }, { "name": "showAllPages", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "object" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/Apps/Search": { "get": { "tags": [ "Settings/Apps" ], "summary": "Gets a list of apps that the logged in user has access to where the app name or tags contains the search string.", "operationId": "Apps_GetAppSearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "description": "Name or tags to search for.", "required": true, "type": "string" }, { "name": "top", "in": "query", "description": "Optional. Default: null. The maximum number of products to return. If null returns all.", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Optional. Default: 0. Defines number of items to skip.", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "isActive", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.AppDto" }, "xml": { "name": "AppDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/Apps/Search/{search}": { "get": { "tags": [ "Settings/Apps" ], "summary": "Gets a list of apps that the logged in user has access to where the app name or tags contains the search string.", "operationId": "Apps_GetV1SettingsAppsSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "description": "Name or tags to search for.", "required": true, "type": "string" }, { "name": "top", "in": "query", "description": "Optional. Default: null. The maximum number of products to return. If null returns all.", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "description": "Optional. Default: 0. Defines number of items to skip.", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "isActive", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.AppDto" }, "xml": { "name": "AppDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/Apps/User": { "get": { "tags": [ "Settings/Apps" ], "operationId": "Apps_GetAppForCurrentUser", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "audienceExclusion", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "None", "WorkflowAssistant" ] } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/CustomSettings": { "get": { "tags": [ "Settings/CustomSettings" ], "summary": "Gets a list of custom settings that the logged in user has access to.", "operationId": "CustomSettings_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "entity", "in": "query", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "app", "in": "query", "required": false, "type": "string", "default": 1, "enum": [ "Global", "ClientPortal", "RepPortal", "Element" ] }, { "name": "excludeImages", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataProcess.Settings.CustomSettingDto" }, "xml": { "name": "CustomSettingDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Settings/CustomSettings" ], "summary": "Used to update existing custom settings. Upon successful modification a 200 will be returned.", "operationId": "CustomSettings_UpdateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "dtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataProcess.Settings.CustomSettingDto" }, "xml": { "name": "CustomSettingDto", "wrapped": true }, "type": "array" } }, { "name": "entity", "in": "query", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataProcess.Settings.CustomSettingDto" }, "xml": { "name": "CustomSettingDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/CustomSettings/{promptName}": { "get": { "tags": [ "Settings/CustomSettings" ], "summary": "Gets the custom setting that has the provided prompt name. If the item specified doesn't exist or isn't \r\naccessible to the logged in user, a mocked object with the option name and default value will be returned.", "operationId": "CustomSettings_GetByPromptAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "promptName", "in": "path", "description": "Prompt name of the option to return.", "required": true, "type": "string" }, { "name": "entity", "in": "query", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.Settings.CustomSettingDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Settings/CustomSettings" ], "summary": "Used to update existing custom setting. Upon successful modification a 200 will be returned.", "operationId": "CustomSettings_PutV1SettingsCustomSettingsByPromptName", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "promptName", "in": "path", "description": "Prompt name of the option to return.", "required": true, "type": "string" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Settings.CustomSettingDto" } }, { "name": "entity", "in": "query", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.Settings.CustomSettingDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/CustomSettings/{promptName}/Image": { "get": { "tags": [ "Settings/CustomSettings" ], "summary": "If the prompt being requested is an image this will return that image. If it is not it will return 400. If the prompt doesn't exist it will return a 404.", "operationId": "CustomSettings_GetImageAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "promptName", "in": "path", "description": "Prompt name of the option to return.", "required": true, "type": "string" }, { "name": "entity", "in": "query", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/CustomSettings/Actions/Reset/{promptName}": { "post": { "tags": [ "Settings/CustomSettings" ], "summary": "Used to reset existing custom setting. Upon successful modification a 200 will be returned.", "operationId": "CustomSettings_ResetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "promptName", "in": "path", "description": "Prompt name of the option to return.", "required": true, "type": "string" }, { "name": "entity", "in": "query", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.Settings.CustomSettingDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/Database/EntityOptions": { "get": { "tags": [ "Settings/Database" ], "operationId": "DatabaseEntityOptions_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "codeNames", "in": "query", "required": false, "items": { "type": "string" }, "collectionFormat": "multi", "type": "array" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/Database/EntityOptions/{userDefineDefinitionId}": { "get": { "tags": [ "Settings/Database" ], "summary": "Gets the database entity option that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "DatabaseEntityOptions_GetV1SettingsDatabaseEntityOptionsByUserDefineDefinitionId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "userDefineDefinitionId", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/Database/EntityOptions/Categories": { "get": { "tags": [ "Settings/Database" ], "summary": "Gets the list categories for the database entity options.", "operationId": "DatabaseEntityOptions_GetCategoriesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/Database/EntityOptions/Categories/{category}": { "get": { "tags": [ "Settings/Database" ], "summary": "Gets the list of database entity options that have the provided category.", "operationId": "DatabaseEntityOptions_GetByCategoryAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "category", "in": "path", "description": "Category of the desired return objects.", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/Database/EntityOptions/Code/{code}": { "get": { "tags": [ "Settings/Database" ], "summary": "Gets the database entity option that has the provided code. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "DatabaseEntityOptions_GetByCodeAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "code", "in": "path", "description": "Code of the desired return object.", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/Database/EntityOptions/Name/{name}": { "get": { "tags": [ "Settings/Database" ], "summary": "Gets the database entity option that has the provided name. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "DatabaseEntityOptions_GetByNameAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "name", "in": "path", "description": "Name of the desired return object.", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/EntityOptions/{entity}": { "put": { "tags": [ "Settings/EntityOptions" ], "operationId": "EntityEntityOptions_UpdateEntityOptionsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "required": true, "type": "string", "enum": [ "RiskCategories", "BrokerDealers", "Representatives", "AssetClasses", "AssetCategories", "Platforms", "Models", "AggregateModels", "IndexBlends", "FundFamilies", "Database", "Custodians", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Product", "PortfolioGroups", "SleeveStrategyAggregates", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10" ] }, { "name": "dtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/EntityOptions/{entity}/{entityId}": { "get": { "tags": [ "Settings/EntityOptions" ], "summary": "Gets a list of entity options that the logged in user has access to.", "operationId": "EntityEntityOptions_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The kind of entity to return options for.", "required": true, "type": "string", "enum": [ "RiskCategories", "BrokerDealers", "Representatives", "AssetClasses", "AssetCategories", "Platforms", "Models", "AggregateModels", "IndexBlends", "FundFamilies", "Database", "Custodians", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Product", "PortfolioGroups", "SleeveStrategyAggregates", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10" ] }, { "name": "entityId", "in": "path", "description": "The id of the entity to return options for.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/EntityOptions/{entity}/{entityId}/{code}/Value": { "get": { "tags": [ "Settings/EntityOptions" ], "summary": "Simple Only gets the entity setting value and type, no other properties.", "operationId": "EntityEntityOptions_GetEntityOptionValueAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The level of entity to retrieve (ex. Database, Representative, Client etc.)", "required": true, "type": "string", "enum": [ "RiskCategories", "BrokerDealers", "Representatives", "AssetClasses", "AssetCategories", "Platforms", "Models", "AggregateModels", "IndexBlends", "FundFamilies", "Database", "Custodians", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Product", "PortfolioGroups", "SleeveStrategyAggregates", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10" ] }, { "name": "entityId", "in": "path", "description": "The ID for the selected entity level (use 0 for database)", "required": true, "type": "integer", "format": "int32" }, { "name": "code", "in": "path", "description": "The Unique Option Code.", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionValueDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Settings/EntityOptions" ], "summary": "Simple - Only updates the entity setting value.", "operationId": "EntityEntityOptions_UpdateEntityOptionValueAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The level of entity to retrieve (ex. Database, Representative, Client etc.)", "required": true, "type": "string", "enum": [ "RiskCategories", "BrokerDealers", "Representatives", "AssetClasses", "AssetCategories", "Platforms", "Models", "AggregateModels", "IndexBlends", "FundFamilies", "Database", "Custodians", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Product", "PortfolioGroups", "SleeveStrategyAggregates", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10" ] }, { "name": "entityId", "in": "path", "description": "The ID for the selected entity level (use 0 for database)", "required": true, "type": "integer", "format": "int32" }, { "name": "code", "in": "path", "description": "The Unique Option Code.", "required": true, "type": "string" }, { "name": "dto", "in": "body", "description": "The new value to be updated.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionValueDto" } }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionValueDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/EntityOptions/{entity}/{entityId}/{userDefineDefinitionId}": { "get": { "tags": [ "Settings/EntityOptions" ], "summary": "Gets the entity option that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "EntityEntityOptions_GetV1SettingsEntityOptionsByEntityByEntityIdByUserDefineDefinitionId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The kind of entity to return options for.", "required": true, "type": "string", "enum": [ "RiskCategories", "BrokerDealers", "Representatives", "AssetClasses", "AssetCategories", "Platforms", "Models", "AggregateModels", "IndexBlends", "FundFamilies", "Database", "Custodians", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Product", "PortfolioGroups", "SleeveStrategyAggregates", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10" ] }, { "name": "entityId", "in": "path", "description": "The id of the entity to return options for.", "required": true, "type": "integer", "format": "int32" }, { "name": "userDefineDefinitionId", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Settings/EntityOptions" ], "summary": "Deletes the user established value for the provided entity option.", "operationId": "EntityEntityOptions_DeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The kind of entity.", "required": true, "type": "string", "enum": [ "RiskCategories", "BrokerDealers", "Representatives", "AssetClasses", "AssetCategories", "Platforms", "Models", "AggregateModels", "IndexBlends", "FundFamilies", "Database", "Custodians", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Product", "PortfolioGroups", "SleeveStrategyAggregates", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10" ] }, { "name": "entityId", "in": "path", "description": "The id of the entity.", "required": true, "type": "integer", "format": "int32" }, { "name": "userDefineDefinitionId", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/EntityOptions/{entity}/{entityId}/Categories": { "get": { "tags": [ "Settings/EntityOptions" ], "summary": "Gets the list categories for the database entity options.", "operationId": "EntityEntityOptions_GetCategoriesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The kind of entity to return options for.", "required": true, "type": "string", "enum": [ "RiskCategories", "BrokerDealers", "Representatives", "AssetClasses", "AssetCategories", "Platforms", "Models", "AggregateModels", "IndexBlends", "FundFamilies", "Database", "Custodians", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Product", "PortfolioGroups", "SleeveStrategyAggregates", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10" ] }, { "name": "entityId", "in": "path", "description": "The id of the entity to return options for.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/EntityOptions/{entity}/{entityId}/Categories/{category}": { "get": { "tags": [ "Settings/EntityOptions" ], "summary": "Gets the list of entity options that have the provided category.", "operationId": "EntityEntityOptions_GetByCategoryAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The kind of entity to return options for.", "required": true, "type": "string", "enum": [ "RiskCategories", "BrokerDealers", "Representatives", "AssetClasses", "AssetCategories", "Platforms", "Models", "AggregateModels", "IndexBlends", "FundFamilies", "Database", "Custodians", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Product", "PortfolioGroups", "SleeveStrategyAggregates", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10" ] }, { "name": "entityId", "in": "path", "description": "The id of the entity to return options for.", "required": true, "type": "integer", "format": "int32" }, { "name": "category", "in": "path", "description": "Category of the desired return objects.", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/EntityOptions/{entity}/{entityId}/Code/{code}": { "get": { "tags": [ "Settings/EntityOptions" ], "summary": "Gets the entity option that has the provided code. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "EntityEntityOptions_GetByCodeAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The kind of entity to return options for.", "required": true, "type": "string", "enum": [ "RiskCategories", "BrokerDealers", "Representatives", "AssetClasses", "AssetCategories", "Platforms", "Models", "AggregateModels", "IndexBlends", "FundFamilies", "Database", "Custodians", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Product", "PortfolioGroups", "SleeveStrategyAggregates", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10" ] }, { "name": "entityId", "in": "path", "description": "The id of the entity to return options for.", "required": true, "type": "integer", "format": "int32" }, { "name": "code", "in": "path", "description": "Code of the desired return object.", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Settings/EntityOptions" ], "summary": "Deletes the user established value for the provided entity option.", "operationId": "EntityEntityOptions_DeleteByCodeAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The kind of entity.", "required": true, "type": "string", "enum": [ "RiskCategories", "BrokerDealers", "Representatives", "AssetClasses", "AssetCategories", "Platforms", "Models", "AggregateModels", "IndexBlends", "FundFamilies", "Database", "Custodians", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Product", "PortfolioGroups", "SleeveStrategyAggregates", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10" ] }, { "name": "entityId", "in": "path", "description": "The id of the entity.", "required": true, "type": "integer", "format": "int32" }, { "name": "code", "in": "path", "description": "The code of the entity option.", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/EntityOptions/{entity}/{entityId}/Codes": { "post": { "tags": [ "Settings/EntityOptions" ], "operationId": "EntityEntityOptions_GetByCodeListAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "required": true, "type": "string", "enum": [ "RiskCategories", "BrokerDealers", "Representatives", "AssetClasses", "AssetCategories", "Platforms", "Models", "AggregateModels", "IndexBlends", "FundFamilies", "Database", "Custodians", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Product", "PortfolioGroups", "SleeveStrategyAggregates", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10" ] }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "codes", "in": "body", "required": true, "schema": { "items": { "type": "string" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/EntityOptions/{entity}/{entityId}/Name/{name}": { "get": { "tags": [ "Settings/EntityOptions" ], "summary": "Gets the entity option that has the provided name. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "EntityEntityOptions_GetByNameAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The kind of entity to return options for.", "required": true, "type": "string", "enum": [ "RiskCategories", "BrokerDealers", "Representatives", "AssetClasses", "AssetCategories", "Platforms", "Models", "AggregateModels", "IndexBlends", "FundFamilies", "Database", "Custodians", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Product", "PortfolioGroups", "SleeveStrategyAggregates", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10" ] }, { "name": "entityId", "in": "path", "description": "The id of the entity to return options for.", "required": true, "type": "integer", "format": "int32" }, { "name": "name", "in": "path", "description": "Name of the desired return object.", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Settings/EntityOptions" ], "summary": "Deletes the user established value for the provided entity option.", "operationId": "EntityEntityOptions_DeleteByNameAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The kind of entity.", "required": true, "type": "string", "enum": [ "RiskCategories", "BrokerDealers", "Representatives", "AssetClasses", "AssetCategories", "Platforms", "Models", "AggregateModels", "IndexBlends", "FundFamilies", "Database", "Custodians", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Product", "PortfolioGroups", "SleeveStrategyAggregates", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10" ] }, { "name": "entityId", "in": "path", "description": "The id of the entity.", "required": true, "type": "integer", "format": "int32" }, { "name": "name", "in": "path", "description": "Name of the desired return object.", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/EntityOptions/{entity}/Code/{code}": { "get": { "tags": [ "Settings/EntityOptions" ], "summary": "Gets a list of entity options that the logged in user has access to.", "operationId": "EntityEntityOptions_GetAssignedByCodeAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The kind of entity to return options for.", "required": true, "type": "string", "enum": [ "RiskCategories", "BrokerDealers", "Representatives", "AssetClasses", "AssetCategories", "Platforms", "Models", "AggregateModels", "IndexBlends", "FundFamilies", "Database", "Custodians", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Product", "PortfolioGroups", "SleeveStrategyAggregates", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10" ] }, { "name": "code", "in": "path", "description": "Any entity option that has the code provided will be returned.", "required": true, "type": "string" }, { "name": "showAssigned", "in": "query", "description": "Optional. If provided will only return entity options with values that are assigned or are not assigned.", "required": false, "type": "boolean" }, { "name": "includeName", "in": "query", "description": "Optional. Default: true.", "required": false, "type": "boolean", "default": true }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Settings/EntityOptions" ], "summary": "Updates the provided entity option.", "operationId": "EntityEntityOptions_UpdateEntityOptionAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The kind of entity being updated.", "required": true, "type": "string", "enum": [ "RiskCategories", "BrokerDealers", "Representatives", "AssetClasses", "AssetCategories", "Platforms", "Models", "AggregateModels", "IndexBlends", "FundFamilies", "Database", "Custodians", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Product", "PortfolioGroups", "SleeveStrategyAggregates", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10" ] }, { "name": "code", "in": "path", "description": "The code for the option to update.", "required": true, "type": "string" }, { "name": "dto", "in": "body", "description": "The option to update.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" } }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/EntityOptions/{entity}/Name/{name}": { "get": { "tags": [ "Settings/EntityOptions" ], "summary": "Gets a list of entity options that the logged in user has access to.", "operationId": "EntityEntityOptions_GetAssignedByNameAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The kind of entity to return options for.", "required": true, "type": "string", "enum": [ "RiskCategories", "BrokerDealers", "Representatives", "AssetClasses", "AssetCategories", "Platforms", "Models", "AggregateModels", "IndexBlends", "FundFamilies", "Database", "Custodians", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Product", "PortfolioGroups", "SleeveStrategyAggregates", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10" ] }, { "name": "name", "in": "path", "description": "Any entity option that has the name provided will be returned.", "required": true, "type": "string" }, { "name": "showAssigned", "in": "query", "description": "Optional. If provided will only return entity options with values that are assigned or are not assigned.", "required": false, "type": "boolean" }, { "name": "includeName", "in": "query", "description": "Optional. Default: true.", "required": false, "type": "boolean", "default": true }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/EntityOptions/Definitions/{entity}": { "get": { "tags": [ "Settings/EntityOptions" ], "summary": "Gets a list of entity option definitions. These are the possible options that could be set for an entity, not the actual values set for a specific entity.", "operationId": "EntityEntityOptions_GetDefinitionsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The kind of entity to return options for.", "required": true, "type": "string", "enum": [ "RiskCategories", "BrokerDealers", "Representatives", "AssetClasses", "AssetCategories", "Platforms", "Models", "AggregateModels", "IndexBlends", "FundFamilies", "Database", "Custodians", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Product", "PortfolioGroups", "SleeveStrategyAggregates", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10" ] }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDefinitionDto" }, "xml": { "name": "EntityOptionDefinitionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/EntityOptions/List": { "get": { "tags": [ "Settings/EntityOptions" ], "summary": "Lists the available entity option levels", "operationId": "EntityEntityOptions_GetEntityLevelsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionLevelDto" }, "xml": { "name": "EntityOptionLevelDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/EntityOptions/List/Code/{code}": { "get": { "tags": [ "Settings/EntityOptions" ], "summary": "Lists the available entity option levels for the entity option with the code provided.", "operationId": "EntityEntityOptions_GetEntityLevelsForCodeAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "code", "in": "path", "required": true, "type": "string" }, { "name": "canEdit", "in": "query", "description": "Optional. Default: null. If provided only the levels this user can edit (true) or can't edit (false) are returned.", "required": false, "type": "boolean" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionLevelDto" }, "xml": { "name": "EntityOptionLevelDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/EntityOptions/List/Name/{name}": { "get": { "tags": [ "Settings/EntityOptions" ], "summary": "Lists the available entity option levels for the entity option with the name provided.", "operationId": "EntityEntityOptions_GetEntityLevelsForNameAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "name", "in": "path", "required": true, "type": "string" }, { "name": "canEdit", "in": "query", "description": "Optional. Default: null. If provided only the levels this user can edit (true) or can't edit (false) are returned.", "required": false, "type": "boolean" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionLevelDto" }, "xml": { "name": "EntityOptionLevelDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/Options": { "get": { "tags": [ "Settings/Options" ], "summary": "Gets a list of options that the logged in user has access to. \r\nThe return is limited to pages of 1000. Use $top and $skip in the query string to page through the data.", "operationId": "Options_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "systemGroup", "in": "query", "description": "Optional. Default null. If provided will limit the options that are returned to just those with the provided system group.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.OptionDto" }, "xml": { "name": "OptionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/Options/{fieldName}": { "get": { "tags": [ "Settings/Options" ], "summary": "Gets the option that has the provided name.", "operationId": "Options_GetByFieldName", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "fieldName", "in": "path", "description": "Name of the option to return.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.OptionDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Settings/Options" ], "summary": "Used to update existing option. Upon successful modification a 200 will be returned.", "operationId": "Options_UpdateOption", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "fieldName", "in": "path", "description": "Name of the option to return.", "required": true, "type": "string" }, { "name": "dto", "in": "body", "description": "The collection of web options being updated.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.OptionDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.OptionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/Owner": { "get": { "tags": [ "Settings/Owner" ], "summary": "Gets the Owner info", "operationId": "Owners_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.OwnerDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Settings/Owner" ], "summary": "Used to update existing owner record.", "operationId": "Owners_UpdateOwnerAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "The owner dto being updated.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.OwnerDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.OwnerDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/Owner/Code": { "get": { "tags": [ "Settings/Owner" ], "summary": "Gets the Owner code", "operationId": "Owners_GetOwnerCodeAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/Owner/ReportImage": { "get": { "tags": [ "Settings/Owner" ], "summary": "Gets the owner's report image if one exists. If none exists a 404 will be thrown.", "operationId": "Owners_GetImageAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/UserDefinedFields/{entity}": { "put": { "tags": [ "Settings/UserDefinedFields" ], "summary": "Updates the provided user defined fields.", "operationId": "EntityUserDefinedFields_UpdateEntityOptions", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The kind of entity being updated.", "required": true, "type": "string", "enum": [ "BrokerDealers", "Wholesalers", "Representatives", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Products", "FundFamilies", "ModelRanges", "PortfolioGroups" ] }, { "name": "dtos", "in": "body", "description": "The options to update.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/UserDefinedFields/{entity}/{entityId}": { "get": { "tags": [ "Settings/UserDefinedFields" ], "summary": "Gets a list of user defined options that the logged in user has access to.", "operationId": "EntityUserDefinedFields_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The kind of entity to return options for.", "required": true, "type": "string", "enum": [ "BrokerDealers", "Wholesalers", "Representatives", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Products", "FundFamilies", "ModelRanges", "PortfolioGroups" ] }, { "name": "entityId", "in": "path", "description": "The id of the entity to return options for.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/UserDefinedFields/{entity}/{entityId}/{key}": { "get": { "tags": [ "Settings/UserDefinedFields" ], "summary": "Gets the user defined fields that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "EntityUserDefinedFields_GetV1SettingsUserDefinedFieldsByEntityByEntityIdByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The kind of entity to return options for.", "required": true, "type": "string", "enum": [ "BrokerDealers", "Wholesalers", "Representatives", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Products", "FundFamilies", "ModelRanges", "PortfolioGroups" ] }, { "name": "entityId", "in": "path", "description": "The id of the entity to return options for.", "required": true, "type": "integer", "format": "int32" }, { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/UserDefinedFields/{entity}/{entityId}/Categories": { "get": { "tags": [ "Settings/UserDefinedFields" ], "summary": "Gets the list categories for the database user defined options.", "operationId": "EntityUserDefinedFields_GetCategories", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The kind of entity to return options for.", "required": true, "type": "string", "enum": [ "BrokerDealers", "Wholesalers", "Representatives", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Products", "FundFamilies", "ModelRanges", "PortfolioGroups" ] }, { "name": "entityId", "in": "path", "description": "The id of the entity to return options for.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/UserDefinedFields/{entity}/{entityId}/Categories/{category}": { "get": { "tags": [ "Settings/UserDefinedFields" ], "summary": "Gets the list of user defined options that have the provided category.", "operationId": "EntityUserDefinedFields_GetByCategory", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The kind of entity to return options for.", "required": true, "type": "string", "enum": [ "BrokerDealers", "Wholesalers", "Representatives", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Products", "FundFamilies", "ModelRanges", "PortfolioGroups" ] }, { "name": "entityId", "in": "path", "description": "The id of the entity to return options for.", "required": true, "type": "integer", "format": "int32" }, { "name": "category", "in": "path", "description": "Category of the desired return objects.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/UserDefinedFields/{entity}/{entityId}/Code/{code}": { "get": { "tags": [ "Settings/UserDefinedFields" ], "summary": "Gets the user defined fields that has the provided code. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "EntityUserDefinedFields_GetByCode", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The kind of entity to return options for.", "required": true, "type": "string", "enum": [ "BrokerDealers", "Wholesalers", "Representatives", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Products", "FundFamilies", "ModelRanges", "PortfolioGroups" ] }, { "name": "entityId", "in": "path", "description": "The id of the entity to return options for.", "required": true, "type": "integer", "format": "int32" }, { "name": "code", "in": "path", "description": "Code of the desired return object.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/UserDefinedFields/{entity}/{entityId}/Name/{name}": { "get": { "tags": [ "Settings/UserDefinedFields" ], "summary": "Gets the user defined fields that has the provided name. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "EntityUserDefinedFields_GetByName", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The kind of entity to return options for.", "required": true, "type": "string", "enum": [ "BrokerDealers", "Wholesalers", "Representatives", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Products", "FundFamilies", "ModelRanges", "PortfolioGroups" ] }, { "name": "entityId", "in": "path", "description": "The id of the entity to return options for.", "required": true, "type": "integer", "format": "int32" }, { "name": "name", "in": "path", "description": "Name of the desired return object.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/UserDefinedFields/{entity}/Code/{code}": { "get": { "tags": [ "Settings/UserDefinedFields" ], "summary": "Gets a list of user defined options that the logged in user has access to.", "operationId": "EntityUserDefinedFields_GetAssignedByCode", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The kind of entity to return options for.", "required": true, "type": "string", "enum": [ "BrokerDealers", "Wholesalers", "Representatives", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Products", "FundFamilies", "ModelRanges", "PortfolioGroups" ] }, { "name": "code", "in": "path", "description": "Any user defined fields that has the code provided will be returned.", "required": true, "type": "string" }, { "name": "showAssigned", "in": "query", "description": "Optional. If provided will only return user defined options with values that are assigned or are not assigned.", "required": false, "type": "boolean" }, { "name": "includeName", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Settings/UserDefinedFields" ], "summary": "Updates the provided user defined fields.", "operationId": "EntityUserDefinedFields_UpdateEntityOption", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The kind of entity being updated.", "required": true, "type": "string", "enum": [ "BrokerDealers", "Wholesalers", "Representatives", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Products", "FundFamilies", "ModelRanges", "PortfolioGroups" ] }, { "name": "code", "in": "path", "description": "The code for the option to update.", "required": true, "type": "string" }, { "name": "dto", "in": "body", "description": "The option to update.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/UserDefinedFields/{entity}/Name/{name}": { "get": { "tags": [ "Settings/UserDefinedFields" ], "summary": "Gets a list of user defined options that the logged in user has access to.", "operationId": "EntityUserDefinedFields_GetAssignedByName", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The kind of entity to return options for.", "required": true, "type": "string", "enum": [ "BrokerDealers", "Wholesalers", "Representatives", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Products", "FundFamilies", "ModelRanges", "PortfolioGroups" ] }, { "name": "name", "in": "path", "description": "Any user defined fields that has the name provided will be returned.", "required": true, "type": "string" }, { "name": "showAssigned", "in": "query", "description": "Optional. If provided will only return user defined options with values that are assigned or are not assigned.", "required": false, "type": "boolean" }, { "name": "includeName", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Settings/UserDefinedFields" ], "summary": "Creates provided user defined fields.", "operationId": "EntityUserDefinedFields_CreateEntityOptionDefinition", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The kind of entity being created.", "required": true, "type": "string", "enum": [ "BrokerDealers", "Wholesalers", "Representatives", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Products", "FundFamilies", "ModelRanges", "PortfolioGroups" ] }, { "name": "name", "in": "path", "description": "The name for the option to update.", "required": true, "type": "string" }, { "name": "dto", "in": "body", "description": "The option to create.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.UserDefinedDefinitionDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.UserDefinedDefinitionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/UserDefinedFields/Definitions/{entity}": { "get": { "tags": [ "Settings/UserDefinedFields" ], "summary": "Get all definitions for specified entity type", "operationId": "EntityUserDefinedFieldDefinitions_GetByAllItems", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "required": true, "type": "string", "enum": [ "BrokerDealers", "Wholesalers", "Representatives", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Products", "FundFamilies", "ModelRanges", "PortfolioGroups" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.UserDefinedDefinitionDto" }, "xml": { "name": "UserDefinedDefinitionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Settings/UserDefinedFields" ], "summary": "Creates provided user defined field definition.", "operationId": "EntityUserDefinedFieldDefinitions_CreateEntityOptionDefinition", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The kind of entity being created.", "required": true, "type": "string", "enum": [ "BrokerDealers", "Wholesalers", "Representatives", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Products", "FundFamilies", "ModelRanges", "PortfolioGroups" ] }, { "name": "dto", "in": "body", "description": "The option to create.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.UserDefinedDefinitionDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.UserDefinedDefinitionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/UserDefinedFields/Definitions/{entity}/Code/{code}": { "get": { "tags": [ "Settings/UserDefinedFields" ], "summary": "Get definition for specified entity type and code", "operationId": "EntityUserDefinedFieldDefinitions_GetByCode", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "required": true, "type": "string", "enum": [ "BrokerDealers", "Wholesalers", "Representatives", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Products", "FundFamilies", "ModelRanges", "PortfolioGroups" ] }, { "name": "code", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.UserDefinedDefinitionDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Settings/UserDefinedFields" ], "summary": "Update definition", "operationId": "EntityUserDefinedFieldDefinitions_UpdateOption", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "required": true, "type": "string", "enum": [ "BrokerDealers", "Wholesalers", "Representatives", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Products", "FundFamilies", "ModelRanges", "PortfolioGroups" ] }, { "name": "code", "in": "path", "required": true, "type": "string" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.UserDefinedDefinitionDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.UserDefinedDefinitionDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Settings/UserDefinedFields" ], "summary": "Delete definition", "operationId": "EntityUserDefinedFieldDefinitions_DeleteByCodeAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "required": true, "type": "string", "enum": [ "BrokerDealers", "Wholesalers", "Representatives", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Products", "FundFamilies", "ModelRanges", "PortfolioGroups" ] }, { "name": "code", "in": "path", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/UserDefinedFields/List": { "get": { "tags": [ "Settings/UserDefinedFields" ], "summary": "Lists the available user defined fields levels", "operationId": "EntityUserDefinedFields_GetEntityLevels", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.UserDefinedFieldLevelDto" }, "xml": { "name": "UserDefinedFieldLevelDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/UserDefinedFields/List/Code/{code}": { "get": { "tags": [ "Settings/UserDefinedFields" ], "summary": "Lists the available user defined fields levels for the user defined fields with the code provided.", "operationId": "EntityUserDefinedFields_GetEntityLevelsForCode", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "code", "in": "path", "required": true, "type": "string" }, { "name": "canEdit", "in": "query", "description": "Optional. Default: null. If provided only the levels this user can edit (true) or can't edit (false) are returned.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.UserDefinedFieldLevelDto" }, "xml": { "name": "UserDefinedFieldLevelDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/UserDefinedFields/List/Name/{name}": { "get": { "tags": [ "Settings/UserDefinedFields" ], "summary": "Lists the available user defined fields levels for the user defined fields with the name provided.", "operationId": "EntityUserDefinedFields_GetEntityLevelsForName", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "name", "in": "path", "required": true, "type": "string" }, { "name": "canEdit", "in": "query", "description": "Optional. Default: null. If provided only the levels this user can edit (true) or can't edit (false) are returned.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.UserDefinedFieldLevelDto" }, "xml": { "name": "UserDefinedFieldLevelDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/UserDefinedTimeFields/{entity}": { "put": { "tags": [ "Settings/UserDefinedTimeFields" ], "summary": "Updates the provided user defined time fields.", "operationId": "EntityUserDefinedTimeFields_UpdateEntityOptions", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The kind of entity being updated.", "required": true, "type": "string", "enum": [ "Assets", "Products" ] }, { "name": "dtos", "in": "body", "description": "The options to update.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionTimeDto" }, "xml": { "name": "EntityOptionTimeDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionTimeDto" }, "xml": { "name": "EntityOptionTimeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/UserDefinedTimeFields/{entity}/{entityId}": { "get": { "tags": [ "Settings/UserDefinedTimeFields" ], "summary": "Gets a list of user defined options that the logged in user has access to.", "operationId": "EntityUserDefinedTimeFields_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The kind of entity to return options for.", "required": true, "type": "string", "enum": [ "Assets", "Products" ] }, { "name": "entityId", "in": "path", "description": "The id of the entity to return options for.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionTimeDto" }, "xml": { "name": "EntityOptionTimeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/UserDefinedTimeFields/{entity}/{entityId}/{key}": { "get": { "tags": [ "Settings/UserDefinedTimeFields" ], "summary": "Gets the user defined time fields that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "EntityUserDefinedTimeFields_GetV1SettingsUserDefinedTimeFieldsByEntityByEntityIdByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The kind of entity to return options for.", "required": true, "type": "string", "enum": [ "Assets", "Products" ] }, { "name": "entityId", "in": "path", "description": "The id of the entity to return options for.", "required": true, "type": "integer", "format": "int32" }, { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionTimeDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/UserDefinedTimeFields/{entity}/{entityId}/Categories": { "get": { "tags": [ "Settings/UserDefinedTimeFields" ], "summary": "Gets the list categories for the database user defined options.", "operationId": "EntityUserDefinedTimeFields_GetCategories", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The kind of entity to return options for.", "required": true, "type": "string", "enum": [ "Assets", "Products" ] }, { "name": "entityId", "in": "path", "description": "The id of the entity to return options for.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/UserDefinedTimeFields/{entity}/{entityId}/Categories/{category}": { "get": { "tags": [ "Settings/UserDefinedTimeFields" ], "summary": "Gets the list of user defined options that have the provided category.", "operationId": "EntityUserDefinedTimeFields_GetByCategory", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The kind of entity to return options for.", "required": true, "type": "string", "enum": [ "Assets", "Products" ] }, { "name": "entityId", "in": "path", "description": "The id of the entity to return options for.", "required": true, "type": "integer", "format": "int32" }, { "name": "category", "in": "path", "description": "Category of the desired return objects.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionTimeDto" }, "xml": { "name": "EntityOptionTimeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/UserDefinedTimeFields/{entity}/{entityId}/Code/{code}": { "get": { "tags": [ "Settings/UserDefinedTimeFields" ], "summary": "Gets the user defined time fields that has the provided code. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "EntityUserDefinedTimeFields_GetByCode", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The kind of entity to return options for.", "required": true, "type": "string", "enum": [ "Assets", "Products" ] }, { "name": "entityId", "in": "path", "description": "The id of the entity to return options for.", "required": true, "type": "integer", "format": "int32" }, { "name": "code", "in": "path", "description": "Code of the desired return object.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionTimeDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/UserDefinedTimeFields/{entity}/{entityId}/Name/{name}": { "get": { "tags": [ "Settings/UserDefinedTimeFields" ], "summary": "Gets the user defined time fields that has the provided name. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "EntityUserDefinedTimeFields_GetByName", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The kind of entity to return options for.", "required": true, "type": "string", "enum": [ "Assets", "Products" ] }, { "name": "entityId", "in": "path", "description": "The id of the entity to return options for.", "required": true, "type": "integer", "format": "int32" }, { "name": "name", "in": "path", "description": "Name of the desired return object.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionTimeDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/UserDefinedTimeFields/{entity}/Code/{code}": { "get": { "tags": [ "Settings/UserDefinedTimeFields" ], "summary": "Gets a list of user defined options that the logged in user has access to.", "operationId": "EntityUserDefinedTimeFields_GetAssignedByCode", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The kind of entity to return options for.", "required": true, "type": "string", "enum": [ "Assets", "Products" ] }, { "name": "code", "in": "path", "description": "Any user defined time fields that has the code provided will be returned.", "required": true, "type": "string" }, { "name": "showAssigned", "in": "query", "description": "Optional. If provided will only return user defined options with values that are assigned or are not assigned.", "required": false, "type": "boolean" }, { "name": "includeName", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionTimeDto" }, "xml": { "name": "EntityOptionTimeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Settings/UserDefinedTimeFields" ], "summary": "Updates the provided user defined time fields.", "operationId": "EntityUserDefinedTimeFields_UpdateEntityOption", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The kind of entity being updated.", "required": true, "type": "string", "enum": [ "Assets", "Products" ] }, { "name": "code", "in": "path", "description": "The code for the option to update.", "required": true, "type": "string" }, { "name": "dto", "in": "body", "description": "The option to update.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionTimeDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionTimeDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/UserDefinedTimeFields/{entity}/Name/{name}": { "get": { "tags": [ "Settings/UserDefinedTimeFields" ], "summary": "Gets a list of user defined options that the logged in user has access to.", "operationId": "EntityUserDefinedTimeFields_GetAssignedByName", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The kind of entity to return options for.", "required": true, "type": "string", "enum": [ "Assets", "Products" ] }, { "name": "name", "in": "path", "description": "Any user defined time fields that has the name provided will be returned.", "required": true, "type": "string" }, { "name": "showAssigned", "in": "query", "description": "Optional. If provided will only return user defined options with values that are assigned or are not assigned.", "required": false, "type": "boolean" }, { "name": "includeName", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionTimeDto" }, "xml": { "name": "EntityOptionTimeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Settings/UserDefinedTimeFields" ], "summary": "Creates provided user defined time fields.", "operationId": "EntityUserDefinedTimeFields_CreateEntityOptionDefinition", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "description": "The kind of entity being created.", "required": true, "type": "string", "enum": [ "Assets", "Products" ] }, { "name": "name", "in": "path", "description": "The name for the option to update.", "required": true, "type": "string" }, { "name": "dto", "in": "body", "description": "The option to create.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.UserDefinedDefinitionDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.UserDefinedDefinitionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/UserDefinedTimeFields/List": { "get": { "tags": [ "Settings/UserDefinedTimeFields" ], "summary": "Lists the available user defined time fields levels", "operationId": "EntityUserDefinedTimeFields_GetEntityLevels", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.UserDefinedTimeFieldLevelDto" }, "xml": { "name": "UserDefinedTimeFieldLevelDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/UserDefinedTimeFields/List/Code/{code}": { "get": { "tags": [ "Settings/UserDefinedTimeFields" ], "summary": "Lists the available user defined time fields levels for the user defined time fields with the code provided.", "operationId": "EntityUserDefinedTimeFields_GetEntityLevelsForCode", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "code", "in": "path", "required": true, "type": "string" }, { "name": "canEdit", "in": "query", "description": "Optional. Default: null. If provided only the levels this user can edit (true) or can't edit (false) are returned.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.UserDefinedTimeFieldLevelDto" }, "xml": { "name": "UserDefinedTimeFieldLevelDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/UserDefinedTimeFields/List/Name/{name}": { "get": { "tags": [ "Settings/UserDefinedTimeFields" ], "summary": "Lists the available user defined time fields levels for the user defined time fields with the name provided.", "operationId": "EntityUserDefinedTimeFields_GetEntityLevelsForName", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "name", "in": "path", "required": true, "type": "string" }, { "name": "canEdit", "in": "query", "description": "Optional. Default: null. If provided only the levels this user can edit (true) or can't edit (false) are returned.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.UserDefinedTimeFieldLevelDto" }, "xml": { "name": "UserDefinedTimeFieldLevelDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/UserOptions": { "get": { "tags": [ "Settings/UserOptions" ], "summary": "Gets a list of user options that the logged in user has access to. \r\nThe return is limited to pages of 1000. Use $top and $skip in the query string to page through the data.", "operationId": "UserOptions_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.UserOptionDto" }, "xml": { "name": "UserOptionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/UserOptions/{optionname}": { "get": { "tags": [ "Settings/UserOptions" ], "summary": "Gets the user option that has the provided name. If the item specified doesn't exist or isn't \r\naccessible to the logged in user, a mocked object with the option name and default value will be returned.", "operationId": "UserOptions_GetByOptionName", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "optionname", "in": "path", "description": "Name of the option to return.", "required": true, "type": "string" }, { "name": "defaultValue", "in": "query", "description": "Optional. Default null. If provided will be used to fill in the value property of the object if one does not already exist.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.UserOptionDto" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Settings/UserOptions" ], "operationId": "UserOptions_UpsertEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "optionname", "in": "path", "required": true, "type": "string" }, { "name": "updateDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.UserOptionDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.UserOptionDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Settings/UserOptions" ], "operationId": "UserOptions_Delete", "consumes": [], "produces": [], "parameters": [ { "name": "optionname", "in": "path", "required": true, "type": "string" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/Views/{pageCode}": { "post": { "tags": [ "Settings/Views" ], "summary": "", "operationId": "Views_CreateViewAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "pageCode", "in": "path", "description": "The page code of the view to be returned.", "required": true, "type": "string" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.PageViewDto" } }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "applyShared", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/Views/{pageCode}/{gridType}": { "get": { "tags": [ "Settings/Views" ], "summary": "Gets a list of views that the logged in user has access to for this controller.", "operationId": "Views_GetViewsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "pageCode", "in": "path", "description": "The page code of the view to be returned.", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "gridType", "in": "path", "required": true, "type": "string", "default": 0, "enum": [ "SlickGrid", "AgGrid" ] }, { "name": "applyShared", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/Views/{pageCode}/{key}": { "get": { "tags": [ "Settings/Views" ], "summary": "Gets the view that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Views_GetViewAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "pageCode", "in": "path", "description": "The page code of the view to be returned.", "required": true, "type": "string" }, { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "applyShared", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Settings/Views" ], "summary": "", "operationId": "Views_UpdateViewAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "pageCode", "in": "path", "description": "The page code of the view to be returned.", "required": true, "type": "string" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.PageViewDto" } }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true }, { "name": "applyShared", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Settings/Views" ], "summary": "", "operationId": "Views_DeleteViewAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "pageCode", "in": "path", "description": "The page code of the view to be returned.", "required": true, "type": "string" }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/Views/{pageCode}/{key}/Actions/RemoveAsDefault": { "put": { "tags": [ "Settings/Views" ], "operationId": "Views_RemoveAsDefaultViewAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "pageCode", "in": "path", "required": true, "type": "string" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.PageViewDto" } }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/Views/{pageCode}/{key}/Actions/SetDefault": { "put": { "tags": [ "Settings/Views" ], "summary": "", "operationId": "Views_UpdateAsDefaultViewAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "pageCode", "in": "path", "description": "The page code of the view to be returned.", "required": true, "type": "string" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.PageViewDto" } }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/Views/{pageCode}/AgGrid/Convert": { "post": { "tags": [ "Settings/Views" ], "operationId": "Views_ConvertViewsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "pageCode", "in": "path", "required": true, "type": "string" }, { "name": "dtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.PageViewDto" }, "xml": { "name": "PageViewDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/Views/PageCodes/{entity}/Simple": { "get": { "tags": [ "Settings/Views" ], "operationId": "Views_GetViewsForEntity", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.Domains.Settings.PageCodeEntityDto" }, "xml": { "name": "PageCodeEntityDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/WebAcknowledgements": { "get": { "tags": [ "Settings/WebAcknowledgements" ], "summary": "Gets all webAcknowledgement objects for user", "operationId": "WebAcknowledgements_GetAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "query", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.WebAcknowledgementDto" }, "xml": { "name": "WebAcknowledgementDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Settings/WebAcknowledgements" ], "summary": "Mass update webAcknowledgements", "operationId": "WebAcknowledgements_UpdateItems", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updatedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.WebAcknowledgementDto" }, "xml": { "name": "WebAcknowledgementDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.WebAcknowledgementDto" }, "xml": { "name": "WebAcknowledgementDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Settings/WebAcknowledgements" ], "summary": "Create a new webAcknowledgement", "operationId": "WebAcknowledgements_CreateWebAcknowledgement", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.WebAcknowledgementDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.WebAcknowledgementDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/WebAcknowledgements/{key}": { "get": { "tags": [ "Settings/WebAcknowledgements" ], "summary": "Gets webAcknowledgement by key", "operationId": "WebAcknowledgements_GetItemByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.WebAcknowledgementDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Settings/WebAcknowledgements" ], "summary": "Update one webAcknowledgement", "operationId": "WebAcknowledgements_UpdateWebAcknowledgement", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.WebAcknowledgementDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.WebAcknowledgementDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Settings/WebAcknowledgements" ], "summary": "Delete a webAcknowledgement", "operationId": "WebAcknowledgements_DeleteItem", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/WebAcknowledgements/{key}/Respond": { "post": { "tags": [ "Settings/WebAcknowledgements" ], "summary": "Log a response for this user for the given webAcknowledgement", "operationId": "WebAcknowledgements_RespondToWebAcknowledgement", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "response", "in": "query", "required": true, "type": "string", "enum": [ "None", "Accept", "Decline", "Later" ] }, { "name": "input", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/WebAcknowledgements/{key}/Responses": { "get": { "tags": [ "Settings/WebAcknowledgements" ], "summary": "Gets webAcknowledgement responses by key", "operationId": "WebAcknowledgements_GetResponsesForItem", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "entity", "in": "query", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.WebAcknowledgementResponseDto" }, "xml": { "name": "WebAcknowledgementResponseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/WebOptions": { "get": { "tags": [ "Settings/WebOptions" ], "summary": "Gets a list of web options that the logged in user has access to. \r\nThe return is limited to pages of 1000. Use $top and $skip in the query string to page through the data.", "operationId": "WebOptions_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "optionType", "in": "query", "description": "Optional. Default null. If provided will limit the web options that are returned to just those with the provided option type. Available options are:\r\n StyleSheet, SiteHeader, WebsiteText, ChartColor, PageDefaults, MobileSetting, EProfileTemplate, MIG_IPS, UMAManager, PBWorksMapping, and Reporting.", "required": false, "type": "string", "enum": [ "StyleSheet", "SiteHeader", "WebsiteText", "ChartColor", "PageDefaults", "MobileSetting", "EProfileTemplate", "MIG_IPS", "UMAManager", "PBWorksMapping", "Reporting", "Trading", "Credentials" ] }, { "name": "entity", "in": "query", "description": "Optional. Default null. If provided will limit the web options that are returned to just those with the provided entity.", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "fieldName", "in": "query", "description": "Optional. Default null. If provided will limit the web options that are returned to just those with the provided field name.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.WebOptionDto" }, "xml": { "name": "WebOptionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Settings/WebOptions" ], "summary": "Used to update existing web options. Upon successful modification a 200 will be returned.", "operationId": "WebOptions_UpdateWebOption", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "The collection of web options being updated.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.WebOptionDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.WebOptionDto" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Settings/WebOptions" ], "summary": "Used to update existing web options. Upon successful modification a 200 will be returned.", "operationId": "WebOptions_CreateWebOption", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "The collection of web options being updated.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.WebOptionDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.WebOptionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Settings/WebOptions/{optionname}": { "get": { "tags": [ "Settings/WebOptions" ], "summary": "Gets the web option that has the provided name. If the item specified doesn't exist or isn't \r\naccessible to the logged in user, a mocked object with the option name and default value will be returned.", "operationId": "WebOptions_GetByOptionName", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "optionname", "in": "path", "description": "Name of the option to return.", "required": true, "type": "string" }, { "name": "defaultValue", "in": "query", "description": "Optional. Default null. If provided will be used to fill in the value property of the object if one does not already exist.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.WebOptionDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Settings/WebOptions" ], "operationId": "WebOptions_Delete", "consumes": [], "produces": [], "parameters": [ { "name": "optionname", "in": "path", "required": true, "type": "string" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Status/Hangfire": { "get": { "tags": [ "Status/Hangfire" ], "operationId": "Status_GetHangfireStatus", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Status.HangfireStatusDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Status/Hangfire/JobsOnInactiveServers": { "get": { "tags": [ "Status/Hangfire" ], "operationId": "Status_JobsOnInactiveServers", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/Hangfire.Storage.Monitoring.ProcessingJobDto" }, "xml": { "name": "ProcessingJobDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Theoretical/InflationRates": { "get": { "tags": [ "Theoretical/InflationRates" ], "summary": "Gets a list of inflation rates that the logged in user has access to.\r\nUse $top and $skip in the query string to page through the data.", "operationId": "InflationRates_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Theoretical.InflationRateDto" }, "xml": { "name": "InflationRateDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Theoretical/InflationRates" ], "summary": "Used to create a new business line. Upon successful creation a 201 will be returned with the location of the nearly created business line.", "operationId": "InflationRates_Create", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Theoretical.InflationRateDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Theoretical.InflationRateDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Theoretical/InflationRates/{key}": { "get": { "tags": [ "Theoretical/InflationRates" ], "summary": "Gets the business line that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "InflationRates_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Theoretical.InflationRateDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Theoretical/InflationRates" ], "summary": "Used to update an existing business line. Upon successful modification a 200 will be returned.", "operationId": "InflationRates_Update", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "string", "format": "date-time" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Theoretical.InflationRateDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Theoretical.InflationRateDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Theoretical/InflationRates" ], "summary": "Used to delete an existing business line. Upon successful deletion a 204 will be returned.", "operationId": "InflationRates_Delete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/AccountTradeInfo/{accountId}": { "get": { "tags": [ "Trading/AccountTradeInfo" ], "summary": "Gets the account trade info for the provided account.", "operationId": "Trading_GetAccountTradeInfo", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.AccountTradeInfoDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Confirm": { "get": { "tags": [ "Trading/Confirm" ], "summary": "Get all trade confirmations", "operationId": "TradeConfirmations_GetAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "confirmType", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "confirmDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "clientId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "object" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Confirm/{key}": { "get": { "tags": [ "Trading/Confirm" ], "summary": "Get trade confirmation by key", "operationId": "TradeConfirmations_GetItemByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Confirm/{key}/Details": { "get": { "tags": [ "Trading/Confirm" ], "summary": "Get trade confirmation by key and parse XML", "operationId": "TradeConfirmations_GetItemDetailsByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Confirm/Accounts/{accountId}/{confirmDate}/{confirmType}": { "get": { "tags": [ "Trading/Confirm" ], "summary": "Get trade confirmation by account, confirmation date and confirmation type", "operationId": "TradeConfirmations_GetItemForAccountConfirmDateAndType", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "confirmDate", "in": "path", "required": true, "type": "string", "format": "date-time" }, { "name": "confirmType", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Confirm/Clients/{clientId}/{confirmDate}/{confirmType}": { "get": { "tags": [ "Trading/Confirm" ], "summary": "Get trade confirmation for client at specified date", "operationId": "TradeConfirmations_GetItemForClientAndConfirmDate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "confirmDate", "in": "path", "required": true, "type": "string", "format": "date-time" }, { "name": "confirmType", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Confirm/Dates": { "get": { "tags": [ "Trading/Confirm" ], "summary": "Get the list of all confirmation dates", "operationId": "TradeConfirmations_GetAllDates", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "confirmType", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "clientId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "xml": { "name": "DateOnly", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ContributionCodeExts": { "get": { "tags": [ "Trading/ContributionCodeExts" ], "summary": "Gets a list of contribution codes extensions that the logged in user has access to.", "operationId": "ContributionCodes_GetContributionCodeExts", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.ContributionCodeExt" }, "xml": { "name": "ContributionCodeExt", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ContributionCodeExts/Simple": { "get": { "tags": [ "Trading/ContributionCodeExts" ], "summary": "Gets a simple list of contribution code extensions that the logged in user has access to.", "operationId": "ContributionCodes_GetContributionCodeExtsSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ContributionCodes/Simple": { "get": { "tags": [ "Trading/ContributionCodes" ], "summary": "Gets a simple list of contribution codes that the logged in user has access to.", "operationId": "ContributionCodes_GetContributionCodesSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Contributions": { "post": { "tags": [ "Trading/Contributions" ], "summary": "Saves contributions", "operationId": "Trading_CalcAndSaveContributionsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "contributionList", "in": "body", "description": "Required. List of Contributions to be saved", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.Remote.Trading.ContributionDto" }, "xml": { "name": "ContributionDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ConvexRebalanceAccount": { "get": { "tags": [ "Trading/ConvexRebalanceAccount" ], "operationId": "ConvexRebalanceAccount_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ConvexRebalanceAccountDto" }, "xml": { "name": "ConvexRebalanceAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ConvexRebalanceAccount/{key}": { "get": { "tags": [ "Trading/ConvexRebalanceAccount" ], "operationId": "ConvexRebalanceAccount_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ConvexRebalanceAccountDto" }, "xml": { "name": "ConvexRebalanceAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Trading/ConvexRebalanceAccount" ], "operationId": "ConvexRebalanceAccount_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ConvexRebalanceAccountDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ConvexRebalanceAccountDto" }, "xml": { "name": "ConvexRebalanceAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ConvexRebalanceAccount/CalculateAccount": { "post": { "tags": [ "Trading/ConvexRebalanceAccount" ], "summary": "Convex rebalance for account.", "operationId": "ConvexRebalanceAccount_ConvexRecalculateAccounts", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "recalcHistory", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/DistributionCodes": { "get": { "tags": [ "Trading/DistributionCodes" ], "operationId": "DistributionCodes_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "transDesc", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.DistributionCodeDto" }, "xml": { "name": "DistributionCodeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/DistributionCodes/{key}/Simple": { "get": { "tags": [ "Trading/DistributionCodes" ], "summary": "Gets a simple list of distribution codes that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "DistributionCodes_GetSimpleByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/DistributionCodes/Simple": { "get": { "tags": [ "Trading/DistributionCodes" ], "summary": "Gets a simple list of distribution codes that the logged in user has access to.", "operationId": "DistributionCodes_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/DistributionCodes/TransDesc": { "get": { "tags": [ "Trading/DistributionCodes" ], "operationId": "DistributionCodes_GetTransDesc", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isQualified", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ExecutionLogs/{asOfDate}": { "get": { "tags": [ "Trading/ExecutionLogs" ], "operationId": "TradeExecutionLogs_GetTradeExecutionLogs", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ExecutionLogs/Schedules/{asOfDate}": { "get": { "tags": [ "Trading/ExecutionLogs" ], "operationId": "TradeExecutionLogSchedules_GetScheduledJobs", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ExecutionLogs/Schedules/Action/QueueStatus": { "put": { "tags": [ "Trading/ExecutionLogs" ], "operationId": "TradeExecutionLogSchedules_UpdateScheduledJobs", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "status", "in": "query", "required": true, "type": "string", "enum": [ "Unknown", "Scheduled", "Processing", "Success", "Failed", "Rescheduled", "Hold", "Resume", "Delete", "Fail", "RunNow" ] }, { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/FixBatches/{fixBatchId}/FixBlockOrders": { "get": { "tags": [ "Trading/FixBatches" ], "operationId": "FixBatch_GetBlocks", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "fixBatchId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.FixBlockOrderDto" }, "xml": { "name": "FixBlockOrderDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/FixBlockOrders": { "get": { "tags": [ "Trading/FixBlockOrders" ], "summary": "Gets a list of fix block orders that the logged in user has access to.\r\nThe return is limited to pages of 10000. Use $top and $skip in the query string to page through the data.", "operationId": "FixBlockOrders_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "description": "Optional. The start of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. The end of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "status", "in": "query", "description": "Optional. Default null. If provided the block orders will be filtered as follows:\r\n open: to return only non-filled block orders\r\n closed: to return only filled block orders\r\n unallocated: to return only block orders that have unsent, or unconfirmed allocations\r\n pending: to return only block orders that have pending transactions", "required": false, "type": "string" }, { "name": "alike", "in": "query", "description": "Optional. Default null. If provided only block orders that are like the block with the provided id will be returned. The will have\r\n the same Ticker, Action, OrdType, Transaction Date, Master Account #, and Executing Broker.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.FixBlockOrderDto" }, "xml": { "name": "FixBlockOrderDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Trading/FixBlockOrders" ], "operationId": "FixBlockOrders_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.FixBlockOrderDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/FixBlockOrders/{blockId}/Fees": { "get": { "tags": [ "Trading/FixBlockOrders" ], "summary": "Gets a list of FixBlockOrderCommissions that the logged in user has access to. \r\nThe return is limited to pages of 1000. Use $top and $skip in the query string to page through the data.", "operationId": "FixBlockOrdersFees_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "blockId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.FixFeeDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Trading/FixBlockOrders" ], "summary": "Takes a Fees/Commissions object, and saves the fee and commission detail to the block order, and to the underlying trade orders.", "operationId": "FixBlockOrdersFees_PutUpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "blockId", "in": "path", "description": "Id of the FixBlockOrder that will be updated", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "Fee detail", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.FixFeeDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.FixFeeDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/FixBlockOrders/{blockId}/FixLogs": { "get": { "tags": [ "Trading/FixBlockOrders" ], "summary": "Returns Fix Log Message for a block order.", "operationId": "FixBlockOrders_GetFixLogsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "blockId", "in": "path", "description": "The fix block order id.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.FixBlockOrderLogDto" }, "xml": { "name": "FixBlockOrderLogDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/FixBlockOrders/{blockId}/Orders": { "get": { "tags": [ "Trading/FixBlockOrders" ], "summary": "Gets a list of orders that fall within the specified block.", "operationId": "FixBlockOrders_GetOrdersForBlock", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "blockId", "in": "path", "description": "The fix block order id.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OrderDto" }, "xml": { "name": "OrderDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/FixBlockOrders/{blockId}/Transactions": { "get": { "tags": [ "Trading/FixBlockOrders" ], "summary": "Gets a list of transactions that fall within the specified block.\r\nThe return is limited to pages of 10000. Use $top and $skip in the query string to page through the data.", "operationId": "FixBlockOrders_GetTransactionsForBlock", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "blockId", "in": "path", "description": "The fix block order id.", "required": true, "type": "integer", "format": "int32" }, { "name": "status", "in": "query", "description": "Optional. Default null. If provided will limit the transactions that are returned to just those with the provided status. Available statuses are\r\n complete, pending, rejected, reversed, and inactive.", "required": false, "type": "string", "enum": [ "Complete", "Pending", "Rejected", "Reversed", "Inactive", "PendingCorpAction", "FutureAip" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TradingTransactionDto" }, "xml": { "name": "TradingTransactionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/FixBlockOrders/{key}": { "get": { "tags": [ "Trading/FixBlockOrders" ], "summary": "Gets the fix block order that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "FixBlockOrders_GetV1TradingFixBlockOrdersByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.FixBlockOrderDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Trading/FixBlockOrders" ], "summary": "Save a fix block order.", "operationId": "FixBlockOrders_UpdateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "FixBlockOrderId to be updated.", "required": true, "type": "integer", "format": "int32" }, { "name": "update", "in": "body", "description": "FixBlockOrderDto object.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.FixBlockOrderDto" } }, { "name": "execute", "in": "query", "description": "Optional. Default is False. If True, the block order will be executed (Transmitted).", "required": false, "type": "boolean", "default": false }, { "name": "autoAllocate", "in": "query", "description": "Optional. Indicates if the blocks should be auto allocated or not. If left blank, The auto allocate will be left as they were when the block was created. This is only used when executeBlock=true", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.FixBlockOrderDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Trading/FixBlockOrders" ], "operationId": "FixBlockOrders_Delete", "consumes": [], "produces": [], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/FixBlockOrders/{key}/ImportAllocations": { "post": { "tags": [ "Trading/FixBlockOrders" ], "summary": "Takes an xlsx, xls, or csv file as multipart content. The file needs either an order id column (named \"order #\", or \"order id\") or an account id column (named \"account #\", or \"account id\").\r\nThe file will be processed and returned as a list of orders. No change will be made to the underlying database.", "operationId": "FixBlockOrders_ImportOrdersPostAsMultipartStream", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OrderDto" }, "xml": { "name": "OrderDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/FixBlockOrders/{key}/RealtimePrice": { "get": { "tags": [ "Trading/FixBlockOrders" ], "summary": "Gets the price to use for the order that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "FixBlockOrders_GetRealtimePriceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "includeDetails", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RealtimePriceDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/FixBlockOrders/Action/Allocate": { "put": { "tags": [ "Trading/FixBlockOrders" ], "operationId": "FixBlockOrders_ActionAllocateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "Ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "markComplete", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.FixBlockOrderDto" }, "xml": { "name": "FixBlockOrderDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/FixBlockOrders/Action/AllocateAutoAdjust": { "put": { "tags": [ "Trading/FixBlockOrders" ], "summary": "Update order qty to match the block orders filled CumQty adjusting the order quantity using pro-rata calculation.", "operationId": "FixBlockOrders_ActionAllocateAutoAdjustAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "blockId", "in": "query", "description": "Block ID to update the underlying order quantities.", "required": true, "type": "integer", "format": "int32" }, { "name": "allocateAutoAdjustType", "in": "query", "required": true, "type": "string", "enum": [ "ProRata", "Random" ] }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.UnallocatedOrderDto" }, "xml": { "name": "UnallocatedOrderDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/FixBlockOrders/Action/Cancel": { "put": { "tags": [ "Trading/FixBlockOrders" ], "operationId": "FixBlockOrders_ActionCancelAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "Ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.FixBlockOrderDto" }, "xml": { "name": "FixBlockOrderDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/FixBlockOrders/Action/Delete": { "put": { "tags": [ "Trading/FixBlockOrders" ], "operationId": "FixBlockOrders_ActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "Ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ignoreSent", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/FixBlockOrders/Action/Execute": { "put": { "tags": [ "Trading/FixBlockOrders" ], "operationId": "FixBlockOrders_ActionExecuteAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "Ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "autoAllocate", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.FixBlockOrderDto" }, "xml": { "name": "FixBlockOrderDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/FixBlockOrders/Filter/Orders": { "get": { "tags": [ "Trading/FixBlockOrders" ], "summary": "Gets a list of orders that the logged in user has access to which fall within the filtering parameters provided. Note: all filters apply to the the fix block order.\r\nThe return is limited to pages of 10000. Use $top and $skip in the query string to page through the data.", "operationId": "FixBlockOrders_GetOrdersForFilteredBlocks", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "description": "Optional. The start of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. The end of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "status", "in": "query", "description": "Optional. Default null. If provided the block orders will be filtered as follows:\r\n open: to return only non-filled block orders\r\n closed: to return only filled block orders\r\n unallocated: to return only block orders that have unsent, or unconfirmed allocations\r\n pending: to return only block orders that have pending transactions", "required": false, "type": "string" }, { "name": "alike", "in": "query", "description": "Optional. Default null. If provided only block orders that are like the block with the provided id will be returned. The will have\r\n the same Ticker, Action, OrdType, Transaction Date, Master Account #, and Executing Broker.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OrderDto" }, "xml": { "name": "OrderDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/FixBlockOrders/Filter/UnallocatedOrders": { "get": { "tags": [ "Trading/FixBlockOrders" ], "summary": "Gets a list of unallocated orders that the logged in user has access to which fall within the filtering parameters provided. Note: all filters apply to the the fix block order.\r\nThe return is limited to pages of 10000. Use $top and $skip in the query string to page through the data.", "operationId": "FixBlockOrders_GetUnallocatedOrdersForFilteredBlocks", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "description": "Optional. The start of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. The end of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "status", "in": "query", "description": "Optional. Default null. If provided the block orders will be filtered as follows:\r\n open: to return only non-filled block orders\r\n closed: to return only filled block orders\r\n unallocated: to return only block orders that have unsent, or unconfirmed allocations\r\n pending: to return only block orders that have pending transactions", "required": false, "type": "string" }, { "name": "alike", "in": "query", "description": "Optional. Default null. If provided only block orders that are like the block with the provided id will be returned. The will have\r\n the same Ticker, Action, OrdType, Transaction Date, Master Account #, and Executing Broker.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.UnallocatedOrderDto" }, "xml": { "name": "UnallocatedOrderDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/FixBlockOrders/UpdateEnMasse": { "put": { "tags": [ "Trading/FixBlockOrders" ], "summary": "Updates every block provided in the list of ids.", "operationId": "FixBlockOrders_UpdateInMassAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "update", "in": "body", "description": "Optional. The ids of the blocks to delete. If left blank, all blocks that have not been sent will be deleted.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.UpdateBlocksInMassDto" } }, { "name": "autoAllocate", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "additionalProperties": { "type": "string" }, "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/FixBlockOrders/UpdateInMass": { "put": { "tags": [ "Trading/FixBlockOrders" ], "summary": "Updates every block provided in the list of ids.", "operationId": "FixBlockOrders_UpdateInMass", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "update", "in": "body", "description": "Optional. The ids of the blocks to delete. If left blank, all blocks that have not been sent will be deleted.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.UpdateBlocksInMassDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.FixBlockOrderDto" }, "xml": { "name": "FixBlockOrderDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/GenerateTrades": { "post": { "tags": [ "Trading/GenerateTrades" ], "summary": "Generates trades of any type based on the instructions in the tradeDefinition provided in the request body.", "operationId": "Trading_GenerateTradesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "tradeDef", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Remote.Trading.TradeDefinition" } }, { "name": "sendNow", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "wait", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/GenerateTrades/Buy": { "post": { "tags": [ "Trading/GenerateTrades" ], "summary": "This is used when buying a product from cash, it handles setting the sell side of the trade to sweep asset/product.", "operationId": "Trading_GenerateTradesBuyAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "tradeDef", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Remote.Trading.BuySells" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/GenerateTrades/Sell": { "post": { "tags": [ "Trading/GenerateTrades" ], "summary": "This is used when selling a product to cash, it handles setting the buy side of the trade to sweep asset/product.", "operationId": "Trading_GenerateTradesSellAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "tradeDef", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.Remote.Trading.BuySells" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/GlobalTradeCount": { "post": { "tags": [ "Trading/GlobalTradeCount" ], "summary": "Returns the number of global trades the logged in user has access to for the criteria provided.\r\nThis is a Post because the UI can send tons of ModelAggs and break the url length", "operationId": "Trading_PostGetGlobalTradeCount", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "globalTradeCountRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Trading.Dto.GlobalTradeCountRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Instances": { "get": { "tags": [ "Trading/Instances" ], "summary": "Gets a list of trade request instances that the logged in user has access to and were created within the range provided. \r\nThe return is limited to pages of 10000. Use $top and $skip in the query string to page through the data.", "operationId": "TradeRequestInstances_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "description": "Cancellation Token", "required": true }, { "name": "startDate", "in": "query", "description": "Optional. The start of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. The end of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "isReady", "in": "query", "description": "Optional. If provided, only ready (or not ready) instances are returned.", "required": false, "type": "boolean" }, { "name": "entity", "in": "query", "description": "Optional. If provided, entityId is required as well. instance for only the specified entity/entityid are returned", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "query", "description": "Optional. If provided, entity is required as well. instance for only the specified entity/entityid are returned", "required": false, "type": "integer", "format": "int32" }, { "name": "useEclipse", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "skipFilterZeroOrderAccounts", "in": "query", "description": "Optional. If provided show orders with zero accounts associated", "required": false, "type": "boolean", "default": false }, { "name": "eclipseFirmId", "in": "query", "required": false, "type": "string" }, { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TradeRequestInstanceDto" }, "xml": { "name": "TradeRequestInstanceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Instances/{entity}/{entityId}": { "get": { "tags": [ "Trading/Instances" ], "operationId": "TradeRequestInstances_GetRepCodeInstances", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "path", "required": true, "type": "string" }, { "name": "entityId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "instanceIds", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "object" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Instances/{key}": { "get": { "tags": [ "Trading/Instances" ], "summary": "Gets the trade request instance that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "TradeRequestInstances_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TradeRequestInstanceDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Instances/{key}/Orders": { "get": { "tags": [ "Trading/Instances" ], "summary": "Gets a list of orders that fall below the trade request instance with the specified key, which the logged in user has access to.", "operationId": "TradeRequestInstances_GetOrdersAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OrderDto" }, "xml": { "name": "OrderDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Instances/Action/Cancel": { "put": { "tags": [ "Trading/Instances" ], "operationId": "TradeRequestInstances_ActionCancel", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Instances/Action/CreateBlocks": { "put": { "tags": [ "Trading/Instances" ], "operationId": "TradeRequestInstances_CreateBlocksAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "instanceIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "autoAllocate", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TradeRequestInstanceDto" }, "xml": { "name": "TradeRequestInstanceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Instances/Action/CreateFee": { "put": { "tags": [ "Trading/Instances" ], "operationId": "TradeRequestInstances_CreateFeeInstance", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "instanceIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Instances/Action/Delete": { "put": { "tags": [ "Trading/Instances" ], "operationId": "TradeRequestInstances_ActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Instances/Action/DisableClientInstance": { "put": { "tags": [ "Trading/Instances" ], "summary": "Disables every order for the instances provided in the list of ids and also sets the instance to executed.\r\nThis should only be used for FTJ's client portal trading. This is only because they wanted to do it the old way it was done in Desktop.", "operationId": "TradeRequestInstances_ActionDisableAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "description": "The instance Ids to delete.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Instances/Action/ExecuteFees": { "put": { "tags": [ "Trading/Instances" ], "operationId": "TradeRequestInstances_ExecuteFeeInstancesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "instanceIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Instances/Action/SetApprovalStatus": { "put": { "tags": [ "Trading/Instances" ], "summary": "", "operationId": "TradeRequestInstances_ActionApprovalStatusAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "status", "in": "query", "required": true, "type": "string", "enum": [ "Approved", "PendingApproval", "NotApproved" ] }, { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TradeRequestInstanceDto" }, "xml": { "name": "TradeRequestInstanceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Instances/Action/SetIsReady": { "put": { "tags": [ "Trading/Instances" ], "operationId": "TradeRequestInstances_SetIsReady", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "instanceIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "isReady", "in": "query", "required": true, "type": "boolean" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TradeRequestInstanceDto" }, "xml": { "name": "TradeRequestInstanceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Instances/Blob/{key}": { "get": { "tags": [ "Trading/Instances" ], "operationId": "TradeRequestInstances_GetBlobAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.Remote.Trading.TradingParameterDto" }, "xml": { "name": "TradingParameterDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Instances/Simple": { "get": { "tags": [ "Trading/Instances" ], "summary": "Gets a simple list of trade request instances that the logged in user has access to. \r\nThe return is limited to pages of 10000. Use $top and $skip in the query string to page through the data.", "operationId": "TradeRequestInstances_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ModelAggs": { "get": { "tags": [ "Trading/ModelAggs" ], "summary": "Gets a list of model aggs that the logged in user has access to. \r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "ModelAggs_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "query", "description": "Limits the results to only model aggs that are permitted for this account.", "required": false, "type": "integer", "format": "int32" }, { "name": "subAdvisorId", "in": "query", "description": "If limiting by accountId allows you to also limit as though the account were under the provided subadvisor.", "required": false, "type": "integer", "format": "int32" }, { "name": "registrationId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "excludeSelfDirected", "in": "query", "description": "Optional. Default: false. When true, self-directed aggregate models are not returned.", "required": false, "type": "boolean", "default": false }, { "name": "modelType", "in": "query", "description": "Optional. Default: null. If provided, only model aggs that contain at least one model of the provided type will be returned.", "required": false, "type": "string" }, { "name": "modelAggType", "in": "query", "required": false, "type": "string" }, { "name": "canMaintainOnly", "in": "query", "description": "Optional. Default: false. If true, only model aggs the current user can edit are returned.", "required": false, "type": "boolean", "default": false }, { "name": "withOrders", "in": "query", "description": "Optional. When provided (true) will return model aggs with orders or when provided (false) will return without orders.", "required": false, "type": "boolean" }, { "name": "forUser", "in": "query", "description": "Optionl. When provided (true) will return the model aggs owned and visable to the User.", "required": false, "type": "boolean" }, { "name": "representativeId", "in": "query", "description": "Optional. Default: null. When there is value, only the model aggs that the representativeIds", "required": false, "type": "integer", "format": "int32" }, { "name": "isUsed", "in": "query", "description": "Optional. When provided will only return model aggs that are used (true) or aren't used (false).", "required": false, "type": "boolean" }, { "name": "isProposalEnabled", "in": "query", "required": false, "type": "boolean" }, { "name": "isAdvisoryWorldModel", "in": "query", "required": false, "type": "boolean" }, { "name": "riskRange", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "None", "OneToTwenty", "TwentyoneToForty", "FortyoneToSixty", "SixtyoneToEighty", "EightyoneToOneHundred", "All" ] }, { "name": "getAllModelsForAllSubAdvisors", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "allModelsActive", "in": "query", "description": "Optional. Will default to true and only bring back modelaggs where all models are active.", "required": false, "type": "boolean", "default": true }, { "name": "includeCommunityModels", "in": "query", "description": "Optional. Default: null No Community Models will be returned. When the value is true, all model aggs, including community models will be returned.", "required": false, "type": "boolean", "default": true }, { "name": "onlyCommunityModels", "in": "query", "description": "Optional. Default: false will return all models. When value is true, will only show Community Models", "required": false, "type": "boolean", "default": false }, { "name": "onlyAstroModels", "in": "query", "description": "Optional. Default: null will return all models. When value is true, will only show Astro Models", "required": false, "type": "boolean" }, { "name": "custodian", "in": "query", "description": "Optional. Default null - filtered model aggregates by associated account custodian", "required": false, "type": "string" }, { "name": "fundFamily", "in": "query", "description": "Optional. Default null - filtered model aggregates by associated account fund family", "required": false, "type": "string" }, { "name": "eclipseModelId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "eclipseFirmId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "WithDetails", "ModelAggLight" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelAggDto" }, "xml": { "name": "ModelAggDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Trading/ModelAggs" ], "operationId": "ModelAggs_CreateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelAggWithDetailsDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelAggWithDetailsDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ModelAggs/{key}": { "get": { "tags": [ "Trading/ModelAggs" ], "summary": "Gets the model agg that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ModelAggs_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "returnStyle", "in": "query", "description": "Indicates if the response should include details or not. Default is WithDetails. WithDetails is much slower, but includes the assigned accounts and Approved Entitites.", "required": false, "type": "string", "default": 1, "enum": [ "Standard", "WithDetails", "ModelAggLight" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelAggDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Trading/ModelAggs" ], "summary": "Updates the billFeeSchedule for the model aggregate", "operationId": "ModelAggs_UpdateAggregateModelAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "ModelAggWithDetails", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelAggWithDetailsDto" } }, { "name": "cancellationToken", "in": "header", "description": "CancellationToken", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelAggWithDetailsDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Trading/ModelAggs" ], "operationId": "ModelAggs_DeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ModelAggs/{key}/{accountId}/Allocations": { "get": { "tags": [ "Trading/ModelAggs" ], "operationId": "ModelAggs_GetAllocationsForAccount", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.CurrentAccountModelDto" }, "xml": { "name": "CurrentAccountModelDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ModelAggs/{key}/Accounts": { "get": { "tags": [ "Trading/ModelAggs" ], "summary": "Returns standard account object for a ModelAggregate Id.", "operationId": "ModelAggs_GetV1TradingModelAggsByKeyAccounts", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "manipulator", "in": "header", "required": true }, { "name": "key", "in": "path", "description": "ModelAggId", "required": true, "type": "integer", "format": "int32" }, { "name": "isActive", "in": "query", "description": "Optional. If False, all accounts are returned, if true, only active true accounts are returned.", "required": false, "type": "boolean" }, { "name": "isManaged", "in": "query", "description": "Optional. If included, accounts are filtered to managed parameter.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountBaseDto" }, "xml": { "name": "AccountBaseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ModelAggs/{key}/Allocations": { "get": { "tags": [ "Trading/ModelAggs" ], "operationId": "ModelAggs_GetAllocationsForAggregateModel", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "includeRiskScore", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.CurrentAccountModelDto" }, "xml": { "name": "CurrentAccountModelDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ModelAggs/{key}/AssignedBenchmarks": { "get": { "tags": [ "Trading/ModelAggs" ], "operationId": "ModelAggs_GetAssignedBenchmarks", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BenchmarkDto" }, "xml": { "name": "BenchmarkDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ModelAggs/{key}/CanMaintain": { "get": { "tags": [ "Trading/ModelAggs" ], "operationId": "ModelAggs_CanMaintain", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.AggregateModelCanMaintainDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ModelAggs/AggTypes": { "get": { "tags": [ "Trading/ModelAggs" ], "operationId": "ModelAggs_GetModelAggModelAggTypes", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ModelAggs/ByModel/{modelId}": { "get": { "tags": [ "Trading/ModelAggs" ], "operationId": "ModelAggs_GetByModelId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "modelId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelAggDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ModelAggs/Element": { "get": { "tags": [ "Trading/ModelAggs" ], "summary": "Gets a list of model aggs that the logged in user has access to. \r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "ModelAggs_GetModelAggsForElement", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "query", "description": "Limits the results to only model aggs that are permitted for this account.", "required": false, "type": "integer", "format": "int32" }, { "name": "subAdvisorId", "in": "query", "description": "If limiting by accountId allows you to also limit as though the account were under the provided subadvisor.", "required": false, "type": "integer", "format": "int32" }, { "name": "registrationId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "excludeSelfDirected", "in": "query", "description": "Optional. Default: false. When true, self-directed aggregate models are not returned.", "required": false, "type": "boolean", "default": false }, { "name": "modelType", "in": "query", "description": "Optional. Default: null. If provided, only model aggs that contain at least one model of the provided type will be returned.", "required": false, "type": "string" }, { "name": "modelAggType", "in": "query", "required": false, "type": "string" }, { "name": "canMaintainOnly", "in": "query", "description": "Optional. Default: false. If true, only model aggs the current user can edit are returned.", "required": false, "type": "boolean", "default": false }, { "name": "withOrders", "in": "query", "description": "Optional. When provided (true) will return model aggs with orders or when provided (false) will return without orders.", "required": false, "type": "boolean" }, { "name": "forUser", "in": "query", "description": "Optionl. When provided (true) will return the model aggs owned and visable to the User.", "required": false, "type": "boolean" }, { "name": "representativeId", "in": "query", "description": "Optional. Default: null. When there is value, only the model aggs that the representativeIds", "required": false, "type": "integer", "format": "int32" }, { "name": "isUsed", "in": "query", "description": "Optional. When provided will only return model aggs that are used (true) or aren't used (false).", "required": false, "type": "boolean" }, { "name": "isProposalEnabled", "in": "query", "required": false, "type": "boolean" }, { "name": "isAdvisoryWorldModel", "in": "query", "required": false, "type": "boolean" }, { "name": "riskRange", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "None", "OneToTwenty", "TwentyoneToForty", "FortyoneToSixty", "SixtyoneToEighty", "EightyoneToOneHundred", "All" ] }, { "name": "getAllModelsForAllSubAdvisors", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "allModelsActive", "in": "query", "description": "Optional. Will default to true and only bring back modelaggs where all models are active.", "required": false, "type": "boolean", "default": true }, { "name": "includeCommunityModels", "in": "query", "description": "Optional. Default: null No Community Models will be returned. When the value is true, all model aggs, including community models will be returned.", "required": false, "type": "boolean", "default": true }, { "name": "onlyCommunityModels", "in": "query", "description": "Optional. Default: false will return all models. When value is true, will only show Community Models", "required": false, "type": "boolean", "default": false }, { "name": "onlyAstroModels", "in": "query", "description": "Optional. Default: null will return all models. When value is true, will only show Astro Models", "required": false, "type": "boolean" }, { "name": "custodian", "in": "query", "description": "Optional. Default null - filtered model aggregates by associated account custodian", "required": false, "type": "string" }, { "name": "fundFamily", "in": "query", "description": "Optional. Default null - filtered model aggregates by associated account fund family", "required": false, "type": "string" }, { "name": "eclipseFirmId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ModelAggs/FindByAllocation": { "put": { "tags": [ "Trading/ModelAggs" ], "operationId": "ModelAggs_FindByAllocation", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "aggregation", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Trading.ModelAggsController.SimpleModelAggregation" } }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "WithDetails", "ModelAggLight" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "object" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ModelAggs/Limited": { "get": { "tags": [ "Trading/ModelAggs" ], "summary": "Gets a list of model aggs with few fields that the logged in user has access to. \r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "ModelAggs_GetLimited", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "query", "description": "Limits the results to only model aggs that are permitted for this account.", "required": false, "type": "integer", "format": "int32" }, { "name": "subAdvisorId", "in": "query", "description": "If limiting by accountId allows you to also limit as though the account were under the provided subadvisor.", "required": false, "type": "integer", "format": "int32" }, { "name": "registrationId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "modelAggType", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.LimitedAggregateModel" }, "xml": { "name": "LimitedAggregateModel", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ModelAggs/List": { "post": { "tags": [ "Trading/ModelAggs" ], "operationId": "ModelAggs_GetListById", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 1, "enum": [ "Standard", "WithDetails", "ModelAggLight" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "object" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ModelAggs/List/Id": { "post": { "tags": [ "Trading/ModelAggs" ], "operationId": "ModelAggs_PostV1TradingModelAggsListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 1, "enum": [ "Standard", "WithDetails", "ModelAggLight" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "object" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ModelAggs/MapEclipseModelsToModelAggs": { "post": { "tags": [ "Trading/ModelAggs" ], "operationId": "ModelAggs_MapEclipseModelIds", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "eclipseModelMappingDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integration.Eclipse.EclipseModelMappingDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ModelAggs/Reporting": { "put": { "tags": [ "Trading/ModelAggs" ], "summary": "Updates the focus point reporting table for the model aggregate", "operationId": "ModelAggsReporting_UpdateModelAggsReportingAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "ModelAggReportingDto", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ModelAggsReporting.FocusPointReportingDto" } }, { "name": "cancellationToken", "in": "header", "description": "CancellationToken", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ModelAggsReporting.FocusPointReportingDto" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Trading/ModelAggs" ], "summary": "Creates a focus point reporting table for the model aggregate", "operationId": "ModelAggsReporting_CreateModelAggsReportingAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "ModelAggReportingDto", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ModelAggsReporting.FocusPointReportingDto" } }, { "name": "cancellationToken", "in": "header", "description": "CancellationToken", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ModelAggsReporting.FocusPointReportingDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ModelAggs/Reporting/{key}": { "get": { "tags": [ "Trading/ModelAggs" ], "summary": "Gets the model agg reporting records based on the model agg key.", "operationId": "ModelAggsReporting_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired model agg.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "description": "CancellationToken", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ModelAggsReporting.FocusPointReportingDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ModelAggs/RequestEclipseModelCreation": { "post": { "tags": [ "Trading/ModelAggs" ], "summary": "Finds all qualifying AggregateModels (have not already been created in Eclipse)\r\nBuilds a requestDto to send to Eclipse, and initiates the request to create\r\nEclipse models from the supplied requestDto.", "operationId": "ModelAggs_RequestEclipseModelCreationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "modelAggIds", "in": "body", "description": "The list of modelAgg IDs being requested to have Eclipse\r\n models created for", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ModelAggs/Search": { "get": { "tags": [ "Trading/ModelAggs" ], "summary": "", "operationId": "ModelAggs_Search", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "top", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "modelAggType", "in": "query", "required": false, "type": "string" }, { "name": "activeOnly", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "isAdvisoryWorldModel", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "eclipseFirmId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ModelAggs/Search/{search}": { "get": { "tags": [ "Trading/ModelAggs" ], "summary": "", "operationId": "ModelAggs_GetV1TradingModelAggsSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "required": true, "type": "string" }, { "name": "top", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "modelAggType", "in": "query", "required": false, "type": "string" }, { "name": "activeOnly", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "isAdvisoryWorldModel", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "eclipseFirmId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ModelAggs/Simple": { "get": { "tags": [ "Trading/ModelAggs" ], "summary": "Gets a simple list of model aggs that the logged in user has access to.", "operationId": "ModelAggs_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "query", "description": "Limits the results to only model aggs that are permitted for this account.", "required": false, "type": "integer", "format": "int32" }, { "name": "subAdvisorId", "in": "query", "description": "If limiting by accountId allows you to also limit as though the account were under the provided subadvisor.", "required": false, "type": "integer", "format": "int32" }, { "name": "registrationId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "excludeSelfDirected", "in": "query", "description": "Optional. Default: false. When true, self-directed aggregate models are not returned.", "required": false, "type": "boolean", "default": false }, { "name": "modelType", "in": "query", "description": "Optional. Default: null. If provided, only model aggs that contain at least one model of the provided type will be returned.", "required": false, "type": "string" }, { "name": "modelAggType", "in": "query", "required": false, "type": "string" }, { "name": "canMaintainOnly", "in": "query", "description": "Optional. Default: false. If true, only model aggs the current user can edit are returned.", "required": false, "type": "boolean", "default": false }, { "name": "withOrders", "in": "query", "description": "Optional. When provided (true) will return model aggs with orders or when provided (false) will return without orders.", "required": false, "type": "boolean" }, { "name": "forUser", "in": "query", "description": "Optionl. When provided (true) will return the model aggs owned and visable to the User.", "required": false, "type": "boolean" }, { "name": "representativeId", "in": "query", "description": "Optional. Default: null. When there is value, only the model aggs that the representativeIds", "required": false, "type": "integer", "format": "int32" }, { "name": "isUsed", "in": "query", "description": "Optional. When provided will only return model aggs that are used (true) or aren't used (false).", "required": false, "type": "boolean" }, { "name": "isProposalEnabled", "in": "query", "required": false, "type": "boolean" }, { "name": "isAdvisoryWorldModel", "in": "query", "required": false, "type": "boolean" }, { "name": "riskRange", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "None", "OneToTwenty", "TwentyoneToForty", "FortyoneToSixty", "SixtyoneToEighty", "EightyoneToOneHundred", "All" ] }, { "name": "getAllModelsForAllSubAdvisors", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "allModelsActive", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "includeCommunityModels", "in": "query", "description": "Optional. Default: null No Community Models will be returned. When the value is true, all model aggs, including community models will be returned.", "required": false, "type": "boolean", "default": true }, { "name": "onlyCommunityModels", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "onlyAstroModels", "in": "query", "description": "Optional. Default: null will return all models. When value is true, will only show Astro Models", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ModelAggs/Simple/ByCommunityModelId/{communityModelId}": { "get": { "tags": [ "Trading/ModelAggs" ], "summary": "Get the model agg for the community model id that is provided", "operationId": "ModelAggs_GetModelAggregateByCommunityModelId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "communityModelId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Trading.SimpleAggregateModel" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ModelAggs/Simple/ByCommunityModelId/{communityModelId}/{eclipseFirmId}": { "get": { "tags": [ "Trading/ModelAggs" ], "summary": "Get the model agg for the community model id that is provided", "operationId": "ModelAggs_GetModelAggregateByCommunityModelIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "communityModelId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "eclipseFirmId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Trading.SimpleAggregateModel" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ModelAggs/Simple/List": { "post": { "tags": [ "Trading/ModelAggs" ], "operationId": "ModelAggs_GetSimpleListById", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.SimpleAggregateModel" }, "xml": { "name": "SimpleAggregateModel", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ModelAggs/Simple/List/Id": { "post": { "tags": [ "Trading/ModelAggs" ], "operationId": "ModelAggs_PostV1TradingModelAggsSimpleListId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.SimpleAggregateModel" }, "xml": { "name": "SimpleAggregateModel", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ModelAggs/Simple/Name": { "get": { "tags": [ "Trading/ModelAggs" ], "operationId": "ModelAggs_GetSimpleByName", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "name", "in": "query", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ModelAggs/Simple/Name/List": { "get": { "tags": [ "Trading/ModelAggs" ], "operationId": "ModelAggs_GetSimpleListByName", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "name", "in": "query", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ModelAggs/Types": { "get": { "tags": [ "Trading/ModelAggs" ], "operationId": "ModelAggs_GetModelAggModelTypes", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ModelAggTypes": { "get": { "tags": [ "Trading/ModelAggTypes" ], "operationId": "AggregateModelType_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelAggTypeDto" }, "xml": { "name": "ModelAggTypeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ModelAnalyzer/ModelAggs/{modelAggId}": { "get": { "tags": [ "Trading/ModelAnalyzer" ], "summary": "Brings back the model agg summary for the ModelAggID selected.", "operationId": "ModelAnalyzer_GetByIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "modelAggId", "in": "path", "description": "Required. The ModelAgg ID.", "required": true, "type": "integer", "format": "int32" }, { "name": "includeMmInRebalance", "in": "query", "description": "Optional. Boolean parameter to include or exclude Money Market in the Rebalance", "required": false, "type": "boolean", "default": false }, { "name": "ignoreDollarModel", "in": "query", "description": "Optional. Boolean parameter to include or exclude Dollar Model", "required": false, "type": "boolean", "default": false }, { "name": "includeCostBasis", "in": "query", "description": "Optional. Boolean parameter to include or exclude Cost Basis", "required": false, "type": "boolean", "default": false }, { "name": "includeTradeBlockedAccounts", "in": "query", "description": "Optional. Boolean parameter to include or exclude Accounts that are Trade Blocked", "required": false, "type": "boolean", "default": false }, { "name": "includeExcludedAssets", "in": "query", "description": "Optional. Boolean parameter to include or exclude Excluded Assets", "required": false, "type": "boolean", "default": false }, { "name": "cancelationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelAnalyzerResultDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ModelDetails/{communityModelId}": { "get": { "tags": [ "Trading/ModelDetails" ], "summary": "Returns model stats by community model id.", "operationId": "ModelDetails_GetDetails", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "communityModelId", "in": "path", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelDetailsDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ModelDetails/List": { "post": { "tags": [ "Trading/ModelDetails" ], "summary": "Returns a list of model stats based on a list of supplied community strategist ids", "operationId": "ModelDetails_GetByListOfId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "description": "List of community strategist ids to return", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "repId", "in": "query", "description": "ID of the logged in rep that will be used to filter models available to them", "required": true, "type": "integer", "format": "int32" }, { "name": "token", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Models": { "get": { "tags": [ "Trading/Models" ], "summary": "Gets a list of models that the logged in user has access to. \r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "Models_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isUsed", "in": "query", "description": "Optional. Determins if only models that are being used, or are not being used will be returned.", "required": false, "type": "boolean" }, { "name": "excludeSelfDirected", "in": "query", "description": "Optional. Default: false. When true, self-directed models are not returned.", "required": false, "type": "boolean", "default": false }, { "name": "canMaintainOnly", "in": "query", "description": "Optional. Default: false. When true, only models the current user can edit are returned.", "required": false, "type": "boolean", "default": false }, { "name": "representativeId", "in": "query", "description": "Optional. Default: null. When there is value, only the models with a matching representativeId will be returned.", "required": false, "type": "integer", "format": "int32" }, { "name": "includeAccounts", "in": "query", "description": "Optional. Default: False. Only matters when returnStyle is Full.", "required": false, "type": "boolean", "default": false }, { "name": "includeCommunityModels", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "returnStyle", "in": "query", "description": "Optional. Default: Standard.", "required": false, "type": "string", "default": 0, "enum": [ "Standard", "Full" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelDto" }, "xml": { "name": "ModelDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Trading/Models" ], "operationId": "Models_CreateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelFullDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Models/{key}": { "get": { "tags": [ "Trading/Models" ], "summary": "Gets the model that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Models_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "includeAccounts", "in": "query", "description": "Optional. Default: False. Only matters when returnStyle is Full.", "required": false, "type": "boolean", "default": false }, { "name": "returnStyle", "in": "query", "description": "Optional. Default: Full.", "required": false, "type": "string", "default": 1, "enum": [ "Standard", "Full" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Trading/Models" ], "operationId": "Models_UpdateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelFullDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelFullDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Trading/Models" ], "operationId": "Models_DeleteAsync", "consumes": [], "produces": [], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Models/{key}/Action/RefreshDynamic": { "put": { "tags": [ "Trading/Models" ], "summary": "", "operationId": "Models_RefreshDynamicModel", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelFullDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Models/{key}/ModelRanges": { "get": { "tags": [ "Trading/Models" ], "operationId": "Models_GetModelRangesForModelId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelRangeFullDto" }, "xml": { "name": "ModelRangeFullDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Models/Action/DeleteModels": { "put": { "tags": [ "Trading/Models" ], "operationId": "Models_DeleteModelsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "modelIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Models/Action/ModelDeleteValidation": { "post": { "tags": [ "Trading/Models" ], "operationId": "Models_DeleteModelValidation", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "models", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.Domains.Trading.ModelsController.ModelsToValidateDto" }, "xml": { "name": "ModelsToValidateDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.Domains.Trading.ModelsController.ValidatedModelDto" }, "xml": { "name": "ValidatedModelDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Models/Element": { "get": { "tags": [ "Trading/Models" ], "summary": "Gets a list of models such that they can be displayed in Element that the logged in user has access to.", "operationId": "Models_GetForElementAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "representativeId", "in": "query", "description": "Optional. Default: null. When there is value, only the models with a matching representativeId will be returned.", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelDetailsDto" }, "xml": { "name": "ModelDetailsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Models/Element/ModelNameInUseValidation": { "get": { "tags": [ "Trading/Models" ], "summary": "Endpoint for element to validate a name.", "description": "ELEMENT", "operationId": "Models_ModelNameInUseValidationAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "name", "in": "query", "description": "name to check", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Models/GroupNumbers": { "get": { "tags": [ "Trading/Models" ], "summary": "Gets a simple list of model group numbers that the logged in user has access to. \r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "Models_GetGroupNum", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isUsed", "in": "query", "description": "Optional. Determins if only models that are being used, or are not being used will be returned.", "required": false, "type": "boolean" }, { "name": "excludeSelfDirected", "in": "query", "description": "Optional. Default: false. When true, self-directed models are not returned.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Models/List": { "post": { "tags": [ "Trading/Models" ], "summary": "Gets the models provided in the list of keys. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Models_GetListById", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "includeAccounts", "in": "query", "description": "Optional. Default: False. Only matters when returnStyle is Full.", "required": false, "type": "boolean", "default": false }, { "name": "returnStyle", "in": "query", "description": "Optional. Default: Full.", "required": false, "type": "string", "default": 1, "enum": [ "Standard", "Full" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelDto" }, "xml": { "name": "ModelDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Models/List/ByModelAgg": { "post": { "tags": [ "Trading/Models" ], "operationId": "Models_GetListByModelAggIds", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "modelAggIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "includeAccounts", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "default": 1, "enum": [ "Standard", "Full" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelFullDto" }, "xml": { "name": "ModelFullDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Models/List/ByModelAgg/Allocations": { "post": { "tags": [ "Trading/Models" ], "operationId": "Models_GetAllocationListByModelAggId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "modelAggId", "in": "body", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "includeAccounts", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelFullDto" }, "xml": { "name": "ModelFullDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Models/List/Entity": { "get": { "tags": [ "Trading/Models" ], "operationId": "Models_GetFullModelsByEntity", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "repId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "subAdvisorId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelFullDto" }, "xml": { "name": "ModelFullDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Models/List/Id": { "post": { "tags": [ "Trading/Models" ], "summary": "Gets the models provided in the list of keys. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Models_PostV1TradingModelsListId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "includeAccounts", "in": "query", "description": "Optional. Default: False. Only matters when returnStyle is Full.", "required": false, "type": "boolean", "default": false }, { "name": "returnStyle", "in": "query", "description": "Optional. Default: Full.", "required": false, "type": "string", "default": 1, "enum": [ "Standard", "Full" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelDto" }, "xml": { "name": "ModelDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Models/ModelTypes": { "get": { "tags": [ "Trading/Models" ], "summary": "Gets a simple list of model types that the logged in user has access to. \r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "Models_GetModelModelTypes", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isUsed", "in": "query", "description": "Optional. Determins if only models that are being used, or are not being used will be returned.", "required": false, "type": "boolean" }, { "name": "excludeSelfDirected", "in": "query", "description": "Optional. Default: false. When true, self-directed models are not returned.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Models/Restrictions": { "get": { "tags": [ "Trading/Models" ], "summary": "Gets a list of model restrictions that the logged in user has access to.", "operationId": "ModelRestrictions_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "modelId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "subAdvisorDefaultId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelRestrictionDto" }, "xml": { "name": "ModelRestrictionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Trading/Models" ], "summary": "Used to create a new model restriction. Upon successful creation a 201 will be returned with the location of the nearly created local price.", "operationId": "ModelRestrictions_CreateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "modelRestrictionDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelRestrictionDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelRestrictionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Models/Restrictions/{key}": { "get": { "tags": [ "Trading/Models" ], "summary": "Gets the model restriction that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ModelRestrictions_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelRestrictionDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Trading/Models" ], "summary": "Used to update an existing model restriction. Upon successful modification a 200 will be returned.", "operationId": "ModelRestrictions_Update", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Model restriction Id of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "modelRestrictionDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelRestrictionDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelRestrictionDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Trading/Models" ], "summary": "Used to delete an existing model restriction. Upon successful deletion a 204 will be returned.", "operationId": "ModelRestrictions_Delete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Model Restriction Id to be deleted", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Models/Search": { "get": { "tags": [ "Trading/Models" ], "summary": "", "operationId": "Models_Search", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Models/Search/{search}": { "get": { "tags": [ "Trading/Models" ], "summary": "", "operationId": "Models_GetV1TradingModelsSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Models/Simple": { "get": { "tags": [ "Trading/Models" ], "summary": "Gets a simple list of models that the logged in user has access to.", "operationId": "Models_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isUsed", "in": "query", "description": "Optional. Determins if only models that are being used, or are not being used will be returned.", "required": false, "type": "boolean" }, { "name": "excludeSelfDirected", "in": "query", "description": "Optional. Default: false. When true, self-directed models are not returned.", "required": false, "type": "boolean", "default": false }, { "name": "platformId", "in": "query", "description": "Optional. When set, only models assigned to this management style are returned.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Models/Simple/List": { "post": { "tags": [ "Trading/Models" ], "operationId": "Models_GetSimpleListById", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.SimpleModel" }, "xml": { "name": "SimpleModel", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Models/Simple/List/Id": { "post": { "tags": [ "Trading/Models" ], "operationId": "Models_PostV1TradingModelsSimpleListId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.SimpleModel" }, "xml": { "name": "SimpleModel", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Models/Simple/List/Name": { "post": { "tags": [ "Trading/Models" ], "operationId": "Models_GetSimpleListByName", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "string" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.SimpleModel" }, "xml": { "name": "SimpleModel", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Models/Sma/AccountType/Restrictions": { "get": { "tags": [ "Trading/Models" ], "summary": "Gets a list of account type restrictions for sma models.", "operationId": "SmaModelAccountTypeRestrictions_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SmaModelAccountTypeRestrictionDto" }, "xml": { "name": "SmaModelAccountTypeRestrictionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Models/Sma/AccountType/Restrictions/{categoryName}": { "get": { "tags": [ "Trading/Models" ], "summary": "Gets a list of account type restrictions for sma models.", "operationId": "SmaModelAccountTypeRestrictions_GetByCategory", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "categoryName", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SmaModelAccountTypeRestrictionDto" }, "xml": { "name": "SmaModelAccountTypeRestrictionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Models/Sma/AccountType/Restrictions/{key}": { "get": { "tags": [ "Trading/Models" ], "summary": "Gets the sma model account type restriction that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "SmaModelAccountTypeRestrictions_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SmaModelAccountTypeRestrictionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Models/Types": { "get": { "tags": [ "Trading/Models" ], "operationId": "Models_GetModelTypes", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Models/Value": { "get": { "tags": [ "Trading/Models" ], "summary": "Gets a list of models (including aum for today and a count of accounts with value) that the logged in user has access to.\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "Models_GetValue", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isUsed", "in": "query", "description": "Optional. Determins if only models that are being used, or are not being used will be returned.", "required": false, "type": "boolean" }, { "name": "resetCache", "in": "query", "description": "Optional. Default: false. The result is cached for fifteen minuetes. To force the cache to refresh call with resetCache = true.", "required": false, "type": "boolean", "default": false }, { "name": "excludeSelfDirected", "in": "query", "description": "Optional. Default: false. When true, self-directed models are not returned.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelValueDto" }, "xml": { "name": "ModelValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Models/Value/{asOfDate}": { "get": { "tags": [ "Trading/Models" ], "summary": "Gets a list of models (including aum for the end of the date specified and a count of accounts with value) that the logged in user has access to.\r\nThe return is limited to pages of 50000. Use $top and $skip in the query string to page through the data.", "operationId": "Models_GetValueAsOfDate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "description": "The aum returned is as of the end of this date.", "required": true, "type": "string", "format": "date-time" }, { "name": "isUsed", "in": "query", "description": "Optional. Determins if only models that are being used, or are not being used will be returned.", "required": false, "type": "boolean" }, { "name": "resetCache", "in": "query", "description": "Optional. Default: false. The result is cached for fifteen minuetes. To force the cache to refresh call with resetCache = true.", "required": false, "type": "boolean", "default": false }, { "name": "excludeSelfDirected", "in": "query", "description": "Optional. Default: false. When true, self-directed models are not returned.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelValueDto" }, "xml": { "name": "ModelValueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Orders": { "get": { "tags": [ "Trading/Orders" ], "summary": "Gets a list of orders that the logged in user has access to and were created within the range provided.", "operationId": "Orders_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "startDate", "in": "query", "description": "Optional. The start of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. The end of the range to report.", "required": false, "type": "string", "format": "date-time" }, { "name": "blocked", "in": "query", "description": "Optional. Default null. If provided will limit the return to only orders that have or haven't been blocked.", "required": false, "type": "boolean" }, { "name": "status", "in": "query", "description": "Optional. Default null. If provided will limit the return as follows:\r\n open: to return only non-filled orders\r\n closed: to return only filled orders\r\n unallocated\r\n : to return only orders that have unsent, or unconfirmed allocations\r\n pending: to return only orders that have pending transactions", "required": false, "type": "string" }, { "name": "accountId", "in": "query", "description": "Optional. Default null. If provided will limit the return to only orders belonging to the account specified.", "required": false, "type": "integer", "format": "int32" }, { "name": "tradeRequestInstanceId", "in": "query", "description": "Optional. Default null. If provided will limit the return to only orders belonging to the instance specified.", "required": false, "type": "integer", "format": "int32" }, { "name": "onlyActualFixOrders", "in": "query", "required": false, "type": "boolean" }, { "name": "tradeIt", "in": "query", "description": "Optional. Default null (all orders). If provided only enabled/disabled trades are returned (tradeIt=true is enabled trades).", "required": false, "type": "boolean" }, { "name": "entity", "in": "query", "description": "Optional. If provided, entityId is required as well. instance for only the specified entity/entityid are returned", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "entityId", "in": "query", "description": "Optional. If provided, entity is required as well. instance for only the specified entity/entityid are returned", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OrderDto" }, "xml": { "name": "OrderDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Orders/{key}": { "get": { "tags": [ "Trading/Orders" ], "summary": "Gets the order that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Orders_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OrderDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Trading/Orders" ], "summary": "Saves the trade order. If it is linked for exchange, the linked order will also be updated.", "operationId": "Orders_UpdateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "key", "in": "path", "description": "FixTradeRequestId to be saved.", "required": true, "type": "integer", "format": "int32" }, { "name": "update", "in": "body", "description": "FixTradeRequest object to be saved.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OrderDto" } }, { "name": "execute", "in": "query", "description": "Optional. Default is False. When True, the trade order will be saved, blocked, and executed.", "required": false, "type": "boolean", "default": false }, { "name": "autoAllocate", "in": "query", "description": "Optional. Indicates if the blocks should be auto allocated or not. If left blank, The auto allocate will be left as they were when the block was created. This is only used when executeBlock=true", "required": false, "type": "boolean", "default": true }, { "name": "returnWholeAccount", "in": "query", "description": "Optional. Default is False. When True, ever order for this account will be returned. When false only the one order will be returned.", "required": false, "type": "boolean", "default": false }, { "name": "blocked", "in": "query", "description": "Optional. Default null. If returnWholeAccount = True and provided will limit the return to only orders that have or haven't been blocked.", "required": false, "type": "boolean" }, { "name": "status", "in": "query", "description": "Optional. Default null. If returnWholeAccount = True and provided will limit the return as follows:\r\n open: to return only non-filled orders\r\n closed: to return only filled orders\r\n unallocated: to return only orders that have unsent, or unconfirmed allocations\r\n pending: to return only orders that have pending transactions", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Trading/Orders" ], "operationId": "Orders_Delete", "consumes": [], "produces": [], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Orders/{key}/AssetLots/{assetId}": { "get": { "tags": [ "Trading/Orders" ], "summary": "Splits the order based on the lots selected.", "operationId": "Orders_GetAssetCostCustodianOnlyUnrealized", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "FixTradeRequestId to be saved.", "required": true, "type": "integer", "format": "int32" }, { "name": "assetId", "in": "path", "description": "FixTradeRequest object to be saved.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CustodianOnlyCostBasisLotDto" }, "xml": { "name": "CustodianOnlyCostBasisLotDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Orders/{key}/RealtimePrice": { "get": { "tags": [ "Trading/Orders" ], "summary": "Gets the price to use for the order that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Orders_GetRealtimePriceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RealtimePriceDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Orders/{key}/SplitByLots": { "put": { "tags": [ "Trading/Orders" ], "summary": "Splits the order based on the lots selected.", "operationId": "Orders_SplitOrderByLots", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "FixTradeRequestId to be saved.", "required": true, "type": "integer", "format": "int32" }, { "name": "lots", "in": "body", "description": "Cost Basis object that has the selected lots that will be used to split the order.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SelectedLotsDto" }, "xml": { "name": "SelectedLotsDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Orders/Action/CalculateGainLoss": { "put": { "tags": [ "Trading/Orders" ], "summary": "Calculates gain loss on all trades for the day.", "operationId": "Orders_ActionCalculateGainLossAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Orders/Action/CreateBlocks": { "put": { "tags": [ "Trading/Orders" ], "operationId": "Orders_CreateBlocksAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "orderIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "autoAllocate", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.CreateBlocksDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Orders/Action/CreateOptionTradeFile": { "post": { "tags": [ "Trading/Orders" ], "summary": "Creates trade file(s) for the provided list of option trades that do not exist in our system (based on previously executed equity trades).", "operationId": "Orders_CreateOptionFileAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "optionTrades", "in": "body", "description": "The batch token plus trades to process.", "required": true, "schema": { "$ref": "#/definitions/OAS.Remote.Trading.OptionTrades" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Orders/Action/Delete": { "put": { "tags": [ "Trading/Orders" ], "operationId": "Orders_ActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ActionDeleteDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Orders/Action/DeleteZeroQuantity": { "put": { "tags": [ "Trading/Orders" ], "operationId": "Orders_ActionDeleteZeroQty", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "Ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Orders/Action/Disable": { "put": { "tags": [ "Trading/Orders" ], "operationId": "Orders_ActionDisableAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "returnWholeAccount", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "blocked", "in": "query", "required": false, "type": "boolean" }, { "name": "status", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OrderDto" }, "xml": { "name": "OrderDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Orders/Action/Enable": { "put": { "tags": [ "Trading/Orders" ], "operationId": "Orders_ActionEnableAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "returnWholeAccount", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "blocked", "in": "query", "required": false, "type": "boolean" }, { "name": "status", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OrderDto" }, "xml": { "name": "OrderDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Orders/Action/RebuildOrderFromSplit": { "put": { "tags": [ "Trading/Orders" ], "summary": "Rebuilds the order from the orders that were created from splitting the original order by Lots.", "operationId": "Orders_RebuildOrder", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "body", "description": "One of the FixTradeRequestIds that is from the original order that is to be reconstructed.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Orders/Action/RefreshPrices": { "put": { "tags": [ "Trading/Orders" ], "operationId": "Orders_ActionRefreshPricesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OrderDto" }, "xml": { "name": "OrderDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Orders/Action/ResetMutualFundTrades": { "put": { "tags": [ "Trading/Orders" ], "operationId": "Orders_ResetMutualFundTrades", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "useTradeIds", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OrderDto" }, "xml": { "name": "OrderDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Orders/Action/RoundQuantity/{nearest}": { "put": { "tags": [ "Trading/Orders" ], "operationId": "Orders_ActionRoundQuantity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "Ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "nearest", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OrderDto" }, "xml": { "name": "OrderDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Orders/Action/SetApprovalStatus": { "put": { "tags": [ "Trading/Orders" ], "operationId": "Orders_ActionSetApprovalStatus", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "approvalStatus", "in": "query", "required": true, "type": "string", "enum": [ "Approved", "PendingApproval", "NotApproved" ] }, { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "instanceId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OrderDto" }, "xml": { "name": "OrderDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Orders/Action/Unlink": { "put": { "tags": [ "Trading/Orders" ], "operationId": "Orders_ActionUnlink", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OrderDto" }, "xml": { "name": "OrderDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Orders/Action/UpdateReinvest": { "put": { "tags": [ "Trading/Orders" ], "operationId": "Orders_UpdateReinvestAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "orderIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "reinvestDividends", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "reinvestSTCapGains", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "reinvestLTCapGains", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OrderDto" }, "xml": { "name": "OrderDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Orders/GetFIXMutualFundsNotSent": { "get": { "tags": [ "Trading/Orders" ], "summary": "Gets all of the FIX Mutual Fund orders that have been blocked and not sent.", "operationId": "Orders_GetFixMutualFundsNotSent", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.FixMutualFundsNotSentDto" }, "xml": { "name": "FixMutualFundsNotSentDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Orders/GetOpenOrders": { "get": { "tags": [ "Trading/Orders" ], "summary": "Gets the open orders for TOM Orders tab.", "operationId": "Orders_GetOpenOrdersAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "tradeRequestInstanceId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "onlyActualFixOrders", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OrderDto" }, "xml": { "name": "OrderDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Orders/Histories": { "get": { "tags": [ "Trading/Orders" ], "summary": "Gets the order histories that fit the parameters specified. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "OrderHistories_GetDeleted", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "modificationType", "in": "query", "description": "Optional. Options are Insert, Update, Delete. If null, all will be returned.", "required": false, "type": "string", "enum": [ "Deleted", "Updated", "Inserted" ] }, { "name": "startDate", "in": "query", "description": "Optional. Start Date for the requested time period. If null, min date will be the default.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. End Date for the requested time period. If null, max date will be the default.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.FixTradeRequestHistoryDto" }, "xml": { "name": "FixTradeRequestHistoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Orders/NewFixedIncomeTrades": { "put": { "tags": [ "Trading/Orders" ], "summary": "Creates new orders with real tickers that will .", "operationId": "Orders_NewFixedIncomeTrades", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "fixedIncomeTrades", "in": "body", "description": "Fixed Income trade data that will make the new orders.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.FixIncomeTradeOrderListDto" }, "xml": { "name": "FixIncomeTradeOrderListDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/OutsideTrading/AvailableCustodians": { "get": { "tags": [ "Trading/OutsideTrading" ], "summary": "Returns a list of available custodians.", "operationId": "OutsideTrading_GetAvailableCustodians", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OutsideTradingCustodiansDto" }, "xml": { "name": "OutsideTradingCustodiansDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/OutsideTrading/CreateAccountModelAndRebalance": { "post": { "tags": [ "Trading/OutsideTrading" ], "summary": "From the householdId, positions, and allocations given, temporary model, account, assets, transactions, and trades will be created.", "operationId": "OutsideTrading_CreateAccountModelAndRebalanceAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "pa", "in": "body", "description": "A householdId and custodianId combination with positions and allocations that will be used to create trades.", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Trading.OutsideTradingPositionsAndAllocations" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OutsideTradingRebalancedAccountDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/OutsideTrading/CreateAdditionalCustodians": { "post": { "tags": [ "Trading/OutsideTrading" ], "summary": "With the householdId and list of custodians, create new custodians for the household.", "operationId": "OutsideTrading_CreateAdditionalCustodians", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "Object with householdId and list of cutodians for the firm.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OutsideTradingAdditionalCustodians" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ClientAndCustodiansDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/OutsideTrading/CreateClientAndCustodian": { "post": { "tags": [ "Trading/OutsideTrading" ], "summary": "From the firm name and list of custodians, a client, registration and custodians will be created.", "operationId": "OutsideTrading_CreateClientAndCustodianAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "outsideTradingFirm", "in": "body", "description": "Object with firm name and list of custodians for the firm.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OutsideTradingFirmAndCustodiansDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ClientAndCustodiansDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/OutsideTrading/OutsideTradingCreateTradeFiles": { "post": { "tags": [ "Trading/OutsideTrading" ], "summary": "From the returned list of orders create blocks and return the trade file.", "operationId": "OutsideTrading_OutsideTradingCreateTradeFilesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "A list of householdId and custodianId combinations with the associated byte[] trade file.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OutsideTradingRebalancedAccountDto" }, "xml": { "name": "OutsideTradingRebalancedAccountDto", "wrapped": true }, "type": "array" } }, { "name": "disableUpdate", "in": "query", "description": "Optional bool. If true the process of updating passed in orders will be skipped.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OutsideTradingTradeFileDto" }, "xml": { "name": "OutsideTradingTradeFileDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/OutsideTrading/UpdateBlockAccountNumber": { "put": { "tags": [ "Trading/OutsideTrading" ], "summary": "Update the Block Account Number", "operationId": "OutsideTrading_UpdateBlockAccountNumber", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "A householdId and custodianId combinations with BlockAccountNumber.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OutsideTradingUpdateBlockAccountNumberDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/OutsideTrading/ValidateAccount": { "post": { "tags": [ "Trading/OutsideTrading" ], "summary": "Validate a account", "operationId": "OutsideTrading_ValidateAccountAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "List of tickers and allocations for validation of a possible account.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.OutsideTradingPositions" }, "xml": { "name": "OutsideTradingPositions", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/OutsideTrading/ValidateModel": { "post": { "tags": [ "Trading/OutsideTrading" ], "summary": "Validate a model", "operationId": "OutsideTrading_ValidateModelAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "List of tickers and targets for validation of a possible model.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.OutsideTradingModelAllocations" }, "xml": { "name": "OutsideTradingModelAllocations", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Overlays": { "get": { "tags": [ "Trading/Overlays" ], "summary": "Gets the overlay grid rows (overlay, restriction count, Last Edited) that the logged in user can access.", "operationId": "Overlays_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OverlayDto" }, "xml": { "name": "OverlayDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Overlays/{key}": { "get": { "tags": [ "Trading/Overlays" ], "summary": "Gets a single overlay by key. Returns a 404 if it does not exist or is not accessible.", "operationId": "Overlays_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OverlayDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Trading/Overlays" ], "summary": "Sets the per-overlay Use Restrictions toggle. Returns the updated overlay.", "operationId": "Overlays_UpdateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "overlayDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OverlayDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OverlayDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Overlays/Restrictions": { "get": { "tags": [ "Trading/Overlays" ], "summary": "Gets the overlay restrictions for the given {overlayId} (or all accessible ones).", "operationId": "OverlayRestrictions_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "overlayId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OverlayRestrictionDto" }, "xml": { "name": "OverlayRestrictionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Trading/Overlays" ], "summary": "Creates a new overlay restriction. Duplicate entity+name entries are prevented (the existing row is\r\nreturned instead).", "operationId": "OverlayRestrictions_CreateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "overlayRestrictionDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OverlayRestrictionDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OverlayRestrictionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Overlays/Restrictions/{key}": { "get": { "tags": [ "Trading/Overlays" ], "summary": "Gets a single overlay restriction by key. Returns a 404 if it does not exist or is not accessible.", "operationId": "OverlayRestrictions_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OverlayRestrictionDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Trading/Overlays" ], "summary": "Updates an existing overlay restriction.", "operationId": "OverlayRestrictions_UpdateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "overlayRestrictionDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OverlayRestrictionDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OverlayRestrictionDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Trading/Overlays" ], "summary": "Deletes an existing overlay restriction. Returns a 204 on success.", "operationId": "OverlayRestrictions_DeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/PendAccounts": { "get": { "tags": [ "Trading/PendAccounts" ], "summary": "Gets a list of pend accounts that the logged in user has access to.\r\nThe return is limited to pages of 10000. Use $top and $skip in the query string to page through the data.", "operationId": "PendAccounts_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "tradeDate", "in": "query", "description": "Optional. Default: null.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.PendAccountDto" }, "xml": { "name": "PendAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Trading/PendAccounts" ], "operationId": "PendAccounts_CreatePendAccounts", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updatedItems", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.PendAccountDto" }, "xml": { "name": "PendAccountDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.PendAccountDto" }, "xml": { "name": "PendAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Trading/PendAccounts" ], "operationId": "PendAccounts_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.PendAccountDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.PendAccountDto" }, "xml": { "name": "PendAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/PendAccounts/{key}": { "get": { "tags": [ "Trading/PendAccounts" ], "summary": "Gets the pend account that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "PendAccounts_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.PendAccountDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/PendAccounts/Action/Delete": { "put": { "tags": [ "Trading/PendAccounts" ], "operationId": "PendAccounts_Delete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/PendAccounts/List": { "post": { "tags": [ "Trading/PendAccounts" ], "operationId": "PendAccounts_GetListById", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.PendAccountDto" }, "xml": { "name": "PendAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/PendAccounts/List/Id": { "post": { "tags": [ "Trading/PendAccounts" ], "operationId": "PendAccounts_PostV1TradingPendAccountsListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.PendAccountDto" }, "xml": { "name": "PendAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Ping": { "get": { "tags": [ "Trading/Ping" ], "summary": "Used to test access to the batch data service", "operationId": "Trading_PingAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "wait", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/PingMany": { "get": { "tags": [ "Trading/PingMany" ], "summary": "Used to test access to the batch data service", "operationId": "Trading_PingManyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancelationToken", "in": "header", "required": true }, { "name": "count", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 100 }, { "name": "dop", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 32 }, { "name": "wait", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.PingDto" }, "xml": { "name": "PingDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Price/ReviewPrices": { "get": { "tags": [ "Trading/Price" ], "summary": "Orions the price service review prices asynchronous.", "description": "Sample Request\r\n\tGET Trading/Price/ReviewPrices?alClientId=1379", "operationId": "Price_OrionPriceServiceReviewPricesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "alClientId", "in": "query", "description": "The al client identifier.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Products/{ticker}/RealtimePrice": { "get": { "tags": [ "Trading/Products" ], "summary": "Returns the real-time price of the product requested if the logged in user has permission to real-time prices. If the user does not or real-time \r\nprices are not available, the most recent Orion price will be returned.", "operationId": "TradingProducts_GetRealtimePriceAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ticker", "in": "path", "description": "The ticker of the product whose price should be looked up.", "required": true, "type": "string" }, { "name": "custodianCommonIdList", "in": "query", "description": "Optional. Default: 1 /*Orion*/. The list of custodians to concider when returning prices.", "required": false, "type": "string", "default": "1" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RealtimePriceDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Products/FundFamilyOverride/{key}": { "get": { "tags": [ "Trading/Products" ], "operationId": "TradingProducts_GetFundFamilyOverride", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.FundFamilyOverrideDTO" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Products/FundFamilyOverrideSave": { "post": { "tags": [ "Trading/Products" ], "operationId": "TradingProducts_SetFundFamilyOverride", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "fundFamilyOverrideDTO", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.FundFamilyOverrideDTO" } } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Products/RealtimePrices": { "post": { "tags": [ "Trading/Products" ], "operationId": "TradingProducts_GetRealtimePricesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "tickers", "in": "body", "required": true, "schema": { "items": { "type": "string" }, "type": "array" } }, { "name": "includeDetails", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "custodianCommonIdList", "in": "query", "required": false, "type": "string", "default": "1" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RealtimePriceDto" }, "xml": { "name": "RealtimePriceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Products/Search": { "get": { "tags": [ "Trading/Products" ], "summary": "Gets a simple list of products that the logged in user has access to where the product name or ticker contains the search string.", "operationId": "TradingProducts_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "search", "in": "query", "description": "Partial product name or ticker to search for.", "required": true, "type": "string" }, { "name": "top", "in": "query", "description": "Optional. Default: 25. The maximum number of products to return.", "required": false, "type": "integer", "format": "int32", "default": 25 }, { "name": "fundFamilyId", "in": "query", "description": "Optional. Default: null. Return any product that falls within the specified fund family.", "required": false, "type": "integer", "format": "int32" }, { "name": "usedProductsOnly", "in": "query", "description": "Optional. Default: false. Return any product that matches the criteria (false) or only those that are used (true).", "required": false, "type": "boolean", "default": false }, { "name": "accountId", "in": "query", "description": "Optional. Default: null. Return any product that has not been excluded for the provided account.", "required": false, "type": "integer", "format": "int32" }, { "name": "useParentProductsOnly", "in": "query", "description": "if set to true [use parent products only].", "required": false, "type": "boolean", "default": false }, { "name": "includeIndexes", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Search.SearchProductDto" }, "xml": { "name": "SearchProductDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Products/Search/{search}": { "get": { "tags": [ "Trading/Products" ], "summary": "Gets a simple list of products that the logged in user has access to where the product name or ticker contains the search string.", "operationId": "TradingProducts_GetV1TradingProductsSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "search", "in": "path", "description": "Partial product name or ticker to search for.", "required": true, "type": "string" }, { "name": "top", "in": "query", "description": "Optional. Default: 25. The maximum number of products to return.", "required": false, "type": "integer", "format": "int32", "default": 25 }, { "name": "fundFamilyId", "in": "query", "description": "Optional. Default: null. Return any product that falls within the specified fund family.", "required": false, "type": "integer", "format": "int32" }, { "name": "usedProductsOnly", "in": "query", "description": "Optional. Default: false. Return any product that matches the criteria (false) or only those that are used (true).", "required": false, "type": "boolean", "default": false }, { "name": "accountId", "in": "query", "description": "Optional. Default: null. Return any product that has not been excluded for the provided account.", "required": false, "type": "integer", "format": "int32" }, { "name": "useParentProductsOnly", "in": "query", "description": "if set to true [use parent products only].", "required": false, "type": "boolean", "default": false }, { "name": "includeIndexes", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Search.SearchProductDto" }, "xml": { "name": "SearchProductDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Queues": { "get": { "tags": [ "Trading/Queues" ], "summary": "Get all trade queues", "operationId": "TradeQueues_GetAllItemsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "autoTradeType", "in": "query", "required": false, "type": "string", "enum": [ "None", "RegistrationRebalance", "SleeveRebalance", "ContributionAllocation", "TransferInRebalance" ] }, { "name": "status", "in": "query", "required": false, "type": "string", "enum": [ "Complete", "Pending", "Failed", "Disabled", "Duplicate", "Processing", "Manual" ] }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "enum": [ "Standard", "ContributionAllocation", "TransferIn" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TradeQueueDto" }, "xml": { "name": "TradeQueueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Queues/Action/HoldUntil": { "put": { "tags": [ "Trading/Queues" ], "operationId": "TradeQueues_ActionHoldUntil", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "setDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Queues/Action/Rebalance/{registrationId}": { "put": { "tags": [ "Trading/Queues" ], "summary": "Rebalance trade queue item and returns the trades created.", "operationId": "TradeQueues_RebalanceTradeQueueItemAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "registrationId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Queues/Action/Reschedule": { "put": { "tags": [ "Trading/Queues" ], "operationId": "TradeQueues_ActionReschedule", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Queues/Action/Status/{newStatus}": { "put": { "tags": [ "Trading/Queues" ], "operationId": "TradeQueues_ActionStatusChange", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newStatus", "in": "path", "required": true, "type": "string", "enum": [ "Complete", "Pending", "Failed", "Disabled", "Duplicate", "Processing", "Manual" ] }, { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/QUODD/check": { "get": { "tags": [ "Trading/QUODD" ], "summary": "Permission check to show QUODD page(s). If either one is False, the page will not display. For some reason, changing these permissions do not immediately take affect. User needs to wait a few minutes before\r\ngainning access. Needs to have access to the RealTimePrices priveliges in order to hit this endpoint.", "description": "Sample Request\r\n\tPOST /v1/trading/check\r\n\t{\r\n \"realTimePrice_Firm_Check\" : \"true\",\r\n \"realTimePrice_Role_Check\" : true\r\n }", "operationId": "Quodd_GetQuoddSetupPermissions", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/QUODD/checkRealTimeStatus": { "get": { "tags": [ "Trading/QUODD" ], "summary": "", "description": "/ Sample Request\r\n GET vor/quodd/api/cid/\" + Orion_ID_Here + \"/status/flag\r\n {\r\n \"additional_info\": \"Exchange agreements required\",\r\n \"pending_agreement_ids\": [\r\n 10,\r\n 13\r\n ],\r\n \"ticker_limit\": 50,\r\n \"redirect_app\": true,\r\n \"status\": 2\r\n }", "operationId": "Quodd_AgreementStatusAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/QUODD/signAgreement": { "get": { "tags": [ "Trading/QUODD" ], "summary": "Gets a list of users. Checks against the logged-in user. If found sends token and tuple back.\r\nIdeally, this method will only be called after demographic informaiton is sent.", "description": "/ Sample Request\r\n POST /vor/quodd/api/cid/orion_client_id/agreement\r\n {\r\n \"token\": \"eyJhbGciOiJSUzUxMiJ9....\",\r\n }", "operationId": "Quodd_SignExchangeAgreementsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.QuoddSigningTokenDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/QUODD/update": { "post": { "tags": [ "Trading/QUODD" ], "summary": "Creates user information\r\nUpdate user information w/ demographic information\r\nAssigns products to user\r\nTake note that QUODD checks for dupe client_user_ids. As such, when developing locally, make sure to use the test method below.\r\nNeeds to have access to the RealTimePrices priveliges in order to hit this endpoint.", "description": " / Sample Request\r\n\t\tPOST /vor/quodd/api/user/seat\r\n\t\t{\r\n \"user_Name\" : \"myfirstuser\",\r\n \"user_Type\" : 1\r\n \"client_user_id\": orion_client_id\r\n }\r\n\r\n POST /vor/quodd/api/cid/orion_client_id/agreement\r\n {\r\n \"first_name\": \"Barry\",\r\n \"last_name\": \"Allen\",\r\n \"address_line_1\": \"1600 Pennsylvania Avenue\",\r\n \"city\": \"Central City\",\r\n \"state\": \"NY\",\r\n \"zip\": \"75094\",\r\n \"country\": \"US\",\r\n \"email\": \"barry@starlabs.com\",\r\n \"phone\": \"214-867-5309\",\r\n \"is_self_employed\": true\r\n }\r\n or\r\n {\r\n \"first_name\": \"Barry\",\r\n \"last_name\": \"Allen\",\r\n \"address_line_1\": \"1600 Pennsylvania Avenue\",\r\n \"city\": \"Central City\",\r\n \"state\": \"NY\",\r\n \"zip\": \"75094\",\r\n \"country\": \"US\",\r\n \"email\": \"barryallen@orion.com\",\r\n \"phone\": \"214-867-5309\",\r\n \"is_self_employed\": false,\r\n \"zip\": \"123456\",\r\n \"country\": \"United States of America\",\r\n \"city\": \"AnyCity1\",\r\n \"user_name\": \"barryallen@orion.com\",\r\n \"employer_zip\": \"4390349034\",\r\n \"title\": \"Map Maker\",\r\n \"employer_name\": \"MapMakers\",\r\n \"employer_city\": \"Employers City\",\r\n \"employer_address\": \"1234 Any Street\",\r\n \"employer_country\": \"United States of America\",\r\n \"employee_function\": \"Trader\",\r\n \"address_line_1\": \"1234 Anystreet\",\r\n \"address_line_2\": null,\r\n \"employer_state\": \"NE\"\r\n }\r\n\r\n POST /vor/quodd/api/cid/orion_client_id/product/1601,1602,1604,93\r\n\r\n ^^ parameters are passed via querystring parameters", "operationId": "Quodd_QuoddRegistrationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "registrationData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Trading.Dto.QuoddUserRegistrationDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/RebalanceLog/{key}": { "get": { "tags": [ "Trading/RebalanceLog" ], "summary": "Returns the Rebalance Log for the given key", "operationId": "RebalanceLogs_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Id for the Rebalance Log.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RebalanceLogDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/RebalanceLog/Account/Simple/{accountId}": { "get": { "tags": [ "Trading/RebalanceLog" ], "summary": "Returns simple details for all the Rebalance Logs for the given account.", "operationId": "RebalanceLogs_GetByAccountId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "description": "Account Id for the Rebalance Logs requested.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SimpleRebalanceLogDto" }, "xml": { "name": "SimpleRebalanceLogDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/RebalanceLog/Instance/Simple/{instanceId}": { "get": { "tags": [ "Trading/RebalanceLog" ], "summary": "Returns simple details for all the Rebalance Logs for the given instance.", "operationId": "RebalanceLogs_GetByInstanceId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "instanceId", "in": "path", "description": "Instance Id for the Rebalance Logs requested.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SimpleRebalanceLogDto" }, "xml": { "name": "SimpleRebalanceLogDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Accounts": { "get": { "tags": [ "Trading/Sleeve" ], "summary": "Gets a list of account sleeves that the logged in user has access to.\r\nThe return is limited to pages of 250000. Use $top and $skip in the query string to page through the data.", "operationId": "SleeveAccounts_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "queryOptions", "in": "header", "required": true }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "enum": [ "Standard", "ContributionAllocation", "TransferIn" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.AccountSleeveDto" }, "xml": { "name": "AccountSleeveDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Accounts/{accountIdOut}/Action/GetETLPreference": { "get": { "tags": [ "Trading/Sleeve" ], "summary": "v2 Extract should always be used.", "operationId": "SleeveAccounts_ActionGetETLPreference", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountIdOut", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Accounts/{accountIdOut}/Action/Transfer": { "put": { "tags": [ "Trading/Sleeve" ], "summary": "Use PUT /v1/Portfolio/SleeveTransfer/Action/Transfer/{entitySessionId} instead", "operationId": "SleeveAccounts_ActionTransfer", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountIdOut", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "transfers", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveActionTransferDto" }, "xml": { "name": "SleeveActionTransferDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Accounts/{accountIdOut}/Action/V2PartialETL": { "put": { "tags": [ "Trading/Sleeve" ], "operationId": "SleeveAccounts_V2PartialETL", "consumes": [], "produces": [], "parameters": [ { "name": "accountIdOut", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Accounts/{key}": { "get": { "tags": [ "Trading/Sleeve" ], "summary": "Gets the account sleeve that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "SleeveAccounts_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "enum": [ "Standard", "ContributionAllocation", "TransferIn" ] } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.AccountSleeveDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Accounts/{key}/Histories": { "get": { "tags": [ "Trading/Sleeve" ], "summary": "Gets a list of account sleeve histories for the key provided.", "operationId": "SleeveAccounts_GetHistoriesByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.AccountSleeveHistoryDto" }, "xml": { "name": "AccountSleeveHistoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Accounts/{key}/Validate": { "put": { "tags": [ "Trading/Sleeve" ], "summary": "Validates updated values for account sleeve", "operationId": "SleeveAccounts_ValidateAccountSleeve", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.AccountSleeveDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.AccountSleeveDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Accounts/AgingCashBalance": { "get": { "tags": [ "Trading/Sleeve" ], "summary": "Returns accounts (sleeves) that are of type contribution, or distribution, that have a balance, and shows the min transdate since the account was last at $0 (When the cash balance started.)", "operationId": "SleeveAccounts_GetAgingCashBalance", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.AgingCashBalancesDto" }, "xml": { "name": "AgingCashBalancesDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Accounts/List": { "post": { "tags": [ "Trading/Sleeve" ], "summary": "Gets a list of account sleeves that match one of the keys in the provided list.", "operationId": "SleeveAccounts_GetListById", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "enum": [ "Standard", "ContributionAllocation", "TransferIn" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.AccountSleeveDto" }, "xml": { "name": "AccountSleeveDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Accounts/List/Id": { "post": { "tags": [ "Trading/Sleeve" ], "summary": "Gets a list of account sleeves that match one of the keys in the provided list.", "operationId": "SleeveAccounts_PostV1TradingSleeveAccountsListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "returnStyle", "in": "query", "required": false, "type": "string", "enum": [ "Standard", "ContributionAllocation", "TransferIn" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.AccountSleeveDto" }, "xml": { "name": "AccountSleeveDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Registrations": { "get": { "tags": [ "Trading/Sleeve" ], "summary": "Gets a list of registration sleeves that the logged in user has access to.\r\nThe return is limited to pages of 1000. Use $top and $skip in the query string to page through the data.", "operationId": "SleeveRegistrations_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RegistrationSleeveDto" }, "xml": { "name": "RegistrationSleeveDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Registrations/{key}": { "get": { "tags": [ "Trading/Sleeve" ], "summary": "Gets the registration sleeve that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "SleeveRegistrations_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "stubSleeve", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "includeAssets", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "includeCostBasis", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RegistrationSleeveFullDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Registrations/{key}/Action/CWMProcess": { "put": { "tags": [ "Trading/Sleeve" ], "summary": "Used to update a registration sleeve as well as its underlying account sleeves.", "operationId": "SleeveRegistrations_CarsonProcessSleevesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "dto", "in": "body", "description": "contains: \r\n systematic amount for Custodial sleeve\r\n systematic Frequency for Custodial sleeve\r\n cycle month for systematic for custodial sleeve\r\n start date for systematic for custodial sleeve\r\n Transaction day for systematic for custodial sleeve", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.CarsonProcessSleevesDto" } }, { "name": "key", "in": "path", "description": "Registration ID", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RegistrationSleeveFullDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Registrations/{key}/Action/MoveInactiveValue": { "put": { "tags": [ "Trading/Sleeve" ], "summary": "Moves value in inactive sleeves in the registration to active sleeves", "operationId": "SleeveRegistrations_MoveInactiveValue", "consumes": [], "produces": [], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Registrations/{key}/Check": { "get": { "tags": [ "Trading/Sleeve" ], "summary": "Check Registration", "operationId": "SleeveRegistrations_CheckRegistrationAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RegistrationCheckDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Registrations/{key}/Histories": { "get": { "tags": [ "Trading/Sleeve" ], "summary": "Gets a list of registration sleeve histories for the key provided.", "operationId": "SleeveRegistrations_GetRegistrationSleeveHistoriesByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RegistrationSleeveHistoryDto" }, "xml": { "name": "RegistrationSleeveHistoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Registrations/{key}/Histories/Accounts": { "get": { "tags": [ "Trading/Sleeve" ], "summary": "Gets a list of account sleeve histories for the key provided.", "operationId": "SleeveRegistrations_GetAccountSleeveHistoriesByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.AccountSleeveHistoryDto" }, "xml": { "name": "AccountSleeveHistoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Registrations/{key}/Histories/Registrations": { "get": { "tags": [ "Trading/Sleeve" ], "summary": "Gets a list of registration sleeve histories for the key provided.", "operationId": "SleeveRegistrations_GetV1TradingSleeveRegistrationsByKeyHistoriesRegistrations", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RegistrationSleeveHistoryDto" }, "xml": { "name": "RegistrationSleeveHistoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Registrations/{key}/Validate": { "put": { "tags": [ "Trading/Sleeve" ], "summary": "Validate Registration Sleeve", "operationId": "SleeveRegistrations_ValidateRegistrationSleeve", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RegistrationSleeveFullDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RegistrationSleeveFullValidationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Registrations/{regId}": { "delete": { "tags": [ "Trading/Sleeve" ], "summary": "Delete sleeves that were mistakenly made", "operationId": "SleeveRegistrations_DeleteSleeves", "consumes": [], "produces": [], "parameters": [ { "name": "regId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Registrations/{registrationId}/GetEclipseEnabled": { "get": { "tags": [ "Trading/Sleeve" ], "operationId": "SleeveRegistrations_GetEclipseEnabled", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "registrationId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Registrations/Action/MoveInactiveValue": { "put": { "tags": [ "Trading/Sleeve" ], "summary": "Moves value in all inactive sleeves to active sleeves", "operationId": "SleeveRegistrations_MoveAllInactiveValues", "consumes": [], "produces": [], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Registrations/Action/Process": { "post": { "tags": [ "Trading/Sleeve" ], "summary": "Used to update a registration sleeve as well as its underlying account sleeves.", "operationId": "SleeveRegistrations_ProcessSleevesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RegistrationSleeveFullDto" } }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "manualOverride", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "isPendingAccount", "in": "query", "description": "Optional parameter to allow sleeving with an account that doesn't exist at a custodian yet.\r\n Accounts will be created with no assets and registration custodial account number will be \"PENDING\". Defaults to false.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RegistrationSleeveFullDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Registrations/Action/Process/Batch": { "post": { "tags": [ "Trading/Sleeve" ], "summary": "Used to update multiple registrations sleeve as well as its underlying account sleeves.", "operationId": "SleeveRegistrations_ProcessSleeveRegistrationsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "registrationSleeveFullDtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RegistrationSleeveFullDto" }, "xml": { "name": "RegistrationSleeveFullDto", "wrapped": true }, "type": "array" } }, { "name": "batchId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Registrations/Action/Process/Historical": { "post": { "tags": [ "Trading/Sleeve" ], "summary": "Used to create historical sleeves", "operationId": "SleeveRegistrations_ProcessHistoricalSleevesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RegistrationSleeveFullDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RegistrationSleeveFullDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Registrations/Action/Process/Historical/Batch": { "post": { "tags": [ "Trading/Sleeve" ], "summary": "Process a batch of historical sleeves import", "operationId": "SleeveRegistrations_ProcessHistoricalSleevesBatchAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "items", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RegistrationSleeveFullDto" }, "xml": { "name": "RegistrationSleeveFullDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Registrations/Action/Process/SleeveSetUpWizard": { "post": { "tags": [ "Trading/Sleeve" ], "summary": "Used to update a registration sleeve as well as its underlying account sleeves.", "operationId": "SleeveRegistrations_ProcessSleeveSetUpWizardAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RegistrationSleeveFullDto" } }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "isRegFullRebalance", "in": "query", "description": "Optional param to indicate if a registration full rebalance has already been run and the trade queue entry needs to be updated to complete.", "required": false, "type": "boolean", "default": false }, { "name": "approved", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RegistrationSleeveFullDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Registrations/Action/Unlock": { "post": { "tags": [ "Trading/Sleeve" ], "summary": "Change registrations to Custom Sleeve by a list of accountIds", "operationId": "SleeveRegistrations_UnlockSleevesbyAccountList", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Registrations/Batch": { "put": { "tags": [ "Trading/Sleeve" ], "summary": "Updates registration sleeve values without processing account sleeves.", "operationId": "SleeveRegistrations_UpdateRegistrationSleevesBatchAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "registrationSleeves", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RegistrationSleeveIsDoNotTradeDto" }, "xml": { "name": "RegistrationSleeveIsDoNotTradeDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true }, { "name": "syncToEclipse", "in": "query", "description": "Optional parameter that decides whether the updates are synced to Eclipse. Default value is false.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Registrations/Guardrails/Action/Validate": { "post": { "tags": [ "Trading/Sleeve" ], "operationId": "SleeveRegistrations_ValidateRiskGuardrails", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "config", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RiskGuardrailValidationConfiguration" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RiskGuardrailValidationResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Registrations/ImportCheck": { "post": { "tags": [ "Trading/Sleeve" ], "summary": "Import Check", "operationId": "SleeveRegistrations_CheckRegistrationsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RegistrationCheckDto" }, "xml": { "name": "RegistrationCheckDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Registrations/IsDoNotTrade": { "get": { "tags": [ "Trading/Sleeve" ], "summary": "Gets the registration sleeves that have IsDoNotTrade = true. This is used by OPS as part of a daily process that sets trade blocks/unblocks.", "operationId": "SleeveRegistrations_GetIsDoNotTrade", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RegistrationSleeveIsDoNotTradeDto" }, "xml": { "name": "RegistrationSleeveIsDoNotTradeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Registrations/IsDoNotTrade/Set": { "post": { "tags": [ "Trading/Sleeve" ], "summary": "Gets the registration sleeves that have IsDoNotTrade = true. This is used by OPS as part of a daily process that sets trade blocks/unblocks.\r\nUpdates the IsDoNotTrade value in tblRegistrationSleeve for a list of registration ids.", "operationId": "SleeveRegistrations_PostIsDoNotTrade", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "registrationIds", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RegistrationTradingInstructionsDto" }, "xml": { "name": "RegistrationTradingInstructionsDto", "wrapped": true }, "type": "array" } }, { "name": "isDoNotTrade", "in": "query", "required": true, "type": "boolean" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Trading.Sleeve.SleeveRegistrationResponseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Registrations/List": { "post": { "tags": [ "Trading/Sleeve" ], "summary": "Gets a list of registration sleeves that match one of the keys in the provided list.", "operationId": "SleeveRegistrations_GetListById", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RegistrationSleeveDto" }, "xml": { "name": "RegistrationSleeveDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Registrations/List/Id": { "post": { "tags": [ "Trading/Sleeve" ], "summary": "Gets a list of registration sleeves that match one of the keys in the provided list.", "operationId": "SleeveRegistrations_PostV1TradingSleeveRegistrationsListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RegistrationSleeveDto" }, "xml": { "name": "RegistrationSleeveDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Registrations/ListWithAccountSleeves": { "post": { "tags": [ "Trading/Sleeve" ], "summary": "Gets a list of registration sleeves that match one of the keys in the provided list with account sleeves.", "operationId": "SleeveRegistrations_GetListByIdWithAccountSleevesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RegistrationSleeveFullValidationDto" }, "xml": { "name": "RegistrationSleeveFullValidationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Registrations/SpecialSleeves": { "put": { "tags": [ "Trading/Sleeve" ], "summary": "Process special locked sleeves. This only processes model and platform.", "operationId": "SleeveRegistrations_SaveSpecialSleevesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "accountSleeveProcessDtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.AccountSleeveProcessDto" }, "xml": { "name": "AccountSleeveProcessDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Registrations/UpcomingSWP": { "put": { "tags": [ "Trading/Sleeve" ], "summary": "A quick update to the Registration Sleeve table to upcomingSWP flag without processing the registration.", "operationId": "SleeveRegistrations_UpdateUpcomingSWPOnRegSleeveAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "upcomingSWPData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.UpcomingSwpDataDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Registrations/UpcomingSWP/CreateAutoJournal": { "post": { "tags": [ "Trading/Sleeve" ], "summary": "Creates UpcomingSWP AutoJournal Transactions", "operationId": "SleeveRegistrations_CreateUpcomingSWPAutoJournalTransactions", "consumes": [], "produces": [], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Sleeve/Registrations/UpdateFirmId/{key}": { "put": { "tags": [ "Trading/Sleeve" ], "summary": "A quick update to the Registration Sleeve talbe to write the FirmId to the table without processing the registration.", "operationId": "SleeveRegistrations_UpdateFirmIdOnRegSleeveAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true }, { "name": "firmId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategy": { "get": { "tags": [ "Trading/SleeveStrategy" ], "summary": "Returns all of the Sleeve Strategies in the database", "operationId": "SleeveStrategy_GetV1TradingSleeveStrategy", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "onlyRiskTypeStrategies", "in": "query", "description": "When true only those Stragegies that have Risk Types.", "required": false, "type": "boolean", "default": false }, { "name": "repId", "in": "query", "description": "Optional. Default: null If provided the results will be filtered to just the Strategies owned by the rep with the Id given.", "required": false, "type": "integer", "format": "int32" }, { "name": "regTypeId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "custodianId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "brokerDealerId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "registrationId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyDto" }, "xml": { "name": "SleeveStrategyDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Trading/SleeveStrategy" ], "summary": "Creates new Sleeve Strategy", "operationId": "SleeveStrategy_CreateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyWithDetailsDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyWithDetailsDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategy/{key}": { "get": { "tags": [ "Trading/SleeveStrategy" ], "summary": "Returns a Sleeve Strategy", "operationId": "SleeveStrategy_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyWithDetailsDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Trading/SleeveStrategy" ], "summary": "Saves changes to the Sleeve Strategy and the Details", "operationId": "SleeveStrategy_UpdateSleeveStrategyAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Required The Sleeve Strategy ID.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "Required The Sleeve Strategy and Details that are being changed for the selected Sleeve Strategy", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyWithDetailsDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyWithDetailsDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Trading/SleeveStrategy" ], "summary": "Deletes the existing Sleeve Strategy", "operationId": "SleeveStrategy_DeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategy/{key}/{batchId}/Action/Process/Registration": { "post": { "tags": [ "Trading/SleeveStrategy" ], "summary": "Used to update multiple registrations sleeves as well as it's underlying account sleeves.", "description": "Intentionally does not accept a request {System.Threading.CancellationToken} for registration processing. Sleeve strategy changes must be applied fully;\r\ncancelling mid-pipeline previously left registrations in an inconsistent state when users closed the browser during save.", "operationId": "SleeveStrategy_PostV1TradingSleeveStrategyByKeyByBatchIdActionProcessRegistration", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The Sleeve Strategy Id", "required": true, "type": "integer", "format": "int32" }, { "name": "batchId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "req", "in": "body", "description": "List of Registrations that have been assigned to the Sleeve Strategy and a List of Registrations unassinged from the strategy.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ProcessStrategiesDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategy/{key}/Action/Process/Accounts": { "post": { "tags": [ "Trading/SleeveStrategy" ], "summary": "Assigns accounts to a Sleeve Strategy", "operationId": "SleeveStrategy_AssignAccountsToSleeveStrategyAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "accountIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true }, { "name": "validateOnly", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyAccountAssignmentReturnDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategy/{key}/Action/Process/Registration": { "post": { "tags": [ "Trading/SleeveStrategy" ], "summary": "Overloaded method", "operationId": "SleeveStrategy_ProcessSleeveStrategiesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The Sleeve Strategy Id", "required": true, "type": "integer", "format": "int32" }, { "name": "req", "in": "body", "description": "List of Registrations that have been assigned to the Sleeve Strategy and a List of Registrations unassinged from the strategy.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ProcessStrategiesDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategy/{key}/DetailHistories": { "get": { "tags": [ "Trading/SleeveStrategy" ], "summary": "Returns the data regarding the changes in the Sleeve Strategy Detail changes", "operationId": "SleeveStrategy_GetSleeveStrategyDetailHistoryByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyDetailHistoryDto" }, "xml": { "name": "SleeveStrategyDetailHistoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategy/{key}/Histories": { "get": { "tags": [ "Trading/SleeveStrategy" ], "summary": "Returns the data regarding the changes in the Sleeve Strategy", "operationId": "SleeveStrategy_GetSleeveStrategyHistoryByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyHistoryDto" }, "xml": { "name": "SleeveStrategyHistoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategy/{SleeveStrategyId}/AssetLevelsAllowed": { "get": { "tags": [ "Trading/SleeveStrategy" ], "summary": "Returns a list of SleeveStrategyAssetLevelAllowed assigned to a SleeveStrategy", "operationId": "SleeveStrategy_GetSleeveStrategyAssetLevelsAllowed", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "SleeveStrategyId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategyAssetLevelAllowed" }, "xml": { "name": "SleeveStrategyAssetLevelAllowed", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategy/{sleeveStrategyId}/ValidateRegistrationModelAssignments": { "post": { "tags": [ "Trading/SleeveStrategy" ], "summary": "Validates selected Models on assigned Registrations against Sleeve Strategy Model Restriction settings.", "operationId": "SleeveStrategy_GetRegistrationModelAssignmentValidationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "sleeveStrategyId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "sleeveStrategyWithDetailsDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyWithDetailsDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RegistrationModelAssignmentValidationDto" }, "xml": { "name": "RegistrationModelAssignmentValidationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategy/CountRegistrationsAssigned/{key}": { "get": { "tags": [ "Trading/SleeveStrategy" ], "summary": "Returns how many registration sleeves have been assigned to the Sleeve Strategy", "operationId": "SleeveStrategy_CountRegistrationsAssingedAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategy/Element": { "get": { "tags": [ "Trading/SleeveStrategy" ], "summary": "Endpoint for element to get sleeve data.", "description": "ELEMENT", "operationId": "SleeveStrategy_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "query", "in": "header", "description": "odata", "required": true }, { "name": "repId", "in": "query", "description": "representitive Id", "required": true, "type": "integer", "format": "int32" }, { "name": "pageSize", "in": "query", "description": "size of page to return", "required": false, "type": "integer", "format": "int32", "default": 10 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataProcess.DTO.OData.QueryPaginatedResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategy/Element/{sleeveId}/Detail": { "get": { "tags": [ "Trading/SleeveStrategy" ], "summary": "Endpoint for Element to get sleeve model details", "operationId": "SleeveStrategy_GetSleeveModels", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "sleeveId", "in": "path", "description": "sleeve id", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyElementDetailDto" }, "xml": { "name": "SleeveStrategyElementDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategy/Element/{sleeveId}/Registration": { "get": { "tags": [ "Trading/SleeveStrategy" ], "summary": "Endpoint for Element to get registrations assigned to a rep and sleeve.", "operationId": "SleeveStrategy_GetSleeveRegistrationsByRep", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "repId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "sleeveId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategy/Element/{sleeveId}/RegWithValue": { "get": { "tags": [ "Trading/SleeveStrategy" ], "summary": "Endpoint for Element to get registrations assigned to a rep and sleeve, including value.", "operationId": "SleeveStrategy_GetSleeveRegistrationsWithValueByRepAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "repId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "sleeveId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationSimpleDto" }, "xml": { "name": "RegistrationSimpleDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategy/Element/NameInUseValidation": { "get": { "tags": [ "Trading/SleeveStrategy" ], "summary": "Endpoint for element to validate a sleeve name.", "description": "ELEMENT", "operationId": "SleeveStrategy_NameInUseValidation", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "name", "in": "query", "description": "sleeve name to check", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "boolean" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategy/RegistrationsAssignedSimple/{key}": { "get": { "tags": [ "Trading/SleeveStrategy" ], "summary": "Returns the Registration Sleeve information for the sleeves assigned to the Sleeve Strategy", "operationId": "SleeveStrategy_GetRegistrationsAssignedSimpleAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RegistrationsAssignedToStrategySimpleDto" }, "xml": { "name": "RegistrationsAssignedToStrategySimpleDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategy/Reps/{repId}/Simple": { "get": { "tags": [ "Trading/SleeveStrategy" ], "operationId": "SleeveStrategy_GetSimpleByRepIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "repId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategy/Restrictions": { "get": { "tags": [ "Trading/SleeveStrategy" ], "summary": "Gets a list of sleeve strategy restrictions that the logged in user has access to.", "operationId": "SleeveStrategyRestrictions_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "sleeveStrategyId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "registrationId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyRestrictionDto" }, "xml": { "name": "SleeveStrategyRestrictionDto", "wrapped": true }, "type": "array" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Trading/SleeveStrategy" ], "summary": "Used to create a new sleeve strategy restriction. Upon successful creation a 201 will be returned with the location of the nearly created sleeve strategy.", "operationId": "SleeveStrategyRestrictions_CreateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "sleeveStrategyRestrictionDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyRestrictionDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyRestrictionDto" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategy/Restrictions/{key}": { "get": { "tags": [ "Trading/SleeveStrategy" ], "summary": "Gets the sleeve strategy restriction that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "SleeveStrategyRestrictions_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyRestrictionDto" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Trading/SleeveStrategy" ], "summary": "Used to update an existing sleeve strategy restriction. Upon successful modification a 200 will be returned.", "operationId": "SleeveStrategyRestrictions_UpdateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "sleeveStrategyRestrictionDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyRestrictionDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyRestrictionDto" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Trading/SleeveStrategy" ], "summary": "Used to delete an existing sleeve strategy restriction. Upon successful deletion a 204 will be returned.", "operationId": "SleeveStrategyRestrictions_DeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Model Restriction Id to be deleted", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategy/ReturnBatchId": { "get": { "tags": [ "Trading/SleeveStrategy" ], "summary": "This method creates a new batchid for consumption later. The batchId identifies the run of sleeve strategies being modified by the user.", "operationId": "SleeveStrategy_ReturnBatchIdForSleeveStrategy", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategy/ReturnRegSleeveWithStrategy/{key}": { "get": { "tags": [ "Trading/SleeveStrategy" ], "summary": "Used to update multiple registrations sleeves as well as it's underlying account sleeves.", "operationId": "SleeveStrategy_ReturnRegSleeveWithStrategyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The Sleeve Strategy Id", "required": true, "type": "integer", "format": "int32" }, { "name": "registrationId", "in": "query", "description": "RegistrationId assigned to the Sleeve Strategy.", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RegistrationSleeveFullDto" }, "xml": { "name": "RegistrationSleeveFullDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategy/Search": { "get": { "tags": [ "Trading/SleeveStrategy" ], "summary": "Returns a list of the Sleeve Strategy id and names beginning with the searchText provided.", "operationId": "SleeveStrategy_Search", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "top", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategy/Search/{search}": { "get": { "tags": [ "Trading/SleeveStrategy" ], "summary": "Returns a list of the Sleeve Strategy id and names beginning with the searchText provided.", "operationId": "SleeveStrategy_GetV1TradingSleeveStrategySearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "required": true, "type": "string" }, { "name": "top", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategy/Simple": { "get": { "tags": [ "Trading/SleeveStrategy" ], "summary": "Returns a list of all the Sleeve Strategy id and names", "operationId": "SleeveStrategy_GetSleeveStrategySimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategy/StrategyStatistics": { "post": { "tags": [ "Trading/SleeveStrategy" ], "summary": "Returns performance statistics for strategy", "operationId": "SleeveStrategy_StrategyStatisticsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyRequestDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyStatisticsResponseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategy/UpdateSubstitutes/{strategyId}/{detailId}": { "put": { "tags": [ "Trading/SleeveStrategy" ], "summary": "Saves changes to the Sleeve Strategy Details Substitutes", "operationId": "SleeveStrategy_UpdateSubstitutesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "strategyId", "in": "path", "description": "Required The Sleeve Strategy ID.", "required": true, "type": "integer", "format": "int32" }, { "name": "detailId", "in": "path", "description": "Required The Sleeve Strategy Detail ID.", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "Required The Sleeve Strategy Detail Substitutes that are being changed for the selected Sleeve Strategy Detail", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.AggregateModelSubstituteDto" }, "xml": { "name": "AggregateModelSubstituteDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategy/Verbose": { "get": { "tags": [ "Trading/SleeveStrategy" ], "operationId": "SleeveStrategy_GetVerbose", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Core", "Mandates", "RiskType", "SleeveStrategyDetails", "Entities", "All" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "isPTModel", "in": "query", "required": false, "type": "boolean" }, { "name": "repId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "editDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "isOverlay", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "isSubAdvisorOwned", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "regTypeId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "custodianId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "brokerDealerId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "registrationId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyVerboseDto" }, "xml": { "name": "SleeveStrategyVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Trading/SleeveStrategy" ], "summary": "Create a new Portfolio Target Strategy", "operationId": "SleeveStrategy_CreateVerboseAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyVerboseDto" } }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyVerboseDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategy/Verbose/{key}": { "get": { "tags": [ "Trading/SleeveStrategy" ], "operationId": "SleeveStrategy_GetVerboseByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Core", "Mandates", "RiskType", "SleeveStrategyDetails", "Entities", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyVerboseDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Trading/SleeveStrategy" ], "summary": "Update Portfolio Target Strategy", "operationId": "SleeveStrategy_UpdateVerboseAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedItem", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyVerboseDto" } }, { "name": "ct", "in": "header", "required": true }, { "name": "processStrategy", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategy/Verbose/List": { "post": { "tags": [ "Trading/SleeveStrategy" ], "operationId": "SleeveStrategy_GetVerboseByList", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Core", "Mandates", "RiskType", "SleeveStrategyDetails", "Entities", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyVerboseDto" }, "xml": { "name": "SleeveStrategyVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategy/Verbose/List/Id": { "post": { "tags": [ "Trading/SleeveStrategy" ], "operationId": "SleeveStrategy_PostV1TradingSleeveStrategyVerboseListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "expand", "in": "query", "required": false, "items": { "type": "string", "enum": [ "None", "Core", "Mandates", "RiskType", "SleeveStrategyDetails", "Entities", "All" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyVerboseDto" }, "xml": { "name": "SleeveStrategyVerboseDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategyAggregate": { "get": { "tags": [ "Trading/SleeveStrategyAggregate" ], "summary": "Returns all of the Sleeve Strategies Aggregates in the database", "operationId": "SleeveStrategyAggregate_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "onlyAggregates", "in": "query", "description": "Optional. Default: true If true, only strategy aggregates with more that one detail will be returned.", "required": false, "type": "boolean", "default": true }, { "name": "includeSleeveRiskInfo", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "repId", "in": "query", "description": "Optional. Default: null If provided the results will be filtered to just the Strategies owned by the rep with the Id given.", "required": false, "type": "integer", "format": "int32" }, { "name": "registrationId", "in": "query", "description": "Optional. Default: null If provided the results will be filtered to just the Strategies accessible by the Id given.", "required": false, "type": "integer", "format": "int32" }, { "name": "regTypeId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "custodianId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "brokerDealerId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyAggregateDto" }, "xml": { "name": "SleeveStrategyAggregateDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Trading/SleeveStrategyAggregate" ], "summary": "Creates new Sleeve Strategy Aggregate", "operationId": "SleeveStrategyAggregate_CreateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "sleeveStrategyAggregateWithDetailsDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyAggregateWithDetailsDto" } }, { "name": "allowOneDetail", "in": "query", "description": "Optional: Default false. If false and a strategy agg with only one detail is passed in, an exception will be thrown saying more than one detail is required. This should only be true from the call to create a regular strategy.", "required": false, "type": "boolean", "default": false }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyAggregateWithDetailsDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategyAggregate/{key}": { "get": { "tags": [ "Trading/SleeveStrategyAggregate" ], "summary": "Returns the Sleeve Strategies Aggregates for the given key.", "operationId": "SleeveStrategyAggregate_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Results will be filtered to just the Strategy Aggregate for the given key.", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyAggregateWithDetailsDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Trading/SleeveStrategyAggregate" ], "summary": "Saves changes to the Sleeve Strategy Aggregate and the Details", "operationId": "SleeveStrategyAggregate_UpdateSleeveStrategyAggregateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Required: The Sleeve Strategy Aggregate ID.", "required": true, "type": "integer", "format": "int32" }, { "name": "sleeveStrategyAggregateWithDetailsDto", "in": "body", "description": "Required: The Sleeve Strategy Aggregate and Details that are being changed for the selected Sleeve Strategy", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyAggregateWithDetailsDto" } }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyAggregateWithDetailsDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Trading/SleeveStrategyAggregate" ], "summary": "Deletes the existing Sleeve Strategy Aggregate", "operationId": "SleeveStrategyAggregate_Delete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategyAggregate/{key}/Action/Process/Registration": { "post": { "tags": [ "Trading/SleeveStrategyAggregate" ], "summary": "Used to update multiple registrations sleeves as well as it's underlying account sleeves.", "operationId": "SleeveStrategyAggregate_ProcessSleeveStrategyAggregateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The Sleeve Strategy Id", "required": true, "type": "integer", "format": "int32" }, { "name": "req", "in": "body", "description": "List of Registrations that have been assigned to the Sleeve Strategy and a List of Registrations unassinged from the strategy.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ProcessStrategiesDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategyAggregate/{key}/DetailHistories": { "get": { "tags": [ "Trading/SleeveStrategyAggregate" ], "summary": "Returns the data regarding the changes in the Sleeve Strategy Detail changes", "operationId": "SleeveStrategyAggregate_GetSleeveStrategyDetailHistoryByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyAggregateDetailHistoryDto" }, "xml": { "name": "SleeveStrategyAggregateDetailHistoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategyAggregate/{key}/Histories": { "get": { "tags": [ "Trading/SleeveStrategyAggregate" ], "summary": "Returns the data regarding the changes in the Sleeve Strategy Aggregates.", "operationId": "SleeveStrategyAggregate_GetSleeveStrategyHistoryByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyAggregateHistoryDto" }, "xml": { "name": "SleeveStrategyAggregateHistoryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategyAggregate/CountRegistrationsAssigned/{key}": { "get": { "tags": [ "Trading/SleeveStrategyAggregate" ], "summary": "Returns how many registration sleeves have been assigned to the Sleeve Strategy", "operationId": "SleeveStrategyAggregate_CountRegistrationsAssinged", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategyAggregate/RegistrationsAssignedSimple/{key}": { "get": { "tags": [ "Trading/SleeveStrategyAggregate" ], "summary": "Returns the Registration Sleeve information for the sleeves assigned to the Sleeve Strategy Aggregate", "operationId": "SleeveStrategyAggregate_GetRegistrationsAssignedSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RegistrationsAssignedToStrategySimpleDto" }, "xml": { "name": "RegistrationsAssignedToStrategySimpleDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategyAggregate/Restrictions": { "get": { "tags": [ "Trading/SleeveStrategyAggregate" ], "summary": "Gets a list of sleeve strategy aggregate restrictions that the logged in user has access to.", "operationId": "SleeveStrategyAggregateRestrictions_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "sleeveStrategyAggregateId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "registrationId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyAggregateRestrictionDto" }, "xml": { "name": "SleeveStrategyAggregateRestrictionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Trading/SleeveStrategyAggregate" ], "summary": "Used to create a new sleeve strategy aggregate restriction. Upon successful creation a 201 will be returned with the location of the nearly created sleeve strategy.", "operationId": "SleeveStrategyAggregateRestrictions_CreateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "sleeveStrategyAggregateRestrictionDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyAggregateRestrictionDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyAggregateRestrictionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategyAggregate/Restrictions/{key}": { "get": { "tags": [ "Trading/SleeveStrategyAggregate" ], "summary": "Gets the sleeve strategy aggregate restriction that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "SleeveStrategyAggregateRestrictions_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyAggregateRestrictionDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Trading/SleeveStrategyAggregate" ], "summary": "Used to update an existing sleeve strategy aggregate restriction. Upon successful modification a 200 will be returned.", "operationId": "SleeveStrategyAggregateRestrictions_UpdateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "sleeveStrategyAggregateRestrictionDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyAggregateRestrictionDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyAggregateRestrictionDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Trading/SleeveStrategyAggregate" ], "summary": "Used to delete an existing sleeve strategy aggregate restriction. Upon successful deletion an\r\nHTTP 204 status code is\r\nreturned.", "operationId": "SleeveStrategyAggregateRestrictions_DeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Sleeve Strategy Aggregate Restriction ID to be deleted.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategyAggregate/ReturnRegSleeveWithStrategyAggregate/{key}": { "get": { "tags": [ "Trading/SleeveStrategyAggregate" ], "summary": "Used to update multiple registrations sleeves as well as it's underlying account sleeves.", "operationId": "SleeveStrategyAggregate_ReturnRegSleeveWithStrategyAggregate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The Sleeve Strategy Id", "required": true, "type": "integer", "format": "int32" }, { "name": "registrationId", "in": "query", "description": "RegistrationId assigned to the Sleeve Strategy.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RegistrationSleeveFullDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategyAggregate/Search": { "get": { "tags": [ "Trading/SleeveStrategyAggregate" ], "summary": "Returns a list of the Sleeve Strategy Aggregate ids and names beginning with the searchText provided.", "operationId": "SleeveStrategyAggregate_Search", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "query", "required": true, "type": "string" }, { "name": "top", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategyAggregate/Search/{search}": { "get": { "tags": [ "Trading/SleeveStrategyAggregate" ], "summary": "Returns a list of the Sleeve Strategy Aggregate ids and names beginning with the searchText provided.", "operationId": "SleeveStrategyAggregate_GetV1TradingSleeveStrategyAggregateSearchBySearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "search", "in": "path", "required": true, "type": "string" }, { "name": "top", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategyAggregate/Simple": { "get": { "tags": [ "Trading/SleeveStrategyAggregate" ], "summary": "Returns a list of all the Sleeve Strategy Aggregate id and names", "operationId": "SleeveStrategyAggregate_GetSleeveStrategySimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "registrationId", "in": "query", "description": "Optional. Default: null If provided the results will be filtered to just the Strategies accessible by the Id given.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategyRiskType": { "get": { "tags": [ "Trading/SleeveStrategyRiskType" ], "summary": "Returns all Sleeve Strategy Risk Types", "operationId": "SleeveStrategyRiskType_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "includeAllocations", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "onlyPtModels", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "ptModelsNotSetUp", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyRiskTypeDto" }, "xml": { "name": "SleeveStrategyRiskTypeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Trading/SleeveStrategyRiskType" ], "summary": "Update list of Sleeve Strategy Risk Types", "operationId": "SleeveStrategyRiskType_UpdateListRiskTypes", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "riskTypes", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyRiskTypeDto" }, "xml": { "name": "SleeveStrategyRiskTypeDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyRiskTypeDto" }, "xml": { "name": "SleeveStrategyRiskTypeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveStrategyRiskType/{key}": { "get": { "tags": [ "Trading/SleeveStrategyRiskType" ], "summary": "Returns Sleeve Strategy Risk Types by key", "operationId": "SleeveStrategyRiskType_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "includeAllocations", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyRiskTypeDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Trading/SleeveStrategyRiskType" ], "summary": "Update list of Sleeve Strategy Risk Types", "operationId": "SleeveStrategyRiskType_UpdateRiskType", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyRiskTypeDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyRiskTypeDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveUpdateQueue": { "get": { "tags": [ "Trading/SleeveUpdateQueue" ], "summary": "Returns all of the Sleeve Update Queue items in the database", "operationId": "SleeveUpdateQueue_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "status", "in": "query", "description": "Will return only the Sleeve Update Queue items that have the matching status passed in.", "required": false, "type": "string", "enum": [ "Pending", "Approved", "Rejected", "Completed", "Failed" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveUpdateQueueDto" }, "xml": { "name": "SleeveUpdateQueueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Trading/SleeveUpdateQueue" ], "summary": "Update list of Sleeve Update Queues", "operationId": "SleeveUpdateQueue_CreateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "The object containing the list of keys and the desired status.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveUpdateQueueDto" } }, { "name": "ct", "in": "header", "description": "CancellationToken", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveUpdateQueueDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveUpdateQueue/{key}": { "get": { "tags": [ "Trading/SleeveUpdateQueue" ], "summary": "Returns the Sleeve Update Queue item in the database", "operationId": "SleeveUpdateQueue_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The id of the Sleeve Update Queue item desired.", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveUpdateQueueDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveUpdateQueue/Action/ProcessAllApproved": { "post": { "tags": [ "Trading/SleeveUpdateQueue" ], "summary": "Process all of the approved Sleeve Update Queue items", "operationId": "SleeveUpdateQueue_ProcessAllApprovedAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "description": "CancellationToken", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveUpdateQueueDto" }, "xml": { "name": "SleeveUpdateQueueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveUpdateQueue/UdpateStatus/{key}": { "put": { "tags": [ "Trading/SleeveUpdateQueue" ], "summary": "Update one Sleeve Update Queue", "operationId": "SleeveUpdateQueue_UpdateAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The id of the Sleeve Update Queue item desired.", "required": true, "type": "integer", "format": "int32" }, { "name": "status", "in": "query", "description": "The status that the user wants to change to, Pending / Approved / Rejected.", "required": true, "type": "string", "enum": [ "Pending", "Approved", "Rejected", "Completed", "Failed" ] }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveUpdateQueueDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SleeveUpdateQueue/UdpateStatusList": { "put": { "tags": [ "Trading/SleeveUpdateQueue" ], "summary": "Update list of Sleeve Update Queues", "operationId": "SleeveUpdateQueue_UpdateListAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "The object containing the list of keys and the desired status.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ChangeSleeveUpdateStatusDto" } }, { "name": "ct", "in": "header", "description": "CancellationToken", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveUpdateQueueDto" }, "xml": { "name": "SleeveUpdateQueueDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/SummaryCount": { "get": { "tags": [ "Trading/SummaryCount" ], "summary": "Returns the number of open orders, pending transactions, and allocation orders the logged in user has access to.", "operationId": "Trading_GetSummaryCountAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TradeCountSummaryDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Tactical": { "put": { "tags": [ "Trading/Tactical" ], "summary": "Recalculate trade shares, trade and post trade amounts.", "operationId": "TradingTactical_UpdateTacticalAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TacticalTradeDto" }, "xml": { "name": "TacticalTradeDto", "wrapped": true }, "type": "array" } }, { "name": "tradeType", "in": "query", "required": true, "type": "string", "enum": [ "Undefined", "Shares", "Dollars", "Percent" ] }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "commitToDb", "in": "query", "description": "Optional. Default: True.", "required": false, "type": "boolean", "default": true }, { "name": "executeTrade", "in": "query", "description": "Optional. Default: True.", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TradeBatchDto" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Trading/Tactical" ], "summary": "Endpoint to create new trade", "operationId": "TradingTactical_CreateTradeAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "newRecord", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TacticalTradeDto" } }, { "name": "usePendingValue", "in": "query", "required": true, "type": "boolean" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "clientId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "modelAggId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "resetCache", "in": "query", "description": "Optional. Default: false. The result is cached for fifteen minutes. To force the cache to refresh call with resetCache = true.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TacticalTradeDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Tactical/{accountId}/{productId}": { "put": { "tags": [ "Trading/Tactical" ], "summary": "Recalculate trade shares, trade and post trade amounts without saving to db.", "operationId": "TradingTactical_UpdateTradeAndPostTradeValuesAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "productId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "updatedTacticalTrade", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TacticalTradeDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TacticalTradeDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Tactical/Account/{accountId}": { "get": { "tags": [ "Trading/Tactical" ], "summary": "Gets a list of tactical trades by account.", "operationId": "TradingTactical_GetTacticalTradesByAccountKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "usePendingValue", "in": "query", "required": true, "type": "boolean" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "includeCash", "in": "query", "description": "If cash is in the model, this is ignored. When False, cash is excluded from values.", "required": false, "type": "boolean", "default": true }, { "name": "ignoreDollarModel", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "modelId", "in": "query", "description": "If passed in, the assigned model will be overriden by this model.", "required": false, "type": "integer", "format": "int32" }, { "name": "cashValue", "in": "query", "description": "If Passed in, the cash in the account will be updated with this value. This is useful if you are adding, or withdrawaling money from the account.", "required": false, "type": "number", "format": "float" }, { "name": "calculateCosts", "in": "query", "description": "If passed in, it will populate costs fields. However, enabling it will have heavy performance impact.", "required": false, "type": "boolean", "default": false }, { "name": "accountType", "in": "query", "required": false, "type": "string" }, { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "defaultAction", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TacticalTradeDto" }, "xml": { "name": "TacticalTradeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Tactical/AccountList": { "get": { "tags": [ "Trading/Tactical" ], "summary": "Gets a list of tactical trades by list of account ids.", "operationId": "TradingTactical_GetTacticalTradesByAccountListAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "query", "required": true, "type": "string" }, { "name": "usePendingValue", "in": "query", "required": true, "type": "boolean" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "includeCash", "in": "query", "description": "If cash is in the model, this is ignored. When False, cash is excluded from values.", "required": false, "type": "boolean", "default": true }, { "name": "ignoreDollarModel", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "modelId", "in": "query", "description": "If passed in, the assigned model will be overriden by this model.", "required": false, "type": "integer", "format": "int32" }, { "name": "cashValue", "in": "query", "description": "If Passed in, the cash in the account will be updated with this value. This is useful if you are adding, or withdrawaling money from the account.", "required": false, "type": "number", "format": "float" }, { "name": "calculateCosts", "in": "query", "description": "If passed in, it will populate costs fields. However, enabling it will have heavy performance impact.", "required": false, "type": "boolean", "default": false }, { "name": "accountType", "in": "query", "required": false, "type": "string" }, { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "defaultAction", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TacticalTradeDto" }, "xml": { "name": "TacticalTradeDto", "wrapped": true }, "type": "array" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Trading/Tactical" ], "summary": "Gets a list of tactical trades by list of account ids.", "operationId": "TradingTactical_PostTacticalTradesByAccountListAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountListRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Trading.Dto.AccountListRequest" } }, { "name": "cancelToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TacticalTradeDto" }, "xml": { "name": "TacticalTradeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Tactical/Action/Balance": { "put": { "tags": [ "Trading/Tactical" ], "summary": "Balance rows in memory", "operationId": "TradingTactical_Balance", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TacticalTradeDto" }, "xml": { "name": "TacticalTradeDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TacticalTradeDto" }, "xml": { "name": "TacticalTradeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Tactical/Action/BuyProportionately": { "put": { "tags": [ "Trading/Tactical" ], "summary": "Spend available cash pro rata to the model", "operationId": "TradingTactical_BuyProportionatelyAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "trades", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TacticalTradeDto" }, "xml": { "name": "TacticalTradeDto", "wrapped": true }, "type": "array" } }, { "name": "usePendingValue", "in": "query", "required": true, "type": "boolean" }, { "name": "populateCosts", "in": "query", "required": true, "type": "boolean" }, { "name": "amount", "in": "query", "required": true, "type": "number", "format": "double" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TacticalTradeDto" }, "xml": { "name": "TacticalTradeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Tactical/Action/BuyRebalance": { "put": { "tags": [ "Trading/Tactical" ], "summary": "Buy all underweight products up their model targets", "operationId": "TradingTactical_BuyRebalanceAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "trades", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TacticalTradeDto" }, "xml": { "name": "TacticalTradeDto", "wrapped": true }, "type": "array" } }, { "name": "usePendingValue", "in": "query", "required": true, "type": "boolean" }, { "name": "populateCosts", "in": "query", "required": true, "type": "boolean" }, { "name": "amount", "in": "query", "required": true, "type": "number", "format": "double" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TacticalTradeDto" }, "xml": { "name": "TacticalTradeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Tactical/Action/SellProportionately": { "put": { "tags": [ "Trading/Tactical" ], "summary": "Sell positions in proportion to the model target % to raise specified amount", "operationId": "TradingTactical_SellProportionatelyAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "trades", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TacticalTradeDto" }, "xml": { "name": "TacticalTradeDto", "wrapped": true }, "type": "array" } }, { "name": "usePendingValue", "in": "query", "required": true, "type": "boolean" }, { "name": "populateCosts", "in": "query", "required": true, "type": "boolean" }, { "name": "amount", "in": "query", "required": true, "type": "number", "format": "double" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TacticalTradeDto" }, "xml": { "name": "TacticalTradeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Tactical/Action/SellRebalance": { "put": { "tags": [ "Trading/Tactical" ], "summary": "Sell all overweight positions to their target percents", "operationId": "TradingTactical_SellRebalanceAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "trades", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TacticalTradeDto" }, "xml": { "name": "TacticalTradeDto", "wrapped": true }, "type": "array" } }, { "name": "usePendingValue", "in": "query", "required": true, "type": "boolean" }, { "name": "populateCosts", "in": "query", "required": true, "type": "boolean" }, { "name": "amount", "in": "query", "required": true, "type": "number", "format": "double" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TacticalTradeDto" }, "xml": { "name": "TacticalTradeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Tactical/Action/TargetAmount": { "put": { "tags": [ "Trading/Tactical" ], "summary": "Assign target percent to specified rows and update update rows", "operationId": "TradingTactical_TargetAmount", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "targetAmount", "in": "query", "description": "The end $ Dollar Amount to target.", "required": true, "type": "number", "format": "double" }, { "name": "data", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TacticalTradeDto" }, "xml": { "name": "TacticalTradeDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TacticalTradeDto" }, "xml": { "name": "TacticalTradeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Tactical/Action/TargetPercent": { "put": { "tags": [ "Trading/Tactical" ], "summary": "Assign target percent to specified rows and update update rows", "operationId": "TradingTactical_TargetPercent", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "targetPercent", "in": "query", "required": true, "type": "number", "format": "double" }, { "name": "data", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TacticalTradeDto" }, "xml": { "name": "TacticalTradeDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TacticalTradeDto" }, "xml": { "name": "TacticalTradeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Tactical/Action/TradingRebalance": { "put": { "tags": [ "Trading/Tactical" ], "summary": "Generate trades to balance account", "operationId": "TradingTactical_RebalanceTradeToolAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "trades", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TacticalTradeDto" }, "xml": { "name": "TacticalTradeDto", "wrapped": true }, "type": "array" } }, { "name": "usePendingValue", "in": "query", "required": true, "type": "boolean" }, { "name": "populateCosts", "in": "query", "required": true, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TacticalTradeDto" }, "xml": { "name": "TacticalTradeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Tactical/Client/{clientId}": { "get": { "tags": [ "Trading/Tactical" ], "summary": "Gets a list of tactical trades by household.", "operationId": "TradingTactical_TacticalTradesByHouseholdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "clientId", "in": "path", "description": "Household/ClientId", "required": true, "type": "integer", "format": "int32" }, { "name": "usePendingValue", "in": "query", "required": true, "type": "boolean" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "includeCash", "in": "query", "description": "If cash is in the model, this is ignored. When False, cash is excluded from values.", "required": false, "type": "boolean", "default": true }, { "name": "ignoreDollarModel", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "modelId", "in": "query", "description": "If passed in, the assigned model will be overridden by this model.", "required": false, "type": "integer", "format": "int32" }, { "name": "cashValue", "in": "query", "description": "If Passed in, the cash in the account will be updated with this value. This is useful if you are adding, or withdrawing money from the account.", "required": false, "type": "number", "format": "float" }, { "name": "calculateCosts", "in": "query", "description": "If passed in, it will populate costs fields. However, enabling it will have heavy performance impact.", "required": false, "type": "boolean", "default": false }, { "name": "modelAggIdFilter", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "defaultAction", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TacticalTradeDto" }, "xml": { "name": "TacticalTradeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Tactical/ClosedOrders": { "put": { "tags": [ "Trading/Tactical" ], "summary": "Gets a list of tactical trades by list of account ids.", "operationId": "TradingTactical_TacticalTradesFromClosedOrdersAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "closedOrders", "in": "body", "description": "List of order dtos.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OrderDto" }, "xml": { "name": "OrderDto", "wrapped": true }, "type": "array" } }, { "name": "usePendingValue", "in": "query", "required": true, "type": "boolean" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "includeCash", "in": "query", "description": "If cash is in the model, this is ignored. When False, cash is excluded from values.", "required": false, "type": "boolean", "default": true }, { "name": "ignoreDollarModel", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "modelId", "in": "query", "description": "If passed in, the assigned model will be overriden by this model.", "required": false, "type": "integer", "format": "int32" }, { "name": "cashValue", "in": "query", "description": "If Passed in, the cash in the account will be updated with this value. This is useful if you are adding, or withdrawaling money from the account.", "required": false, "type": "number", "format": "float" }, { "name": "calculateCosts", "in": "query", "description": "If passed in, it will populate costs fields. However, enabling it will have heavy performance impact.", "required": false, "type": "boolean", "default": false }, { "name": "accountType", "in": "query", "required": false, "type": "string" }, { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "defaultAction", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TacticalTradeDto" }, "xml": { "name": "TacticalTradeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Tactical/Product/{productId}": { "get": { "tags": [ "Trading/Tactical" ], "summary": "Gets a list of tactical trades by product.", "operationId": "TradingTactical_TacticalTradesByProductAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "usePendingValue", "in": "query", "required": true, "type": "boolean" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "includeCash", "in": "query", "description": "If cash is in the model, this is ignored. When False, cash is excluded from values.", "required": false, "type": "boolean", "default": true }, { "name": "ignoreDollarModel", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "modelId", "in": "query", "description": "If passed in, the assigned model will be overriden by this model.", "required": false, "type": "integer", "format": "int32" }, { "name": "cashValue", "in": "query", "description": "If Passed in, the cash in the account will be updated with this value. This is useful if you are adding, or withdrawaling money from the account.", "required": false, "type": "number", "format": "float" }, { "name": "calculateCosts", "in": "query", "description": "If passed in, it will populate costs fields. However, enabling it will have heavy performance impact.", "required": false, "type": "boolean", "default": false }, { "name": "resetCache", "in": "query", "description": "Optional. Default: false. The result is cached for fifteen minutes. To force the cache to refresh call with resetCache = true.", "required": false, "type": "boolean", "default": false }, { "name": "defaultAction", "in": "query", "description": "Optional. Default: null The user is able to select buy, sell, or nothing when opening tactical trade editor. The action will then be populated for all of the trades.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TacticalTradeDto" }, "xml": { "name": "TacticalTradeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Tactical/Registration/{registrationId}": { "get": { "tags": [ "Trading/Tactical" ], "summary": "Gets a list of tactical trades by registration.", "operationId": "TradingTactical_TacticalTradesByRegistrationAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "registrationId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "usePendingValue", "in": "query", "required": true, "type": "boolean" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "includeCash", "in": "query", "description": "If cash is in the model, this is ignored. When False, cash is excluded from values.", "required": false, "type": "boolean", "default": true }, { "name": "ignoreDollarModel", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "modelId", "in": "query", "description": "If passed in, the assigned model will be overridden by this model.", "required": false, "type": "integer", "format": "int32" }, { "name": "cashValue", "in": "query", "description": "If Passed in, the cash in the account will be updated with this value. This is useful if you are adding, or withdrawing money from the account.", "required": false, "type": "number", "format": "float" }, { "name": "calculateCosts", "in": "query", "description": "If passed in, it will populate costs fields. However, enabling it will have heavy performance impact.", "required": false, "type": "boolean", "default": false }, { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "defaultAction", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TacticalTradeDto" }, "xml": { "name": "TacticalTradeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Tactical/TradingTool": { "put": { "tags": [ "Trading/Tactical" ], "summary": "Endpoint to run trading tools", "operationId": "TradingTactical_TacticalTradeToolAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "trades", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TacticalTradeDto" }, "xml": { "name": "TacticalTradeDto", "wrapped": true }, "type": "array" } }, { "name": "routine", "in": "query", "required": true, "type": "string", "enum": [ "Rebalance", "SellProportionately", "SellRebalance", "BuyProportionately", "BuyRebalance" ] }, { "name": "usePendingValue", "in": "query", "required": true, "type": "boolean" }, { "name": "populateCosts", "in": "query", "required": true, "type": "boolean" }, { "name": "amount", "in": "query", "required": false, "type": "number", "format": "double", "default": 0.0 } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TacticalTradeDto" }, "xml": { "name": "TacticalTradeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/TradeBlockReasons": { "put": { "tags": [ "Trading/TradeBlockReasons" ], "operationId": "TradeBlockReason_UpdateTradeBlockReasonAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "tradeBlockReason", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TradeBlockReasonDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/TradeBlockReasons/{tradeBlockReasonGlobalId}": { "delete": { "tags": [ "Trading/TradeBlockReasons" ], "operationId": "TradeBlockReason_DeleteTradeBlockReasonAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "tradeBlockReasonGlobalId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/TradeBlocks": { "get": { "tags": [ "Trading/TradeBlocks" ], "operationId": "TradeBlock_GetTradeBlockDetailsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "relatedType", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "relatedTypeId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Trading/TradeBlocks" ], "summary": "Replaces trade block detail records with the given {tradeBlockDetailDtos} payload.", "description": "The trade block detail records to be replaced are identified by the\r\n{OAS.WebApi.DTO.Trading.TradeBlockDetailDto.Id} values in {tradeBlockDetailDtos}.", "operationId": "TradeBlock_UpdateTradeBlockDetailsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "tradeBlockDetailDtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TradeBlockDetailDto" }, "xml": { "name": "TradeBlockDetailDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true }, { "name": "createSyncEvent", "in": "query", "description": "Whether or not to create a sync event that will notify other systems", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Trading/TradeBlocks" ], "summary": "Creates trade block detail records for the given {tradeBlockDetailDtos} payload.", "description": "Sample Request\r\nPOST Trading/TradeBlocks", "operationId": "TradeBlock_CreateTradeBlockDetailsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "tradeBlockDetailDtos", "in": "body", "description": "An array of {OAS.WebApi.DTO.Trading.TradeBlockDetailDto} objects within a JSON\r\n object.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TradeBlockDetailDto" }, "xml": { "name": "TradeBlockDetailDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true }, { "name": "createSyncEvent", "in": "query", "description": "Whether or not to create a sync event that will notify other systems", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/TradeBlocks/{tradeBlockId}": { "get": { "tags": [ "Trading/TradeBlocks" ], "summary": "Returns the Trade Block Detail having the given ID.", "description": "Sample Request:\r\nGET Trading/TradeBlocks/{id}", "operationId": "TradeBlock_GetAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "tradeBlockId", "in": "path", "description": "The Trade Block Detail identifier.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Trading/TradeBlocks" ], "summary": "Deletes the trade block details record identified by the given {tradeBlockId}.", "description": "Sample Request\r\nDELETE Trading/TradeBlocks/{id}", "operationId": "TradeBlock_DeleteAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "tradeBlockId", "in": "path", "description": "The Trade Block Detail identifier.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true }, { "name": "createSyncEvent", "in": "query", "description": "Whether or not to create a sync event that will notify other systems", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/TradeBlocks/DeleteByGlobalIds": { "post": { "tags": [ "Trading/TradeBlocks" ], "summary": "Deletes the trade block details records identified by the collection of\r\n{tradeBlockDetailIds} in the payload.", "description": "Sample Request\r\nDELETE Trading/TradeBlocks", "operationId": "TradeBlock_DeleteTradeBlockDetailsByGlobalIdAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "globalIds", "in": "body", "required": true, "schema": { "items": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true }, { "name": "createSyncEvent", "in": "query", "description": "Whether or not to create a sync event that will notify other systems", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/TradeBlocks/DeleteByReasonForCurrentUser": { "post": { "tags": [ "Trading/TradeBlocks" ], "summary": "Soft-deletes trade block details for the authenticated user, the given registration/account scopes\r\nfrom the request body, and the given trade block reason global id.", "operationId": "TradeBlock_DeleteByReasonForCurrentUserAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "description": "Reason global id and one or more entity (enum/id) pairs.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.DeleteByReasonForCurrentUserRequest" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/TradeBlocks/DeleteRequests": { "post": { "tags": [ "Trading/TradeBlocks" ], "summary": "Deletes the trade block details records identified by the collection of\r\n{tradeBlockDetailIds} in the payload.", "description": "Sample Request\r\nDELETE Trading/TradeBlocks", "operationId": "TradeBlock_DeleteTradeBlockDetailsByIdAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "tradeBlockDetailIds", "in": "body", "description": "The Trade Block Detail identifiers.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true }, { "name": "createSyncEvent", "in": "query", "description": "Whether or not to create a sync event that will notify other systems", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/TradeBlocks/QueueForAccountIds": { "post": { "tags": [ "Trading/TradeBlocks" ], "summary": "Creates outbox events for the provided {accountIds} with active Trade Block Details.", "operationId": "TradeBlock_QueueTradeBlockDetailsForAccountIdsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "accountIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/TradeBlocks/Reasons": { "get": { "tags": [ "Trading/TradeBlocks" ], "summary": "Returns Trade Block Reasons", "description": "Sample Request:\r\nGET Trading/TradeBlocks/Reasons", "operationId": "TradeBlock_GetReasonsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/TradeBlocks/Reasons/Simple": { "get": { "tags": [ "Trading/TradeBlocks" ], "summary": "Returns a simple list of Trade Block Reasons for the OAS.Search.", "description": "Sample Request:\r\nGET Trading/TradeBlocks/Reasons/Simple", "operationId": "TradeBlock_GetReasonsSimpleAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/TradeBlocks/Related": { "get": { "tags": [ "Trading/TradeBlocks" ], "summary": "Returns Trade Block Related Entities", "description": "Sample Request:\r\nGET Trading/TradeBlocks/Related", "operationId": "TradeBlock_GetTradeBlockRelatedEntitiesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "relatedType", "in": "query", "description": "The entity type that the trade block applies to. Registration = 6, Account = 7", "required": true, "type": "integer", "format": "int32" }, { "name": "relatedTypeId", "in": "query", "description": "The ID of the related type for which the trade block details are returned.", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "description": "The cancellation token.", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/TradeDefinition": { "get": { "tags": [ "Trading/TradeDefinition" ], "summary": "This generates a generic trade definition loaded with the database default settings. This object can be retrieved, filled in with trade instructions, and sent to the Trade Generation Routines.", "operationId": "Trading_GetTradeDefinitionAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "routine", "in": "query", "description": "Required. The kind of trade definition to return", "required": true, "type": "string", "enum": [ "Undefined", "Rebalance", "GlobalTrades", "BuySell", "SellAll", "TargetPercent", "ProRated", "QuickTrade", "QuickTradeBlock", "Distribution", "OptionTrade" ] }, { "name": "resetCache", "in": "query", "description": "Optional. Default: false. The result is cached for fifteen minutes. To force the cache to refresh call with resetCache = true.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Remote.Trading.TradeDefinition" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/TradeExecution/ErrorCheck": { "get": { "tags": [ "Trading/TradeExecution" ], "operationId": "Trading_GetRunTradeErrorChecks", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.TradeRunErrorChecksAccountDto" }, "xml": { "name": "TradeRunErrorChecksAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/TradeFiles": { "get": { "tags": [ "Trading/TradeFiles" ], "summary": "Gets a list of trade files that have already been generated that the logged in user has access to and were created within the range provided. \r\nThe return is limited to pages of 10000. Use $top and $skip in the query string to page through the data.", "operationId": "TradeFiles_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "description": "Optional. The start of the range to report. Default is today.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. The end of the range to report. Default is today.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TradeFileDto" }, "xml": { "name": "TradeFileDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/TradeFiles/{fileId}": { "get": { "tags": [ "Trading/TradeFiles" ], "summary": "Gets a trade file that has already been generated and has the key provided.", "operationId": "TradeFiles_GetById", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "fileId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TradeFileDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/TradeFiles/{fileId}/File": { "get": { "tags": [ "Trading/TradeFiles" ], "summary": "Downloads the trade file to the browser using an http stream for the given TradeFile.Id. This method will also update the trade file as \"processed\", each time it is called.", "operationId": "TradeFiles_DownloadFile", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "fileId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/TradeFiles/{fileId}/Log": { "get": { "tags": [ "Trading/TradeFiles" ], "summary": "Downloads the trade log to the browser using an http stream for the given TradeFile.Id.", "operationId": "TradeFiles_DownloadLog", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "fileId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/TradeFiles/{fileId}/Reset": { "get": { "tags": [ "Trading/TradeFiles" ], "summary": "Resets the provided trade file.", "operationId": "TradeFiles_ResetFile", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "fileId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TradeFileDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/TradeFiles/{fileId}/Transmit": { "post": { "tags": [ "Trading/TradeFiles" ], "summary": "Transmits trade file to ftp destination.", "operationId": "TradeFiles_TransmitFileAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "fileId", "in": "path", "description": "dwnldprep file id to be transmited.", "required": true, "type": "integer", "format": "int32" }, { "name": "allowReTransmit", "in": "query", "description": "Default False. When False, and error will occur if the file.Status = \"sent\". When true, the file will be sent again.", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/TradeFiles/CreateTradeFileFromAllocations": { "post": { "tags": [ "Trading/TradeFiles" ], "summary": "Creates a trade file from allocation block. Takes one or more blockIds", "operationId": "TradeFiles_CreateTradeFileFromBlocksAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "blockIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/TradeFiles/Fees": { "get": { "tags": [ "Trading/TradeFiles" ], "summary": "Gets a list of trade files that have already been generated that the logged in user has access to and were created within the range provided. \r\nThe return is limited to pages of 10000. Use $top and $skip in the query string to page through the data.", "operationId": "TradeFiles_GetFeeFilesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "startDate", "in": "query", "description": "Optional. The start of the range to report. Default is today.", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. The end of the range to report. Default is today.", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TradeFileDto" }, "xml": { "name": "TradeFileDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/TradeFiles/WithProcessing": { "get": { "tags": [ "Trading/TradeFiles" ], "summary": "Returns the Trade files that were created on the specified date, also adds \"temporary\" records in for currently processing files.", "operationId": "TradeFiles_GetWithProcessing", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "query", "description": "Created date of the trade files", "required": true, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TradeFileDto" }, "xml": { "name": "TradeFileDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/TradeGenerationStatus/{batchId}": { "get": { "tags": [ "Trading/TradeGenerationStatus" ], "summary": "Gets the status of trade generation for the batchId provided.", "operationId": "Trading_TradeGenerationStatus", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "batchId", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "includeErrors", "in": "query", "description": "Default is True. When true, the Errors collection will be populated with Errors, Warnings, and Informational Messages", "required": false, "type": "boolean", "default": false }, { "name": "waitSeconds", "in": "query", "description": "Default is 0. If specified, the endpoint will re-check in the specified amount of time before returning. This is to help reduce polling chatter.", "required": false, "type": "integer", "format": "int32", "default": 0 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.BatchProcessingDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/TradeGenerationStatus/{batchId}/Message": { "get": { "tags": [ "Trading/TradeGenerationStatus" ], "summary": "Returns a message formatted for the users inbox based on a trade batch id.", "operationId": "Trading_TradeGenerationStatusMessage", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "batchId", "in": "path", "description": "Id from tblBatchProcessing", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.MessageDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/TradeStatuses": { "get": { "tags": [ "Trading/TradeStatuses" ], "summary": "Gets a list of trade statuses that the logged in user has access to.", "operationId": "TradeStatuses_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TradeStatusDto" }, "xml": { "name": "TradeStatusDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/TradeValidation": { "get": { "tags": [ "Trading/TradeValidation" ], "summary": "Gets account trade validation.", "operationId": "Trading_GetAccountTradeValidation", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "action", "in": "query", "required": true, "type": "string" }, { "name": "sellProductId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "buyProductId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "shares", "in": "query", "required": false, "type": "number", "format": "double" }, { "name": "dollars", "in": "query", "required": false, "type": "number", "format": "double" }, { "name": "percent", "in": "query", "required": false, "type": "number", "format": "double" }, { "name": "usePendingValue", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "verboseValidation", "in": "query", "description": "Optional. Default = False. When true, extra checks are done, STF Warning and Existing open trade order exists.", "required": false, "type": "boolean", "default": false }, { "name": "checkBuyOverspendingCash", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.AccountTradeValidationDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Transactions": { "get": { "tags": [ "Trading/Transactions" ], "operationId": "TradingTransactions_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "status", "in": "query", "required": false, "type": "string", "enum": [ "Complete", "Pending", "Rejected", "Reversed", "Inactive", "PendingCorpAction", "FutureAip" ] }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "transTypeId", "in": "query", "required": false, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" }, { "name": "asOfDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "hasValue", "in": "query", "required": false, "type": "boolean" }, { "name": "editedStartDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "editedEndDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TradingTransactionDto" }, "xml": { "name": "TradingTransactionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Trading/Transactions" ], "summary": "Obsolete. Will be removed after the June 2014 build. Use Portfolio/Transactions/Verbose instead.", "operationId": "TradingTransactions_UpdateList", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "updates", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TradingTransactionDto" }, "xml": { "name": "TradingTransactionDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TradingTransactionDto" }, "xml": { "name": "TradingTransactionDto", "wrapped": true }, "type": "array" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Transactions/{key}": { "get": { "tags": [ "Trading/Transactions" ], "summary": "Gets the transaction that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "TradingTransactions_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TradingTransactionDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Trading/Transactions" ], "summary": "Obsolete. Will be removed after the June 2014 build. Use Portfolio/Transactions/Verbose/{key} instead.", "operationId": "TradingTransactions_Update", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "update", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TradingTransactionDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TradingTransactionDto" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Transactions/Action/Delete": { "put": { "tags": [ "Trading/Transactions" ], "operationId": "TradingTransactions_ActionDelete", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Transactions/Action/StatusChange/{status}": { "put": { "tags": [ "Trading/Transactions" ], "operationId": "TradingTransactions_ActionReject", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "status", "in": "path", "required": true, "type": "string", "enum": [ "Complete", "Pending", "Rejected", "Reversed", "Inactive", "PendingCorpAction", "FutureAip" ] }, { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Transactions/List": { "post": { "tags": [ "Trading/Transactions" ], "summary": "Gets a list of transactions that match one of the keys in the provided list.", "operationId": "TradingTransactions_GetListById", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TradingTransactionDto" }, "xml": { "name": "TradingTransactionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/Transactions/List/Id": { "post": { "tags": [ "Trading/Transactions" ], "summary": "Gets a list of transactions that match one of the keys in the provided list.", "operationId": "TradingTransactions_PostV1TradingTransactionsListId", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "description": "List of keys of the desired return objects.", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TradingTransactionDto" }, "xml": { "name": "TradingTransactionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/TransactionSubTypes": { "get": { "tags": [ "Trading/TransactionSubTypes" ], "summary": "Returns a list of all the transaction sub types that the logged in user has access to.", "operationId": "TransactionSubTypes_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "transTypeCommonId", "in": "query", "description": "Optional. Default null. Used to limit return to only those transaction sub types that are match the common id.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TransactionSubTypeDto" }, "xml": { "name": "TransactionSubTypeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/TransactionTypes": { "get": { "tags": [ "Trading/TransactionTypes" ], "summary": "Returns a list of all the transaction types that the logged in user has access to.", "operationId": "TransactionTypes_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isValid", "in": "query", "description": "Optional. Default null. Used to limit return to only those transaction types that are or aren't valid.", "required": false, "type": "boolean" }, { "name": "usagePriority", "in": "query", "description": "Optional. Default 0. Used to limit transaction type on its usage priority. Will return number enter and higher", "required": false, "type": "integer", "format": "int32", "default": 0 }, { "name": "detail", "in": "query", "description": "Optional. Default false. Used to provide more details about the transaction type.", "required": false, "type": "boolean", "default": false }, { "name": "isBillable", "in": "query", "required": false, "type": "boolean" }, { "name": "isUsed", "in": "query", "required": false, "type": "boolean" }, { "name": "includeRemark", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TransactionTypeDto" }, "xml": { "name": "TransactionTypeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/TransactionTypes/{key}": { "get": { "tags": [ "Trading/TransactionTypes" ], "summary": "Gets the TransType that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "description": "Sample Request\r\n\tGET /Trading/TransactionTypes/53", "operationId": "TransactionTypes_GetByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "The TransactionTypeID", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TransactionTypeDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/UnallocatedOrders": { "put": { "tags": [ "Trading/UnallocatedOrders" ], "operationId": "UnallocatedOrders_UpdateEntityAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "updateList", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.UnallocatedOrderDto" }, "xml": { "name": "UnallocatedOrderDto", "wrapped": true }, "type": "array" } }, { "name": "allocate", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "markComplete", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Trading/UnallocatedOrders" ], "summary": "Creates a new order, and ties it to the block.", "operationId": "UnallocatedOrders_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.UnallocatedOrderDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.UnallocatedOrderDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/UnallocatedOrders/{key}": { "get": { "tags": [ "Trading/UnallocatedOrders" ], "summary": "Gets the order that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "UnallocatedOrders_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.UnallocatedOrderDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Trading/UnallocatedOrders" ], "summary": "Updates the OrderQty only on the orders object.", "operationId": "UnallocatedOrders_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "update", "in": "body", "description": "UnallocatedOrderDto to update", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.UnallocatedOrderDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.UnallocatedOrderDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Trading/UnallocatedOrders" ], "operationId": "UnallocatedOrders_Delete", "consumes": [], "produces": [], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/UnallocatedOrders/New/BlockId/{blockId}/AccountId/{accountId}": { "get": { "tags": [ "Trading/UnallocatedOrders" ], "summary": "Returns a newly initialized unallocated dto based on the accountId, and blockId. It does not create a record in the database, Update must be called to persist to database.", "operationId": "UnallocatedOrders_GetNew", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "blockId", "in": "path", "description": "FixBlockOrder Id that this trade order will be added to.", "required": true, "type": "integer", "format": "int32" }, { "name": "accountId", "in": "path", "description": "Account Id that will be adding an allocation trade.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.UnallocatedOrderDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/UploadTargets/Simple": { "get": { "tags": [ "Trading/UploadTargets" ], "summary": "Gets a simple list of upload targets that the logged in user has access to.", "operationId": "UploadTargets_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "formatType", "in": "query", "required": false, "type": "string", "enum": [ "Undefined", "FixAllocation", "FeeFile", "TradeFile", "NameFile", "TaxFiles" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ValidateImport/Distributions": { "post": { "tags": [ "Trading/ValidateImport" ], "summary": "Takes an xlsx, xls, or csv file as multipart content. The file needs either an account id column (named \"account id\", \"accountid\", \"pkaccount\", \"acct id\", or \"acctid\")\r\nor an account number column (named \"account number\", or \"acct number\"). The file will be processed and returned as a list signifying the id or number provided. If the account \r\nvalid, the \"isValid\" property will be true. If it is invalid, the \"isValid\" property will be false and a message about why it is invalid will be provided.", "operationId": "ValidateImportDistribution_AccountValidationForDistribution", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.DistributionValidationDto" }, "xml": { "name": "DistributionValidationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ValidateImport/FeeAndLoanDistribution": { "post": { "tags": [ "Trading/ValidateImport" ], "summary": "Takes an xlsx, xls, or csv file as multipart content. The file needs either an account id column (named \"account id\", \"accountid\", \"pkaccount\", \"acct id\", or \"acctid\")\r\nor an account number column (named \"account number\", or \"acct number\"). The file will be processed and returned as a list signifying the id or number provided. If the account \r\nvalid, the \"isValid\" property will be true. If it is invalid, the \"isValid\" property will be false and a message about why it is invalid will be provided.", "operationId": "ValidateImportFeeAndLoanDistribution_ValidationForFeeAndLoanDistributionAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "validateImportFileDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataProcess.DTO.Trading.ValidateImport.FeeAndLoanDistributionValidationDto" }, "xml": { "name": "FeeAndLoanDistributionValidationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ValidateImport/FeeAndLoanDistribution/Import": { "post": { "tags": [ "Trading/ValidateImport" ], "operationId": "ValidateImportFeeAndLoanDistribution_ImportFeeAndLoanDistributionsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "file", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataProcess.DTO.Trading.ValidateImport.FeeAndLoanDistributionValidationDto" }, "xml": { "name": "FeeAndLoanDistributionValidationDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ValidateImport/Orders": { "post": { "tags": [ "Trading/ValidateImport" ], "summary": "Takes an xlsx, xls, or csv file as multipart content. The file needs either an account id column (named \"account id\", \"accountid\", \"pkaccount\", \"acct id\", or \"acctid\")\r\nor an account number column (named \"account number\", or \"acct number\"). The file will be processed and returned as a list signifying the id or number provided. If the account \r\nvalid, the \"isValid\" property will be true. If it is invalid, the \"isValid\" property will be false and a message about why it is invalid will be provided.", "operationId": "TradingValidateImportOrders_OrderPostAsMultipartStreamAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateOrdersFileImportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateOrderDto" }, "xml": { "name": "ValidateOrderDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ValidateImport/Orders/List": { "post": { "tags": [ "Trading/ValidateImport" ], "summary": "Takes a list of accounts. At a minimum either the Id property or the number property must be filled in. The list will be processed and returned. If the account \r\nvalid, the \"isValid\" property will be true. If it is invalid, the \"isValid\" property will be false and a message about why it is invalid will be provided.", "operationId": "TradingValidateImportOrders_OrdersPostAsContent", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "orders", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateOrderDto" }, "xml": { "name": "ValidateOrderDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateOrderDto" }, "xml": { "name": "ValidateOrderDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ValidateImport/Orders/Templates/Csv": { "get": { "tags": [ "Trading/ValidateImport" ], "operationId": "TradingValidateImportOrders_GetCsvTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ValidateImport/Orders/Templates/Xls": { "get": { "tags": [ "Trading/ValidateImport" ], "operationId": "TradingValidateImportOrders_GetXlsTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ValidateImport/Orders/Templates/Xlsx": { "get": { "tags": [ "Trading/ValidateImport" ], "operationId": "TradingValidateImportOrders_GetXlsxTemplate", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ValidateImport/Sleeve/Registrations/ValidateImport/Sleeve/Registration": { "post": { "tags": [ "Trading/ValidateImport" ], "summary": "Import Sleeves", "operationId": "ValidateImportSleeveRegistrations_ImportSleeveRegistrations", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RegistrationSleeveFullValidationDto" }, "xml": { "name": "RegistrationSleeveFullValidationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ValidateImport/Sleeve/Registrations/ValidateImport/Sleeve/Registration/HistoricalSleeveImport": { "post": { "tags": [ "Trading/ValidateImport" ], "summary": "Import historical Sleeves", "operationId": "ValidateImportSleeveRegistrations_HistoricalSleeveImport", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RegistrationSleeveFullValidationDto" }, "xml": { "name": "RegistrationSleeveFullValidationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ValidateImport/Sleeve/Registrations/WithoutProcess": { "post": { "tags": [ "Trading/ValidateImport" ], "summary": "Import registration sleeve changes without processing account sleeves", "operationId": "ValidateImportSleeveRegistrations_ImportSleeveRegistrationsWithoutProcessAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RegistrationSleeveValidationDto" }, "xml": { "name": "RegistrationSleeveValidationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ValidateImport/SleeveStrategy/Registrations/Import/Batch": { "post": { "tags": [ "Trading/ValidateImport" ], "summary": "Used to assign Sleeve Strategy Aggregates to Registrations in bulk with import.", "operationId": "ValidateImportAssignSleeveStrategies_ProcessSleeveRegistrationsImportAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "registrationCheckDtos", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RegistrationCheckDto" }, "xml": { "name": "RegistrationCheckDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ValidateImport/SleeveStrategy/Registrations/Validate": { "post": { "tags": [ "Trading/ValidateImport" ], "summary": "Validates import file for processing.", "operationId": "ValidateImportAssignSleeveStrategies_ValidateAssignSleeveStrategiesImportAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RegistrationCheckDto" }, "xml": { "name": "RegistrationCheckDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ValidateImport/Strategy": { "post": { "tags": [ "Trading/ValidateImport" ], "summary": "Takes an xlsx, xls, or csv file as multipart content.\r\nThe file will be processed and returned. If the account valid, the \"isValid\" property will be true.\r\nIf it is invalid, the \"isValid\" property will be false and a message about why it is invalid will be provided.", "operationId": "ValidateImportStrategy_StrategyImportValidationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ValidateStrategiesDto" }, "xml": { "name": "ValidateStrategiesDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ValidateImport/Strategy/ProcessImport": { "post": { "tags": [ "Trading/ValidateImport" ], "summary": "The method runs a buld insert to a temp table from the import file then runs a procedure that creates the strategies.", "operationId": "ValidateImportStrategy_ProcessStrategyImport", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "list", "in": "body", "description": "The list of strategies for the import.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ValidateStrategiesDto" }, "xml": { "name": "ValidateStrategiesDto", "wrapped": true }, "type": "array" } }, { "name": "removeCustomizations", "in": "query", "required": true, "type": "boolean" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ValidateImport/Strategy/Revalidate": { "post": { "tags": [ "Trading/ValidateImport" ], "summary": "Takes a List ValidateStrategiesDto.\r\nThe dto will be processed and returned. If the account valid, the \"isValid\" property will be true.\r\nIf it is invalid, the \"isValid\" property will be false and a message about why it is invalid will be provided.", "operationId": "ValidateImportStrategy_StrategyDtoValidationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "list", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ValidateStrategiesDto" }, "xml": { "name": "ValidateStrategiesDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ValidateStrategiesDto" }, "xml": { "name": "ValidateStrategiesDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ValidateImport/StrategyAggregate": { "post": { "tags": [ "Trading/ValidateImport" ], "summary": "Takes an xlsx, xls, or csv file as multipart content.\r\nThe file will be processed and returned. If the account valid, the \"isValid\" property will be true. \r\nIf it is invalid, the \"isValid\" property will be false and a message about why it is invalid will be provided.", "operationId": "ValidateImportStrategyAggregate_StrategyImportValidationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ValidateStrategyAggregatesDto" }, "xml": { "name": "ValidateStrategyAggregatesDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ValidateImport/StrategyAggregate/ProcessImport": { "post": { "tags": [ "Trading/ValidateImport" ], "summary": "The method runs a buld insert to a temp table from the import file then runs a procedure that creates the strategy aggregates.", "operationId": "ValidateImportStrategyAggregate_ProcessStrategyImport", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [], "parameters": [ { "name": "validateStrategyAggregatesDtos", "in": "body", "description": "The list of strategies for the import.", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ValidateStrategyAggregatesDto" }, "xml": { "name": "ValidateStrategyAggregatesDto", "wrapped": true }, "type": "array" } }, { "name": "removeCustomizations", "in": "query", "required": false, "type": "boolean" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Trading/ValidateImport/StrategyAggregate/Revalidate": { "post": { "tags": [ "Trading/ValidateImport" ], "summary": "Takes a List ValidateStrategyAggregatesDto.\r\nThe dto will be processed and returned. If the account valid, the \"isValid\" property will be true. \r\nIf it is invalid, the \"isValid\" property will be false and a message about why it is invalid will be provided.", "operationId": "ValidateImportStrategyAggregate_StrategyDtoValidationAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "list", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ValidateStrategyAggregatesDto" }, "xml": { "name": "ValidateStrategyAggregatesDto", "wrapped": true }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ValidateStrategyAggregatesDto" }, "xml": { "name": "ValidateStrategyAggregatesDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/User/Homepage/Assigned/Dashboards/{dashboardId}/Cards/{cardId}": { "delete": { "tags": [ "User/Homepage" ], "summary": "Remove card from dashboard.", "operationId": "UserDashboard_RemoveCardFromDashboardAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dashboardId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cardId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/User/Homepage/Assigned/PortfolioView/Dashboards/{dashboardName}": { "get": { "tags": [ "User/Homepage" ], "summary": "Get assigned portfolio view dashboard for the current login user.", "operationId": "UserDashboard_GetPortfolioViewDashboardAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dashboardName", "in": "path", "required": true, "type": "string" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/User/Homepage/RoleDashboards": { "post": { "tags": [ "User/Homepage" ], "operationId": "UserDashboard_UpdateRoleDashboardsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "roleDashboards", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.RoleDashboardDto" }, "xml": { "name": "RoleDashboardDto", "wrapped": true }, "type": "array" } }, { "name": "isPortfolioView", "in": "query", "required": true, "type": "boolean" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/User/Homepage/UserDashboards": { "post": { "tags": [ "User/Homepage" ], "operationId": "UserDashboard_UpdateUserDashboardsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "userDashboards", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.UserHomepageDashboardSimpleDto" }, "xml": { "name": "UserHomepageDashboardSimpleDto", "wrapped": true }, "type": "array" } }, { "name": "isPortfolioView", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/APILogs": { "get": { "tags": [ "Utility/APILogs" ], "summary": "Get a list of API log records for the current users \"partnerAppId\".", "operationId": "APILogs_GetAllAPILogs", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "userId", "in": "query", "required": false, "type": "string" }, { "name": "startTime", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endTime", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "hasException", "in": "query", "required": false, "type": "boolean" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Utility.spimRequestLogViewerGetList" }, "xml": { "name": "spimRequestLogViewerGetList", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/APILogs/{correlationId}": { "get": { "tags": [ "Utility/APILogs" ], "summary": "Get a single api log record for the correlation id.", "operationId": "APILogs_GetByCorrelationId", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "correlationId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Utility.spimRequestLogViewerGetList" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Archive/Blobs": { "post": { "tags": [ "Utility/Archive" ], "summary": "Trigger policy blob archiver", "operationId": "Archive_BlobArchiverTrigger", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Archive/Relocate/S3/Database": { "post": { "tags": [ "Utility/Archive" ], "summary": "Initiate a hangfire job to relocate file from s3 to database for all files with EFileLocation = EFileLocation.AmazonS3.", "operationId": "Archive_RelocateAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Archive/Relocate/S3/Database/Blob/List": { "post": { "tags": [ "Utility/Archive" ], "summary": "Initiate hangfire job to relocate file from s3 to database for file with EFileLocation = EFileLocation.AmazonS3.", "operationId": "Archive_PostV1UtilityArchiveRelocateS3DatabaseBlobList", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "blobs", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Archive/Retire": { "post": { "tags": [ "Utility/Archive" ], "summary": "Retire all blobs from database.", "operationId": "Archive_RetireDatabaseBlobs", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/AuditAlert": { "post": { "tags": [ "Utility/AuditAlert" ], "operationId": "Utility_AuditAlertAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "auditFile", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.Domains.Utility.UtilityController.AuditFileImportFileDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/BatchProcessing": { "get": { "tags": [ "Utility/BatchProcessing" ], "operationId": "BatchProcessing_GetAllBatchProcessing", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "includeErrors", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "processingType", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "status", "in": "query", "required": false, "items": { "type": "string", "enum": [ "New", "Processing", "Failed", "PartiallyComplete", "Complete", "Canceled" ] }, "collectionFormat": "multi", "type": "array" }, { "name": "alClientID", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.BatchProcessingDto" }, "xml": { "name": "BatchProcessingDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/BatchProcessing/{batchId}": { "get": { "tags": [ "Utility/BatchProcessing" ], "summary": "Gets the status of batch processing for the batchId provided.", "operationId": "BatchProcessing_BatchProcessingStatus", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "batchId", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "includeErrors", "in": "query", "description": "Default is True. When true, the Errors collection will be populated with Errors, Warnings, and Informational Messages", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.BatchProcessingDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/BatchProcessing/{batchId}/Errors": { "get": { "tags": [ "Utility/BatchProcessing" ], "summary": "Gets all errors for a specific batchId", "operationId": "BatchProcessing_GetBatchProcessingErrors", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "batchId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.BatchProcessingErrorDto" }, "xml": { "name": "BatchProcessingErrorDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/BatchProcessing/Counts": { "get": { "tags": [ "Utility/BatchProcessing" ], "operationId": "BatchProcessing_GetAllBatchProcessingCounts", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "includeErrors", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "processingType", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "status", "in": "query", "required": false, "items": { "type": "string", "enum": [ "New", "Processing", "Failed", "PartiallyComplete", "Complete", "Canceled" ] }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.GridCountDto" }, "xml": { "name": "GridCountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/BatchProcessing/GetLast": { "get": { "tags": [ "Utility/BatchProcessing" ], "summary": "Gets the status of batch processing for the batchId provided.", "operationId": "BatchProcessing_GetLastBatchProcessing", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "processingType", "in": "query", "required": true, "type": "integer", "format": "int32" }, { "name": "status", "in": "query", "required": true, "type": "string", "enum": [ "New", "Processing", "Failed", "PartiallyComplete", "Complete", "Canceled" ] }, { "name": "includeErrors", "in": "query", "description": "Default is True. When true, the Errors collection will be populated with Errors, Warnings, and Informational Messages", "required": false, "type": "boolean", "default": false }, { "name": "currentDatabaseOnly", "in": "query", "required": false, "type": "boolean", "default": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.BatchProcessingDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/BatchProcessing/List": { "post": { "tags": [ "Utility/BatchProcessing" ], "operationId": "BatchProcessing_GetListById", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "includeErrors", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.BatchProcessingDto" }, "xml": { "name": "BatchProcessingDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/BatchProcessing/List/Id": { "post": { "tags": [ "Utility/BatchProcessing" ], "operationId": "BatchProcessing_PostV1UtilityBatchProcessingListId", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "includeErrors", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.BatchProcessingDto" }, "xml": { "name": "BatchProcessingDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Cache/Test": { "post": { "tags": [ "Utility/Cache" ], "operationId": "Utility_Cache", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "type": "string" } }, { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/DatabaseActionQueue": { "get": { "tags": [ "Utility/DatabaseActionQueue" ], "operationId": "DatabaseAction_ViewAllDatabaseActionsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Utility/DatabaseActionQueue" ], "operationId": "DatabaseAction_CreateNewDatabaseAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dbActionRequest", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Utility.DatabaseCreation.DatabaseActionRequest" } }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/DatabaseActionQueue/{databaseActionQueueID}": { "get": { "tags": [ "Utility/DatabaseActionQueue" ], "operationId": "DatabaseAction_ViewDatabaseActionsAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "databaseActionQueueID", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/DatabaseGroups": { "get": { "tags": [ "Utility/DatabaseGroups" ], "operationId": "DatabaseGroups_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.DatabaseGroupDto" }, "xml": { "name": "DatabaseGroupDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Utility/DatabaseGroups" ], "summary": "Creates a new Database Group record, and returns the new record in the location header.", "operationId": "DatabaseGroups_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "description": "Database Group", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.DatabaseGroupDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.DatabaseGroupDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/DatabaseGroups/{key}": { "get": { "tags": [ "Utility/DatabaseGroups" ], "summary": "Gets the Database Group that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "DatabaseGroups_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.DatabaseGroupDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Utility/DatabaseGroups" ], "summary": "Updates an existing Database Group record.", "operationId": "DatabaseGroups_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Database Group Id to update", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "description": "New Database Group values", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.DatabaseGroupDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.DatabaseGroupDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Utility/DatabaseGroups" ], "operationId": "DatabaseGroups_Delete", "consumes": [], "produces": [], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "204": { "description": "No Content" } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/DatabaseGroups/Simple": { "get": { "tags": [ "Utility/DatabaseGroups" ], "summary": "Returns a simple Id/Name for all Database Group records", "operationId": "DatabaseGroups_GetSimpleAll", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "isPrivate", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/DateExpressions": { "post": { "tags": [ "Utility/DateExpressions" ], "operationId": "Utility_ResolveDateExpressions", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "expressions", "in": "body", "required": true, "schema": { "items": { "type": "string" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.DateExpressionResultDto" }, "xml": { "name": "DateExpressionResultDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/DateExpressions/{asOfDate}": { "post": { "tags": [ "Utility/DateExpressions" ], "operationId": "Utility_PostV1UtilityDateExpressionsByAsOfDate", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "path", "required": true, "type": "string" }, { "name": "expressions", "in": "body", "required": true, "schema": { "items": { "type": "string" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.DateExpressionResultDto" }, "xml": { "name": "DateExpressionResultDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/EmailClients": { "post": { "tags": [ "Utility/EmailClients" ], "summary": "Used to email one message to a number of provided clients.", "operationId": "Utility_SendEmailMessage", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "setting", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.EmailMessageSettingDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/EntitySession/{parseAsType}/{entityType}": { "post": { "tags": [ "Utility/EntitySession" ], "operationId": "EntitySession_CreateEntitySessionBodyAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "parseAsType", "in": "path", "required": true, "type": "string" }, { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "string" }, "type": "array" } }, { "name": "entityType", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/EntitySession/SimpleFile/{parseAsType}/{entityType}": { "post": { "tags": [ "Utility/EntitySession" ], "summary": "Creates an entity session ID to associate selected ids\r\nSample Request\r\nPOST /EntitySession/IdList/Account\r\n[1, 2, 3]", "operationId": "EntitySession_CreateEntitySessionAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "parseAsType", "in": "path", "required": true, "type": "string" }, { "name": "entityType", "in": "path", "description": "A valid entity type: Registration, Account, Asset", "required": true, "type": "string" }, { "name": "simpleFile", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportSingleFileDto" } }, { "name": "ct", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Excel": { "post": { "tags": [ "Utility/Excel" ], "summary": "Converts the provided IWorkbook to an excel file.", "operationId": "Excel_MakeExcelFileAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "workbook", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.Utility.Excel.IWorkbook" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Excel/Run/{filename}": { "get": { "tags": [ "Utility/Excel" ], "summary": "Used to download a previously generated Excel Export.", "operationId": "Excel_RunReportAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "filename", "in": "path", "description": "The filename provided by the generate endpoint.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/FeatureFlag": { "get": { "tags": [ "Utility/FeatureFlag" ], "summary": "When this endpoint is called without querystring params, then returns all the feature flag for which the privilege is null\r\nor user has privilege.\r\nif the query param is provided then the corresponding feature flag details will be returned but if the user does not have \r\nprivilege then empty result is returned", "operationId": "FeatureFlag_GetAllFeatureFlagAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "code", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/FeatureFlag/{featureFlagId}": { "put": { "tags": [ "Utility/FeatureFlag" ], "summary": "When this endpoint is called it should update the Global value database column based on the FeatureFlagId, If the \r\nglobal value is not null or empty then delete all the records from tblFeatureFlagAlClient\r\nWhen this endpoint is called and user don’t have the privilege FeatureFlags or \r\ndon’t have the privilege associated on the definition(if it is not null) Then Unauthorized is returned", "operationId": "FeatureFlag_UpdateFeatureFlagDetailsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "featureFlagToUpdate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.FeatureFlagDto" } }, { "name": "featureFlagId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/FeatureFlag/{featureFlagId}/AlClient": { "get": { "tags": [ "Utility/FeatureFlag" ], "summary": "when there is corresponding record on the FeatureFlagAlClient then use that records value, if not use the tblFeatureFlag\r\nDefault value for the value\r\nwhen this endpoint is called and user does not have privilege featureflags then unauthorized is returned.", "operationId": "FeatureFlag_GetFeatureFlagDetailsByIdAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "featureFlagId", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Utility/FeatureFlag" ], "operationId": "FeatureFlag_CreateFeatureFlagAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "setupTypeToCreate", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.FeatureFlagAlClientDto" }, "xml": { "name": "FeatureFlagAlClientDto", "wrapped": true }, "type": "array" } }, { "name": "featureFlagId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/FileToBase64": { "post": { "tags": [ "Utility/FileToBase64" ], "summary": "Takes a file as multipart content. The file will be returned as a base64 string.", "operationId": "Utility_PostMultipartStreamAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Groupings": { "get": { "tags": [ "Utility/Groupings" ], "operationId": "GroupingViews_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "query", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "usedFor", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "None", "Trading", "Reporting", "RepProfileAssignment", "Compass" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.DynamicGroupingDto" }, "xml": { "name": "DynamicGroupingDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Groupings/{key}": { "get": { "tags": [ "Utility/Groupings" ], "operationId": "GroupingViews_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "doRefresh", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "searchTerm", "in": "query", "required": false, "type": "string" }, { "name": "fillNames", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.DynamicGroupingFullDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Groupings/AccessPerson": { "get": { "tags": [ "Utility/Groupings" ], "summary": "Returns list of representative for grouping view.", "operationId": "GroupingViews_AccessPersonView", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "isActive", "in": "query", "required": false, "type": "boolean" }, { "name": "templateId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformAccessPersonDto" }, "xml": { "name": "InformAccessPersonDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Groupings/Accounts": { "get": { "tags": [ "Utility/Groupings" ], "summary": "Returns list of account for grouping view.", "operationId": "GroupingViews_AccountView", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "manipulator", "in": "header", "required": true }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "top", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "usedFor", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "None", "Trading", "Reporting", "RepProfileAssignment", "Compass" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.GroupingViewAccountDto" }, "xml": { "name": "GroupingViewAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Utility/Groupings" ], "summary": "Returns list of account for grouping view.", "operationId": "GroupingViews_PostV1UtilityGroupingsAccounts", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "usedFor", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "None", "Trading", "Reporting", "RepProfileAssignment", "Compass" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.GroupingViewAccountDto" }, "xml": { "name": "GroupingViewAccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Groupings/Action/Refresh": { "put": { "tags": [ "Utility/Groupings" ], "operationId": "GroupingViews_ActionRefreshAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ids", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Groupings/Clients": { "get": { "tags": [ "Utility/Groupings" ], "summary": "Returns list of clients for grouping view.", "operationId": "GroupingViews_ClientView", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "manipulator", "in": "header", "required": true }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "top", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.GroupingViewClientDto" }, "xml": { "name": "GroupingViewClientDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Utility/Groupings" ], "summary": "Returns list of clients for grouping view.", "operationId": "GroupingViews_PostV1UtilityGroupingsClients", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.GroupingViewClientDto" }, "xml": { "name": "GroupingViewClientDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Groupings/Entities": { "get": { "tags": [ "Utility/Groupings" ], "summary": "Returns a list of entities that have dynamic groups associated to them.", "operationId": "GroupingViews_GetTypes", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "usedFor", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "None", "Trading", "Reporting", "RepProfileAssignment", "Compass" ] } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "xml": { "name": "Entity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Groupings/Registrations": { "get": { "tags": [ "Utility/Groupings" ], "summary": "Returns list of registration for grouping view.", "operationId": "GroupingViews_RegistrationView", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "manipulator", "in": "header", "required": true }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "top", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.GroupingViewRegistrationDto" }, "xml": { "name": "GroupingViewRegistrationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Utility/Groupings" ], "summary": "Returns list of registration for grouping view.", "operationId": "GroupingViews_PostV1UtilityGroupingsRegistrations", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "entityIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "manipulator", "in": "header", "required": true }, { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.GroupingViewRegistrationDto" }, "xml": { "name": "GroupingViewRegistrationDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Groupings/Representatives": { "get": { "tags": [ "Utility/Groupings" ], "summary": "Returns list of representative for grouping view.", "operationId": "GroupingViews_RepresentativeView", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "manipulator", "in": "header", "required": true }, { "name": "skip", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "top", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.GroupingViewRepresentativeDto" }, "xml": { "name": "GroupingViewRepresentativeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Utility/Groupings" ], "summary": "Returns list of representative for grouping view.", "operationId": "GroupingViews_PostV1UtilityGroupingsRepresentatives", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entityIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.GroupingViewRepresentativeDto" }, "xml": { "name": "GroupingViewRepresentativeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Groupings/Simple": { "get": { "tags": [ "Utility/Groupings" ], "operationId": "GroupingViews_GetSimple", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "entity", "in": "query", "required": false, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, { "name": "usedFor", "in": "query", "required": false, "type": "string", "default": 0, "enum": [ "None", "Trading", "Reporting", "RepProfileAssignment", "Compass" ] }, { "name": "isPrivate", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Hangfire/Servers": { "get": { "tags": [ "Utility/Hangfire" ], "operationId": "Utility_HangfireServers", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/Hangfire.Storage.Monitoring.ServerDto" }, "xml": { "name": "ServerDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/HomepageDashboard/Export/Excel": { "post": { "tags": [ "Utility/HomepageDashboard" ], "operationId": "ExcelExporter_ExcelExporterAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataProcess.HomePageDashboard.Services.TableData" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Html/{sessionId}": { "get": { "tags": [ "Utility/Html" ], "operationId": "Utility_HtmlAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "forceStepFunction", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Html2Pdf": { "post": { "tags": [ "Utility/Html2Pdf" ], "operationId": "Utility_Html2Pdf", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.PdfSettingDto" } }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Html2Pdf/{sessionId}": { "get": { "tags": [ "Utility/Html2Pdf" ], "operationId": "Utility_Html2PdfAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "type": "string", "format": "uuid" }, { "name": "cancellationToken", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Import": { "get": { "tags": [ "Utility/Import" ], "summary": "Gets a list view of Imports for the Custom Import process.", "operationId": "Import_GetImportsWithoutDataAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "importTypeId", "in": "query", "description": "Optional. Default null. If provided, will only pull imports of the given ImportType", "required": false, "type": "integer", "format": "int32" }, { "name": "importId", "in": "query", "description": "Optional. Default null. If provided, will only pull imports of the given Id", "required": false, "type": "integer", "format": "int32" }, { "name": "importSource", "in": "query", "description": "Optional. Default null. If provided, will only pull imports of the given source", "required": false, "type": "string", "enum": [ "None", "OrionVision", "DataQuery" ] }, { "name": "imported", "in": "query", "description": "Optional. Default null. If provided, will only pull imports that have been imported", "required": false, "type": "boolean" }, { "name": "startDate", "in": "query", "description": "Optional. Default null. If provided, will only pull imports with a start date on/after the given date", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Optional. Default null. If provided, will only pull imports wiht a start date on/before the given date", "required": false, "type": "string", "format": "date-time" }, { "name": "ct", "in": "header", "description": "Cancellation Token of the request", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportWithoutDataDto" }, "xml": { "name": "ImportWithoutDataDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Import/{state}": { "post": { "tags": [ "Utility/Import" ], "summary": "Genericized endpoint to process the provided import object, for the provided state.\r\n\r\nE.G. If the user passes in Validate, and has the ImportId and ImportTypeId populated in the input object, the user will receive the current validation state of the import.", "operationId": "Import_ProcessImportsByStateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "state", "in": "path", "description": "The processing state to be used in this processing", "required": true, "type": "string" }, { "name": "import", "in": "body", "description": "The Import object to process.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportModifyDto" } }, { "name": "ct", "in": "header", "required": true }, { "name": "userId", "in": "query", "description": "Optional.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportEditableDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Import/Common/{id}/{alClientId}/Apply": { "put": { "tags": [ "Utility/Import" ], "summary": "Applies a single client's data in a multi-db custom import", "operationId": "ImportCommon_ApplyMultiDbImportAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "description": "The import common ID", "required": true, "type": "integer", "format": "int32" }, { "name": "alClientId", "in": "path", "description": "The client ID", "required": true, "type": "integer", "format": "int32" }, { "name": "import", "in": "body", "description": "An ImportCommonActionDto specifying the action, import common ID, client ID, and user ID for the action", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportCommonActionDto" } }, { "name": "ct", "in": "header", "description": "A cancellation token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportEditableDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Import/Common/{id}/{alClientId}/Create": { "put": { "tags": [ "Utility/Import" ], "summary": "Creates a single client's import for a multi-db custom import", "operationId": "ImportCommon_CreateMultiDbImportAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "description": "The import common ID", "required": true, "type": "integer", "format": "int32" }, { "name": "alClientId", "in": "path", "description": "The client ID", "required": true, "type": "integer", "format": "int32" }, { "name": "import", "in": "body", "description": "An ImportCommonActionDto specifying the action, import common ID, client ID and user ID for the action", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportCommonActionDto" } }, { "name": "ct", "in": "header", "description": "The Cancellation Token of the request", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Import/Common/{id}/{alClientId}/Delete": { "put": { "tags": [ "Utility/Import" ], "summary": "Reverses a single client's data in a multi-db custom import", "operationId": "ImportCommon_DeleteImportExtAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "description": "The import common ID", "required": true, "type": "integer", "format": "int32" }, { "name": "alClientId", "in": "path", "description": "The client ID", "required": true, "type": "integer", "format": "int32" }, { "name": "import", "in": "body", "description": "An ImportCommonActionDto specifying the action, import common ID, client ID, and user ID for the action", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportCommonActionDto" } }, { "name": "ct", "in": "header", "description": "A cancellation token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Import/Common/{id}/{alClientId}/ExcludeErrors": { "put": { "tags": [ "Utility/Import" ], "summary": "Excludes Errors for a single client's data in a multi-db custom import", "description": "Sample Request\r\n # Example To Exlude single ext record for a given import common\r\n\tPOST /Utility/Import/Common/524/ExcludeErrors\r\n [\r\n {\r\n \"ALClientId\":1,\r\n \"IsReversal\":false,\r\n \"ImportCommonId\":524\r\n }\r\n ]\r\n \r\n # Example to exlude errors for all EXT Records\r\n\tPOST /Utility/Import/Common/524/ExcludeErrors\r\n\t[]", "operationId": "ImportCommon_ExcludeErrorsMultiDbImportAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "description": "The import common ID", "required": true, "type": "integer", "format": "int32" }, { "name": "alClientId", "in": "path", "description": "The client ID", "required": true, "type": "integer", "format": "int32" }, { "name": "import", "in": "body", "description": "An ImportCommonActionDto specifying the action, import common ID, client ID, and user ID for the action", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportCommonActionDto" } }, { "name": "ct", "in": "header", "description": "A cancellation token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportEditableDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Import/Common/{id}/{alClientId}/Reset": { "put": { "tags": [ "Utility/Import" ], "summary": "Resets a single client's data in a multi-db custom import", "operationId": "ImportCommon_ResetMultiDbImportAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "description": "The import common ID", "required": true, "type": "integer", "format": "int32" }, { "name": "alClientId", "in": "path", "description": "The client ID", "required": true, "type": "integer", "format": "int32" }, { "name": "import", "in": "body", "description": "An ImportCommonActionDto specifying the action, import common ID, client ID, and user ID for the action", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportCommonActionDto" } }, { "name": "ct", "in": "header", "description": "A cancellation token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportEditableDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Import/Common/{id}/{alClientId}/Reverse": { "put": { "tags": [ "Utility/Import" ], "summary": "Reverses a single client's data in a multi-db custom import", "operationId": "ImportCommon_ReverseMultiDbImportAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "description": "The import common ID", "required": true, "type": "integer", "format": "int32" }, { "name": "alClientId", "in": "path", "description": "The client ID", "required": true, "type": "integer", "format": "int32" }, { "name": "import", "in": "body", "description": "An ImportCommonActionDto specifying the action, import common ID, client ID, and user ID for the action", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportCommonActionDto" } }, { "name": "ct", "in": "header", "description": "A cancellation token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportEditableDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Import/Common/{id}/{alClientId}/Status": { "put": { "tags": [ "Utility/Import" ], "summary": "Updates the status for a ImportCommon", "operationId": "ImportCommon_UpdateStatusAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "description": "The import common ID", "required": true, "type": "integer", "format": "int32" }, { "name": "alClientId", "in": "path", "description": "The client ID", "required": true, "type": "integer", "format": "int32" }, { "name": "status", "in": "body", "description": "The status string", "required": true, "schema": { "type": "string" } }, { "name": "ct", "in": "header", "description": "The cancellation token of the request", "required": true }, { "name": "isReversal", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Import/Common/{id}/{alClientId}/Validate": { "put": { "tags": [ "Utility/Import" ], "summary": "Validates a single client's data in a multi-db custom import", "operationId": "ImportCommon_ValidateMultiDbImportAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "description": "The import common ID", "required": true, "type": "integer", "format": "int32" }, { "name": "alClientId", "in": "path", "description": "The client ID", "required": true, "type": "integer", "format": "int32" }, { "name": "import", "in": "body", "description": "An ImportCommonActionDto specifying the action, import common ID, client ID, and user ID for the action", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportCommonActionDto" } }, { "name": "ct", "in": "header", "description": "A cancellation token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportEditableDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Import/Common/{key}": { "get": { "tags": [ "Utility/Import" ], "summary": "Gets a Common Import by Id", "operationId": "ImportCommon_GetByKeyAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Id of the Common Import", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportCommonDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Import/Common/{key}/{importAction}": { "put": { "tags": [ "Utility/Import" ], "summary": "Requeue's common import ext records for update", "operationId": "ImportCommon_UpdateManyAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Id of the Common Import", "required": true, "type": "integer", "format": "int32" }, { "name": "importAction", "in": "path", "required": true, "type": "string", "enum": [ "Create", "Validate", "Apply", "Reset", "Reverse", "Delete", "ExcludeErrors" ] }, { "name": "selectedImportCommonExts", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportCommonExtDto" }, "xml": { "name": "ImportCommonExtDto", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Import/Common/CreateFromFile": { "post": { "tags": [ "Utility/Import" ], "summary": "Creates a new import based on the provided object for multi database imports.", "operationId": "ImportCommon_CreateMutliDBImportAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "importFromFileDTO", "in": "body", "description": "Object that containts the file to create the import with, the import name, and the ID of the import type", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportCreateFromFileDto" } }, { "name": "ct", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportCommonDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Import/Common/Detail": { "get": { "tags": [ "Utility/Import" ], "summary": "Get a list of ImportCommonExtImportCommonDto for MultiDB Custom Imports", "operationId": "ImportCommon_Detail", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "startDate", "in": "query", "description": "Filters where AuditedDate is after this", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "description": "Filters where AuditedDate is before this", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportCommonExtImportCommonDto" }, "xml": { "name": "ImportCommonExtImportCommonDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Import/Common/Details/{importCommonId}": { "get": { "tags": [ "Utility/Import" ], "operationId": "ImportCommon_GetMultiDbDetails", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "importCommonId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "startDate", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportCommonExtDetailsDto" }, "xml": { "name": "ImportCommonExtDetailsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Import/Common/GetFile/{key}": { "get": { "tags": [ "Utility/Import" ], "summary": "Gets a Common Import by Id", "operationId": "ImportCommon_GetFileAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Id of the Common Import", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "description": "Cancellation Token", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Import/Common/Summary/{importCommonId}": { "get": { "tags": [ "Utility/Import" ], "operationId": "ImportCommon_GetImportCommonSummaryAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "importCommonId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportCommonSummaryDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Import/Common/UserDatabases": { "get": { "tags": [ "Utility/Import" ], "summary": "Return a list of Databases for the user", "operationId": "ImportCommon_UserAlClients", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.UserDatabasesDto" }, "xml": { "name": "UserDatabasesDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Import/Create": { "post": { "tags": [ "Utility/Import" ], "summary": "Creates a new import based on the provided object.", "operationId": "Import_CreateNewImportAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "import", "in": "body", "description": "The import to create, based on it's ImportType and WorkingData objects.", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportModifyDto" } }, { "name": "ct", "in": "header", "required": true }, { "name": "userId", "in": "query", "description": "Optional.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportEditableDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Import/CreateFromFile": { "post": { "tags": [ "Utility/Import" ], "summary": "Creates a new import based on the provided object", "operationId": "Import_CreateNewImportFromFileAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "importDto", "in": "body", "description": "Object that containts the file to create the import with, the import name, and the ID of the import type", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportCreateFromFileDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportEditableDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Import/DeleteMany": { "put": { "tags": [ "Utility/Import" ], "operationId": "Import_DeleteManyAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "keys", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Import/PostImport/{key}": { "get": { "tags": [ "Utility/Import" ], "operationId": "Import_GetPostDataImportAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportEditableDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Import/PreImport/{key}": { "get": { "tags": [ "Utility/Import" ], "operationId": "Import_GetPreDataImportAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportEditableDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/ImportType": { "get": { "tags": [ "Utility/ImportType" ], "summary": "Gets a list of ImportTypes available for the Custom Import process.", "description": "Sample Request\r\n GET /Utility/ImportType\r\n OR\r\n GET /Utility/ImportType?importTypeId=1\r\n OR\r\n GET /Utility/ImportType?multiDB=false\r\n OR\r\n GET /Utility/ImportType?importTypeId=1&multiDB=false", "operationId": "ImportType_GetImportTypesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "importTypeId", "in": "query", "description": "Optional. Default: null. If provided, returns only the ImportType with the provided Id", "required": false, "type": "integer", "format": "int32" }, { "name": "multiDB", "in": "query", "description": "Optional. Default: false. If provided, returns only ImportTypes valid for MultiDatabase Imports", "required": false, "type": "boolean", "default": false }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportTypeBaseInfoDto" }, "xml": { "name": "ImportTypeBaseInfoDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/ImportType/{key}": { "get": { "tags": [ "Utility/ImportType" ], "summary": "Gets the ImportType for the Custom Process, including Column definitions and SlickGrid display definitions", "operationId": "ImportType_GetImportTypeAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the ImportType to return", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true }, { "name": "multiDB", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportTypeDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/ImportType/{name}": { "get": { "tags": [ "Utility/ImportType" ], "operationId": "ImportType_GetImportTypeByNameAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "name", "in": "path", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportTypeDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/ImportType/All": { "get": { "tags": [ "Utility/ImportType" ], "summary": "Gets all import types in the system.", "operationId": "ImportType_GetAllImportTypesAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportTypeBaseInfoDto" }, "xml": { "name": "ImportTypeBaseInfoDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/ImportType/UpdateConfigJson/{key}": { "post": { "tags": [ "Utility/ImportType" ], "summary": "This is for the modification of the import types. This is only something we should be doing in Dev or Test, and only certain people should be able to access it.", "operationId": "ImportType_UpdateImportTypeResultSetStructureAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "resultSetStructure", "in": "body", "required": true, "schema": { "type": "object" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportTypeDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Logging/{eventName}": { "post": { "tags": [ "Utility/Logging" ], "summary": "Used to log custom users information", "operationId": "Utility_LogCustomInfo", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "eventName", "in": "path", "required": true, "type": "string" }, { "name": "customObject", "in": "body", "required": true, "schema": { "type": "object" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/MaintenanceLastRun/{key}": { "get": { "tags": [ "Utility/MaintenanceLastRun" ], "summary": "Gets the Maintenance Last Run that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "Utility_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.MaintenanceLastRunDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/PageQueries": { "get": { "tags": [ "Utility/PageQueries" ], "summary": "Returns page queries for the specified page code.", "operationId": "PageQueries_GetQueries", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "pageCode", "in": "query", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.PageQueryDto" }, "xml": { "name": "PageQueryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Utility/PageQueries" ], "summary": "This POST, will return the same information as the GET, however the POST allows default values to be passed in the body, so the parameters will be returned with the specified defaults already populated.\r\nThis is meant for use where the interface needs to pass in parameters based on the context of where they are in the application, but the UI does not want to prompt the user for the information.", "operationId": "PageQueries_GetQueriesWithDefaults", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "pageCode", "in": "query", "required": true, "type": "string" }, { "name": "defaultParameters", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.PageQueryParameterDto" }, "xml": { "name": "PageQueryParameterDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.PageQueryDto" }, "xml": { "name": "PageQueryDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/PageQueries/{key}": { "get": { "tags": [ "Utility/PageQueries" ], "summary": "Returns page query for the specified key.", "operationId": "PageQueries_GetQueryByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.PageQueryDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/PageQueries/{pageQueryId}/Count": { "post": { "tags": [ "Utility/PageQueries" ], "summary": "TODO: Ben", "operationId": "PageQueries_RunQueryCountAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "pageQueryId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.PageQueryDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/PageQueries/{pageQueryId}/Results": { "post": { "tags": [ "Utility/PageQueries" ], "summary": "TODO: Ben", "operationId": "PageQueries_RunQueryAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "pageQueryId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.PageQueryDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Pgp/UserIds": { "get": { "tags": [ "Utility/Pgp" ], "operationId": "Pgp_PgpKeys", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "string" }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/PreviousBusinessDay": { "get": { "tags": [ "Utility/PreviousBusinessDay" ], "summary": "", "operationId": "Utility_GetPreviousBusinessDay", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "asOfDate", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/PreviousBusinessDay/v2": { "get": { "tags": [ "Utility/PreviousBusinessDay" ], "summary": "Returns the Previous Business Day", "operationId": "Utility_GetV1UtilityPreviousBusinessDayV2", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "date", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Process/Actions": { "get": { "tags": [ "Utility/Process" ], "operationId": "ProcessActivities_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessActivityDto" }, "xml": { "name": "ProcessActivityDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Utility/Process" ], "summary": "Adds a new Corporate Action Extension to the database.", "operationId": "ProcessActivities_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessActivityDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessActivityDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Process/Actions/{key}": { "get": { "tags": [ "Utility/Process" ], "summary": "Gets the Corporate Action Extension that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ProcessActivities_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessActivityDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Utility/Process" ], "summary": "Gets the Corporate Action Extension that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ProcessActivities_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "update", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Utility.Process.ProcessActivity" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Utility.Process.ProcessActivity" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Utility/Process" ], "operationId": "ProcessActivities_DeleteEntity", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Process/Assignments": { "get": { "tags": [ "Utility/Process" ], "summary": "Get all Corporate Action Processes\r\nThe return is limited to pages of 10000. Use $top and $skip in the query string to page through the data.", "operationId": "ProcessAssignments_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "userId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessAssignmentDto" }, "xml": { "name": "ProcessAssignmentDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Utility/Process" ], "summary": "Add new task", "operationId": "ProcessAssignments_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessAssignmentDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessAssignmentDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Process/Assignments/{key}": { "get": { "tags": [ "Utility/Process" ], "summary": "Gets the Corporate Action Extension that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ProcessAssignments_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessAssignmentDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Utility/Process" ], "summary": "Gets the Corporate Action Extension that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ProcessAssignments_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "update", "in": "body", "description": "Key of the desired return object.", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Utility.Process.ProcessAssignment" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Utility.Process.ProcessAssignment" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Utility/Process" ], "operationId": "ProcessAssignments_DeleteEntity", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Process/Definitions": { "get": { "tags": [ "Utility/Process" ], "operationId": "ProcessDefinitions_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessDefinitionDto" }, "xml": { "name": "ProcessDefinitionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Utility/Process" ], "summary": "Adds a new Corporate Action Extension to the database.", "operationId": "ProcessDefinitions_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessDefinitionDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessDefinitionDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Process/Definitions/{key}": { "get": { "tags": [ "Utility/Process" ], "operationId": "ProcessDefinitions_GeEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessDefinitionDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Utility/Process" ], "summary": "Gets the Corporate Action Extension that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ProcessDefinitions_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "update", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessDefinitionDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessDefinitionDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Utility/Process" ], "operationId": "ProcessDefinitions_DeleteEntity", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Process/Definitions/{key}/Detail": { "get": { "tags": [ "Utility/Process" ], "operationId": "ProcessDefinitions_GeEntityByKeyDetail", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessDefinitionDetailDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Process/Elements": { "get": { "tags": [ "Utility/Process" ], "summary": "Get all Corporate Action Processes\r\nThe return is limited to pages of 10000. Use $top and $skip in the query string to page through the data.", "operationId": "ProcessElements_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "definitionId", "in": "query", "description": "Optional.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessElementDto" }, "xml": { "name": "ProcessElementDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Utility/Process" ], "summary": "Add new task", "operationId": "ProcessElements_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "elementDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessElementDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessElementDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Process/Elements/{key}": { "get": { "tags": [ "Utility/Process" ], "summary": "Gets the Corporate Action Extension that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ProcessElements_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessElementDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Utility/Process" ], "summary": "", "operationId": "ProcessElements_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "update", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessElementDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessElementDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Utility/Process" ], "operationId": "ProcessElements_DeleteEntity", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Process/Elements/{key}/Descendants": { "get": { "tags": [ "Utility/Process" ], "operationId": "ProcessElements_GetEntityDescendantsByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessElementDto" }, "xml": { "name": "ProcessElementDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Process/Events": { "get": { "tags": [ "Utility/Process" ], "summary": "Get all Corporate Action Processes\r\nThe return is limited to pages of 10000. Use $top and $skip in the query string to page through the data.", "operationId": "ProcessEvents_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "elementId", "in": "query", "description": "Optional.", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessEventDto" }, "xml": { "name": "ProcessEventDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Utility/Process" ], "summary": "Add new task", "operationId": "ProcessEvents_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "EventDto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessEventDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessEventDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Process/Events/{key}": { "get": { "tags": [ "Utility/Process" ], "summary": "Gets the Corporate Action Extension that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ProcessEvents_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessEventDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Utility/Process" ], "summary": "", "operationId": "ProcessEvents_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "update", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessEventDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessEventDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Utility/Process" ], "operationId": "ProcessEvents_DeleteEntity", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Process/Fields": { "post": { "tags": [ "Utility/Process" ], "summary": "Add new task", "operationId": "ProcessFields_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessFieldDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessFieldDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Process/Fields/{key}": { "get": { "tags": [ "Utility/Process" ], "summary": "Gets the Corporate Action Extension that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ProcessFields_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessFieldDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Utility/Process" ], "summary": "Gets the Corporate Action Extension that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ProcessFields_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "update", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Utility.Process.ProcessField" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Utility.Process.ProcessField" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Utility/Process" ], "operationId": "ProcessFields_DeleteEntity", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Process/Instances": { "get": { "tags": [ "Utility/Process" ], "operationId": "ProcessInstances_GetEntities", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "typeId", "in": "query", "required": true, "items": { "type": "integer", "format": "int32" }, "collectionFormat": "multi", "type": "array" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessInstanceDetailDto" }, "xml": { "name": "ProcessInstanceDetailDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Utility/Process" ], "operationId": "ProcessInstances_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessInstanceDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessInstanceDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Process/Instances/{key}": { "get": { "tags": [ "Utility/Process" ], "operationId": "ProcessInstances_GetEntity", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessInstanceDetailDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Utility/Process" ], "operationId": "ProcessInstances_Delete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Process/Participants": { "get": { "tags": [ "Utility/Process" ], "operationId": "ProcessParticipants_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "definitionId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "instanceId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessParticipantDto" }, "xml": { "name": "ProcessParticipantDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Utility/Process" ], "summary": "Add new task", "operationId": "ProcessParticipants_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessParticipantDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessParticipantDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Process/Participants/{key}": { "get": { "tags": [ "Utility/Process" ], "summary": "Gets the Corporate Action Extension that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ProcessParticipants_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessParticipantDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Utility/Process" ], "summary": "Gets the Corporate Action Extension that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ProcessParticipants_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "update", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Utility.Process.ProcessParticipant" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Utility.Process.ProcessParticipant" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Utility/Process" ], "operationId": "ProcessParticipants_DeleteEntity", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Process/Tasks": { "get": { "tags": [ "Utility/Process" ], "summary": "Get all Corporate Action Processes\r\nThe return is limited to pages of 10000. Use $top and $skip in the query string to page through the data.", "operationId": "ProcessTasks_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "instanceId", "in": "query", "description": "Optional.", "required": false, "type": "integer", "format": "int32" }, { "name": "definitionId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessTaskDto" }, "xml": { "name": "ProcessTaskDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Utility/Process" ], "summary": "Add new task", "operationId": "ProcessTasks_CreateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "dto", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessTaskDto" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessTaskDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Process/Tasks/{key}": { "get": { "tags": [ "Utility/Process" ], "summary": "Gets the Corporate Action Extension that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ProcessTasks_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessTaskDto" } } }, "security": [ { "Authorization": [] } ] }, "put": { "tags": [ "Utility/Process" ], "summary": "Gets the Corporate Action Extension that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "ProcessTasks_UpdateEntity", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" }, { "name": "update", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.DataModel.Utility.Process.ProcessTask" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.DataModel.Utility.Process.ProcessTask" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Utility/Process" ], "operationId": "ProcessTasks_DeleteEntity", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Routing/Trading/AssignAccounts/SleeveStrategy/{sleeveStrategyId}": { "post": { "tags": [ "Utility/Routing" ], "summary": "Assign Accounts to SleeveStrategy", "operationId": "Routing_AssignAccountsToSleeveStrategy", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "sleeveStrategyId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "accountIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true }, { "name": "validateOnly", "in": "query", "required": false, "type": "boolean", "default": true }, { "name": "eclipseFirmId", "in": "query", "required": false, "type": "string" }, { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyAccountAssignmentReturnDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Routing/Trading/CreateTrade": { "post": { "tags": [ "Utility/Routing" ], "summary": "Create a trade in Eclipse", "operationId": "Routing_CreateTrade", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "tradeOrders", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.LocalTradeOrderInstance" }, "xml": { "name": "LocalTradeOrderInstance", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true }, { "name": "refreshAnalytics", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "eclipseFirmId", "in": "query", "required": false, "type": "string" }, { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Routing/Trading/Instance/{tradeInstanceId}": { "get": { "tags": [ "Utility/Routing" ], "summary": "Get TradeInstances", "operationId": "Routing_GetTradeInstanceById", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "tradeInstanceId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "tradingPlatform", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true }, { "name": "eclipseFirmId", "in": "query", "required": false, "type": "string" }, { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TradeRequestInstanceDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Routing/Trading/Instances/{tradeInstanceId}/UpdateStatus": { "post": { "tags": [ "Utility/Routing" ], "summary": "", "operationId": "Routing_UpdateEclipseInstanceStatus", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "tradeInstanceId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "isEnabled", "in": "query", "required": true, "type": "boolean" }, { "name": "ct", "in": "header", "required": true }, { "name": "isDeleted", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "eclipseFirmId", "in": "query", "required": false, "type": "string" }, { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseTradeOrder" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Routing/Trading/Instances/{tradeOrderInstanceId}/Trades": { "get": { "tags": [ "Utility/Routing" ], "summary": "Returns the trade orders from Eclipse based on an Instance ID", "operationId": "Routing_GetEclipseTradesForTradeOrderInstance", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "tradeOrderInstanceId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true }, { "name": "eclipseFirmId", "in": "query", "required": false, "type": "string" }, { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseTradeOrderObject" }, "xml": { "name": "EclipseTradeOrderObject", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Routing/Trading/Instances/Trades": { "post": { "tags": [ "Utility/Routing" ], "summary": "Returns the trade orders from Eclipse based on an Instance ID", "operationId": "Routing_GetTradeOrdersForInstances", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "tradeOrderInstances", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.TradeEntityInfo" }, "xml": { "name": "TradeEntityInfo", "wrapped": true }, "type": "array" } }, { "name": "ct", "in": "header", "required": true }, { "name": "eclipseFirmId", "in": "query", "required": false, "type": "string" }, { "name": "waitLength", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 5000 }, { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OrderDto" }, "xml": { "name": "OrderDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Routing/Trading/Model/{modelId}/SetEditedBy": { "put": { "tags": [ "Utility/Routing" ], "summary": "Updates the last edited by on a model", "operationId": "Routing_UpdateModelEditedBy", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "modelId", "in": "path", "description": "The id of the updated model", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "description": "CancellationToken", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Routing/Trading/Model/Firm": { "post": { "tags": [ "Utility/Routing" ], "summary": "Create a model and model agg in the corresponding platform", "operationId": "Routing_CreateModel", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "model", "in": "body", "description": "The model to be created", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelFullDto" } }, { "name": "ct", "in": "header", "description": "Cancellation Token", "required": true }, { "name": "repId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "eclipseFirmId", "in": "query", "required": false, "type": "string" }, { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelFullDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Routing/Trading/Model/Firm/{modelId}": { "delete": { "tags": [ "Utility/Routing" ], "summary": "Delete an existing TOM or Eclipse model", "operationId": "Routing_DeleteModel", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "modelId", "in": "path", "description": "The model id to delete.", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "description": "CancellationToken", "required": true }, { "name": "eclipseFirmId", "in": "query", "required": false, "type": "string" }, { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Routing/Trading/Model/Firm/Update": { "post": { "tags": [ "Utility/Routing" ], "summary": "Update an existing TOM or Eclipse model", "operationId": "Routing_UpdateModel", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "model", "in": "body", "description": "The updated model", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelFullDto" } }, { "name": "ct", "in": "header", "description": "CancellationToken", "required": true }, { "name": "eclipseFirmId", "in": "query", "required": false, "type": "string" }, { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "skipModelAgg", "in": "query", "required": false, "type": "boolean", "default": false }, { "name": "reverseSyncTimeout", "in": "query", "required": false, "type": "integer", "format": "int32", "default": 2000 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelFullDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Routing/Trading/Platform": { "get": { "tags": [ "Utility/Routing" ], "summary": "Return the trading platform associated with the logged in rep, based on Firm Level settings and Rep Level Settings", "operationId": "Routing_GetRepTradingPlatform", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "cancellationToken", "in": "header", "required": true }, { "name": "repId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "string", "enum": [ "TOM", "Eclipse" ] } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Routing/Trading/Platform/{accountId}": { "get": { "tags": [ "Utility/Routing" ], "summary": "Return the trading platform associated with the specific account", "operationId": "Routing_GetAccountTradingPlatform", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accountId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "cancellationToken", "in": "header", "required": true }, { "name": "repId", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "string", "enum": [ "TOM", "Eclipse" ] } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Routing/Trading/Platform/Rep/{repId}/Cache": { "post": { "tags": [ "Utility/Routing" ], "operationId": "Routing_CacheAccountTradePlatform", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "repId", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "accountIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.TradeEntityInfo" }, "xml": { "name": "TradeEntityInfo", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Routing/Trading/Product": { "get": { "tags": [ "Utility/Routing" ], "summary": "Return the a list of products that contain the search term", "operationId": "Routing_ProductSearch", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "searchTerm", "in": "query", "description": "The query you are searching for", "required": true, "type": "string" }, { "name": "accountId", "in": "query", "description": "The ID of the account that products are being traded on", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "description": "Cancellation Token", "required": true }, { "name": "platform", "in": "query", "required": false, "type": "string", "enum": [ "TOM", "Eclipse" ] }, { "name": "resultsCount", "in": "query", "description": "How many results to return", "required": false, "type": "integer", "format": "int32", "default": 20 }, { "name": "eclipseFirmId", "in": "query", "required": false, "type": "string" }, { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Search.SearchProductDto" }, "xml": { "name": "SearchProductDto", "wrapped": true }, "type": "array" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Routing/Trading/Product/Firm": { "get": { "tags": [ "Utility/Routing" ], "summary": "Returns a list of products based on platform, without restrictions", "operationId": "Routing_GetV1UtilityRoutingTradingProductFirm", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "searchTerm", "in": "query", "description": "The query you are searching for", "required": true, "type": "string" }, { "name": "ct", "in": "header", "description": "Cancellation Token", "required": true }, { "name": "platform", "in": "query", "required": false, "type": "string", "enum": [ "TOM", "Eclipse" ] }, { "name": "repId", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "resultsCount", "in": "query", "description": "How many results to return", "required": false, "type": "integer", "format": "int32", "default": 20 }, { "name": "eclipseFirmId", "in": "query", "required": false, "type": "string" }, { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Search.SearchProductExtendedDto" }, "xml": { "name": "SearchProductExtendedDto", "wrapped": true }, "type": "array" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Routing/Trading/RefreshAnalytics": { "post": { "tags": [ "Utility/Routing" ], "summary": "", "operationId": "Routing_RefreshAccountAnalytics", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "orionAccountIds", "in": "body", "required": true, "schema": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, { "name": "ct", "in": "header", "required": true }, { "name": "eclipseFirmId", "in": "query", "required": false, "type": "string" }, { "name": "resetCache", "in": "query", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseResponse" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Search/AllDatabases": { "get": { "tags": [ "Utility/Search" ], "summary": "Get results that match provided criteria.", "operationId": "AllDatabaseSearches_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "brokerDealerId", "in": "query", "description": "Optional. Default: null. Broker Dealer Id.", "required": false, "type": "integer", "format": "int32" }, { "name": "repId", "in": "query", "description": "Optional. Default: null. Representative Id.", "required": false, "type": "integer", "format": "int32" }, { "name": "clientId", "in": "query", "description": "Optional. Default: null. Client ID.", "required": false, "type": "integer", "format": "int32" }, { "name": "clientFirstName", "in": "query", "description": "Optional. Default: null. Client first name.", "required": false, "type": "string" }, { "name": "clientLastName", "in": "query", "description": "Optional. Default: null. Client last name.", "required": false, "type": "string" }, { "name": "accountId", "in": "query", "description": "Optional. Default: null. Account ID.", "required": false, "type": "integer", "format": "int32" }, { "name": "accountNumber", "in": "query", "description": "Optional. Default: null. Account number.", "required": false, "type": "string" }, { "name": "registrationId", "in": "query", "description": "Optional. Default: null. Registration ID.", "required": false, "type": "integer", "format": "int32" }, { "name": "registrationTypeId", "in": "query", "description": "Optional. Default: null. Registration type ID.", "required": false, "type": "integer", "format": "int32" }, { "name": "subAdvisorId", "in": "query", "description": "Optional. Default: null. SubAdvisor Id.", "required": false, "type": "integer", "format": "int32" }, { "name": "clientSsnOrTaxId", "in": "query", "description": "Optional. Default: null. Client SSN or Tax Id.", "required": false, "type": "string" }, { "name": "repLastName", "in": "query", "description": "Optional. Default: null. Representative last name.", "required": false, "type": "string" }, { "name": "repFirstName", "in": "query", "description": "Optional. Default: null. Representative first name.", "required": false, "type": "string" }, { "name": "repNo", "in": "query", "description": "Optional. Default: null. Representative number.", "required": false, "type": "string" }, { "name": "registrationLastName", "in": "query", "description": "Optional. Default: null. Registration last name.", "required": false, "type": "string" }, { "name": "registrationFirstName", "in": "query", "description": "Optional. Default: null. Registration first name.", "required": false, "type": "string" }, { "name": "registrationSsnOrTaxId", "in": "query", "description": "Optional. Default: null. Registration SSN or Tax Id.", "required": false, "type": "string" }, { "name": "outsideId", "in": "query", "description": "Optional. Default: null. Outside Id.", "required": false, "type": "string" }, { "name": "isActive", "in": "query", "description": "Optional. Default: null. Accout IsActive status.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.AllDatabaseSearchDto" }, "xml": { "name": "AllDatabaseSearchDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/Search/AllDatabases/Count": { "get": { "tags": [ "Utility/Search" ], "summary": "Get count of results that match provided criteria.", "operationId": "AllDatabaseSearches_Count", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "brokerDealerId", "in": "query", "description": "Optional. Default: null. Broker Dealer Id.", "required": false, "type": "integer", "format": "int32" }, { "name": "repId", "in": "query", "description": "Optional. Default: null. Representative Id.", "required": false, "type": "integer", "format": "int32" }, { "name": "clientId", "in": "query", "description": "Optional. Default: null. Client ID.", "required": false, "type": "integer", "format": "int32" }, { "name": "clientFirstName", "in": "query", "description": "Optional. Default: null. Client first name.", "required": false, "type": "string" }, { "name": "clientLastName", "in": "query", "description": "Optional. Default: null. Client last name.", "required": false, "type": "string" }, { "name": "accountId", "in": "query", "description": "Optional. Default: null. Account ID.", "required": false, "type": "integer", "format": "int32" }, { "name": "accountNumber", "in": "query", "description": "Optional. Default: null. Account number.", "required": false, "type": "string" }, { "name": "registrationId", "in": "query", "description": "Optional. Default: null. Registration ID.", "required": false, "type": "integer", "format": "int32" }, { "name": "registrationTypeId", "in": "query", "description": "Optional. Default: null. Registration type ID.", "required": false, "type": "integer", "format": "int32" }, { "name": "subAdvisorId", "in": "query", "description": "Optional. Default: null. SubAdvisor Id.", "required": false, "type": "integer", "format": "int32" }, { "name": "clientSsnOrTaxId", "in": "query", "description": "Optional. Default: null. Client SSN or Tax Id.", "required": false, "type": "string" }, { "name": "repLastName", "in": "query", "description": "Optional. Default: null. Representative last name.", "required": false, "type": "string" }, { "name": "repFirstName", "in": "query", "description": "Optional. Default: null. Representative first name.", "required": false, "type": "string" }, { "name": "repNo", "in": "query", "description": "Optional. Default: null. Representative number.", "required": false, "type": "string" }, { "name": "registrationLastName", "in": "query", "description": "Optional. Default: null. Registration last name.", "required": false, "type": "string" }, { "name": "registrationFirstName", "in": "query", "description": "Optional. Default: null. Registration first name.", "required": false, "type": "string" }, { "name": "registrationSsnOrTaxId", "in": "query", "description": "Optional. Default: null. Registration SSN or Tax Id.", "required": false, "type": "string" }, { "name": "outsideId", "in": "query", "description": "Optional. Default: null. Outside Id.", "required": false, "type": "string" }, { "name": "isActive", "in": "query", "description": "Optional. Default: null. Accout IsActive status.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/SlickGridExport": { "post": { "tags": [ "Utility/SlickGridExport" ], "summary": "Gets a data file representation of the slick grid json data provided via Form[ \"data\" ]. \r\nIf the accept header has \"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet\" the return will be xlsx.\r\nIf the accept header has \"application/vnd.ms-excel\" the return will be xls.\r\nIf the accept header has \"text/csv\" the return will be csv.", "operationId": "SlickGridToExcel_MakeExcelFileAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "utcOffsetMinutes", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "downloadName", "in": "query", "required": false, "type": "string", "default": "SlickGridExport" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/SlickGridExport/AGxlsxEncryptedExport": { "post": { "tags": [ "Utility/SlickGridExport" ], "summary": "Used to generate a slickgridexport xlsx. The successful return will be 201 Created \r\nwith the location set to the url of the newly generated file.", "operationId": "SlickGridToExcel_MakeXlsxEncryptedFileAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "utcOffsetMinutes", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "downloadName", "in": "query", "required": false, "type": "string", "default": "SlickGridExport" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "deprecated": true, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/SlickGridExport/csv": { "post": { "tags": [ "Utility/SlickGridExport" ], "summary": "Used to generate a slickgridexport csv. The successful return will be 201 Created \r\nwith the location set to the url of the newly generated file.", "operationId": "SlickGridToExcel_MakeCsvFileAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "utcOffsetMinutes", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "downloadName", "in": "query", "required": false, "type": "string", "default": "SlickGridExport" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/SlickGridExport/Run/{filename}": { "get": { "tags": [ "Utility/SlickGridExport" ], "summary": "Used to download a previously generated SlickGridExport.", "operationId": "SlickGridToExcel_RunReportAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "filename", "in": "path", "description": "The filename provided by the generate endpoint.", "required": true, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/SlickGridExport/xls": { "post": { "tags": [ "Utility/SlickGridExport" ], "summary": "Used to generate a slickgridexport xls. The successful return will be 201 Created \r\nwith the location set to the url of the newly generated file.", "operationId": "SlickGridToExcel_MakeXlsFileAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "utcOffsetMinutes", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "downloadName", "in": "query", "required": false, "type": "string", "default": "SlickGridExport" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/SlickGridExport/xlsx": { "post": { "tags": [ "Utility/SlickGridExport" ], "summary": "Used to generate a slickgridexport xlsx. The successful return will be 201 Created \r\nwith the location set to the url of the newly generated file.", "operationId": "SlickGridToExcel_MakeXlsxFileAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "utcOffsetMinutes", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "downloadName", "in": "query", "required": false, "type": "string", "default": "SlickGridExport" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/SlickGridExport/zip": { "post": { "tags": [ "Utility/SlickGridExport" ], "summary": "Used to generate a slickgridexport csv. The successful return will be 201 Created \r\nwith the location set to the url of the newly generated file.", "operationId": "SlickGridToExcel_MakeZipFileAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "downloadName", "in": "query", "required": false, "type": "string", "default": "SlickGridExport" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/SMS/SendPIN": { "post": { "tags": [ "Utility/SMS" ], "summary": "Sends a validation PIN to the specified phone nmber. Use /VerifyPIN to validate the phone number.", "operationId": "Sms_SendPINAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "ct", "in": "header", "required": true }, { "name": "phoneNumber", "in": "query", "description": "Optional. Pass in the new phone number to save on the user", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/SMS/Test": { "get": { "tags": [ "Utility/SMS" ], "operationId": "Sms_TestAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "type", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/SMS/VerifyPIN": { "post": { "tags": [ "Utility/SMS" ], "summary": "Validates that the User entered PIN matches the PIN sent to the users phonenumber from /SendPIN.", "operationId": "Sms_VerifyPINAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "pin", "in": "query", "required": true, "type": "string" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/SubscriptionCenter/Setup": { "post": { "tags": [ "Utility/SubscriptionCenter" ], "operationId": "SubscriptionCenter_SetupDatabaseUserAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.SubscriptionCenter.SubscriptionCenterUserRequestDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/SubscriptionCenter/Setup/Retry/{id}": { "post": { "tags": [ "Utility/SubscriptionCenter" ], "operationId": "SubscriptionCenter_RetrySetupAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer", "format": "int32" }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/SubscriptionCenter/User": { "get": { "tags": [ "Utility/SubscriptionCenter" ], "operationId": "SubscriptionCenter_GetDatabaseUserAsync", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "userGuid", "in": "query", "required": true, "type": "string", "format": "uuid" }, { "name": "firmId", "in": "query", "required": false, "type": "string", "format": "uuid" }, { "name": "ct", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] }, "post": { "tags": [ "Utility/SubscriptionCenter" ], "operationId": "SubscriptionCenter_CreateDatabaseUserAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "request", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.SubscriptionCenter.SubscriptionCenterUserRequestDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/ValidateExpressions": { "post": { "tags": [ "Utility/ValidateExpressions" ], "operationId": "Utility_ValidateExpressions", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "expressions", "in": "body", "required": true, "schema": { "items": { "type": "string" }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ExpressionValidResultDto" }, "xml": { "name": "ExpressionValidResultDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/WorkflowProcessInstances": { "get": { "tags": [ "Utility/WorkflowProcessInstances" ], "summary": "Gets a list of WWorkflow Process Instance that the logged in user has access to.", "operationId": "WorkflowProcessInstances_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "processTypeId", "in": "query", "description": "Optional. When provided will only return Workflow Process Types that have the provided Type Id. Overrides processTypeCode.", "required": false, "type": "integer", "format": "int32" }, { "name": "processTypeCode", "in": "query", "description": "Optional. When provided will only return Workflow Process Types that have the provided Type Code. Overridden by processTypeId.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.WorkflowProcessInstanceDto" }, "xml": { "name": "WorkflowProcessInstanceDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/WorkflowProcessInstances/{key}": { "get": { "tags": [ "Utility/WorkflowProcessInstances" ], "summary": "Gets the Workflow Process Instance that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "WorkflowProcessInstances_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.WorkflowProcessInstanceDto" } } }, "security": [ { "Authorization": [] } ] }, "delete": { "tags": [ "Utility/WorkflowProcessInstances" ], "operationId": "WorkflowProcessInstances_Delete", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/WorkflowProcessInstances/{templetId}": { "put": { "tags": [ "Utility/WorkflowProcessInstances" ], "summary": "Gets the Workflow Process Instance that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "WorkflowProcessInstances_CreateNewInstance", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "templetId", "in": "path", "description": "Templet Id to base the new instance on", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "type": "integer", "format": "int32" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/WorkflowProcessInstances/Dashboard": { "get": { "tags": [ "Utility/WorkflowProcessInstances" ], "summary": "Gets a list of WWorkflow Process Instance that the logged in user has access to.", "operationId": "WorkflowProcessInstances_GetDashboard", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "processTypeId", "in": "query", "description": "Optional. When provided will only return Workflow Process Types that have the provided Type Id. Overrides processTypeCode.", "required": false, "type": "integer", "format": "int32" }, { "name": "processTypeCode", "in": "query", "description": "Optional. When provided will only return Workflow Process Types that have the provided Type Code. Overridden by processTypeId.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.WorkflowProcessInstanceDashboardDto" }, "xml": { "name": "WorkflowProcessInstanceDashboardDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/WorkflowProcessTemplates": { "get": { "tags": [ "Utility/WorkflowProcessTemplates" ], "summary": "Gets a list of Workflow Process Templates that the logged in user has access to.", "operationId": "WorkflowProcessTemplates_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "processTypeId", "in": "query", "description": "Optional. When provided will only return Workflow Process Types that have the provided Type Id. Overrides processTypeCode.", "required": false, "type": "integer", "format": "int32" }, { "name": "processTypeCode", "in": "query", "description": "Optional. When provided will only return Workflow Process Types that have the provided Type Code. Overridden by processTypeId.", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.WorkflowProcessTemplateDto" }, "xml": { "name": "WorkflowProcessTemplateDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/WorkflowProcessTemplates/{key}": { "get": { "tags": [ "Utility/WorkflowProcessTemplates" ], "summary": "Gets the WorkflowProcessTemplate that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "WorkflowProcessTemplates_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.WorkflowProcessTemplateDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/WorkflowProcessTypes": { "get": { "tags": [ "Utility/WorkflowProcessTypes" ], "summary": "Gets a list of Workflow Process Types that the logged in user has access to.", "operationId": "WorkflowProcessTypes_Get", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "processTypeCode", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.WorkflowProcessTypeDto" }, "xml": { "name": "WorkflowProcessTypeDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/Utility/WorkflowProcessTypes/{key}": { "get": { "tags": [ "Utility/WorkflowProcessTypes" ], "summary": "Gets the Workflow Process Type that has the provided key. If the item specified doesn't exist or isn't accessible to the logged in users a 404 will be thrown.", "operationId": "WorkflowProcessTypes_GetEntityByKey", "consumes": [], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "key", "in": "path", "description": "Key of the desired return object.", "required": true, "type": "integer", "format": "int32" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.WorkflowProcessTypeDto" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/ValidateImport/Accounts": { "post": { "tags": [ "ValidateImport/Accounts" ], "summary": "Takes an xlsx, xls, or csv file as multipart content. The file needs either an account id column (named \"account id\", \"accountid\", \"pkaccount\", \"acct id\", or \"acctid\")\r\nor an account number column (named \"account number\", or \"acct number\"). The file will be processed and returned as a list signifying the id or number provided. If the account \r\nvalid, the \"isValid\" property will be true. If it is invalid, the \"isValid\" property will be false and a message about why it is invalid will be provided.", "operationId": "ValidateImportAccounts_AccountPostAsMultipartStream", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.AccountDto" }, "xml": { "name": "AccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/ValidateImport/Accounts/Contributions": { "post": { "tags": [ "ValidateImport/Accounts" ], "summary": "Takes an xlsx, xls, or csv file as multipart content. The file needs either an account id column (named \"account id\", \"accountid\", \"pkaccount\", \"acct id\", or \"acctid\")\r\nor an account number column (named \"account number\", or \"acct number\"). The file will be processed and returned as a list signifying the id or number provided. If the account \r\nvalid, the \"isValid\" property will be true. If it is invalid, the \"isValid\" property will be false and a message about why it is invalid will be provided.", "operationId": "ValidateImportAccounts_AccountWithContributionPostAsMultipartStream", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.AccountContributionDto" }, "xml": { "name": "AccountContributionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/ValidateImport/Accounts/List": { "post": { "tags": [ "ValidateImport/Accounts" ], "summary": "Takes a list of accounts. At a minimum either the Id property or the number property must be filled in. The list will be processed and returned. If the account \r\nvalid, the \"isValid\" property will be true. If it is invalid, the \"isValid\" property will be false and a message about why it is invalid will be provided.", "operationId": "ValidateImportAccounts_AccountPostAsContent", "consumes": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "accounts", "in": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.AccountDto" }, "xml": { "name": "AccountDto", "wrapped": true }, "type": "array" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.AccountDto" }, "xml": { "name": "AccountDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/ValidateImport/Accounts/PostPayments": { "post": { "tags": [ "ValidateImport/Accounts" ], "summary": "Takes a list of accounts. At a minimum either the Id property or the number property must be filled in. The list will be processed and returned. If the account \r\nvalid, the \"isValid\" property will be true. If it is invalid, the \"isValid\" property will be false and a message about why it is invalid will be provided.", "operationId": "ValidateImportAccounts_AccountsForPostPaymentsAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } }, { "name": "startDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "endDate", "in": "query", "required": true, "type": "string", "format": "date-time" }, { "name": "cancellationToken", "in": "header", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PostPaymentsDto" }, "xml": { "name": "PostPaymentsDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/ValidateImport/Accounts/TransactionsImport": { "post": { "tags": [ "ValidateImport/Accounts" ], "summary": "Takes an xlsx, xls, or csv file as multipart content. The file needs either an transaction id column (named \"transaction id\", \"transactionid\", \"pkTransaction\", \"tran id\", or \"tranid\")\r\n. The file will be processed and returned as a list signifying the id provided. If the transaction is \r\nvalid, the \"isValid\" property will be true. If it is invalid, the \"isValid\" property will be false and a message about why it is invalid will be provided.", "operationId": "ValidateImportAccounts_TransactionsPostAsMultipartStream", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillTransactionDto" }, "xml": { "name": "BillTransactionDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/ValidateImport/Billing/Bills": { "post": { "tags": [ "ValidateImport/Billing" ], "summary": "Takes an xlsx, xls, or csv file as multipart content. The file will be parsed and returned as a generic list of sheets, with each sheet \r\ncontaining a list that represents the data on that sheet. The first row is assumed to be the column headers. Not available in production.\r\nReturns a list of Bill Items", "operationId": "ValidateImportBilling_ValidateAsync", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } }, { "name": "ct", "in": "header", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillSimpleEntityDto" }, "xml": { "name": "BillSimpleEntityDto", "wrapped": true }, "type": "array" } } }, "security": [ { "Authorization": [] } ] } }, "/v1/ValidateImport/Echo": { "post": { "tags": [ "ValidateImport/Echo" ], "summary": "Takes an xlsx, xls, or csv file as multipart content. The file will be parsed and returned as a generic list of sheets, with each sheet \r\ncontaining a list that represents the data on that sheet. The first row is assumed to be the column headers. Not available in production.", "operationId": "ValidateImportEcho_PostMultipartStream", "consumes": [ "text/plain", "application/json", "text/json", "application/x-www-form-urlencoded", "multipart/form-data" ], "produces": [ "text/plain", "application/json", "text/json", "application/xml", "text/xml", "multipart/form-data" ], "parameters": [ { "name": "validate", "in": "body", "required": true, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto" } } ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } } }, "security": [ { "Authorization": [] } ] } } }, "definitions": { "System.Threading.CancellationToken": { "properties": { "isCancellationRequested": { "readOnly": true, "type": "boolean" }, "canBeCanceled": { "readOnly": true, "type": "boolean" }, "waitHandle": { "$ref": "#/definitions/System.Threading.WaitHandle", "readOnly": true } }, "xml": { "name": "CancellationToken" }, "type": "object" }, "System.Threading.WaitHandle": { "properties": { "handle": { "type": "object" }, "safeWaitHandle": { "$ref": "#/definitions/Microsoft.Win32.SafeHandles.SafeWaitHandle" } }, "xml": { "name": "WaitHandle" }, "type": "object" }, "Microsoft.Win32.SafeHandles.SafeWaitHandle": { "properties": { "isInvalid": { "readOnly": true, "type": "boolean" }, "isClosed": { "readOnly": true, "type": "boolean" } }, "xml": { "name": "SafeWaitHandle" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.AggregatorDto": { "properties": { "aggregatorID": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "AggregatorDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.AggregatorTokenResponseDto": { "description": "Response object for aggregator token api calls", "properties": { "idToken": { "description": "Id token from tblapplinkdtl externalId", "type": "string" }, "aggregatorName": { "description": "Aggergator name from tblapplink", "type": "string" } }, "xml": { "name": "AggregatorTokenResponseDto" }, "type": "object" }, "OAS.DataModel.Confirm.PlanningName": { "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int32" }, "acctCode": { "type": "string", "maxLength": 500, "minLength": 0 }, "accountType": { "type": "string", "maxLength": 50, "minLength": 0 }, "accountNumberDisplay": { "type": "string", "maxLength": 50, "minLength": 0 }, "description": { "type": "string", "maxLength": 500, "minLength": 0 }, "nickname": { "type": "string", "maxLength": 500, "minLength": 0 }, "productName": { "type": "string", "maxLength": 500, "minLength": 0 }, "status": { "type": "string", "maxLength": 50, "minLength": 0 }, "lineOfBusiness": { "type": "string", "maxLength": 500, "minLength": 0 }, "balanceType": { "type": "string", "maxLength": 50, "minLength": 0 }, "interestRate": { "type": "number", "format": "double" }, "interestRateType": { "type": "string", "maxLength": 50, "minLength": 0 }, "interstRateAsOf": { "type": "string", "format": "date-time" }, "lastActivityDate": { "type": "string", "format": "date-time" }, "currentBalance": { "type": "number", "format": "double" }, "availableBalance": { "type": "number", "format": "double" }, "balanceAsOf": { "type": "string", "format": "date-time" }, "fiAttributes": { "type": "string" }, "currencyCode": { "type": "string", "maxLength": 50, "minLength": 0 }, "ocAccountNum": { "type": "string", "maxLength": 64, "minLength": 0 }, "credentialId": { "type": "string", "maxLength": 100, "minLength": 0 } }, "xml": { "name": "PlanningName" }, "type": "object" }, "OAS.DataModel.Confirm.PlanningPosition": { "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int32" }, "downloadFileId": { "type": "integer", "format": "int32" }, "cusip": { "type": "string", "maxLength": 50, "minLength": 0 }, "ticker": { "type": "string", "maxLength": 50, "minLength": 0 }, "acctCode": { "type": "string", "maxLength": 500, "minLength": 0 }, "unitBalance": { "type": "number", "format": "double" }, "price": { "type": "number", "format": "double" }, "effectiveDate": { "type": "string", "format": "date-time" }, "fileAssetValue": { "type": "number", "format": "double" }, "credentialId": { "type": "string", "maxLength": 100, "minLength": 0 }, "holdingName": { "type": "string", "maxLength": 50, "minLength": 0 }, "holdingType": { "type": "string", "maxLength": 50, "minLength": 0 } }, "xml": { "name": "PlanningPosition" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.AggregatorIdTokenDto": { "properties": { "id_Token": { "type": "string" }, "credentialId": { "type": "string" } }, "xml": { "name": "AggregatorIdTokenDto" }, "type": "object" }, "OAS.DataModel.Confirm.PlanningTransaction": { "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int32" }, "downloadFileId": { "type": "integer", "format": "int32" }, "cusip": { "type": "string", "maxLength": 50, "minLength": 0 }, "ticker": { "type": "string", "maxLength": 50, "minLength": 0 }, "acctCode": { "type": "string", "maxLength": 500, "minLength": 0 }, "effectiveDate": { "type": "string", "format": "date-time" }, "fileTranCode": { "type": "string", "maxLength": 50, "minLength": 0 }, "noUnits": { "type": "number", "format": "double" }, "price": { "type": "number", "format": "double" }, "netTransAmt": { "type": "number", "format": "double" }, "grossTransAmt": { "type": "number", "format": "double" }, "note": { "type": "string", "maxLength": 3000, "minLength": 0 }, "tradeRefNum": { "type": "string" }, "credentialId": { "type": "string", "maxLength": 100, "minLength": 0 }, "transTypeId": { "type": "integer", "format": "int32" }, "transactionSubTypeId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" } }, "xml": { "name": "PlanningTransaction" }, "type": "object" }, "OAS.WebApi.DTO.Authorization.ALClientDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "clientName": { "type": "string" }, "selected": { "type": "boolean" }, "lockDown": { "type": "string", "enum": [ "None", "Billing" ] }, "ops": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.AlClientOpsDto" }, "guid": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "ALClientDto" }, "type": "object" }, "OAS.WebApi.DTO.Security.AlClientOpsDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "clientName": { "type": "string" }, "isFullOps": { "type": "boolean" }, "isBilling": { "type": "boolean" }, "isComposites": { "type": "boolean" }, "isStatements": { "type": "boolean" }, "isTrading": { "type": "boolean" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "databaseName": { "type": "string" }, "serverName": { "type": "string" } }, "xml": { "name": "AlClientOpsDto" }, "type": "object" }, "OAS.WebApi.DTO.Security.UserDetailDto": { "properties": { "userName": { "type": "string" }, "loginUserId": { "type": "string" }, "userId": { "type": "integer", "format": "int32" }, "contactType": { "type": "string", "enum": [ "NotApproved", "Approved", "MainContact", "NoLongerWithFirm" ] }, "userDetailId": { "type": "integer", "format": "int32" }, "selected": { "type": "boolean" }, "userGuid": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "entityName": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" } }, "xml": { "name": "UserDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Authorization.UserVerboseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "portfolio": { "$ref": "#/definitions/OAS.WebApi.DTO.Authorization.UserPortfolioDto" }, "personal": { "$ref": "#/definitions/OAS.WebApi.DTO.Authorization.UserPersonalDto" } }, "xml": { "name": "UserVerboseDto" }, "type": "object" }, "OAS.WebApi.DTO.Authorization.UserPortfolioDto": { "properties": { "loginUserId": { "type": "string" }, "lastPasswordChange": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "twoFactor": { "type": "boolean" } }, "xml": { "name": "UserPortfolioDto" }, "type": "object" }, "OAS.WebApi.DTO.Authorization.UserPersonalDto": { "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "entityName": { "type": "string" }, "homePhone": { "$ref": "#/definitions/OAS.WebApi.DTO.Authorization.FullPhoneNumberDto" }, "businessPhone": { "$ref": "#/definitions/OAS.WebApi.DTO.Authorization.FullPhoneNumberDto" }, "mobilePhone": { "$ref": "#/definitions/OAS.WebApi.DTO.Authorization.VerifiablePhoneNumberDto" }, "otherPhone": { "$ref": "#/definitions/OAS.WebApi.DTO.Authorization.FullPhoneNumberDto" }, "email": { "type": "string" } }, "xml": { "name": "UserPersonalDto" }, "type": "object" }, "OAS.WebApi.DTO.Authorization.FullPhoneNumberDto": { "properties": { "extension": { "type": "string" }, "number": { "type": "string" } }, "xml": { "name": "FullPhoneNumberDto" }, "type": "object" }, "OAS.WebApi.DTO.Authorization.VerifiablePhoneNumberDto": { "properties": { "isVerified": { "type": "boolean" }, "number": { "type": "string" } }, "xml": { "name": "VerifiablePhoneNumberDto" }, "type": "object" }, "OAS.WebApi.DTO.Security.UserProfileDto": { "properties": { "entity": { "type": "string" }, "userName": { "type": "string" }, "loginUserId": { "type": "string" }, "databaseCount": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "userDetailId": { "type": "integer", "format": "int32" }, "roleId": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "alClientName": { "type": "string" }, "alClientGuid": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "alClientLockType": { "type": "integer", "format": "int32" }, "instanceName": { "readOnly": true, "type": "string" }, "userGuid": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "phoneNumber": { "type": "string" }, "twoFactor": { "type": "boolean" }, "daysUntilPasswordExpires": { "type": "integer", "format": "int32" }, "rights": { "additionalProperties": { "type": "boolean" }, "type": "object" }, "entityId": { "type": "integer", "format": "int32" }, "entityName": { "type": "string" }, "parentEntityId": { "type": "integer", "format": "int32" }, "parentEntity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "masterGroup": { "type": "string" }, "advisorNumber": { "type": "string" }, "passwordInfo": { "$ref": "#/definitions/OAS.DataModel.Authentication.PasswordInfo" }, "isOps": { "type": "boolean" } }, "xml": { "name": "UserProfileDto" }, "type": "object" }, "OAS.DataModel.Authentication.PasswordInfo": { "properties": { "shouldChange": { "type": "boolean" }, "count": { "type": "integer", "format": "int32" } }, "xml": { "name": "PasswordInfo" }, "type": "object" }, "OAS.DataModel.Security.NewUserDto": { "properties": { "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "userName": { "type": "string" }, "password": { "type": "string" }, "verifyBirthDate": { "type": "string", "format": "date-time" }, "verifyLastFourSSN": { "type": "string" } }, "xml": { "name": "NewUserDto" }, "type": "object" }, "OAS.WebApi.DTO.Authorization.ServiceTeamDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "team": { "type": "string" }, "emailAddress": { "type": "string" }, "phone": { "type": "string" }, "assignedDatabaseCount": { "type": "integer", "format": "int32" }, "memberCount": { "type": "integer", "format": "int32" }, "teamType": { "type": "string", "enum": [ "ServiceTeam", "ReconTeam", "ApplicationTeam", "AlternateApplicationTeam", "RemovedServiceTeam" ] }, "chatUrl": { "type": "string" }, "firmChatRouteId": { "type": "string" }, "chatRouteIntendedRecipient": { "type": "string" } }, "xml": { "name": "ServiceTeamDto" }, "type": "object" }, "OAS.DataModel.Security.UserDetailIntegration": { "required": [ "id", "userDetailId", "integrationType", "integrationInfo" ], "properties": { "id": { "type": "integer", "format": "int32" }, "userDetailId": { "type": "integer", "format": "int32" }, "integrationType": { "type": "string", "enum": [ "Undefined", "Salesforce", "Orion", "OrionWeb", "Redtail", "Junxure", "WebApi", "eMoney", "inStream", "trxRebalance", "RiskAlyze", "AssetLock" ] }, "integrationInfo": { "type": "string", "maxLength": 1000, "minLength": 0 } }, "xml": { "name": "UserDetailIntegration" }, "type": "object" }, "OAS.WebApi.DTO.Security.DatabaseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "clientName": { "type": "string" }, "guid": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "selected": { "type": "boolean" }, "serviceTeamId": { "type": "integer", "format": "int32" }, "masterGroup": { "type": "string" }, "lockDown": { "type": "string", "enum": [ "None", "Billing" ] }, "advisorNumber": { "type": "integer", "format": "int32" }, "firmType": { "type": "string", "enum": [ "None", "Foundations", "Essentials", "Advantage", "OrionTradingOnly", "OrionRiskOnly", "OrionComplianceOnly", "OrionPlanningOnly", "OasLegacy" ] } }, "xml": { "name": "DatabaseDto" }, "type": "object" }, "OAS.WebApi.DTO.Security.RightDto": { "properties": { "code": { "type": "string" }, "defaulDesc": { "type": "string" }, "canRead": { "type": "boolean" }, "canAdd": { "type": "boolean" }, "canUpdate": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "objectTypeCode": { "type": "string" }, "minimumVersion": { "type": "string" } }, "xml": { "name": "RightDto" }, "type": "object" }, "OAS.WebApi.DTO.Security.AuthorizationPrivilegeDto": { "properties": { "code": { "type": "string" }, "readIsGranted": { "type": "boolean" }, "editIsGranted": { "type": "boolean" }, "deleteIsGranted": { "type": "boolean" } }, "xml": { "name": "AuthorizationPrivilegeDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillAccountDto": { "properties": { "tieredFeePriority": { "type": "integer", "format": "int32" }, "acceptsList": { "type": "boolean" }, "fundFamilyId": { "type": "integer", "format": "int32" }, "managementStyleId": { "type": "integer", "format": "int32" }, "subAdvisorId": { "type": "integer", "format": "int32" }, "feeScheduleId": { "type": "integer", "format": "int32" }, "additionalColumns": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Interface.AdditionalColumnDefinition" }, "xml": { "name": "AdditionalColumnDefinition", "wrapped": true }, "type": "array" }, "masterPayoutScheduleId": { "type": "integer", "format": "int32" }, "payMethodId": { "type": "integer", "format": "int32" }, "bankName": { "type": "string" }, "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "addressLine3": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "performanceMasterPayoutScheduleId": { "type": "integer", "format": "int32" }, "performanceFeeScheduleId": { "type": "integer", "format": "int32" }, "tradeInstruction": { "type": "string" }, "paysForAccountsActive": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "accountType": { "type": "string" }, "registrationName": { "type": "string" }, "registrationId": { "type": "integer", "format": "int32" }, "fundName": { "type": "string" }, "accountNumber": { "type": "string" }, "accountName": { "type": "string" }, "remainingAmount": { "type": "number", "format": "double" }, "managementStyle": { "type": "string" }, "subAdvisorName": { "type": "string" }, "feeSchedule": { "type": "string" }, "masterPayoutSchedule": { "type": "string" }, "payMethod": { "type": "string" }, "billFrequency": { "type": "string", "enum": [ "Undefined", "Monthly", "Quarterly", "Triannual", "Semiannually", "Annually", "AtMaturity" ] }, "billStyle": { "type": "string", "enum": [ "Advance", "Arrears" ] }, "billAccountStatus": { "type": "string", "enum": [ "Ready", "NotReady", "ReportingOnly", "FinancialPlanningFeeOnly" ] }, "billingStatus": { "type": "string", "enum": [ "ReadyToBill", "Hold", "PendingReview" ] }, "valuationMethod": { "type": "string", "enum": [ "PeriodEndingValue", "AvgDailyBalance", "AvgMonthlyBalance" ] }, "accountValue": { "type": "number", "format": "double" }, "accountStartDate": { "type": "string", "format": "date-time" }, "clientName": { "type": "string" }, "billStartDate": { "type": "string", "format": "date-time" }, "lastBilledThroughDate": { "type": "string", "format": "date-time" }, "custodialAccountNumber": { "type": "string" }, "isPerformanceBilled": { "type": "boolean" }, "lastPerfBillDate": { "type": "string", "format": "date-time" }, "includeInAggregate": { "type": "boolean" }, "useFeeHierarchy": { "type": "boolean" }, "cycleMonth": { "type": "integer", "format": "int32" }, "performanceMasterPayoutSchedule": { "type": "string" }, "performanceFeeSchedule": { "type": "string" }, "representativeName": { "type": "string" }, "representativeNumber": { "type": "string" }, "isActive": { "type": "boolean" }, "lastTransactionDate": { "type": "string", "format": "date-time" }, "custodian": { "type": "string" }, "lastName": { "type": "string" }, "businessLine": { "type": "string" }, "outsideId": { "type": "string" }, "modelName": { "type": "string" }, "noFeeAggregate": { "type": "string" }, "status": { "type": "string", "enum": [ "Ready", "NotReady", "ReportingOnly", "FinancialPlanningFeeOnly" ] }, "paysForAccountNumbers": { "type": "string" }, "prevAmountApplied": { "type": "number", "format": "double" }, "accountIdThatDoesPaying": { "type": "integer", "format": "int32" } }, "xml": { "name": "BillAccountDto" }, "type": "object" }, "OAS.WebApi.DTO.Interface.AdditionalColumnDefinition": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "xml": { "name": "AdditionalColumnDefinition" }, "type": "object" }, "OAS.WebApi.Code.Projection.ProjectionManipulatorOfOAS.WebApi.DTO.Billing.BillAccountGridDto": { "properties": { "type": { "readOnly": true, "type": "string" }, "hasImpact": { "readOnly": true, "type": "boolean" }, "top": { "readOnly": true, "type": "integer", "format": "int32" }, "skip": { "readOnly": true, "type": "integer", "format": "int32" }, "requestedProperties": { "description": "The properties the user specifically asked for", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" }, "requiredProperties": { "description": "The properties that are required to fulfill the requested properties", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProjectionManipulator`1" }, "type": "object" }, "OAS.WebApi.Code.Projection.ProjectionManipulatorProperty": { "properties": { "name": { "readOnly": true, "type": "string" }, "dtoProperty": { "$ref": "#/definitions/System.Reflection.PropertyInfo", "readOnly": true } }, "xml": { "name": "ProjectionManipulatorProperty" }, "type": "object" }, "System.Reflection.PropertyInfo": { "properties": { "memberType": { "readOnly": true, "type": "string", "enum": [ "Constructor", "Event", "Field", "Method", "Property", "TypeInfo", "Custom", "NestedType", "All" ] }, "propertyType": { "readOnly": true, "type": "string" }, "attributes": { "readOnly": true, "type": "string", "enum": [ "None", "SpecialName", "ReservedMask", "RTSpecialName", "HasDefault", "Reserved2", "Reserved3", "Reserved4" ] }, "canRead": { "readOnly": true, "type": "boolean" }, "canWrite": { "readOnly": true, "type": "boolean" }, "getMethod": { "$ref": "#/definitions/System.Reflection.MethodInfo", "readOnly": true }, "setMethod": { "$ref": "#/definitions/System.Reflection.MethodInfo", "readOnly": true }, "isSpecialName": { "readOnly": true, "type": "boolean" }, "name": { "readOnly": true, "type": "string" }, "declaringType": { "readOnly": true, "type": "string" }, "reflectedType": { "readOnly": true, "type": "string" }, "customAttributes": { "items": { "$ref": "#/definitions/System.Reflection.CustomAttributeData" }, "readOnly": true, "xml": { "name": "CustomAttributeData", "wrapped": true }, "type": "array" }, "metadataToken": { "readOnly": true, "type": "integer", "format": "int32" }, "module": { "readOnly": true, "type": "object" } }, "xml": { "name": "PropertyInfo" }, "type": "object" }, "System.Reflection.MethodInfo": { "properties": { "memberType": { "readOnly": true, "type": "string", "enum": [ "Constructor", "Event", "Field", "Method", "Property", "TypeInfo", "Custom", "NestedType", "All" ] }, "returnType": { "readOnly": true, "type": "string" }, "returnParameter": { "$ref": "#/definitions/System.Reflection.ParameterInfo", "readOnly": true }, "returnTypeCustomAttributes": { "$ref": "#/definitions/System.Reflection.ICustomAttributeProvider", "readOnly": true }, "methodImplementationFlags": { "readOnly": true, "type": "string", "enum": [ "CodeTypeMask", "IL", "Native", "OPTIL", "Runtime", "ManagedMask", "Unmanaged", "Managed", "ForwardRef", "PreserveSig", "InternalCall", "Synchronized", "NoInlining", "AggressiveInlining", "NoOptimization", "SecurityMitigations", "MaxMethodImplVal" ] }, "methodHandle": { "readOnly": true, "type": "object" }, "attributes": { "readOnly": true, "type": "string", "enum": [ "MemberAccessMask", "PrivateScope", "Private", "FamANDAssem", "Assembly", "Family", "FamORAssem", "Public", "Static", "Final", "Virtual", "HideBySig", "CheckAccessOnOverride", "VtableLayoutMask", "ReuseSlot", "NewSlot", "Abstract", "SpecialName", "PinvokeImpl", "UnmanagedExport", "RTSpecialName", "ReservedMask", "HasSecurity", "RequireSecObject" ] }, "callingConvention": { "readOnly": true, "type": "string", "enum": [ "Standard", "VarArgs", "Any", "HasThis", "ExplicitThis" ] }, "isGenericMethodDefinition": { "readOnly": true, "type": "boolean" }, "containsGenericParameters": { "readOnly": true, "type": "boolean" }, "isGenericMethod": { "readOnly": true, "type": "boolean" }, "isSecurityCritical": { "readOnly": true, "type": "boolean" }, "isSecuritySafeCritical": { "readOnly": true, "type": "boolean" }, "isSecurityTransparent": { "readOnly": true, "type": "boolean" }, "isPublic": { "readOnly": true, "type": "boolean" }, "isPrivate": { "readOnly": true, "type": "boolean" }, "isFamily": { "readOnly": true, "type": "boolean" }, "isAssembly": { "readOnly": true, "type": "boolean" }, "isFamilyAndAssembly": { "readOnly": true, "type": "boolean" }, "isFamilyOrAssembly": { "readOnly": true, "type": "boolean" }, "isStatic": { "readOnly": true, "type": "boolean" }, "isFinal": { "readOnly": true, "type": "boolean" }, "isVirtual": { "readOnly": true, "type": "boolean" }, "isHideBySig": { "readOnly": true, "type": "boolean" }, "isAbstract": { "readOnly": true, "type": "boolean" }, "isSpecialName": { "readOnly": true, "type": "boolean" }, "isConstructor": { "readOnly": true, "type": "boolean" }, "name": { "readOnly": true, "type": "string" }, "declaringType": { "readOnly": true, "type": "string" }, "reflectedType": { "readOnly": true, "type": "string" }, "customAttributes": { "items": { "$ref": "#/definitions/System.Reflection.CustomAttributeData" }, "readOnly": true, "xml": { "name": "CustomAttributeData", "wrapped": true }, "type": "array" }, "metadataToken": { "readOnly": true, "type": "integer", "format": "int32" }, "module": { "readOnly": true, "type": "object" } }, "xml": { "name": "MethodInfo" }, "type": "object" }, "System.Reflection.CustomAttributeData": { "properties": { "attributeType": { "readOnly": true, "type": "string" }, "constructor": { "$ref": "#/definitions/System.Reflection.ConstructorInfo", "readOnly": true }, "constructorArguments": { "items": { "$ref": "#/definitions/System.Reflection.CustomAttributeTypedArgument" }, "readOnly": true, "xml": { "name": "CustomAttributeTypedArgument", "wrapped": true }, "type": "array" }, "namedArguments": { "items": { "$ref": "#/definitions/System.Reflection.CustomAttributeNamedArgument" }, "readOnly": true, "xml": { "name": "CustomAttributeNamedArgument", "wrapped": true }, "type": "array" } }, "xml": { "name": "CustomAttributeData" }, "type": "object" }, "System.Reflection.ParameterInfo": { "properties": { "parameterType": { "readOnly": true, "type": "string" }, "name": { "readOnly": true, "type": "string" }, "hasDefaultValue": { "readOnly": true, "type": "boolean" }, "defaultValue": { "readOnly": true, "type": "object" }, "rawDefaultValue": { "readOnly": true, "type": "object" }, "position": { "readOnly": true, "type": "integer", "format": "int32" }, "attributes": { "readOnly": true, "type": "string", "enum": [ "None", "In", "Out", "Lcid", "Retval", "Optional", "ReservedMask", "HasDefault", "HasFieldMarshal", "Reserved3", "Reserved4" ] }, "member": { "$ref": "#/definitions/System.Reflection.MemberInfo", "readOnly": true }, "isIn": { "readOnly": true, "type": "boolean" }, "isOut": { "readOnly": true, "type": "boolean" }, "isLcid": { "readOnly": true, "type": "boolean" }, "isRetval": { "readOnly": true, "type": "boolean" }, "isOptional": { "readOnly": true, "type": "boolean" }, "metadataToken": { "readOnly": true, "type": "integer", "format": "int32" }, "customAttributes": { "items": { "$ref": "#/definitions/System.Reflection.CustomAttributeData" }, "readOnly": true, "xml": { "name": "CustomAttributeData", "wrapped": true }, "type": "array" } }, "xml": { "name": "ParameterInfo" }, "type": "object" }, "System.Reflection.ICustomAttributeProvider": { "properties": {}, "xml": { "name": "ICustomAttributeProvider" }, "type": "object" }, "System.Reflection.ConstructorInfo": { "properties": { "memberType": { "readOnly": true, "type": "string", "enum": [ "Constructor", "Event", "Field", "Method", "Property", "TypeInfo", "Custom", "NestedType", "All" ] }, "methodImplementationFlags": { "readOnly": true, "type": "string", "enum": [ "CodeTypeMask", "IL", "Native", "OPTIL", "Runtime", "ManagedMask", "Unmanaged", "Managed", "ForwardRef", "PreserveSig", "InternalCall", "Synchronized", "NoInlining", "AggressiveInlining", "NoOptimization", "SecurityMitigations", "MaxMethodImplVal" ] }, "methodHandle": { "readOnly": true, "type": "object" }, "attributes": { "readOnly": true, "type": "string", "enum": [ "MemberAccessMask", "PrivateScope", "Private", "FamANDAssem", "Assembly", "Family", "FamORAssem", "Public", "Static", "Final", "Virtual", "HideBySig", "CheckAccessOnOverride", "VtableLayoutMask", "ReuseSlot", "NewSlot", "Abstract", "SpecialName", "PinvokeImpl", "UnmanagedExport", "RTSpecialName", "ReservedMask", "HasSecurity", "RequireSecObject" ] }, "callingConvention": { "readOnly": true, "type": "string", "enum": [ "Standard", "VarArgs", "Any", "HasThis", "ExplicitThis" ] }, "isGenericMethodDefinition": { "readOnly": true, "type": "boolean" }, "containsGenericParameters": { "readOnly": true, "type": "boolean" }, "isGenericMethod": { "readOnly": true, "type": "boolean" }, "isSecurityCritical": { "readOnly": true, "type": "boolean" }, "isSecuritySafeCritical": { "readOnly": true, "type": "boolean" }, "isSecurityTransparent": { "readOnly": true, "type": "boolean" }, "isPublic": { "readOnly": true, "type": "boolean" }, "isPrivate": { "readOnly": true, "type": "boolean" }, "isFamily": { "readOnly": true, "type": "boolean" }, "isAssembly": { "readOnly": true, "type": "boolean" }, "isFamilyAndAssembly": { "readOnly": true, "type": "boolean" }, "isFamilyOrAssembly": { "readOnly": true, "type": "boolean" }, "isStatic": { "readOnly": true, "type": "boolean" }, "isFinal": { "readOnly": true, "type": "boolean" }, "isVirtual": { "readOnly": true, "type": "boolean" }, "isHideBySig": { "readOnly": true, "type": "boolean" }, "isAbstract": { "readOnly": true, "type": "boolean" }, "isSpecialName": { "readOnly": true, "type": "boolean" }, "isConstructor": { "readOnly": true, "type": "boolean" }, "name": { "readOnly": true, "type": "string" }, "declaringType": { "readOnly": true, "type": "string" }, "reflectedType": { "readOnly": true, "type": "string" }, "customAttributes": { "items": { "$ref": "#/definitions/System.Reflection.CustomAttributeData" }, "readOnly": true, "xml": { "name": "CustomAttributeData", "wrapped": true }, "type": "array" }, "metadataToken": { "readOnly": true, "type": "integer", "format": "int32" }, "module": { "readOnly": true, "type": "object" } }, "xml": { "name": "ConstructorInfo" }, "type": "object" }, "System.Reflection.CustomAttributeTypedArgument": { "properties": { "argumentType": { "readOnly": true, "type": "string" }, "value": { "readOnly": true, "type": "object" } }, "xml": { "name": "CustomAttributeTypedArgument" }, "type": "object" }, "System.Reflection.CustomAttributeNamedArgument": { "properties": { "memberInfo": { "$ref": "#/definitions/System.Reflection.MemberInfo", "readOnly": true }, "typedValue": { "$ref": "#/definitions/System.Reflection.CustomAttributeTypedArgument", "readOnly": true }, "memberName": { "readOnly": true, "type": "string" }, "isField": { "readOnly": true, "type": "boolean" } }, "xml": { "name": "CustomAttributeNamedArgument" }, "type": "object" }, "System.Reflection.MemberInfo": { "properties": { "memberType": { "readOnly": true, "type": "string", "enum": [ "Constructor", "Event", "Field", "Method", "Property", "TypeInfo", "Custom", "NestedType", "All" ] }, "name": { "readOnly": true, "type": "string" }, "declaringType": { "readOnly": true, "type": "string" }, "reflectedType": { "readOnly": true, "type": "string" }, "customAttributes": { "items": { "$ref": "#/definitions/System.Reflection.CustomAttributeData" }, "readOnly": true, "xml": { "name": "CustomAttributeData", "wrapped": true }, "type": "array" }, "metadataToken": { "readOnly": true, "type": "integer", "format": "int32" }, "module": { "readOnly": true, "type": "object" } }, "xml": { "name": "MemberInfo" }, "type": "object" }, "OAS.WebApi.Code.Projection.ProjectionManipulatorOfOAS.WebApi.DTO.Billing.BillAccountAssetLevelDto": { "properties": { "type": { "readOnly": true, "type": "string" }, "hasImpact": { "readOnly": true, "type": "boolean" }, "top": { "readOnly": true, "type": "integer", "format": "int32" }, "skip": { "readOnly": true, "type": "integer", "format": "int32" }, "requestedProperties": { "description": "The properties the user specifically asked for", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" }, "requiredProperties": { "description": "The properties that are required to fulfill the requested properties", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProjectionManipulator`1" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillAccountBaseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "accountType": { "type": "string" }, "registrationName": { "type": "string" }, "registrationId": { "type": "integer", "format": "int32" }, "fundName": { "type": "string" }, "accountNumber": { "type": "string" }, "accountName": { "type": "string" }, "remainingAmount": { "type": "number", "format": "double" }, "managementStyle": { "type": "string" }, "subAdvisorName": { "type": "string" }, "feeSchedule": { "type": "string" }, "masterPayoutSchedule": { "type": "string" }, "payMethod": { "type": "string" }, "billFrequency": { "type": "string", "enum": [ "Undefined", "Monthly", "Quarterly", "Triannual", "Semiannually", "Annually", "AtMaturity" ] }, "billStyle": { "type": "string", "enum": [ "Advance", "Arrears" ] }, "billAccountStatus": { "type": "string", "enum": [ "Ready", "NotReady", "ReportingOnly", "FinancialPlanningFeeOnly" ] }, "billingStatus": { "type": "string", "enum": [ "ReadyToBill", "Hold", "PendingReview" ] }, "valuationMethod": { "type": "string", "enum": [ "PeriodEndingValue", "AvgDailyBalance", "AvgMonthlyBalance" ] }, "accountValue": { "type": "number", "format": "double" }, "accountStartDate": { "type": "string", "format": "date-time" }, "clientName": { "type": "string" }, "billStartDate": { "type": "string", "format": "date-time" }, "lastBilledThroughDate": { "type": "string", "format": "date-time" }, "custodialAccountNumber": { "type": "string" }, "isPerformanceBilled": { "type": "boolean" }, "lastPerfBillDate": { "type": "string", "format": "date-time" }, "includeInAggregate": { "type": "boolean" }, "useFeeHierarchy": { "type": "boolean" }, "cycleMonth": { "type": "integer", "format": "int32" }, "performanceMasterPayoutSchedule": { "type": "string" }, "performanceFeeSchedule": { "type": "string" }, "representativeName": { "type": "string" }, "representativeNumber": { "type": "string" }, "isActive": { "type": "boolean" }, "lastTransactionDate": { "type": "string", "format": "date-time" }, "custodian": { "type": "string" }, "lastName": { "type": "string" }, "businessLine": { "type": "string" }, "outsideId": { "type": "string" }, "modelName": { "type": "string" }, "noFeeAggregate": { "type": "string" }, "status": { "type": "string", "enum": [ "Ready", "NotReady", "ReportingOnly", "FinancialPlanningFeeOnly" ] }, "paysForAccountNumbers": { "type": "string" }, "prevAmountApplied": { "type": "number", "format": "double" }, "accountIdThatDoesPaying": { "type": "integer", "format": "int32" } }, "xml": { "name": "BillAccountBaseDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillAccountSimpleDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "accountType": { "type": "string" }, "registrationName": { "type": "string" }, "registrationId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "accountName": { "type": "string" }, "feeSchedule": { "type": "string" }, "accountValue": { "type": "number", "format": "double" }, "accountStartDate": { "type": "string", "format": "date-time" }, "clientName": { "type": "string" }, "feeScheduleId": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "custodian": { "type": "string" }, "businessLine": { "type": "string" }, "billStartDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "BillAccountSimpleDto" }, "type": "object" }, "OAS.DataModel.Portfolio.SimpleAccount": { "properties": { "number": { "type": "string" }, "managementStyle": { "type": "string" }, "isActive": { "type": "boolean" }, "clientId": { "type": "integer", "format": "int32" }, "custodian": { "type": "string" }, "registrationId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "SimpleAccount" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillingAccountCountsDto": { "properties": { "feeScheduleIsZero": { "type": "integer", "format": "int32" }, "missingFeeSchedules": { "type": "integer", "format": "int32" }, "missingManagementStyles": { "type": "integer", "format": "int32" }, "missingPayoutSchedules": { "type": "integer", "format": "int32" }, "billStatusNotReady": { "type": "integer", "format": "int32" }, "payingFeeIsZero": { "type": "integer", "format": "int32" }, "payingFeeIsIndirect": { "type": "integer", "format": "int32" }, "payingFeeIsInactive": { "type": "integer", "format": "int32" }, "checkPayPaidByOther": { "type": "integer", "format": "int32" }, "subadvisorFeeSchedule": { "type": "integer", "format": "int32" }, "accountsPaidByAndFor": { "type": "integer", "format": "int32" }, "assetLevelBilling": { "type": "integer", "format": "int32" } }, "xml": { "name": "BillingAccountCountsDto" }, "type": "object" }, "OAS.WebApi.Code.Projection.ProjectionManipulatorOfOAS.WebApi.DTO.Billing.BillAccountDto": { "properties": { "type": { "readOnly": true, "type": "string" }, "hasImpact": { "readOnly": true, "type": "boolean" }, "top": { "readOnly": true, "type": "integer", "format": "int32" }, "skip": { "readOnly": true, "type": "integer", "format": "int32" }, "requestedProperties": { "description": "The properties the user specifically asked for", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" }, "requiredProperties": { "description": "The properties that are required to fulfill the requested properties", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProjectionManipulator`1" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillAccountSummaryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "clientId": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "billMarketValue": { "type": "number", "format": "double" }, "feeSchedule": { "type": "string" }, "payMethod": { "type": "string" }, "masterPayoutSchedule": { "type": "string" }, "paysForAccountNumbers": { "readOnly": true, "type": "string" }, "balanceDue": { "type": "number", "format": "double" }, "creditRemaining": { "type": "number", "format": "double" }, "billStartDate": { "type": "string", "format": "date-time" }, "valuationMethod": { "type": "string", "enum": [ "PeriodEndingValue", "AvgDailyBalance", "AvgMonthlyBalance" ] }, "billFrequency": { "type": "string", "enum": [ "Undefined", "Monthly", "Quarterly", "Triannual", "Semiannually", "Annually", "AtMaturity" ] }, "isActive": { "type": "boolean" }, "registrationName": { "type": "string" }, "accountType": { "type": "string" }, "representativeNumber": { "type": "string" }, "representativeName": { "type": "string" }, "accountValue": { "type": "number", "format": "double" }, "model": { "type": "string" } }, "xml": { "name": "BillAccountSummaryDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillAccountGridDto": { "properties": { "paysForAccountsActive": { "type": "boolean" }, "additionalColumns": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Interface.AdditionalColumnDefinition" }, "xml": { "name": "AdditionalColumnDefinition", "wrapped": true }, "type": "array" }, "id": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "accountType": { "type": "string" }, "registrationName": { "type": "string" }, "registrationId": { "type": "integer", "format": "int32" }, "fundName": { "type": "string" }, "accountNumber": { "type": "string" }, "accountName": { "type": "string" }, "remainingAmount": { "type": "number", "format": "double" }, "managementStyle": { "type": "string" }, "subAdvisorName": { "type": "string" }, "feeSchedule": { "type": "string" }, "masterPayoutSchedule": { "type": "string" }, "payMethod": { "type": "string" }, "billFrequency": { "type": "string", "enum": [ "Undefined", "Monthly", "Quarterly", "Triannual", "Semiannually", "Annually", "AtMaturity" ] }, "billStyle": { "type": "string", "enum": [ "Advance", "Arrears" ] }, "billAccountStatus": { "type": "string", "enum": [ "Ready", "NotReady", "ReportingOnly", "FinancialPlanningFeeOnly" ] }, "billingStatus": { "type": "string", "enum": [ "ReadyToBill", "Hold", "PendingReview" ] }, "valuationMethod": { "type": "string", "enum": [ "PeriodEndingValue", "AvgDailyBalance", "AvgMonthlyBalance" ] }, "accountValue": { "type": "number", "format": "double" }, "accountStartDate": { "type": "string", "format": "date-time" }, "clientName": { "type": "string" }, "billStartDate": { "type": "string", "format": "date-time" }, "lastBilledThroughDate": { "type": "string", "format": "date-time" }, "custodialAccountNumber": { "type": "string" }, "isPerformanceBilled": { "type": "boolean" }, "lastPerfBillDate": { "type": "string", "format": "date-time" }, "includeInAggregate": { "type": "boolean" }, "useFeeHierarchy": { "type": "boolean" }, "cycleMonth": { "type": "integer", "format": "int32" }, "performanceMasterPayoutSchedule": { "type": "string" }, "performanceFeeSchedule": { "type": "string" }, "representativeName": { "type": "string" }, "representativeNumber": { "type": "string" }, "isActive": { "type": "boolean" }, "lastTransactionDate": { "type": "string", "format": "date-time" }, "custodian": { "type": "string" }, "lastName": { "type": "string" }, "businessLine": { "type": "string" }, "outsideId": { "type": "string" }, "modelName": { "type": "string" }, "noFeeAggregate": { "type": "string" }, "status": { "type": "string", "enum": [ "Ready", "NotReady", "ReportingOnly", "FinancialPlanningFeeOnly" ] }, "paysForAccountNumbers": { "type": "string" }, "prevAmountApplied": { "type": "number", "format": "double" }, "accountIdThatDoesPaying": { "type": "integer", "format": "int32" } }, "xml": { "name": "BillAccountGridDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillAccountRecurringAdjustmentDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "fundName": { "type": "string" }, "accountNumber": { "type": "string" }, "managementStyle": { "type": "string" }, "subAdvisorName": { "type": "string" }, "feeSchedule": { "type": "string" }, "masterPayoutSchedule": { "type": "string" }, "accountValue": { "type": "number", "format": "double" }, "clientName": { "type": "string" }, "clientFirstName": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "additionalAnnualAmount": { "type": "number", "format": "double" }, "adjustmentTypeDescription": { "type": "string" }, "entityDescription": { "type": "string" }, "billScheduleName": { "type": "string" }, "type": { "type": "string" }, "billStartDate": { "type": "string", "format": "date-time" }, "feeScheduleId": { "type": "integer", "format": "int32" }, "representativeName": { "type": "string" }, "representativeNumber": { "type": "string" }, "businessLine": { "type": "string" }, "accountStartDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "adjustmentStartDate": { "type": "string", "format": "date-time" }, "adjustmentEndDate": { "type": "string", "format": "date-time" }, "outsideId": { "type": "string" } }, "xml": { "name": "BillAccountRecurringAdjustmentDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.HouseholdRecurringAdjustmentDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "adjustmentId": { "type": "integer", "format": "int32" }, "clientName": { "type": "string" }, "additionalAnnualAmount": { "type": "number", "format": "double" }, "type": { "type": "string" }, "feeScheduleName": { "type": "string" }, "adjustmentTypeDescription": { "type": "string" }, "entity": { "type": "string" } }, "xml": { "name": "HouseholdRecurringAdjustmentDto" }, "type": "object" }, "OAS.DataModel.SimpleEntity": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "SimpleEntity" }, "type": "object" }, "OAS.WebApi.DTO.ValidateImport.ImportFileFilterDto": { "required": [ "columnName" ], "properties": { "columnName": { "type": "string", "pattern": "^(Household ID|Account ID|Account Number|Representative Name|Representative Number|Product ID|Download Symbol)$" }, "filterType": { "type": "string", "enum": [ "Include", "Exclude" ] }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile", "description": "the imported file" } }, "xml": { "name": "ImportFileFilterDto" }, "type": "object" }, "MultipartDataMediaFormatter.Infrastructure.HttpFile": { "properties": { "fileName": { "type": "string" }, "mediaType": { "type": "string" }, "data": { "$ref": "#/definitions/System.Net.Http.StreamContent" } }, "xml": { "name": "HttpFile" }, "type": "object" }, "System.Net.Http.StreamContent": { "properties": { "headers": { "items": { "$ref": "#/definitions/System.Collections.Generic.KeyValuePairOfSystem.StringAndSystem.Collections.Generic.IEnumerableOfSystem.String" }, "readOnly": true, "xml": { "name": "KeyValuePair`2", "wrapped": true }, "type": "array" } }, "xml": { "name": "StreamContent" }, "type": "object" }, "System.Collections.Generic.KeyValuePairOfSystem.StringAndSystem.Collections.Generic.IEnumerableOfSystem.String": { "properties": { "key": { "readOnly": true, "type": "string" }, "value": { "items": { "type": "string" }, "readOnly": true, "type": "array" } }, "xml": { "name": "KeyValuePair`2" }, "type": "object" }, "OAS.DataModel.Billing.BillAccountStatus": { "required": [ "id", "status", "isBilled" ], "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "type": "string", "maxLength": 25, "minLength": 0 }, "isBilled": { "type": "boolean" } }, "xml": { "name": "BillAccountStatus" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillAdjustmentTypeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "isPayable": { "type": "boolean" }, "adjustmentType": { "type": "string" }, "isDebit": { "type": "boolean" }, "transactionType": { "type": "string" }, "name": { "type": "string" }, "feeFileGroup": { "type": "integer", "format": "int32" }, "isPayableAffect": { "type": "boolean" }, "isNet": { "type": "boolean" }, "isExcludedEU": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" } }, "xml": { "name": "BillAdjustmentTypeDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillAdjustmentTypeHistoryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string" }, "isDebit": { "type": "boolean" }, "isPayableAffect": { "type": "boolean" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" } }, "xml": { "name": "BillAdjustmentTypeHistoryDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillAssetDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "lastName": { "type": "string" }, "fundFamily": { "type": "string" }, "accountNumber": { "type": "string" }, "productName": { "type": "string" }, "value": { "type": "number", "format": "double" }, "isFeeExcluded": { "type": "boolean" }, "isPayingFee": { "type": "boolean" }, "active": { "type": "boolean" }, "ticker": { "type": "string" }, "assetClass": { "type": "string" }, "excludeAmount": { "type": "number", "format": "double" }, "excludeAmountType": { "type": "string", "enum": [ "Percent", "Dollars", "Shares" ] }, "excludePercentOf": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "billAssetId": { "type": "integer", "format": "int32" }, "excludeEndDate": { "type": "string", "format": "date-time" }, "excludeStartDate": { "type": "string", "format": "date-time" }, "businessLine": { "type": "string" }, "representativeName": { "type": "string" }, "representativeNumber": { "type": "string" }, "cycleMonth": { "type": "integer", "format": "int32" }, "fundFamilyId": { "type": "integer", "format": "int32" }, "excludeFromMargin": { "type": "boolean" }, "feeBillExclusionMode": { "type": "string", "enum": [ "No", "YesAll", "SelectBillEntities" ] }, "excludedBillEntities": { "type": "string" }, "productId": { "type": "integer", "format": "int32" } }, "xml": { "name": "BillAssetDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.HouseholdExclusionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "lastName": { "type": "string" }, "assignmentType": { "readOnly": true, "type": "string" }, "classificationMethod": { "type": "string" }, "categoryClass": { "type": "string" }, "representativeName": { "type": "string" }, "representativeNumber": { "type": "string" }, "excluded": { "type": "boolean" }, "active": { "type": "boolean" } }, "xml": { "name": "HouseholdExclusionDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.SecurityClassExclusionDto": { "description": "DTO for security class exclusions displayed on the Exclusions page.", "properties": { "id": { "type": "integer", "format": "int32" }, "classificationMethod": { "type": "string" }, "securityClass": { "type": "string" }, "securityClassificationMethodId": { "type": "integer", "format": "int32" } }, "xml": { "name": "SecurityClassExclusionDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.RepPayableSummaryParamsDto": { "properties": { "keys": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "RepPayableSummaryParamsDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.RepPayableSummaryDto": { "properties": { "fileId": { "type": "integer", "format": "int32" }, "openWith": { "type": "string" }, "fileName": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "description": { "type": "string" } }, "xml": { "name": "RepPayableSummaryDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.AuditFileBlobDto": { "properties": { "instanceId": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "createdDate": { "type": "string", "format": "date-time" }, "id": { "type": "integer", "format": "int32" }, "openWith": { "type": "string" }, "fileName": { "type": "string" }, "blobDesc": { "type": "string" }, "blobText": { "type": "string" }, "category": { "type": "string" }, "isZip": { "type": "boolean" } }, "xml": { "name": "AuditFileBlobDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillAssetItemDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "fkBillAccountItem": { "type": "integer", "format": "int32" }, "fkAsset": { "type": "integer", "format": "int32" }, "cPricePerShare": { "type": "number", "format": "double" }, "cBillMktvalue": { "type": "number", "format": "double" }, "cFeeAmount": { "type": "number", "format": "double" }, "dtEditDate": { "type": "string", "format": "date-time" }, "sEditedBy": { "type": "string" }, "dtCreateDate": { "type": "string", "format": "date-time" }, "sCreatedBy": { "type": "string" }, "billShares": { "type": "number", "format": "double" }, "transDate": { "type": "string", "format": "date-time" }, "assetProportion": { "type": "number", "format": "double" }, "tieredVal": { "type": "number", "format": "double" }, "fkTransaction": { "type": "integer", "format": "int32" }, "fkBillInstance": { "type": "integer", "format": "int32" }, "accruedInterest": { "type": "number", "format": "double" }, "assetAccountNumber": { "type": "string" }, "productName": { "type": "string" } }, "xml": { "name": "BillAssetItemDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillCompareTypeDto": { "properties": { "type": { "type": "string" }, "asOfDate": { "type": "string", "format": "date-time" }, "isMockBill": { "type": "boolean" }, "frequency": { "type": "integer", "format": "int32" } }, "xml": { "name": "BillCompareTypeDto" }, "type": "object" }, "OAS.DataModel.Billing.BillCompareDashboardCounts": { "properties": { "isScheduleChangedCount": { "type": "integer", "format": "int32" }, "isPreviousActiveCount": { "type": "integer", "format": "int32" }, "isNewAccountCount": { "type": "integer", "format": "int32" }, "isCashFlowCount": { "type": "integer", "format": "int32" }, "isAdjustmentsAppliedCount": { "type": "integer", "format": "int32" }, "isAggregationChangedCount": { "type": "integer", "format": "int32" }, "isCancellationCount": { "type": "integer", "format": "int32" }, "others": { "type": "integer", "format": "int32" } }, "xml": { "name": "BillCompareDashboardCounts" }, "type": "object" }, "OAS.DataModel.Billing.BillCompareDashboard": { "properties": { "accountID": { "type": "integer", "format": "int32" }, "acctCode": { "type": "string" }, "isApproved": { "type": "boolean" } }, "xml": { "name": "BillCompareDashboard" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillCompareNoteDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "compareFromOfDate": { "type": "string", "format": "date-time" }, "isMockCompareFrom": { "type": "boolean" }, "compareToOfDate": { "type": "string", "format": "date-time" }, "isMockCompareTo": { "type": "boolean" }, "filterValue": { "type": "integer", "format": "int32" }, "notes": { "type": "string" }, "isApproved": { "type": "boolean" }, "frequency": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "BillCompareNoteDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillDataDto": { "properties": { "billAccountItemId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "fundFamilyName": { "type": "string" }, "accountNumber": { "type": "string" }, "balanceDue": { "type": "number", "format": "double" }, "representativeName": { "type": "string" }, "aggregateValue": { "type": "number", "format": "double" }, "billedMarketValue": { "type": "number", "format": "double" }, "payMethod": { "type": "string" }, "feeSchedule": { "type": "string" }, "masterPayoutSchedule": { "type": "string" }, "initialAmount": { "type": "number", "format": "double" }, "adjustmentsValue": { "type": "number", "format": "double" }, "feePercent": { "type": "number", "format": "double" }, "daysInCycle": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "registrationId": { "type": "integer", "format": "int32" }, "clientName": { "type": "string" }, "clientLastName": { "type": "string" }, "accountType": { "type": "string" }, "outsideId": { "type": "string" }, "subAdvisorName": { "type": "string" }, "custodian": { "type": "string" }, "billFrequency": { "type": "string", "enum": [ "Undefined", "Monthly", "Quarterly", "Triannual", "Semiannually", "Annually", "AtMaturity" ] }, "valueMethod": { "type": "string", "enum": [ "PeriodEndingValue", "AvgDailyBalance", "AvgMonthlyBalance" ] }, "managementStyle": { "type": "string" }, "calcDate": { "type": "string", "format": "date-time" }, "billId": { "type": "integer", "format": "int32" }, "billInstanceId": { "type": "integer", "format": "int32" }, "modelName": { "type": "string" } }, "xml": { "name": "BillDataDto" }, "type": "object" }, "OAS.DataModel.Billing.BillGeneratorOverview": { "properties": { "hhNewAccountNotReady": { "type": "integer", "format": "int32" }, "hhNewAccountReady": { "type": "integer", "format": "int32" }, "hhStatusNewMoney": { "type": "integer", "format": "int32" }, "valuationMethodPeriodEnding": { "type": "integer", "format": "int32" }, "valuationMethodAvgDailyBalance": { "type": "integer", "format": "int32" }, "valuationMethodAvgMonthlyBalance": { "type": "integer", "format": "int32" }, "billStyleAdvanced": { "type": "integer", "format": "int32" }, "billStyleArrear": { "type": "integer", "format": "int32" } }, "xml": { "name": "BillGeneratorOverview" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillGeneratorBillTimeFramesDto": { "properties": { "timeFrames": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillTimeFrameDto" }, "xml": { "name": "BillTimeFrameDto", "wrapped": true }, "type": "array" }, "others": { "items": { "type": "string" }, "type": "array" } }, "xml": { "name": "BillGeneratorBillTimeFramesDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillTimeFrameDto": { "properties": { "frequency": { "type": "string", "enum": [ "Undefined", "Monthly", "Quarterly", "Triannual", "Semiannually", "Annually", "AtMaturity" ] }, "billStyleId": { "type": "integer", "format": "int32" }, "periodName": { "type": "string" }, "dateRange": { "type": "string" } }, "xml": { "name": "BillTimeFrameDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.BillAccountItemDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "billAccountId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "billStatus": { "type": "string" }, "billType": { "type": "string", "enum": [ "Unknown", "Renewal", "NewMoney", "NewAccount", "FinancialPlanningFee", "Performance", "AdvanceCreditDebit" ] }, "billId": { "type": "integer", "format": "int32" }, "billInstanceId": { "type": "integer", "format": "int32" }, "payForAccountId": { "type": "integer", "format": "int32" }, "highAssetId": { "type": "integer", "format": "int32" }, "initialAmount": { "type": "number", "format": "double" }, "balanceDue": { "type": "number", "format": "double" }, "calcDate": { "type": "string", "format": "date-time" }, "custodian": { "type": "string" }, "fundFamily": { "type": "string" }, "representative": { "type": "string" }, "businessLine": { "type": "string" }, "valid": { "type": "boolean" }, "totalMarketValue": { "type": "number", "format": "double" }, "dailyAccrualPercent": { "type": "number", "format": "double" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "daysInCycle": { "type": "integer", "format": "int32" }, "oldReceivableID": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "basis": { "type": "integer", "format": "int32" }, "aggregateValue": { "type": "number", "format": "double" }, "feePercent": { "type": "number", "format": "double" }, "error": { "type": "string" }, "feeSchedule": { "type": "string" }, "buildComplete": { "type": "boolean" }, "isLocked": { "type": "boolean" }, "payForPercent": { "type": "number", "format": "float" }, "tempAccountItemId": { "type": "integer", "format": "int32" }, "appliedAdjustment": { "type": "number", "format": "double" }, "daysInYear": { "type": "integer", "format": "int32" }, "billFrequency": { "type": "integer", "format": "int32" }, "payMethod": { "type": "string" }, "accountStampId": { "type": "integer", "format": "int32" }, "flatFee": { "type": "number", "format": "double" }, "howBilled": { "type": "integer", "format": "int32" }, "lastCollectAttempt": { "type": "string", "format": "date-time" }, "payoutAggregateValue": { "type": "number", "format": "double" }, "payoutBasis": { "type": "integer", "format": "int32" }, "transferMarketValue": { "type": "number", "format": "double" }, "indirectLink": { "type": "integer", "format": "int32" }, "note": { "type": "string" }, "registrationName": { "type": "string" } }, "xml": { "name": "BillAccountItemDto" }, "type": "object" }, "OAS.DataModel.Billing.BillAccountItem": { "required": [ "id", "billAccountId", "billStatusId", "billTypeId", "calcDate", "editedDate", "editedBy", "createdDate", "createdBy", "isValid", "buildComplete", "isLocked", "appliedAdjustment", "transferMarketValue" ], "properties": { "id": { "type": "integer", "format": "int32" }, "billAccountId": { "type": "integer", "format": "int32" }, "billStatusId": { "type": "integer", "format": "int32" }, "billTypeId": { "type": "integer", "format": "int32" }, "billInstanceId": { "type": "integer", "format": "int32" }, "payForAccountId": { "type": "integer", "format": "int32" }, "highAssetId": { "type": "integer", "format": "int32" }, "initialAmount": { "type": "number", "format": "double" }, "balanceDue": { "type": "number", "format": "double" }, "calcDate": { "type": "string", "format": "date-time" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "isValid": { "type": "boolean" }, "totalMarketValue": { "type": "number", "format": "double" }, "dailyAccrualPercent": { "type": "number", "format": "double" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "daysInCycle": { "type": "integer", "format": "int32" }, "oldReceivableID": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "basis": { "type": "integer", "format": "int32" }, "aggregateValue": { "type": "number", "format": "double" }, "feePercent": { "type": "number", "format": "double" }, "error": { "type": "string", "maxLength": 200, "minLength": 0 }, "feeSchedule": { "type": "string", "maxLength": 50, "minLength": 0 }, "buildComplete": { "type": "boolean" }, "isLocked": { "type": "boolean" }, "payForPercent": { "type": "number", "format": "float" }, "tempAccountItemId": { "type": "integer", "format": "int32" }, "appliedAdjustment": { "type": "number", "format": "double" }, "daysInYear": { "type": "integer", "format": "int32" }, "billFrequency": { "type": "integer", "format": "int32" }, "payMethod": { "type": "string", "maxLength": 25, "minLength": 0 }, "accountStampId": { "type": "integer", "format": "int32" }, "flatFee": { "type": "number", "format": "double" }, "howBilled": { "type": "integer", "format": "int32" }, "lastCollectAttempt": { "type": "string", "format": "date-time" }, "payoutAggregateValue": { "type": "number", "format": "double" }, "payoutBasis": { "type": "integer", "format": "int32" }, "transferMarketValue": { "type": "number", "format": "double" }, "indirectLink": { "type": "integer", "format": "int32" }, "account": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAccount" }, "items": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillItem" }, "xml": { "name": "BillItem", "wrapped": true }, "type": "array" }, "adjustments": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAccountItemAdjustment" }, "xml": { "name": "BillAccountItemAdjustment", "wrapped": true }, "type": "array" }, "billAssetItems": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAssetItem" }, "xml": { "name": "BillAssetItem", "wrapped": true }, "type": "array" }, "payableItems": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.PayableItem" }, "xml": { "name": "PayableItem", "wrapped": true }, "type": "array" }, "highAsset": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Asset" }, "payForAccount": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" }, "billStatus": { "$ref": "#/definitions/OAS.DataModel.Billing.BillStatus" }, "note": { "type": "string", "maxLength": 255, "minLength": 0 } }, "xml": { "name": "BillAccountItem" }, "type": "object" }, "OAS.DataModel.Billing.BillAccount": { "required": [ "id", "billPayMethodId", "billFeeScheduleId", "accountId", "editedDate", "editedBy", "createdDate", "createdBy", "cycleMonth", "billFrequency", "isActive", "billingStyle", "billMasterPayoutScheduleId", "acceptsList", "feeFormCount", "useMinFee", "valueMethod", "additionalAnnualAmount", "additionalAnnualAmountType", "billEntityId", "includeInAggregate", "status" ], "properties": { "id": { "type": "integer", "format": "int32" }, "billPayMethodId": { "type": "integer", "format": "int32" }, "billFeeScheduleId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "billPayoutScheduleId": { "type": "integer", "format": "int32" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "custodialAccountNumber": { "type": "string", "maxLength": 50, "minLength": 0 }, "abaNumber": { "type": "string", "maxLength": 20, "minLength": 0 }, "bankAccountNumber": { "type": "string", "maxLength": 20, "minLength": 0 }, "bankName": { "type": "string", "maxLength": 50, "minLength": 0 }, "nameOnAccount": { "type": "string", "maxLength": 50, "minLength": 0 }, "creditCardNumber": { "type": "string", "format": "byte" }, "cycleMonth": { "type": "integer", "format": "int32" }, "billFrequency": { "type": "string", "enum": [ "Undefined", "Monthly", "Quarterly", "Triannual", "Semiannually", "Annually", "AtMaturity" ] }, "expirationDate": { "type": "string", "maxLength": 10, "minLength": 0 }, "nameOnCard": { "type": "string", "maxLength": 50, "minLength": 0 }, "cardType": { "type": "string", "maxLength": 20, "minLength": 0 }, "nmAcctNum": { "type": "string", "maxLength": 50, "minLength": 0 }, "nmAcctName": { "type": "string", "maxLength": 50, "minLength": 0 }, "nmClientName": { "type": "string", "maxLength": 50, "minLength": 0 }, "timestamp": { "type": "string", "format": "byte" }, "isActive": { "type": "boolean" }, "billingStyle": { "type": "string", "enum": [ "Advance", "Arrears" ] }, "billMasterPayoutScheduleId": { "type": "integer", "format": "int32" }, "acceptsList": { "type": "boolean" }, "feeFormCount": { "type": "integer", "format": "int32" }, "lastPerfBillDate": { "type": "string", "format": "date-time" }, "isPerformanceBilled": { "type": "boolean" }, "performanceFeeScheduleId": { "type": "integer", "format": "int32" }, "performanceMasterPayoutScheduleId": { "type": "integer", "format": "int32" }, "billStartDate": { "type": "string", "format": "date-time" }, "useMinFee": { "type": "boolean" }, "valueMethod": { "type": "string", "enum": [ "PeriodEndingValue", "AvgDailyBalance", "AvgMonthlyBalance" ] }, "additionalAnnualAmount": { "type": "number", "format": "double" }, "additionalAnnualAmountType": { "type": "integer", "format": "int32" }, "billAdjTypeId": { "type": "integer", "format": "int32" }, "billEntityId": { "type": "integer", "format": "int32" }, "creditCardNoEncryption": { "type": "string", "maxLength": 255, "minLength": 0 }, "addressLine1": { "type": "string", "maxLength": 255, "minLength": 0 }, "addressLine2": { "type": "string", "maxLength": 255, "minLength": 0 }, "addressLine3": { "type": "string", "maxLength": 255, "minLength": 0 }, "city": { "type": "string", "maxLength": 30, "minLength": 0 }, "state": { "type": "string", "maxLength": 2, "minLength": 0 }, "zip": { "type": "string", "maxLength": 10, "minLength": 0 }, "includeInAggregate": { "type": "boolean" }, "status": { "type": "string", "enum": [ "Ready", "NotReady", "ReportingOnly", "FinancialPlanningFeeOnly" ] }, "tieredFeePriority": { "type": "integer", "format": "int32" }, "useFeeHierarchy": { "type": "boolean" }, "billEntity": { "$ref": "#/definitions/OAS.DataModel.Billing.BillEntity" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" }, "billPaysForAccounts": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillPayForAccount" }, "xml": { "name": "BillPayForAccount", "wrapped": true }, "type": "array" }, "billPaysForAccountDetail": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillPayForAccountDetail" }, "xml": { "name": "BillPayForAccountDetail", "wrapped": true }, "type": "array" }, "billAccountSchedules": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAccountSchedule" }, "xml": { "name": "BillAccountSchedule", "wrapped": true }, "type": "array" }, "accountItems": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAccountItem" }, "xml": { "name": "BillAccountItem", "wrapped": true }, "type": "array" }, "billMasterPayoutSchedule": { "$ref": "#/definitions/OAS.DataModel.Billing.BillMasterSchedule" }, "billPayMethod": { "$ref": "#/definitions/OAS.DataModel.Billing.BillPayMethod" }, "billFeeSchedule": { "$ref": "#/definitions/OAS.DataModel.Billing.BillSchedule" }, "billPayoutSchedule": { "$ref": "#/definitions/OAS.DataModel.Billing.BillSchedule" }, "billAccountEntityPayees": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAccountEntityPayee" }, "xml": { "name": "BillAccountEntityPayee", "wrapped": true }, "type": "array" }, "performanceMasterPayoutSchedule": { "$ref": "#/definitions/OAS.DataModel.Billing.BillMasterSchedule" }, "performanceFeeSchedule": { "$ref": "#/definitions/OAS.DataModel.Billing.BillSchedule" }, "paysForAccountAcctCodes": { "$ref": "#/definitions/OAS.DataModel.Billing.BillPaysForAccountAcctCodes" }, "gridData": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAccountForEF" }, "lastBilledThroughDate": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAccountLastBilledThroughDate" } }, "xml": { "name": "BillAccount" }, "type": "object" }, "OAS.DataModel.Billing.BillItem": { "required": [ "id", "billAccountItemId", "billId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "billAccountItemId": { "type": "integer", "format": "int32" }, "billId": { "type": "integer", "format": "int32" }, "billInstanceId": { "type": "integer", "format": "int32" }, "bill": { "$ref": "#/definitions/OAS.DataModel.Billing.Bill" }, "accountItem": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAccountItem" } }, "xml": { "name": "BillItem" }, "type": "object" }, "OAS.DataModel.Billing.BillAccountItemAdjustment": { "required": [ "id", "billAccountItemId", "billAdjustmentTypeId", "previousBalance", "currentBalance", "changeAmount", "editedDate", "editedBy", "createdDate", "createdBy", "dateOccured", "isLocked" ], "properties": { "id": { "type": "integer", "format": "int32" }, "billAccountItemId": { "type": "integer", "format": "int32" }, "billAdjustmentTypeId": { "type": "integer", "format": "int32" }, "billEntityId": { "type": "integer", "format": "int32" }, "billPaymentId": { "type": "integer", "format": "int32" }, "previousBalance": { "type": "number", "format": "double" }, "currentBalance": { "type": "number", "format": "double" }, "changeAmount": { "type": "number", "format": "double" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "dateOccured": { "type": "string", "format": "date-time" }, "isLocked": { "type": "boolean" }, "paidForByAccountId": { "type": "integer", "format": "int32" }, "billInstanceId": { "type": "integer", "format": "int32" }, "generalAccountDetailSrcId": { "type": "integer", "format": "int32" }, "generalAccountDetailAdjId": { "type": "integer", "format": "int32" }, "additionalAnnualAmount": { "type": "number", "format": "double" }, "additionalAnnualAmountType": { "type": "integer", "format": "int32" }, "tradeRequestId": { "type": "integer", "format": "int32" }, "accountItem": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAccountItem" }, "billPayment": { "$ref": "#/definitions/OAS.DataModel.Billing.BillPayment" }, "billAdjustmentType": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAdjustmentType" }, "billEntity": { "$ref": "#/definitions/OAS.DataModel.Billing.BillEntity" } }, "xml": { "name": "BillAccountItemAdjustment" }, "type": "object" }, "OAS.DataModel.Billing.BillAssetItem": { "required": [ "id", "assetId", "dtEditDate", "sEditedBy", "dtCreateDate", "sCreatedBy", "accruedInterest" ], "properties": { "id": { "type": "integer", "format": "int32" }, "billAccountItemId": { "type": "integer", "format": "int32" }, "assetId": { "type": "integer", "format": "int32" }, "cPricePerShare": { "type": "number", "format": "double" }, "cBillMktvalue": { "type": "number", "format": "double" }, "cFeeAmount": { "type": "number", "format": "double" }, "dtEditDate": { "type": "string", "format": "date-time" }, "sEditedBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "dtCreateDate": { "type": "string", "format": "date-time" }, "sCreatedBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "billShares": { "type": "number", "format": "double" }, "transDate": { "type": "string", "format": "date-time" }, "assetProportion": { "type": "number", "format": "double" }, "tieredVal": { "type": "number", "format": "double" }, "fkTransaction": { "type": "integer", "format": "int32" }, "fkBillInstance": { "type": "integer", "format": "int32" }, "accruedInterest": { "type": "number", "format": "double" }, "asset": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Asset" }, "billAccountItem": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAccountItem" }, "transaction": { "$ref": "#/definitions/OAS.DataModel.Trading.Transaction" } }, "xml": { "name": "BillAssetItem" }, "type": "object" }, "OAS.DataModel.Billing.PayableItem": { "required": [ "id", "billAccountItemId", "payeeId", "billStatusId", "billEntityId", "initialAmount", "balanceDue", "calcDate", "editedDate", "editedBy", "createdDate", "createdBy", "isLocked", "isPoints", "hasBeenReported" ], "properties": { "id": { "type": "integer", "format": "int32" }, "billAccountItemId": { "type": "integer", "format": "int32" }, "payeeId": { "type": "integer", "format": "int32" }, "billStatusId": { "type": "integer", "format": "int32" }, "billEntityId": { "type": "integer", "format": "int32" }, "initialAmount": { "type": "number", "format": "double" }, "balanceDue": { "type": "number", "format": "double" }, "calcDate": { "type": "string", "format": "date-time" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "oldReceivableId": { "type": "integer", "format": "int32" }, "isLocked": { "type": "boolean" }, "aggregateValue": { "type": "number", "format": "double" }, "payoutSchedule": { "type": "string", "maxLength": 50, "minLength": 0 }, "error": { "type": "string", "maxLength": 200, "minLength": 0 }, "payPercent": { "type": "number", "format": "double" }, "tempPayableItemId": { "type": "integer", "format": "int32" }, "billInstanceId": { "type": "integer", "format": "int32" }, "basis": { "type": "integer", "format": "int32" }, "isPoints": { "type": "boolean" }, "hasBeenReported": { "type": "boolean" }, "adjustments": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.PayableItemAdjustment" }, "xml": { "name": "PayableItemAdjustment", "wrapped": true }, "type": "array" }, "payee": { "$ref": "#/definitions/OAS.DataModel.Billing.Payee" }, "billEntity": { "$ref": "#/definitions/OAS.DataModel.Billing.BillEntity" }, "billAccountItem": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAccountItem" }, "notes": { "type": "string" } }, "xml": { "name": "PayableItem" }, "type": "object" }, "OAS.DataModel.Portfolio.Asset": { "required": [ "id", "accountId", "productId", "createdDate", "isActive", "pendingCalls", "isManaged", "isStrategyOverride", "isAdvReportable", "is13FReportable" ], "properties": { "id": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "downloadSymbolId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "createdDate": { "type": "string", "format": "date-time" }, "accountNumber": { "type": "string", "maxLength": 50, "minLength": 0 }, "isActive": { "type": "boolean" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "lastBuyDate": { "type": "string", "format": "date-time" }, "isSCAPReinvested": { "type": "boolean" }, "isLCAPReinvested": { "type": "boolean" }, "isDIVReinvested": { "type": "boolean" }, "dwnldTypeId": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "isNASent": { "type": "boolean" }, "importKey": { "type": "string", "maxLength": 20, "minLength": 0 }, "secondaryAccountNumber": { "type": "string", "maxLength": 50, "minLength": 0 }, "isTradeBlocked": { "type": "boolean" }, "lastReconDate": { "type": "string", "format": "date-time" }, "expectedReconDate": { "type": "string", "format": "date-time" }, "tradeBlockReason": { "type": "string", "maxLength": 20, "minLength": 0 }, "assetLevelStrategyId": { "type": "integer", "format": "int32" }, "pendingCalls": { "type": "integer", "format": "int32" }, "isManaged": { "type": "boolean" }, "assetStatus": { "type": "string", "enum": [ "Undefined", "NormalDownloading", "ManuallyManaged", "Alternative" ] }, "isStrategyOverride": { "type": "boolean" }, "isAdvisorOnly": { "type": "boolean" }, "isAdvReportable": { "type": "boolean" }, "is13FReportable": { "type": "boolean" }, "excludedFromPositionOnly": { "type": "boolean" }, "dailyChangeTolerance": { "type": "number", "format": "double" }, "mscsFundAccountNumber": { "type": "string" }, "isOrionVision": { "type": "boolean" }, "custodianCommonIdList": { "type": "string" }, "assetLevelStrategy": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AssetLevelStrategy" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" }, "product": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductLocal" }, "assetValues": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AssetValue" }, "xml": { "name": "AssetValue", "wrapped": true }, "type": "array" }, "live": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AssetLive" }, "cache": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AssetCache" }, "excludedFromRebalance": { "$ref": "#/definitions/OAS.DataModel.Trading.AssetExcludedFromRebalance" }, "transactions": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.Transaction" }, "xml": { "name": "Transaction", "wrapped": true }, "type": "array" }, "billAssets": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAsset" }, "xml": { "name": "BillAsset", "wrapped": true }, "type": "array" }, "billAssetsAdditionalInfo": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAssetAdditionalInfo" }, "xml": { "name": "BillAssetAdditionalInfo", "wrapped": true }, "type": "array" }, "systematicAccounts": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SystematicAccount" }, "xml": { "name": "SystematicAccount", "wrapped": true }, "type": "array" }, "billAssetAdditionalInfoForEF": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAssetAdditionalInfoForEF" }, "stepups": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AssetStepUp" }, "xml": { "name": "AssetStepUp", "wrapped": true }, "type": "array" }, "bifurcates": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AssetBifurcate" }, "xml": { "name": "AssetBifurcate", "wrapped": true }, "type": "array" }, "costBasisHistories": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AssetCostBasisHistory" }, "xml": { "name": "AssetCostBasisHistory", "wrapped": true }, "type": "array" }, "loans": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AssetLoan" }, "xml": { "name": "AssetLoan", "wrapped": true }, "type": "array" }, "downloadSymbol": { "$ref": "#/definitions/OAS.DataModel.Portfolio.DownloadSymbol" }, "costBasisLots": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.CurrentUnrealizedAssetCost" }, "xml": { "name": "CurrentUnrealizedAssetCost", "wrapped": true }, "type": "array" }, "custodianOnlyCostBasis": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AssetCostCustodianOnlyUnrealizedCurrent" }, "xml": { "name": "AssetCostCustodianOnlyUnrealizedCurrent", "wrapped": true }, "type": "array" }, "assetConfirmErrors": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.AssetConfirmError" }, "xml": { "name": "AssetConfirmError", "wrapped": true }, "type": "array" }, "assetPositionOnlyBalances": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.AssetPositionOnlyBalance" }, "xml": { "name": "AssetPositionOnlyBalance", "wrapped": true }, "type": "array" }, "commitments": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.Alternative.CommitmentLedger" }, "xml": { "name": "CommitmentLedger", "wrapped": true }, "type": "array" }, "alternativeSchedules": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.Alternative.AlternativeSchedule" }, "xml": { "name": "AlternativeSchedule", "wrapped": true }, "type": "array" }, "taxErrors": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.TaxError" }, "xml": { "name": "TaxError", "wrapped": true }, "type": "array" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.AssetEntityOption" }, "xml": { "name": "AssetEntityOption", "wrapped": true }, "type": "array" }, "userDefinedFields": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.AssetUserDefinedField" }, "xml": { "name": "AssetUserDefinedField", "wrapped": true }, "type": "array" }, "userDefinedTimeFields": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.AssetUserDefinedTimeField" }, "xml": { "name": "AssetUserDefinedTimeField", "wrapped": true }, "type": "array" } }, "xml": { "name": "Asset" }, "type": "object" }, "OAS.DataModel.Portfolio.Account": { "required": [ "id", "registrationId", "fundFamilyId", "isActive", "isSweepAcct", "createdDate", "accountStatusId", "isPhoneAuthorized", "isManaged", "isOps", "isDiscretionary", "isWrapManaged", "isWrapSponsored", "isAdvReportable", "is13FReportable", "isAuaReportable", "isPositionOnlyRecon" ], "properties": { "id": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "fundFamilyId": { "type": "integer", "format": "int32" }, "shareClassId": { "type": "integer", "format": "int32" }, "platformId": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "isSweepAcct": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedByOverride": { "type": "string", "maxLength": 50, "minLength": 0 }, "provider": { "type": "string", "maxLength": 10, "minLength": 0 }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "cancelDate": { "type": "string", "format": "date-time" }, "cancelValue": { "type": "number", "format": "double" }, "isTradingBlocked": { "type": "boolean" }, "tradingInstructions": { "type": "string" }, "outsideId": { "type": "string", "maxLength": 50, "minLength": 0 }, "groupNumber": { "type": "string", "maxLength": 25, "minLength": 0 }, "subAdvisorId": { "type": "integer", "format": "int32" }, "importKey": { "type": "string", "maxLength": 20, "minLength": 0 }, "startDate": { "type": "string", "format": "date-time" }, "startValue": { "type": "number", "format": "double" }, "isOrigSMCAcct": { "type": "boolean" }, "planId": { "type": "integer", "format": "int32" }, "signatureStatus": { "type": "string", "maxLength": 100, "minLength": 0 }, "accountStatusId": { "type": "integer", "format": "int32" }, "isPhoneAuthorized": { "type": "boolean" }, "accountHistoryId": { "type": "integer", "format": "int32" }, "sweepAssetId": { "type": "integer", "format": "int32" }, "initialPurchaseDate": { "type": "string", "format": "date-time" }, "accountHistoryUniqueId": { "type": "integer", "format": "int32" }, "isManaged": { "type": "boolean" }, "isOps": { "type": "boolean" }, "downloadSourceId": { "type": "integer", "format": "int32" }, "accountHistoryBillingId": { "type": "integer", "format": "int32" }, "accountHistoryBillingUniqueId": { "type": "integer", "format": "int32" }, "riskScore": { "type": "number", "format": "double" }, "isDiscretionary": { "type": "boolean" }, "isUnfunded": { "type": "boolean" }, "isBundled": { "type": "boolean" }, "isExcludedFromFirmAssets": { "type": "boolean" }, "isWrapManaged": { "type": "boolean" }, "isWrapSponsored": { "type": "boolean" }, "isAdvReportable": { "type": "boolean" }, "is13FReportable": { "type": "boolean" }, "isAuaReportable": { "type": "boolean" }, "custodialRepCode": { "type": "string" }, "isPositionOnlyRecon": { "type": "boolean" }, "eclipseFirmId": { "type": "integer", "format": "int32" }, "currentDownloadError": { "type": "string" }, "prevDownloadError": { "type": "string" }, "advCustodyTypeId": { "type": "integer", "format": "int32" }, "custodianCommonIdList": { "type": "string" }, "nickname": { "type": "string", "maxLength": 100, "minLength": 0 }, "overlayId": { "type": "integer", "format": "int32" }, "custodian": { "$ref": "#/definitions/OAS.DataModel.Portfolio.CustodianLocal" }, "registration": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Registration" }, "historicAccount": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" }, "historicAccountBilling": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" }, "assets": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Asset" }, "xml": { "name": "Asset", "wrapped": true }, "type": "array" }, "accountValues": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AccountValue" }, "xml": { "name": "AccountValue", "wrapped": true }, "type": "array" }, "fundFamily": { "$ref": "#/definitions/OAS.DataModel.Portfolio.FundFamilyLocal" }, "additionalClients": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ClientAccountAdditional" }, "xml": { "name": "ClientAccountAdditional", "wrapped": true }, "type": "array" }, "subAdvisor": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SubAdvisor" }, "platform": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Platform" }, "modelingInfo": { "$ref": "#/definitions/OAS.DataModel.Trading.ModelAccount" }, "info": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AccountAdditionalInfo" }, "plan": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Plan" }, "businessLine": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AccountBusinessLine" }, "accountCode": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AccountCode" }, "accountManagers": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AccountManager" }, "xml": { "name": "AccountManager", "wrapped": true }, "type": "array" }, "billAccounts": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAccount" }, "xml": { "name": "BillAccount", "wrapped": true }, "type": "array" }, "billAccountInfoForEF": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAccountInfoForEF" }, "billPaysForAccounts": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillPayForAccount" }, "xml": { "name": "BillPayForAccount", "wrapped": true }, "type": "array" }, "billPaysForHouseholds": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillPaysForHousehold" }, "xml": { "name": "BillPaysForHousehold", "wrapped": true }, "type": "array" }, "billPaysForRegistrations": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillPaysForRegistration" }, "xml": { "name": "BillPaysForRegistration", "wrapped": true }, "type": "array" }, "billAdditionalAnnualAmounts": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAccountAdditionalAnnualAmount" }, "xml": { "name": "BillAccountAdditionalAnnualAmount", "wrapped": true }, "type": "array" }, "generalAccountDetails": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.GeneralAccountDetail" }, "xml": { "name": "GeneralAccountDetail", "wrapped": true }, "type": "array" }, "changes": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AccountChange" }, "xml": { "name": "AccountChange", "wrapped": true }, "type": "array" }, "changeHistories": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AccountChangeHistory" }, "xml": { "name": "AccountChangeHistory", "wrapped": true }, "type": "array" }, "shareClass": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ShareClass" }, "notes": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AccountNote" }, "xml": { "name": "AccountNote", "wrapped": true }, "type": "array" }, "blobs": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AccountBlob" }, "xml": { "name": "AccountBlob", "wrapped": true }, "type": "array" }, "systematics": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SystematicAccount" }, "xml": { "name": "SystematicAccount", "wrapped": true }, "type": "array" }, "sleeve": { "$ref": "#/definitions/OAS.DataModel.Trading.AccountSleeve" }, "accountStatus": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AccountStatus" }, "downloadSource": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadSource" }, "rmdCalculationSummary": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AccountRmdCalculationSummary" }, "referralSchedules": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.AccountReferral" }, "xml": { "name": "AccountReferral", "wrapped": true }, "type": "array" }, "audits": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AccountAudit" }, "xml": { "name": "AccountAudit", "wrapped": true }, "type": "array" }, "swpDcaSummary": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AccountExtSwpDcaSummary" }, "targetCashSummary": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AccountExtTargetCashSummary" }, "missingAccountInfo": { "$ref": "#/definitions/OAS.DataModel.Portfolio.MissingAccountInfo" }, "linkedToHistoryAccountWithValue": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AccountFilterLinkedToHistoryAccountWithValue" }, "recursivelyLinked": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AccountFilterRecursivelyLinked" }, "linkedWithNoTransactions": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AccountFilterLinkedWithNoTransactions" }, "xml": { "name": "AccountFilterLinkedWithNoTransactions", "wrapped": true }, "type": "array" }, "strewnAcrossMultipleAccounts": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AccountFilterStrewnAcrossMultipleAccounts" }, "xml": { "name": "AccountFilterStrewnAcrossMultipleAccounts", "wrapped": true }, "type": "array" }, "rmdYearOverrides": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AccountRmdYearOverride" }, "xml": { "name": "AccountRmdYearOverride", "wrapped": true }, "type": "array" }, "rmdYearOverrideAudits": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AccountRmdYearOverrideAudit" }, "xml": { "name": "AccountRmdYearOverrideAudit", "wrapped": true }, "type": "array" }, "sweepAsset": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Asset" }, "targetAllocations": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AccountTargetAllocation" }, "xml": { "name": "AccountTargetAllocation", "wrapped": true }, "type": "array" }, "productEquivalents": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AccountProductEquivalent" }, "xml": { "name": "AccountProductEquivalent", "wrapped": true }, "type": "array" }, "sma": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AccountExtSma" }, "bondTrade": { "$ref": "#/definitions/OAS.DataModel.Trading.AccountBondTrade" }, "compositeExclusions": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.CompositeAccountExclude" }, "xml": { "name": "CompositeAccountExclude", "wrapped": true }, "type": "array" }, "modelRestrictionEligibleAccounts": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.ModelRestrictionEligibleAccount" }, "xml": { "name": "ModelRestrictionEligibleAccount", "wrapped": true }, "type": "array" }, "modelAggregateRestrictionEligibleAccount": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.ModelAggregateRestrictionEligibleAccount" }, "xml": { "name": "ModelAggregateRestrictionEligibleAccount", "wrapped": true }, "type": "array" }, "userDefinedPageCodes": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.AccountUserDefinedPageCode" }, "xml": { "name": "AccountUserDefinedPageCode", "wrapped": true }, "type": "array" }, "futureCashflows": { "items": { "$ref": "#/definitions/OAS.DataModel.Theoretical.AccountFutureCashflow" }, "xml": { "name": "AccountFutureCashflow", "wrapped": true }, "type": "array" }, "growthRates": { "items": { "$ref": "#/definitions/OAS.DataModel.Theoretical.AccountGrowthRate" }, "xml": { "name": "AccountGrowthRate", "wrapped": true }, "type": "array" }, "taxRates": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AccountTaxRate" }, "xml": { "name": "AccountTaxRate", "wrapped": true }, "type": "array" }, "goals": { "items": { "$ref": "#/definitions/OAS.DataModel.Theoretical.AccountGoal" }, "xml": { "name": "AccountGoal", "wrapped": true }, "type": "array" }, "dailyAnnuityiValues": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.DailyAnnuityValue" }, "xml": { "name": "DailyAnnuityValue", "wrapped": true }, "type": "array" }, "suitability": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AccountExtSuitability" }, "accountAnnuities": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AccountAnnuity" }, "xml": { "name": "AccountAnnuity", "wrapped": true }, "type": "array" }, "riskScoreTable": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AccountRiskScoreTable" }, "sloas": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AccountSloa" }, "xml": { "name": "AccountSloa", "wrapped": true }, "type": "array" }, "permissibleAggregateModels": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AccountPermissibleAggregateModel" }, "xml": { "name": "AccountPermissibleAggregateModel", "wrapped": true }, "type": "array" }, "portfolioGroups": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.PortfolioGroupAccount" }, "xml": { "name": "PortfolioGroupAccount", "wrapped": true }, "type": "array" }, "portfolioGroupSrcAccounts": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.PortfolioGroupSrcAccount" }, "xml": { "name": "PortfolioGroupSrcAccount", "wrapped": true }, "type": "array" }, "astroTaxSchedules": { "items": { "$ref": "#/definitions/OAS.DataModel.Integration.Astro.AstroAccountTaxSchedule" }, "xml": { "name": "AstroAccountTaxSchedule", "wrapped": true }, "type": "array" }, "astroAccount": { "$ref": "#/definitions/OAS.DataModel.Integration.Astro.AstroAccount" }, "accountFeeHierarchy": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.FeeHierarchyAccount" }, "xml": { "name": "FeeHierarchyAccount", "wrapped": true }, "type": "array" }, "accountBalanceStatus": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AccountBalanceStatus" }, "registrationCustodianBeneficiaries": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.RegistrationCustodianBeneficiary" }, "xml": { "name": "RegistrationCustodianBeneficiary", "wrapped": true }, "type": "array" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.AccountEntityOption" }, "xml": { "name": "AccountEntityOption", "wrapped": true }, "type": "array" }, "userDefinedFields": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.AccountUserDefinedField" }, "xml": { "name": "AccountUserDefinedField", "wrapped": true }, "type": "array" }, "enableMode": { "type": "boolean" }, "eclipseEtlVersion": { "type": "integer", "format": "int32" }, "requestedById": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "automatedAccountCreation": { "type": "boolean" }, "suppressTradeCreation": { "type": "boolean" }, "tradeQueueStatus": { "type": "string", "enum": [ "Complete", "Pending", "Failed", "Disabled", "Duplicate", "Processing", "Manual" ] } }, "xml": { "name": "Account" }, "type": "object" }, "OAS.DataModel.Billing.BillStatus": { "required": [ "id", "sBillStatus", "sBillStatusDesc", "itemData", "isPayable" ], "properties": { "id": { "type": "integer", "format": "int32" }, "sBillStatus": { "type": "string", "maxLength": 50, "minLength": 0 }, "sBillStatusDesc": { "type": "string", "maxLength": 255, "minLength": 0 }, "itemData": { "type": "integer", "format": "int32" }, "isPayable": { "type": "boolean" } }, "xml": { "name": "BillStatus" }, "type": "object" }, "OAS.DataModel.Billing.BillEntity": { "required": [ "id", "entityName", "isPayableEntity", "isUserAdded" ], "properties": { "id": { "type": "integer", "format": "int32" }, "entityName": { "type": "string", "maxLength": 20, "minLength": 0 }, "entityDescription": { "type": "string", "maxLength": 255, "minLength": 0 }, "isPayableEntity": { "type": "boolean" }, "isUserAdded": { "type": "boolean" }, "isActive": { "type": "boolean" }, "isApplyToAstro": { "type": "boolean" }, "excludeFromRefundCalculations": { "type": "boolean" }, "separateOnFeeFile": { "type": "boolean" }, "payeeId": { "type": "integer", "format": "int32" }, "collectFromId": { "type": "integer", "format": "int32" }, "billEntityReportAsId": { "type": "integer", "format": "int32" }, "payee": { "$ref": "#/definitions/OAS.DataModel.Billing.Payee" }, "billEntityReportAs": { "$ref": "#/definitions/OAS.DataModel.Billing.BillEntity" }, "reportsForBillEntites": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillEntity" }, "xml": { "name": "BillEntity", "wrapped": true }, "type": "array" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "createDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" } }, "xml": { "name": "BillEntity" }, "type": "object" }, "OAS.DataModel.Billing.BillPayForAccount": { "required": [ "id", "billAccountId", "accountId", "percent", "isActive", "editedDate", "editedby", "createdDate", "createdBy" ], "properties": { "id": { "type": "integer", "format": "int32" }, "billAccountId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "percent": { "type": "number", "format": "double" }, "timestamp": { "type": "string", "format": "byte" }, "isActive": { "type": "boolean" }, "editedDate": { "type": "string", "format": "date-time" }, "editedby": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" }, "billAccount": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAccount" } }, "xml": { "name": "BillPayForAccount" }, "type": "object" }, "OAS.DataModel.Billing.BillPayForAccountDetail": { "properties": { "id": { "type": "integer", "format": "int32" }, "billAccountId": { "type": "integer", "format": "int32" }, "accountNumbers": { "type": "string" }, "accountStatus": { "type": "string" }, "billAccount": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAccount" } }, "xml": { "name": "BillPayForAccountDetail" }, "type": "object" }, "OAS.DataModel.Billing.BillAccountSchedule": { "required": [ "id", "billAccountId", "billScheduleId", "assignmentType" ], "properties": { "id": { "type": "integer", "format": "int32" }, "billAccountId": { "type": "integer", "format": "int32" }, "billScheduleId": { "type": "integer", "format": "int32" }, "assignmentType": { "type": "string", "enum": [ "Undefined", "ProductCategory", "ProductClass", "RiskCategory", "AssetCategory", "Ticker", "SecurityClassification" ] }, "category": { "type": "string", "maxLength": 20, "minLength": 0 }, "productClassId": { "type": "integer", "format": "int32" }, "riskCategoryId": { "type": "integer", "format": "int32" }, "productCategoryId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "securityClassificationMethodId": { "type": "integer", "format": "int32" }, "securityClassId": { "type": "integer", "format": "int32" }, "billSchedule": { "$ref": "#/definitions/OAS.DataModel.Billing.BillSchedule" }, "productClass": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductClass" }, "riskCategory": { "$ref": "#/definitions/OAS.DataModel.Portfolio.RiskCategory" }, "productCategory": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductCategory" }, "product": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductLocal" }, "securityClassificationMethod": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SecurityClassification.MethodLocal" }, "securityClass": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SecurityClassification.SecurityClassLocal" } }, "xml": { "name": "BillAccountSchedule" }, "type": "object" }, "OAS.DataModel.Billing.BillMasterSchedule": { "required": [ "id", "name", "isPoints", "editedDate", "createdDate", "createdBy", "isDefault" ], "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "isPoints": { "type": "boolean" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "timestamp": { "type": "string", "format": "byte" }, "description": { "type": "string", "maxLength": 200, "minLength": 0 }, "isDefault": { "type": "boolean" }, "billAccounts": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAccount" }, "xml": { "name": "BillAccount", "wrapped": true }, "type": "array" }, "details": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillMasterScheduleDetail" }, "xml": { "name": "BillMasterScheduleDetail", "wrapped": true }, "type": "array" } }, "xml": { "name": "BillMasterSchedule" }, "type": "object" }, "OAS.DataModel.Billing.BillPayMethod": { "required": [ "id", "payInstruction", "itemData" ], "properties": { "id": { "type": "integer", "format": "int32" }, "payInstruction": { "type": "string", "maxLength": 20, "minLength": 0 }, "payDescription": { "type": "string", "maxLength": 255, "minLength": 0 }, "itemData": { "type": "integer", "format": "int32" }, "invoiceVerbage": { "type": "string", "maxLength": 1000, "minLength": 0 }, "dayOfMonthDue": { "type": "integer", "format": "int32" }, "paymentType": { "type": "string", "enum": [ "None", "FeeFile", "Check", "CreditCard", "ACH", "Special" ] }, "uploadTargetId": { "type": "integer", "format": "int32" } }, "xml": { "name": "BillPayMethod" }, "type": "object" }, "OAS.DataModel.Billing.BillSchedule": { "required": [ "id", "name", "scheduleType", "schedule", "basis", "minimumFee", "howBilled", "isActive" ], "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "scheduleType": { "type": "string", "maxLength": 10, "minLength": 0 }, "schedule": { "type": "string", "enum": [ "Undefined", "Fee", "Payout", "BDOverride", "Remainder", "PerformanceFee", "PerformancePayout" ] }, "basis": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "billEntityId": { "type": "integer", "format": "int32" }, "description": { "type": "string", "maxLength": 200, "minLength": 0 }, "minimumFee": { "type": "number", "format": "double" }, "howBilled": { "type": "integer", "format": "int32" }, "scheduleCode": { "type": "string", "maxLength": 10, "minLength": 0 }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "isPayoutCreditOffset": { "type": "boolean" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "showInFeeCalculator": { "type": "boolean" }, "minFeeAcctValueThreshold": { "type": "number", "format": "double" }, "linearBreakpointMaximums": { "type": "boolean" }, "aggregateByHousehold": { "type": "boolean" }, "billMasterScheduleDetails": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillMasterScheduleDetail" }, "xml": { "name": "BillMasterScheduleDetail", "wrapped": true }, "type": "array" }, "billEntity": { "$ref": "#/definitions/OAS.DataModel.Billing.BillEntity" }, "details": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillScheduleDetail" }, "xml": { "name": "BillScheduleDetail", "wrapped": true }, "type": "array" } }, "xml": { "name": "BillSchedule" }, "type": "object" }, "OAS.DataModel.Billing.BillAccountEntityPayee": { "required": [ "billAccountId", "billEntityId", "payeeId" ], "properties": { "billAccountId": { "type": "integer", "format": "int32" }, "billEntityId": { "type": "integer", "format": "int32" }, "payeeId": { "type": "integer", "format": "int32" }, "payee": { "$ref": "#/definitions/OAS.DataModel.Billing.Payee" }, "billingAccount": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAccount" } }, "xml": { "name": "BillAccountEntityPayee" }, "type": "object" }, "OAS.DataModel.Billing.BillPaysForAccountAcctCodes": { "required": [ "billAccountId" ], "properties": { "billAccountId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "accountNumbers": { "type": "string", "maxLength": 8000, "minLength": 0 }, "paysForAccountIsActive": { "type": "boolean" }, "billAccount": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAccount" } }, "xml": { "name": "BillPaysForAccountAcctCodes" }, "type": "object" }, "OAS.DataModel.Billing.BillAccountForEF": { "required": [ "billAccountId", "billClientStatusId" ], "properties": { "billAccountId": { "type": "integer", "format": "int32" }, "billClientStatusId": { "type": "string", "enum": [ "ReadyToBill", "Hold", "PendingReview" ] }, "revPayNoFeeAgg": { "type": "string" }, "businessLine": { "type": "string", "maxLength": 255, "minLength": 0 }, "paidForByAccountId": { "type": "integer", "format": "int32" } }, "xml": { "name": "BillAccountForEF" }, "type": "object" }, "OAS.DataModel.Billing.BillAccountLastBilledThroughDate": { "required": [ "billAccountId" ], "properties": { "billAccountId": { "type": "integer", "format": "int32" }, "lastBilledDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "BillAccountLastBilledThroughDate" }, "type": "object" }, "OAS.DataModel.Billing.Bill": { "required": [ "id", "billClientId", "billTransmitMethodId", "calcDate", "editDate", "editedBy", "createDate", "createdBy", "isValid" ], "properties": { "id": { "type": "integer", "format": "int32" }, "billClientId": { "type": "integer", "format": "int32" }, "billTransmitMethodId": { "type": "integer", "format": "int32" }, "blobId": { "type": "integer", "format": "int32" }, "calcDate": { "type": "string", "format": "date-time" }, "editDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "createDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "isValid": { "type": "integer", "format": "int32" }, "timestamp": { "type": "string", "format": "byte" }, "oldInvoiceNo": { "type": "integer", "format": "int32" }, "billTypeId": { "type": "integer", "format": "int32" }, "billInstanceId": { "type": "integer", "format": "int32" }, "clientStampId": { "type": "integer", "format": "int32" }, "isRecalc": { "type": "boolean" }, "transmitMethod": { "$ref": "#/definitions/OAS.DataModel.Billing.BillTransmitMethod" }, "billClient": { "$ref": "#/definitions/OAS.DataModel.Billing.BillClient" }, "billType": { "$ref": "#/definitions/OAS.DataModel.Billing.BillType" }, "items": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillItem" }, "xml": { "name": "BillItem", "wrapped": true }, "type": "array" }, "instance": { "$ref": "#/definitions/OAS.DataModel.Billing.BillInstance" }, "info": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAdditionalInfo" }, "log": { "$ref": "#/definitions/OAS.DataModel.Billing.BillLog" } }, "xml": { "name": "Bill" }, "type": "object" }, "OAS.DataModel.Billing.BillPayment": { "required": [ "id", "checkAmt", "createdBy", "editedDate", "editedBy", "tranOrigin", "balance" ], "properties": { "id": { "type": "integer", "format": "int32" }, "billPayMethodId": { "type": "integer", "format": "int32" }, "paymentNumber": { "type": "string", "maxLength": 30, "minLength": 0 }, "batchNumber": { "type": "string", "maxLength": 30, "minLength": 0 }, "checkAmt": { "type": "number", "format": "double" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "posted": { "type": "string", "format": "date-time" }, "tranOrigin": { "type": "string", "maxLength": 100, "minLength": 0 }, "balance": { "type": "number", "format": "double" }, "rowVersion": { "type": "string", "format": "byte", "maxLength": 8 }, "oldReceivableID": { "type": "integer", "format": "int32" } }, "xml": { "name": "BillPayment" }, "type": "object" }, "OAS.DataModel.Billing.BillAdjustmentType": { "required": [ "id", "isPayable", "adjustmentType", "isDebit" ], "properties": { "id": { "type": "integer", "format": "int32" }, "isPayable": { "type": "boolean" }, "adjustmentType": { "type": "string", "maxLength": 20, "minLength": 0 }, "isDebit": { "type": "boolean" }, "description": { "type": "string", "maxLength": 255, "minLength": 0 }, "isPayableAffect": { "type": "boolean" }, "isNet": { "type": "boolean" }, "isExcludedEU": { "type": "boolean" }, "transactionType": { "type": "string" }, "feeFileGroup": { "type": "integer", "format": "int32" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 } }, "xml": { "name": "BillAdjustmentType" }, "type": "object" }, "OAS.DataModel.Trading.Transaction": { "required": [ "id", "transTypeId", "assetId", "transDate", "transAmount", "navPrice", "noUnits", "tradeStatus", "isBilled", "isNewMoneyReady", "isAdvanceBilled" ], "properties": { "id": { "type": "integer", "format": "int32" }, "transTypeId": { "type": "integer", "format": "int32" }, "transactionSubTypeId": { "type": "integer", "format": "int32" }, "assetId": { "type": "integer", "format": "int32" }, "transDate": { "type": "string", "format": "date-time" }, "settleDate": { "type": "string", "format": "date-time" }, "transAmount": { "type": "number", "format": "double" }, "navPrice": { "type": "number", "format": "double" }, "noUnits": { "type": "number", "format": "double" }, "audit": { "$ref": "#/definitions/OAT.DataModel.ComplexTypes.BasicAuditNotNullNull" }, "tradeStatus": { "type": "string", "enum": [ "Complete", "Pending", "Rejected", "Reversed", "Inactive", "PendingCorpAction", "FutureAip" ] }, "isBilled": { "type": "boolean" }, "isNewMoneyReady": { "type": "boolean" }, "dpInstanceId": { "type": "integer", "format": "int32" }, "dwnldPrepId": { "type": "integer", "format": "int32" }, "notes": { "type": "string", "maxLength": 255, "minLength": 0 }, "transTime": { "type": "string", "format": "date-time" }, "importKey": { "type": "string", "maxLength": 20, "minLength": 0 }, "importTime": { "type": "string", "format": "date-time" }, "swpDate": { "type": "string", "format": "date-time" }, "isAdvanceBilled": { "type": "boolean" }, "state": { "type": "string", "maxLength": 2, "minLength": 0 }, "distributionCodeId": { "type": "integer", "format": "int32" }, "contributionCodeId": { "type": "integer", "format": "int32" }, "tradeRefNum": { "type": "string", "maxLength": 20, "minLength": 0 }, "tradeRequestId": { "type": "integer", "format": "int32" }, "tranLinkCode": { "type": "string", "maxLength": 25, "minLength": 0 }, "payeeId": { "type": "integer", "format": "int32" }, "advisorNotes": { "type": "string", "maxLength": 255, "minLength": 0 }, "eclipseOrderId": { "type": "integer", "format": "int32" }, "performanceFeeBreak": { "type": "boolean" }, "fileTranCode": { "type": "string", "maxLength": 50, "minLength": 0 }, "asset": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Asset" }, "transType": { "$ref": "#/definitions/OAS.DataModel.Trading.TransactionType" }, "transactionSubType": { "$ref": "#/definitions/OAS.DataModel.Trading.TransactionSubType" }, "fixTradeRequests": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.FixTradeRequest" }, "xml": { "name": "FixTradeRequest", "wrapped": true }, "type": "array" }, "contributionCode": { "$ref": "#/definitions/OAS.DataModel.Trading.ContributionCode" }, "distributionCode": { "$ref": "#/definitions/OAS.DataModel.Trading.DistributionCode" }, "extension": { "$ref": "#/definitions/OAS.DataModel.Trading.TransactionExt" }, "alternative": { "$ref": "#/definitions/OAS.DataModel.Trading.TransactionExtAlternative" }, "costBasis": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.TranCostBasis" }, "xml": { "name": "TranCostBasis", "wrapped": true }, "type": "array" }, "transactionCommission": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.TransactionCommission" }, "xml": { "name": "TransactionCommission", "wrapped": true }, "type": "array" }, "transactionFee": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.TransactionFee" }, "xml": { "name": "TransactionFee", "wrapped": true }, "type": "array" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.TransactionEntityOption" }, "xml": { "name": "TransactionEntityOption", "wrapped": true }, "type": "array" }, "unitBalance": { "$ref": "#/definitions/OAS.DataModel.Trading.TransactionUnitBalance" }, "billAssetItems": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAssetItem" }, "xml": { "name": "BillAssetItem", "wrapped": true }, "type": "array" }, "userDefinedFields": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.TransactionUserDefinedField" }, "xml": { "name": "TransactionUserDefinedField", "wrapped": true }, "type": "array" }, "errors": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.TransactionTaxError" }, "xml": { "name": "TransactionTaxError", "wrapped": true }, "type": "array" }, "errorSummary": { "$ref": "#/definitions/OAS.DataModel.Confirm.TransactionTaxErrorSummary" } }, "xml": { "name": "Transaction" }, "type": "object" }, "OAS.DataModel.Billing.PayableItemAdjustment": { "required": [ "id", "payableItemId", "billAdjustmentTypeId", "previousBalance", "currentBalance", "changeAmount", "editedDate", "editedBy", "createdDate", "createdBy", "billEntityId", "isLocked" ], "properties": { "id": { "type": "integer", "format": "int32" }, "payableItemId": { "type": "integer", "format": "int32" }, "billAdjustmentTypeId": { "type": "integer", "format": "int32" }, "payoutDashboardPaymentId": { "type": "integer", "format": "int32" }, "previousBalance": { "type": "number", "format": "double" }, "currentBalance": { "type": "number", "format": "double" }, "changeAmount": { "type": "number", "format": "double" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "dateOccured": { "type": "string", "format": "date-time" }, "dtStartDate": { "type": "string", "format": "date-time" }, "dtEndDate": { "type": "string", "format": "date-time" }, "billEntityId": { "type": "integer", "format": "int32" }, "isLocked": { "type": "boolean" }, "billInstanceId": { "type": "integer", "format": "int32" }, "adjustmentType": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAdjustmentType" }, "payableItem": { "$ref": "#/definitions/OAS.DataModel.Billing.PayableItem" }, "billEntity": { "$ref": "#/definitions/OAS.DataModel.Billing.BillEntity" } }, "xml": { "name": "PayableItemAdjustment" }, "type": "object" }, "OAS.DataModel.Billing.Payee": { "required": [ "id", "personalId", "isActive" ], "properties": { "id": { "type": "integer", "format": "int32" }, "personalId": { "type": "integer", "format": "int32" }, "timeStamp": { "type": "string", "format": "byte" }, "oldAutoId": { "type": "integer", "format": "int32" }, "oldPayeeCode": { "type": "string", "maxLength": 50, "minLength": 0 }, "impDate": { "type": "string", "format": "date-time" }, "isActive": { "type": "boolean" }, "importKey": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "payoutOverride": { "type": "number", "format": "double" }, "personal": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Personal" }, "payableItems": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.PayableItem" }, "xml": { "name": "PayableItem", "wrapped": true }, "type": "array" }, "blobs": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.PayeeBlob" }, "xml": { "name": "PayeeBlob", "wrapped": true }, "type": "array" }, "reps": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Representative" }, "xml": { "name": "Representative", "wrapped": true }, "type": "array" } }, "xml": { "name": "Payee" }, "type": "object" }, "OAS.DataModel.Portfolio.AssetLevelStrategy": { "required": [ "id", "assetStrategy" ], "properties": { "id": { "type": "integer", "format": "int32" }, "assetStrategy": { "type": "string", "maxLength": 100, "minLength": 0 }, "color": { "type": "string", "maxLength": 50, "minLength": 0 }, "sortOrder": { "type": "integer", "format": "int32" }, "assignmentDefinitions": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AssetLevelStrategyAssign" }, "xml": { "name": "AssetLevelStrategyAssign", "wrapped": true }, "type": "array" } }, "xml": { "name": "AssetLevelStrategy" }, "type": "object" }, "OAS.DataModel.Portfolio.ProductLocal": { "required": [ "estimatedDividendFrequency", "id", "ticker", "isActive", "shareClassId", "defaultPrice", "tradesPerDay", "repurchaseBlockDays", "is144A", "allowIncomeOverride" ], "properties": { "productSubTypeId": { "type": "integer", "format": "int32" }, "estimatedDividendFrequency": { "type": "number", "format": "double" }, "audit": { "$ref": "#/definitions/OAT.DataModel.ComplexTypes.BasicAuditNotNullNull" }, "id": { "type": "integer", "format": "int32" }, "fundFamilyId": { "type": "integer", "format": "int32" }, "ticker": { "type": "string", "maxLength": 50, "minLength": 0 }, "cusip": { "type": "string", "maxLength": 50, "minLength": 0 }, "isin": { "type": "string", "maxLength": 50, "minLength": 0 }, "isActive": { "type": "boolean" }, "productName": { "type": "string", "maxLength": 150, "minLength": 0 }, "rowVersion": { "type": "string", "format": "byte" }, "importDate": { "type": "string", "format": "date-time" }, "shareClassId": { "type": "integer", "format": "int32" }, "apcCode": { "type": "string", "maxLength": 20, "minLength": 0 }, "micropalCode": { "type": "string", "maxLength": 20, "minLength": 0 }, "defaultPrice": { "type": "number", "format": "double" }, "convSchSells": { "type": "boolean" }, "productType": { "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, "fundNumber": { "type": "string", "maxLength": 20, "minLength": 0 }, "isUsePriceTime": { "type": "boolean" }, "tradeCutoffTime": { "type": "string", "format": "date-time" }, "estimateReportTime": { "type": "string", "format": "date-time" }, "estimateInterval": { "type": "integer", "format": "int32" }, "shortTermTradeFeeDays": { "type": "integer", "format": "int32" }, "shortTermTradeFeePercent": { "type": "number", "format": "double" }, "tradesPerDay": { "type": "integer", "format": "int32" }, "repurchaseBlockDays": { "type": "integer", "format": "int32" }, "is144A": { "type": "boolean" }, "productParentId": { "type": "integer", "format": "int32" }, "priceStatus": { "type": "string", "enum": [ "Normal", "Default", "Manual", "ReceivedMoreThan1Day", "InfrequentPricing", "SecurityIsWorthless", "IndeterminableValue", "NotActiveProduct" ] }, "subHoldingId": { "type": "integer", "format": "int32" }, "strikePrice": { "type": "number", "format": "double" }, "optionLotSize": { "type": "integer", "format": "int32" }, "expirationDate": { "type": "string", "format": "date-time" }, "allowIncomeOverride": { "type": "boolean" }, "isDividendSuspended": { "type": "boolean" }, "annualIncomeRate": { "type": "number", "format": "double" }, "paymentFrequency": { "type": "string", "enum": [ "AtMaturity", "Monthly", "BiMonthly", "Quarterly", "Triannually", "Semiannually", "Annually", "Biennially" ] }, "advAssetCategoryId": { "type": "integer", "format": "int32" }, "advAssetDescription": { "type": "string" }, "excludeFromCB": { "type": "boolean" }, "globalProductName": { "type": "string" }, "paymentCycleDateType": { "type": "string", "enum": [ "Normal", "NextBusinessDay", "PreviousBusinessDay" ] }, "isMLP": { "type": "boolean" }, "isIntervalFund": { "type": "boolean" }, "inceptionDate": { "type": "string", "format": "date-time" }, "shortTermDiscountObligation": { "type": "boolean" }, "parent": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductLocal" }, "productGroupRecord": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductGroup" }, "extension": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductExtension" }, "subType": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductSubType" }, "fundFamily": { "$ref": "#/definitions/OAS.DataModel.Portfolio.FundFamilyGlobalInLocal" }, "shareClass": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ShareClass" }, "assets": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Asset" }, "xml": { "name": "Asset", "wrapped": true }, "type": "array" }, "localPrices": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.PriceLocal" }, "xml": { "name": "PriceLocal", "wrapped": true }, "type": "array" }, "currentPrices": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.PriceCurrent" }, "xml": { "name": "PriceCurrent", "wrapped": true }, "type": "array" }, "downloadSymbols": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.DownloadSymbol" }, "xml": { "name": "DownloadSymbol", "wrapped": true }, "type": "array" }, "descriptionProviderDetail": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductDescriptionProviderFlat" }, "fundFamilyProducts": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.FundFamilyProductInLocal" }, "xml": { "name": "FundFamilyProductInLocal", "wrapped": true }, "type": "array" }, "aumSummary": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductAumSummary" }, "assumedRates": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AssumedRate" }, "xml": { "name": "AssumedRate", "wrapped": true }, "type": "array" }, "bondRates": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.BondRate" }, "xml": { "name": "BondRate", "wrapped": true }, "type": "array" }, "bondCalls": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductBondCall" }, "xml": { "name": "ProductBondCall", "wrapped": true }, "type": "array" }, "billProducts": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillProduct" }, "xml": { "name": "BillProduct", "wrapped": true }, "type": "array" }, "errors": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.ProductTaxError" }, "xml": { "name": "ProductTaxError", "wrapped": true }, "type": "array" }, "errorSummary": { "$ref": "#/definitions/OAS.DataModel.Confirm.ProductTaxErrorSummary" }, "alternativeExpectedReturns": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.Alternative.ExpectedReturn" }, "xml": { "name": "ExpectedReturn", "wrapped": true }, "type": "array" }, "info": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductLocalAdditionalInfo" }, "filter": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductLocalFilter" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.ProductEntityOption" }, "xml": { "name": "ProductEntityOption", "wrapped": true }, "type": "array" }, "userDefinedFields": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.ProductUserDefinedField" }, "xml": { "name": "ProductUserDefinedField", "wrapped": true }, "type": "array" }, "userDefinedTimeFields": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.ProductUserDefinedTimeField" }, "xml": { "name": "ProductUserDefinedTimeField", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProductLocal" }, "type": "object" }, "OAS.DataModel.Portfolio.AssetValue": { "required": [ "asOfDate", "assetId", "unitBalance", "navPrice", "editedDate" ], "properties": { "asOfDate": { "type": "integer", "format": "int32" }, "assetId": { "type": "integer", "format": "int32" }, "unitBalance": { "type": "number", "format": "double" }, "navPrice": { "type": "number", "format": "double" }, "value": { "type": "number", "format": "double" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "AssetValue" }, "type": "object" }, "OAS.DataModel.Portfolio.AssetLive": { "required": [ "id", "currShares", "pendShares", "assetStatus" ], "properties": { "id": { "type": "integer", "format": "int32" }, "currValue": { "type": "number", "format": "double" }, "currShares": { "type": "number", "format": "double" }, "pendValue": { "type": "number", "format": "double" }, "pendShares": { "type": "number", "format": "double" }, "actualNavPrice": { "type": "number", "format": "double" }, "actualPriceDate": { "type": "string", "format": "date-time" }, "actualCustodianCommon": { "type": "integer", "format": "int32" }, "assetStatus": { "type": "integer", "format": "int32" } }, "xml": { "name": "AssetLive" }, "type": "object" }, "OAS.DataModel.Portfolio.AssetCache": { "required": [ "id", "accountId", "currShares" ], "properties": { "id": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "currValue": { "type": "number", "format": "double" }, "currShares": { "type": "number", "format": "double" }, "navPrice": { "type": "number", "format": "double" } }, "xml": { "name": "AssetCache" }, "type": "object" }, "OAS.DataModel.Trading.AssetExcludedFromRebalance": { "required": [ "assetId" ], "properties": { "assetId": { "type": "integer", "format": "int32" }, "asset": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Asset" } }, "xml": { "name": "AssetExcludedFromRebalance" }, "type": "object" }, "OAS.DataModel.Billing.BillAsset": { "required": [ "id", "assetId", "isFeeExcluded", "isPayingFee", "excludeAmount", "excludeAmountType", "excludePercentOf" ], "properties": { "id": { "type": "integer", "format": "int32" }, "assetId": { "type": "integer", "format": "int32" }, "isFeeExcluded": { "type": "boolean" }, "isPayingFee": { "type": "boolean" }, "timestamp": { "type": "string", "format": "byte" }, "editedDate": { "type": "string", "format": "date-time" }, "editedby": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "excludeAmount": { "type": "number", "format": "double" }, "excludeAmountType": { "type": "string", "enum": [ "Percent", "Dollars", "Shares" ] }, "excludePercentOf": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "excludeStartDate": { "type": "string", "format": "date-time" }, "excludeEndDate": { "type": "string", "format": "date-time" }, "excludeFromMargin": { "type": "boolean" }, "feeBillExclusionMode": { "type": "string", "enum": [ "No", "YesAll", "SelectBillEntities" ] }, "asset": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Asset" } }, "xml": { "name": "BillAsset" }, "type": "object" }, "OAS.DataModel.Billing.BillAssetAdditionalInfo": { "required": [ "id", "assetId", "isFeeExcluded", "isPayingFee", "excludeAmount", "excludeAmountType", "excludePercentOf", "isFeeExcludedAsset", "isFeeExcludedProduct", "isFeeExcludedHouseholdAsset" ], "properties": { "id": { "type": "integer", "format": "int32" }, "assetId": { "type": "integer", "format": "int32" }, "isFeeExcluded": { "type": "integer", "format": "int32" }, "isPayingFee": { "type": "boolean" }, "timestamp": { "type": "string", "format": "byte" }, "editedDate": { "type": "string", "format": "date-time" }, "editedby": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "excludeAmount": { "type": "number", "format": "double" }, "excludeAmountType": { "type": "integer", "format": "int32" }, "excludePercentOf": { "type": "integer", "format": "int32" }, "excludeStartDate": { "type": "string", "format": "date-time" }, "excludeEndDate": { "type": "string", "format": "date-time" }, "isFeeExcludedAsset": { "type": "boolean" }, "isFeeExcludedProduct": { "type": "boolean" }, "isFeeExcludedHouseholdAsset": { "type": "integer", "format": "int32" } }, "xml": { "name": "BillAssetAdditionalInfo" }, "type": "object" }, "OAS.DataModel.Portfolio.SystematicAccount": { "required": [ "id", "accountId", "isProrated", "dataEntryMethod", "swpFrequency", "swpCycleMonth", "startDate", "transactionDay", "isActive", "swpAmount", "swpSource", "isTaxWithType", "editedDate", "editedBy", "createdDate", "createdBy", "isRecalc", "isSpouse", "type", "isCashFundingIgnored", "isAutoRmd" ], "properties": { "id": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "isProrated": { "type": "boolean" }, "dataEntryMethod": { "type": "integer", "format": "int32" }, "swpFrequency": { "type": "string", "enum": [ "Monthly", "Quarterly", "Semiannually", "Annually" ] }, "swpCycleMonth": { "type": "integer", "format": "int32", "maximum": 12, "minimum": 1 }, "startDate": { "type": "string", "format": "date-time" }, "transactionDay": { "type": "integer", "format": "int32", "maximum": 31, "minimum": 1 }, "custodialSWPDate": { "type": "integer", "format": "int32" }, "inActiveDate": { "type": "string", "format": "date-time" }, "isActive": { "type": "boolean" }, "swpAmount": { "type": "number", "format": "double" }, "howTransfered": { "type": "integer", "format": "int32" }, "bankOfRecord": { "type": "string", "maxLength": 50, "minLength": 0 }, "addressOfRecord": { "type": "string", "maxLength": 100, "minLength": 0 }, "bankAcctNum": { "type": "string", "maxLength": 50, "minLength": 0 }, "abaNum": { "type": "string", "maxLength": 50, "minLength": 0 }, "taxesWithheld": { "type": "number", "format": "double" }, "swpSource": { "type": "integer", "format": "int32" }, "swpAcctNum": { "type": "string", "maxLength": 50, "minLength": 0 }, "notes": { "type": "string", "maxLength": 8000, "minLength": 0 }, "isTaxWithType": { "type": "string", "enum": [ "Undefined", "Dollar", "Percent", "Unknown", "None" ] }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "rowVersion": { "type": "string", "format": "byte" }, "lifeType": { "type": "integer", "format": "int32" }, "isRecalc": { "type": "boolean" }, "beneficiaryName": { "type": "string", "maxLength": 50, "minLength": 0 }, "isSpouse": { "type": "boolean" }, "beneficiaryBDay": { "type": "string", "format": "date-time" }, "beneficiarySSN": { "type": "string", "maxLength": 15, "minLength": 0 }, "beneficiaryEncryptedSSN": { "type": "string", "format": "byte" }, "type": { "type": "string", "enum": [ "None", "Withdrawal", "Rmd", "Purchase", "Dca" ] }, "isCashFundingIgnored": { "type": "boolean" }, "assetId": { "type": "integer", "format": "int32" }, "endDate": { "type": "string", "format": "date-time" }, "stateTax": { "type": "number", "format": "double" }, "isDoubleCheck": { "type": "boolean" }, "doubleCheckDate": { "type": "string", "format": "date-time" }, "doubleCheckBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "reconcileStatus": { "type": "string", "maxLength": 15, "minLength": 0 }, "reconcileDate": { "type": "string", "format": "date-time" }, "lastReconcile": { "type": "string", "format": "date-time" }, "distributionCodeId": { "type": "integer", "format": "int32" }, "importKey": { "type": "string", "maxLength": 15, "minLength": 0 }, "custodialSystematicId": { "type": "string", "maxLength": 500, "minLength": 0 }, "nextDate": { "type": "string", "format": "date-time" }, "isAutoRmd": { "type": "boolean" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" }, "asset": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Asset" }, "audits": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SystematicAccountAudit" }, "xml": { "name": "SystematicAccountAudit", "wrapped": true }, "type": "array" } }, "xml": { "name": "SystematicAccount" }, "type": "object" }, "OAS.DataModel.Billing.BillAssetAdditionalInfoForEF": { "properties": { "assetId": { "type": "integer", "format": "int32" }, "isFeeExcluded": { "type": "integer", "format": "int32" } }, "xml": { "name": "BillAssetAdditionalInfoForEF" }, "type": "object" }, "OAS.DataModel.Portfolio.AssetStepUp": { "required": [ "id", "assetId", "stepUpPercent", "transDate", "unitPrice" ], "properties": { "id": { "type": "integer", "format": "int32" }, "assetId": { "type": "integer", "format": "int32" }, "stepUpPercent": { "type": "number", "format": "double" }, "transDate": { "type": "string", "format": "date-time" }, "unitPrice": { "type": "number", "format": "double" }, "createdBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "asset": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Asset" } }, "xml": { "name": "AssetStepUp" }, "type": "object" }, "OAS.DataModel.Portfolio.AssetBifurcate": { "required": [ "id", "assetId", "startDate", "method" ], "properties": { "id": { "type": "integer", "format": "int32" }, "assetId": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "method": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "asset": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Asset" } }, "xml": { "name": "AssetBifurcate" }, "type": "object" }, "OAS.DataModel.Portfolio.AssetCostBasisHistory": { "required": [ "id", "assetId", "importedDate", "createdBy" ], "properties": { "id": { "type": "integer", "format": "int32" }, "assetId": { "type": "integer", "format": "int32" }, "acquiredDate": { "type": "string", "format": "date-time" }, "sellDate": { "type": "string", "format": "date-time" }, "holdPeriodDate": { "type": "string", "format": "date-time" }, "costAmt": { "type": "number", "format": "double" }, "noUnits": { "type": "number", "format": "double" }, "method": { "type": "string", "maxLength": 50, "minLength": 0 }, "proceedAmt": { "type": "number", "format": "double" }, "importedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "asset": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Asset" } }, "xml": { "name": "AssetCostBasisHistory" }, "type": "object" }, "OAS.DataModel.Portfolio.AssetLoan": { "required": [ "id", "assetId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "assetId": { "type": "integer", "format": "int32" }, "totalInterestPaid": { "type": "number", "format": "double" }, "totalPrincipalPaid": { "type": "number", "format": "double" }, "interestRate": { "type": "number", "format": "double" }, "loanDate": { "type": "string", "format": "date-time" }, "originalLoanAmount": { "type": "number", "format": "double" }, "totalPayments": { "type": "integer", "format": "int32" }, "paymentNumber": { "type": "integer", "format": "int32" }, "remainingPayments": { "type": "integer", "format": "int32" }, "paymentFrequency": { "type": "integer", "format": "int32" }, "paymentDueDay": { "type": "integer", "format": "int32" }, "interestPayment": { "type": "number", "format": "double" }, "principlePayment": { "type": "number", "format": "double" }, "totalPayment": { "type": "number", "format": "double" }, "notes": { "type": "string", "maxLength": 500, "minLength": 0 }, "asset": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Asset" } }, "xml": { "name": "AssetLoan" }, "type": "object" }, "OAS.DataModel.Portfolio.DownloadSymbol": { "required": [ "id", "symbol" ], "properties": { "id": { "type": "integer", "format": "int32" }, "symbol": { "type": "string", "maxLength": 50, "minLength": 0 }, "productId": { "type": "integer", "format": "int32" }, "isNASDAQPlatformSymbol": { "type": "boolean" }, "audits": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.DownloadSymbolHistory" }, "xml": { "name": "DownloadSymbolHistory", "wrapped": true }, "type": "array" } }, "xml": { "name": "DownloadSymbol" }, "type": "object" }, "OAS.DataModel.Portfolio.CurrentUnrealizedAssetCost": { "required": [ "assetId", "asOfDate", "acquiredDate", "origCostPerShare" ], "properties": { "assetId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "lotId": { "type": "integer", "format": "int64" }, "longTermCost": { "type": "number", "format": "double" }, "shortTermCost": { "type": "number", "format": "double" }, "longTermUnits": { "type": "number", "format": "double" }, "shortTermUnits": { "type": "number", "format": "double" }, "acquiredDate": { "type": "string", "format": "date-time" }, "amortizationAmt": { "type": "number", "format": "double" }, "origCostPerShare": { "type": "number", "format": "double" }, "editedDate": { "type": "string", "format": "date-time" }, "asset": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Asset" }, "costPerShare": { "type": "number", "format": "double" } }, "xml": { "name": "CurrentUnrealizedAssetCost" }, "type": "object" }, "OAS.DataModel.Portfolio.AssetCostCustodianOnlyUnrealizedCurrent": { "required": [ "assetId", "assetCostCustodianId", "asOfDate", "acquiredDate", "origCostPerShare" ], "properties": { "assetId": { "type": "integer", "format": "int32" }, "assetCostCustodianId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "cost": { "type": "number", "format": "double" }, "units": { "type": "number", "format": "double" }, "acquiredDate": { "type": "string", "format": "date-time" }, "amortizationAmt": { "type": "number", "format": "double" }, "origCostPerShare": { "type": "number", "format": "double" } }, "xml": { "name": "AssetCostCustodianOnlyUnrealizedCurrent" }, "type": "object" }, "OAS.DataModel.Confirm.AssetConfirmError": { "required": [ "asOf", "assetId", "lastUpdate", "performanceError", "transactionError", "message", "asOfDate", "acceptable" ], "properties": { "asOf": { "type": "integer", "format": "int32" }, "assetId": { "type": "integer", "format": "int32" }, "lastUpdate": { "type": "string", "format": "date-time" }, "performanceError": { "type": "boolean" }, "transactionError": { "type": "boolean" }, "message": { "type": "string" }, "asOfDate": { "type": "string", "format": "date-time" }, "acceptable": { "type": "boolean" }, "note": { "type": "string", "maxLength": 255, "minLength": 0 }, "asset": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Asset" } }, "xml": { "name": "AssetConfirmError" }, "type": "object" }, "OAS.DataModel.Confirm.AssetPositionOnlyBalance": { "required": [ "asOf", "assetId", "unitBalance", "asOfDate", "auditedDate", "isEstimated" ], "properties": { "asOf": { "type": "integer", "format": "int32" }, "assetId": { "type": "integer", "format": "int32" }, "unitBalance": { "type": "number", "format": "double" }, "asset": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Asset" }, "asOfDate": { "type": "string", "format": "date-time" }, "productValuationId": { "type": "integer", "format": "int32" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "isEstimated": { "type": "boolean" }, "valuationStatus": { "type": "string", "enum": [ "Complete", "Pending" ] }, "notes": { "type": "string", "maxLength": 255, "minLength": 0 }, "requiresValuationUpsert": { "type": "boolean" }, "requiresTransactionReversal": { "type": "boolean" } }, "xml": { "name": "AssetPositionOnlyBalance" }, "type": "object" }, "OAS.DataModel.Confirm.Alternative.CommitmentLedger": { "required": [ "id", "assetId", "ledgerType", "asOfDate", "amount", "tradeStatus", "auditedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "assetId": { "type": "integer", "format": "int32" }, "ledgerType": { "type": "string", "enum": [ "CommittedCapital", "UnFundedAdjustment", "ContributedCapital", "Distribution" ] }, "asOfDate": { "type": "string", "format": "date-time" }, "amount": { "type": "number", "format": "double" }, "notes": { "type": "string", "maxLength": 255, "minLength": 0 }, "tradeStatus": { "type": "string", "enum": [ "Complete", "Pending", "Rejected", "Reversed", "Inactive", "PendingCorpAction", "FutureAip" ] }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "asset": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Asset" } }, "xml": { "name": "CommitmentLedger" }, "type": "object" }, "OAS.DataModel.Confirm.Alternative.AlternativeSchedule": { "required": [ "id", "assetId", "scheduleType", "scheduleDate", "amount", "amountType", "auditedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "assetId": { "type": "integer", "format": "int32" }, "scheduleType": { "type": "string", "enum": [ "CapitalCommitment", "Distribution" ] }, "scheduleDate": { "type": "string", "format": "date-time" }, "amount": { "type": "number", "format": "double" }, "amountType": { "type": "string", "enum": [ "Dollars", "Percent" ] }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "asset": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Asset" } }, "xml": { "name": "AlternativeSchedule" }, "type": "object" }, "OAS.DataModel.Confirm.TaxError": { "required": [ "id", "auditType", "errorMessage", "resolutionMessage", "createdDate", "createdBy" ], "properties": { "id": { "type": "integer", "format": "int32" }, "auditType": { "type": "string", "enum": [ "CustodialRealizedSharesDoNotMatch", "CustodialRealizedMissing", "CustodialUnrealizedMissing", "CustodialRealizedUnknownAcquiredDate", "CustodialUnrealizedUnknownAcquiredDate", "CustodialRealizedUnknownCostBasis", "CustodialUnrealizedUnknownCostBasis", "OrionUnknownCostBasis", "MoneyMarketProducts", "OrionMissingCostBasis" ] }, "assetId": { "type": "integer", "format": "int32" }, "errorMessage": { "type": "string", "maxLength": 255, "minLength": 0 }, "resolutionMessage": { "type": "string", "maxLength": 255, "minLength": 0 }, "expectedUnits": { "type": "number", "format": "double" }, "costUnits": { "type": "number", "format": "double" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "reviewed": { "type": "boolean" } }, "xml": { "name": "TaxError" }, "type": "object" }, "OAS.DataModel.Settings.AssetEntityOption": { "required": [ "entityId", "userDefineDefinitionId", "userDefineDataId", "name", "code", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "AssetEntityOption" }, "type": "object" }, "OAS.DataModel.Settings.AssetUserDefinedField": { "required": [ "entityId", "userDefineDefinitionId", "userDefineDataId", "name", "code", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "AssetUserDefinedField" }, "type": "object" }, "OAS.DataModel.Settings.AssetUserDefinedTimeField": { "required": [ "entityId", "userDefineDefinitionId", "name", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "values": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.AssetUserDefinedTimeFieldValue" }, "xml": { "name": "AssetUserDefinedTimeFieldValue", "wrapped": true }, "type": "array" } }, "xml": { "name": "AssetUserDefinedTimeField" }, "type": "object" }, "OAS.DataModel.Portfolio.CustodianLocal": { "required": [ "id", "personalId", "name", "sweepLevel", "isDirect", "feeReqSrc", "sweepProductClassId", "isUsingEquityBlockTrades", "is2PartTrading", "isUseB50Setup", "isSupermarket", "isManual", "allowManualOrderAllocate", "custodianCommonIdList", "directTrading", "downloadsCostBasis", "aggregateSleeves", "replenishMinCash" ], "properties": { "id": { "type": "integer", "format": "int32" }, "personalId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "maxLength": 40, "minLength": 0 }, "description": { "type": "string" }, "code": { "type": "string", "maxLength": 50, "minLength": 0 }, "sweepLevel": { "type": "string", "enum": [ "Invalid", "Registration", "Account" ] }, "isDirect": { "type": "boolean" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "custodialAccountNum": { "type": "string", "maxLength": 50, "minLength": 0 }, "canSweepFeesToCustAcct": { "type": "boolean" }, "feeReqSrc": { "type": "string", "enum": [ "Invalid", "HighValueFund", "CashAccount", "ProRata" ] }, "isDefault": { "type": "boolean" }, "isCreateDistribution": { "type": "boolean" }, "custTaxID": { "type": "string", "maxLength": 50, "minLength": 0 }, "masterAccountNumber": { "type": "string", "maxLength": 50, "minLength": 0 }, "sweepProductClassId": { "type": "integer", "format": "int32" }, "isQpeTransExcluded": { "type": "boolean" }, "isUsingEquityBlockTrades": { "type": "boolean" }, "is2PartTrading": { "type": "boolean" }, "isUseB50Setup": { "type": "boolean" }, "canTransmitAfterHours": { "type": "boolean" }, "isSupermarket": { "type": "boolean" }, "isManual": { "type": "boolean" }, "allowManualOrderAllocate": { "type": "boolean" }, "manualOrderAllocationClOrdID": { "type": "string", "maxLength": 35, "minLength": 0 }, "dtcNum": { "type": "string", "maxLength": 10, "minLength": 0 }, "custodianCommonIdList": { "type": "string", "maxLength": 100, "minLength": 0 }, "directTrading": { "type": "string", "enum": [ "None", "Tda" ] }, "communitiesDirectTrading": { "type": "string", "maxLength": 50, "minLength": 0 }, "downloadsCostBasis": { "type": "boolean" }, "fixUploadTargetId": { "type": "integer", "format": "int32" }, "brokerCommission": { "type": "number", "format": "double" }, "aggregateSleeves": { "type": "boolean" }, "minCashBalance": { "type": "number", "format": "double" }, "replenishMinCash": { "type": "boolean" }, "shareTradeThreshold": { "type": "number", "format": "double" }, "trustType": { "type": "string", "enum": [ "None", "CTC", "EAS" ] }, "feeFileUploadTarget": { "type": "integer", "format": "int32" }, "custodianGlobalId": { "type": "integer", "format": "int32" }, "globalId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "accounts": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" }, "xml": { "name": "Account", "wrapped": true }, "type": "array" }, "aumSummary": { "$ref": "#/definitions/OAS.DataModel.Portfolio.CustodianAumSummary" }, "personal": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Personal" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.CustodianEntityOption" }, "xml": { "name": "CustodianEntityOption", "wrapped": true }, "type": "array" }, "fixTradingSettings": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.CustodianFixTradeSetting" }, "xml": { "name": "CustodianFixTradeSetting", "wrapped": true }, "type": "array" }, "algorithms": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.CustodianAlgorithm" }, "xml": { "name": "CustodianAlgorithm", "wrapped": true }, "type": "array" }, "custComplexes": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.CustComplex" }, "xml": { "name": "CustComplex", "wrapped": true }, "type": "array" } }, "xml": { "name": "CustodianLocal" }, "type": "object" }, "OAS.DataModel.Portfolio.Registration": { "required": [ "id", "clientId", "personalId", "createdDate", "isActive", "registrationTypeId", "isLifestyleOption" ], "properties": { "id": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "personalId": { "type": "integer", "format": "int32" }, "personalDeceasedId": { "type": "integer", "format": "int32" }, "createdDate": { "type": "string", "format": "date-time" }, "netIncome": { "type": "number", "format": "double" }, "netWorth": { "type": "number", "format": "double" }, "riskTol": { "type": "integer", "format": "int32" }, "stockPerc": { "type": "string", "maxLength": 6, "minLength": 0 }, "returnObjective": { "type": "string", "maxLength": 25, "minLength": 0 }, "isActive": { "type": "boolean" }, "investmentAmt": { "type": "number", "format": "double" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "registrationTypeId": { "type": "integer", "format": "int32" }, "investmentObjective": { "type": "string", "maxLength": 25, "minLength": 0 }, "timeHorizon": { "type": "string", "maxLength": 25, "minLength": 0 }, "createdBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "isReadyToTrade": { "type": "integer", "format": "int32" }, "dtNewAcctSent": { "type": "string", "maxLength": 10, "minLength": 0 }, "importKey": { "type": "string", "maxLength": 20, "minLength": 0 }, "riskBudget": { "type": "integer", "format": "int32" }, "isLifestyleOption": { "type": "boolean" }, "targetSpendRate": { "type": "number", "format": "double" }, "dateOfDeath": { "type": "string", "format": "date-time" }, "targetDate": { "type": "string", "format": "date-time" }, "targetDollarAmount": { "type": "number", "format": "double" }, "isRTQLocked": { "type": "boolean" }, "isEligibleDesignatedBeneficiary": { "type": "boolean" }, "isEDBTenYearOverride": { "type": "boolean" }, "isNonPersonBeneficiary": { "type": "boolean" }, "globalId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "isSoleBeneficiary": { "type": "boolean" }, "overlayId": { "type": "integer", "format": "int32" }, "isNonInitialInheritorBira": { "type": "boolean" }, "initialOwnerDateOfDeath": { "type": "string", "format": "date-time" }, "type": { "$ref": "#/definitions/OAS.DataModel.Portfolio.RegistrationType" }, "client": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Client" }, "accounts": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" }, "xml": { "name": "Account", "wrapped": true }, "type": "array" }, "billRegistrations": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillRegistration" }, "xml": { "name": "BillRegistration", "wrapped": true }, "type": "array" }, "blobs": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.RegistrationBlob" }, "xml": { "name": "RegistrationBlob", "wrapped": true }, "type": "array" }, "notes": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.RegistrationNote" }, "xml": { "name": "RegistrationNote", "wrapped": true }, "type": "array" }, "beneficiaries": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.RegistrationBeneficiary" }, "xml": { "name": "RegistrationBeneficiary", "wrapped": true }, "type": "array" }, "decedent": { "$ref": "#/definitions/OAS.DataModel.Portfolio.RegistrationDecedent" }, "additionalRepAssignmentsPercent": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AdditionalRepAssignmentPercent" }, "xml": { "name": "AdditionalRepAssignmentPercent", "wrapped": true }, "type": "array" }, "registrationRepAdditionals": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.RegistrationRepAdditional" }, "xml": { "name": "RegistrationRepAdditional", "wrapped": true }, "type": "array" }, "suitability": { "$ref": "#/definitions/OAS.DataModel.Portfolio.RegistrationSuitability" }, "changes": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.RegistrationChange" }, "xml": { "name": "RegistrationChange", "wrapped": true }, "type": "array" }, "sleeve": { "$ref": "#/definitions/OAS.DataModel.Trading.RegistrationSleeve" }, "ofacChecks": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.OfacCheck" }, "xml": { "name": "OfacCheck", "wrapped": true }, "type": "array" }, "rmdCalculationSummary": { "$ref": "#/definitions/OAS.DataModel.Portfolio.RegistrationRmdCalculationSummary" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.RegistrationEntityOption" }, "xml": { "name": "RegistrationEntityOption", "wrapped": true }, "type": "array" }, "info": { "$ref": "#/definitions/OAS.DataModel.Portfolio.RegistrationAdditionalInfo" }, "registrationValues": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.RegistrationValue" }, "xml": { "name": "RegistrationValue", "wrapped": true }, "type": "array" }, "targetAllocations": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.RegistrationTargetAllocation" }, "xml": { "name": "RegistrationTargetAllocation", "wrapped": true }, "type": "array" }, "personal": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Personal" }, "userDefinedFields": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.RegistrationUserDefinedField" }, "xml": { "name": "RegistrationUserDefinedField", "wrapped": true }, "type": "array" }, "userDefinedPageCodes": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.RegistrationUserDefinedPageCode" }, "xml": { "name": "RegistrationUserDefinedPageCode", "wrapped": true }, "type": "array" } }, "xml": { "name": "Registration" }, "type": "object" }, "OAS.DataModel.Portfolio.AccountValue": { "required": [ "accountId", "asOfDate" ], "properties": { "accountId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "integer", "format": "int32" }, "value": { "type": "number", "format": "double" }, "cashValue": { "type": "number", "format": "double" } }, "xml": { "name": "AccountValue" }, "type": "object" }, "OAS.DataModel.Portfolio.FundFamilyLocal": { "required": [ "id", "personalId", "isAnnuity" ], "properties": { "id": { "type": "integer", "format": "int32" }, "personalId": { "type": "integer", "format": "int32" }, "isAnnuity": { "type": "boolean" }, "trader": { "type": "string", "maxLength": 20, "minLength": 0 }, "unitBalanceScale": { "type": "integer", "format": "int32" }, "priceScale": { "type": "integer", "format": "int32" }, "isAcctNumUnique": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "isCreateDistribution": { "type": "boolean" }, "isShareClassSensitive": { "type": "boolean" }, "extension": { "$ref": "#/definitions/OAS.DataModel.Portfolio.FundFamilyExt" }, "name": { "type": "string", "maxLength": 255, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "isActive": { "type": "boolean" }, "sungardBrokerId": { "type": "integer", "format": "int32" }, "custComplexes": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.CustComplex" }, "xml": { "name": "CustComplex", "wrapped": true }, "type": "array" }, "accounts": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" }, "xml": { "name": "Account", "wrapped": true }, "type": "array" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.FundFamilyEntityOption" }, "xml": { "name": "FundFamilyEntityOption", "wrapped": true }, "type": "array" }, "custodianTradeFileFormats": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.CustodianTradeFileFormat" }, "xml": { "name": "CustodianTradeFileFormat", "wrapped": true }, "type": "array" }, "userDefinedFields": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.FundFamilyUserDefinedField" }, "xml": { "name": "FundFamilyUserDefinedField", "wrapped": true }, "type": "array" } }, "xml": { "name": "FundFamilyLocal" }, "type": "object" }, "OAS.DataModel.Portfolio.ClientAccountAdditional": { "required": [ "clientId", "accountId", "weight" ], "properties": { "clientId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "weight": { "type": "number", "format": "double" }, "client": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Client" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" } }, "xml": { "name": "ClientAccountAdditional" }, "type": "object" }, "OAS.DataModel.Portfolio.SubAdvisor": { "required": [ "id", "personalId", "isActive", "createdBy", "createdDate", "editedBy", "editedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "personalId": { "type": "integer", "format": "int32" }, "payeeId": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "saCode": { "type": "string", "maxLength": 100, "minLength": 0 }, "description": { "type": "string" }, "logoImage": { "type": "string", "format": "byte" }, "masterAccountNumber": { "type": "string", "maxLength": 50, "minLength": 0 }, "getTargetAllocEmail": { "type": "boolean" }, "targetAllocEmails": { "type": "string" }, "eclipseFirmId": { "type": "integer", "format": "int32" }, "isOciSyncEnable": { "type": "boolean" }, "personal": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Personal" }, "payee": { "$ref": "#/definitions/OAS.DataModel.Billing.Payee" }, "accounts": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" }, "xml": { "name": "Account", "wrapped": true }, "type": "array" }, "aumSummary": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SubAdvisorAumSummary" }, "entities": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SubAdvisorEntity" }, "xml": { "name": "SubAdvisorEntity", "wrapped": true }, "type": "array" }, "restrictions": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.ModelRestriction" }, "xml": { "name": "ModelRestriction", "wrapped": true }, "type": "array" }, "notes": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SubAdvisorNote" }, "xml": { "name": "SubAdvisorNote", "wrapped": true }, "type": "array" }, "blobs": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SubAdvisorBlob" }, "xml": { "name": "SubAdvisorBlob", "wrapped": true }, "type": "array" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.SubAdvisorEntityOption" }, "xml": { "name": "SubAdvisorEntityOption", "wrapped": true }, "type": "array" }, "userDefinedFields": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.SubAdvisorUserDefinedField" }, "xml": { "name": "SubAdvisorUserDefinedField", "wrapped": true }, "type": "array" } }, "xml": { "name": "SubAdvisor" }, "type": "object" }, "OAS.DataModel.Portfolio.Platform": { "required": [ "id", "name", "isDefault", "isWrapFeeProgram" ], "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "maxLength": 100, "minLength": 0 }, "abbreviation": { "type": "string", "maxLength": 100, "minLength": 0 }, "description": { "type": "string", "maxLength": 255, "minLength": 0 }, "rowVersion": { "type": "string", "format": "byte" }, "rankOrder": { "type": "integer", "format": "int32" }, "isDefault": { "type": "boolean" }, "isActive": { "type": "boolean" }, "ipsId": { "type": "integer", "format": "int32" }, "color": { "type": "string", "maxLength": 12, "minLength": 0 }, "platformTypeId": { "type": "integer", "format": "int32" }, "objective": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "isWrapFeeProgram": { "type": "boolean" }, "modelAggId": { "type": "integer", "format": "int32" }, "accounts": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" }, "xml": { "name": "Account", "wrapped": true }, "type": "array" }, "aumSummary": { "$ref": "#/definitions/OAS.DataModel.Portfolio.PlatformAumSummary" }, "platformType": { "$ref": "#/definitions/OAS.DataModel.Portfolio.PlatformType" }, "modelAgg": { "$ref": "#/definitions/OAS.DataModel.Trading.AggregateModel" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.PlatformEntityOption" }, "xml": { "name": "PlatformEntityOption", "wrapped": true }, "type": "array" } }, "xml": { "name": "Platform" }, "type": "object" }, "OAS.DataModel.Trading.ModelAccount": { "required": [ "id", "accountId", "rebalanceYN", "isOutsideModel", "minCashBalanceType", "autoRebalFrequency", "autoRebalMonth", "autoRebalDay", "replenishMinCash", "dollarModelAmount" ], "properties": { "id": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "rebalanceYN": { "type": "boolean" }, "isOutsideModel": { "type": "boolean" }, "minCashBalance": { "type": "number", "format": "double" }, "audit": { "$ref": "#/definitions/OAT.DataModel.ComplexTypes.BasicAuditNotNullNotNull" }, "editedByOverride": { "type": "string", "maxLength": 40, "minLength": 0 }, "rowVersion": { "type": "string", "format": "byte" }, "oldClientID": { "type": "integer", "format": "int32" }, "aggregateModelId": { "type": "integer", "format": "int32" }, "fundList": { "type": "string", "maxLength": 50, "minLength": 0 }, "minCashBalanceType": { "type": "string", "enum": [ "Dollars", "Percent" ] }, "aggregateModelNewMoneyId": { "type": "integer", "format": "int32" }, "autoRebalFrequency": { "type": "string", "enum": [ "None", "Monthly", "Quarterly", "Semiannual", "Annual" ] }, "autoRebalMonth": { "type": "integer", "format": "int32", "maximum": 12, "minimum": 1 }, "autoRebalDay": { "type": "integer", "format": "int32", "maximum": 31, "minimum": 1 }, "lastRebalanced": { "type": "string", "format": "date-time" }, "replenishMinCash": { "type": "boolean" }, "dollarModelId": { "type": "integer", "format": "int32" }, "dollarModelAmount": { "type": "number", "format": "double" }, "cashLiability": { "type": "number", "format": "double" }, "expireMinCash": { "type": "number", "format": "double" }, "expireMinCashType": { "type": "string", "enum": [ "Dollars", "Percent" ] }, "expireMinCashDate": { "type": "string", "format": "date-time" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" }, "aggregateModel": { "$ref": "#/definitions/OAS.DataModel.Trading.AggregateModel" }, "aggregateModelNewMoney": { "$ref": "#/definitions/OAS.DataModel.Trading.AggregateModel" }, "history": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.ModelAccountHistory" }, "xml": { "name": "ModelAccountHistory", "wrapped": true }, "type": "array" } }, "xml": { "name": "ModelAccount" }, "type": "object" }, "OAS.DataModel.Portfolio.AccountAdditionalInfo": { "required": [ "accountId" ], "properties": { "accountId": { "type": "integer", "format": "int32" }, "businessLineId": { "type": "integer", "format": "int32" }, "lastTransDate": { "type": "string", "format": "date-time" }, "accountNumber": { "type": "string", "maxLength": 50, "minLength": 0 }, "maskedAccountNumber": { "type": "string", "maxLength": 56, "minLength": 0 }, "maskedSecondaryAccountNumber": { "type": "string", "maxLength": 56, "minLength": 0 }, "secondaryAccountNumber": { "type": "string", "maxLength": 50, "minLength": 0 }, "cashValueCurrent": { "type": "number", "format": "double" }, "cashValuePostTrade": { "type": "number", "format": "double" }, "currValue": { "type": "number", "format": "double" }, "pendValue": { "type": "number", "format": "double" }, "cashBalanceCurrValue": { "type": "number", "format": "double" }, "annuityIncomeValue": { "type": "number", "format": "double" }, "custodialAccountNumber": { "type": "string", "maxLength": 50, "minLength": 0 }, "modelType": { "type": "string" }, "businessLine": { "$ref": "#/definitions/OAS.DataModel.Portfolio.BusinessLine" }, "fixedLengthMaskedAccountNumber": { "type": "string", "maxLength": 50, "minLength": 0 } }, "xml": { "name": "AccountAdditionalInfo" }, "type": "object" }, "OAS.DataModel.Portfolio.Plan": { "required": [ "id", "personalId", "isFundWindow", "syncAddress", "status", "createdBy", "createdDate", "editedBy", "editedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "planAdministratorId": { "type": "integer", "format": "int32" }, "personalId": { "type": "integer", "format": "int32" }, "personalSponsorId": { "type": "integer", "format": "int32" }, "isFundWindow": { "type": "boolean" }, "syncAddress": { "type": "boolean" }, "planNumber": { "type": "string", "maxLength": 20, "minLength": 0 }, "trustee": { "type": "string", "maxLength": 50, "minLength": 0 }, "status": { "type": "string", "maxLength": 80, "minLength": 0 }, "notes": { "type": "string", "maxLength": 255, "minLength": 0 }, "createdBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "importKey": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "isCustodianNotified": { "type": "boolean" }, "shareClassId": { "type": "integer", "format": "int32" }, "registrationTypeId": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "planCustodialAccountNumber": { "type": "string", "maxLength": 50, "minLength": 0 }, "custodian": { "$ref": "#/definitions/OAS.DataModel.Portfolio.CustodianLocal" }, "personal": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Personal" }, "personalSponsor": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Personal" }, "registrationType": { "$ref": "#/definitions/OAS.DataModel.Portfolio.RegistrationType" }, "aumSummary": { "$ref": "#/definitions/OAS.DataModel.Portfolio.PlanAumSummary" }, "planAdministrator": { "$ref": "#/definitions/OAS.DataModel.Portfolio.PlanAdministrator" }, "fees": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.PlanFee" }, "xml": { "name": "PlanFee", "wrapped": true }, "type": "array" }, "participants": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" }, "xml": { "name": "Account", "wrapped": true }, "type": "array" }, "tasks": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.PlanTask" }, "xml": { "name": "PlanTask", "wrapped": true }, "type": "array" }, "platforms": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.PlanPlatform" }, "xml": { "name": "PlanPlatform", "wrapped": true }, "type": "array" }, "representatives": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.PlanRepresentative" }, "xml": { "name": "PlanRepresentative", "wrapped": true }, "type": "array" }, "planNotes": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.PlanNote" }, "xml": { "name": "PlanNote", "wrapped": true }, "type": "array" } }, "xml": { "name": "Plan" }, "type": "object" }, "OAS.DataModel.Portfolio.AccountBusinessLine": { "required": [ "accountId", "businessLineId" ], "properties": { "accountId": { "type": "integer", "format": "int32" }, "businessLineId": { "type": "integer", "format": "int32" }, "businessLine": { "$ref": "#/definitions/OAS.DataModel.Portfolio.BusinessLine" } }, "xml": { "name": "AccountBusinessLine" }, "type": "object" }, "OAS.DataModel.Portfolio.AccountCode": { "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int32" }, "acctCode": { "type": "string" }, "maskedAcctCode": { "type": "string" }, "secondaryAcctCode": { "type": "string" }, "maskedSecondaryAcctCode": { "type": "string" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" } }, "xml": { "name": "AccountCode" }, "type": "object" }, "OAS.DataModel.Portfolio.AccountManager": { "required": [ "id", "accountId", "entityId", "entity" ], "properties": { "id": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] } }, "xml": { "name": "AccountManager" }, "type": "object" }, "OAS.DataModel.Billing.BillAccountInfoForEF": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "valueMethod": { "type": "string", "enum": [ "PeriodEndingValue", "AvgDailyBalance", "AvgMonthlyBalance" ] }, "billingStyle": { "type": "string", "enum": [ "Advance", "Arrears" ] }, "scheduleName": { "type": "string" }, "billStartDate": { "type": "string", "format": "date-time" }, "billFrequency": { "type": "string", "enum": [ "Undefined", "Monthly", "Quarterly", "Triannual", "Semiannually", "Annually", "AtMaturity" ] }, "cycleMonth": { "type": "integer", "format": "int32" } }, "xml": { "name": "BillAccountInfoForEF" }, "type": "object" }, "OAS.DataModel.Billing.BillPaysForHousehold": { "required": [ "id", "accountId", "payPercent", "createdDate", "createdBy", "editedDate", "editedBy" ], "properties": { "id": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "payPercent": { "type": "number", "format": "double" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" } }, "xml": { "name": "BillPaysForHousehold" }, "type": "object" }, "OAS.DataModel.Billing.BillPaysForRegistration": { "required": [ "id", "accountId", "payPercent", "createdDate", "createdBy", "editedDate", "editedBy" ], "properties": { "id": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "payPercent": { "type": "number", "format": "double" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" } }, "xml": { "name": "BillPaysForRegistration" }, "type": "object" }, "OAS.DataModel.Billing.BillAccountAdditionalAnnualAmount": { "required": [ "accountId", "id", "additionalAnnualAmount", "additionalAnnualAmountType", "billAdjTypeId", "billEntityId", "ignoreThreshold", "requiresEA" ], "properties": { "accountId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "additionalAnnualAmount": { "type": "number", "format": "double" }, "additionalAnnualAmountType": { "type": "integer", "format": "int32" }, "billAdjTypeId": { "type": "integer", "format": "int32" }, "billEntityId": { "type": "integer", "format": "int32" }, "ignoreThreshold": { "type": "number", "format": "double" }, "requiresEA": { "type": "boolean" }, "billScheduleId": { "type": "integer", "format": "int32" }, "endDate": { "type": "string", "format": "date-time" }, "startDate": { "type": "string", "format": "date-time" }, "adjustmentType": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAdjustmentType" }, "billEntity": { "$ref": "#/definitions/OAS.DataModel.Billing.BillEntity" }, "billSchedule": { "$ref": "#/definitions/OAS.DataModel.Billing.BillSchedule" } }, "xml": { "name": "BillAccountAdditionalAnnualAmount" }, "type": "object" }, "OAS.DataModel.Billing.GeneralAccountDetail": { "required": [ "id", "generalAccountId", "billEntityId", "editedDate", "editedBy", "createdDate", "createdBy", "currentBalance", "changeAmount", "occurred", "billAdjustmentTypeId", "billBalance" ], "properties": { "id": { "type": "integer", "format": "int32" }, "generalAccountId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "billEntityId": { "type": "integer", "format": "int32" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "timestamp": { "type": "string", "format": "byte" }, "currentBalance": { "type": "number", "format": "double" }, "changeAmount": { "type": "number", "format": "double" }, "occurred": { "type": "string", "format": "date-time" }, "billAdjustmentTypeId": { "type": "integer", "format": "int32" }, "notes": { "type": "string", "maxLength": 1000, "minLength": 0 }, "billBalance": { "type": "number", "format": "double" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" }, "generalAccount": { "$ref": "#/definitions/OAS.DataModel.Billing.GeneralAccount" }, "billAdjustmentType": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAdjustmentType" }, "billAccountItemAdjustments": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAccountItemAdjustment" }, "xml": { "name": "BillAccountItemAdjustment", "wrapped": true }, "type": "array" }, "masterBillAccountItemAdjustments": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAccountItemAdjustment" }, "xml": { "name": "BillAccountItemAdjustment", "wrapped": true }, "type": "array" } }, "xml": { "name": "GeneralAccountDetail" }, "type": "object" }, "OAS.DataModel.Portfolio.AccountChange": { "required": [ "id", "accountId", "entity", "asOfDate", "oldEntityId", "newEntityId", "createdBy", "createdDate", "editedBy", "editedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "asOfDate": { "type": "string", "format": "date-time" }, "oldEntityId": { "type": "integer", "format": "int32" }, "newEntityId": { "type": "integer", "format": "int32" }, "oldEntityName": { "type": "string", "maxLength": 255, "minLength": 0 }, "newEntityName": { "type": "string", "maxLength": 255, "minLength": 0 }, "createdBy": { "type": "string", "maxLength": 255, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 255, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" } }, "xml": { "name": "AccountChange" }, "type": "object" }, "OAS.DataModel.Portfolio.AccountChangeHistory": { "required": [ "id", "accountId", "entity", "asOfDate", "oldEntityId", "newEntityId", "createdBy", "createdDate", "editedBy", "editedDate", "changeType" ], "properties": { "id": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "asOfDate": { "type": "string", "format": "date-time" }, "oldEntityId": { "type": "integer", "format": "int32" }, "newEntityId": { "type": "integer", "format": "int32" }, "oldEntityName": { "type": "string", "maxLength": 255, "minLength": 0 }, "newEntityName": { "type": "string", "maxLength": 255, "minLength": 0 }, "createdBy": { "type": "string", "maxLength": 255, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 255, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "changeType": { "type": "string", "maxLength": 1, "minLength": 0 }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" } }, "xml": { "name": "AccountChangeHistory" }, "type": "object" }, "OAS.DataModel.Portfolio.ShareClass": { "required": [ "id", "class" ], "properties": { "id": { "type": "integer", "format": "int32" }, "class": { "type": "string", "maxLength": 10, "minLength": 0 }, "description": { "type": "string", "maxLength": 255, "minLength": 0 }, "oldFundId": { "type": "integer", "format": "int32" }, "loadType": { "type": "string", "maxLength": 1, "minLength": 0 }, "isDefault": { "type": "boolean" } }, "xml": { "name": "ShareClass" }, "type": "object" }, "OAS.DataModel.Portfolio.AccountNote": { "required": [ "id", "createdDate", "createdBy", "systemGenerated", "isWebVisible" ], "properties": { "accountId": { "type": "integer", "format": "int32" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" }, "id": { "type": "integer", "format": "int32" }, "text": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "rowVersion": { "type": "string", "format": "byte" }, "category": { "type": "string", "maxLength": 25, "minLength": 0 }, "userOwnerId": { "type": "integer", "format": "int32" }, "systemGenerated": { "type": "boolean" }, "isWebVisible": { "type": "boolean" }, "requestFollowup": { "type": "boolean" } }, "xml": { "name": "AccountNote" }, "type": "object" }, "OAS.DataModel.Portfolio.AccountBlob": { "required": [ "id", "isZip", "uniqueID" ], "properties": { "accountId": { "type": "integer", "format": "int32" }, "crmDocuments": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.CrmDocument" }, "xml": { "name": "CrmDocument", "wrapped": true }, "type": "array" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" }, "id": { "type": "integer", "format": "int32" }, "openWith": { "type": "string", "maxLength": 200, "minLength": 0 }, "fileName": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "rowVersion": { "type": "string", "format": "byte" }, "blobDesc": { "type": "string", "maxLength": 200, "minLength": 0 }, "blobText": { "type": "string" }, "isZip": { "type": "boolean" }, "fileNETidmId": { "type": "string", "maxLength": 9, "minLength": 0 }, "filePath": { "type": "string", "maxLength": 500, "minLength": 0 }, "eFileLocation": { "type": "string", "enum": [ "Undefined", "Database", "FileServer", "AmazonS3", "HttpGet", "RedtailIms", "Communities" ] }, "rootPath": { "type": "string", "maxLength": 100, "minLength": 0 }, "uniqueID": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "AccountBlob" }, "type": "object" }, "OAS.DataModel.Trading.AccountSleeve": { "required": [ "accountId", "targetAllocation", "targetBalanceType", "contributionAllocation", "distributionAllocation", "corporateActionAllocation", "toleranceUpper", "toleranceLower", "sleeveType" ], "properties": { "accountId": { "type": "integer", "format": "int32" }, "targetAllocation": { "type": "number", "format": "double" }, "targetBalanceType": { "type": "string", "enum": [ "Dollars", "Percent" ] }, "contributionAllocation": { "type": "number", "format": "double" }, "distributionAllocation": { "type": "number", "format": "double" }, "corporateActionAllocation": { "type": "number", "format": "double" }, "toleranceUpper": { "type": "number", "format": "double" }, "toleranceLower": { "type": "number", "format": "double" }, "sleeveType": { "type": "string", "enum": [ "Normal sleeve", "Custodial account", "Contribution sleeve", "Distribution sleeve", "Unmanaged sleeve" ] }, "doNotTrade": { "type": "boolean" }, "isCustomized": { "type": "boolean" }, "sleeveStrategyDetailId": { "type": "integer", "format": "int32" }, "sleeveStrategyId": { "type": "integer", "format": "int32" }, "sleeveStrategy": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategy" }, "sleeveStrategyToleranceUpper": { "type": "number", "format": "double" }, "sleeveStrategyToleranceLower": { "type": "number", "format": "double" }, "tradeBlockModels": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.TradeBlockModel" }, "xml": { "name": "TradeBlockModel", "wrapped": true }, "type": "array" }, "audit": { "$ref": "#/definitions/OAT.DataModel.ComplexTypes.BasicAuditNotNullNotNull" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" }, "history": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.AccountSleeveHistory" }, "xml": { "name": "AccountSleeveHistory", "wrapped": true }, "type": "array" } }, "xml": { "name": "AccountSleeve" }, "type": "object" }, "OAS.DataModel.Portfolio.AccountStatus": { "required": [ "id", "status", "description", "sortOrder", "isVisible", "includeInBusinessMetrics", "isDownloading", "state" ], "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "type": "string", "maxLength": 25, "minLength": 0 }, "description": { "type": "string", "maxLength": 160, "minLength": 0 }, "sortOrder": { "type": "integer", "format": "int32" }, "isVisible": { "type": "boolean" }, "includeInBusinessMetrics": { "type": "boolean" }, "isDownloading": { "type": "boolean" }, "state": { "type": "string", "enum": [ "Complete", "Pending", "Rejected", "SentToCustodian" ] } }, "xml": { "name": "AccountStatus" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadSource": { "required": [ "id", "downloadFormatId", "downloadDescription", "transmitMethod", "url", "allowPriceImport", "allowSecondaryAcctCodeMatch", "allowAcctCodeMatch", "allowAcctCodeMatchWOZero", "allowNameImport", "allowPositionImport", "allowTransactionImport", "allowBeneficiaryImport", "allowBankingImport", "allowDuplicateAssets", "allowProperName", "advReportable", "thirteenFReportable", "principalAndIncome", "autoCreateStartingValues", "allowRMDImport", "removeSettleDateTrades", "allowSystematicImport", "isOrionEnterpriseEnabled", "allowSecurityImport", "allowCorpActionImport", "allowDivImport", "patternMatchType", "baseAcctLength", "useReversal", "isActive", "underReview", "allowTranDetailImport", "allowGenericImport", "allowCostBasisImport", "isAutoHouseholding", "isAcctCreation", "isUnVerifiedSells", "ignoreRepVerify", "doNotUseBulk", "allowPriceZero", "createTransactionInPendingStatus", "newAccounts", "isSourceExclusionCB", "isSourceExclusionTran", "newAccountCenterSuppression", "positionOnlyReconcile", "isFixSmallBalance", "alwaysCreateNewRegistration", "noOrionPriceCopy", "archiveFiles", "registrationBaseNumber", "isDividendTransactionCombination" ], "properties": { "id": { "type": "integer", "format": "int32" }, "downloadFormatId": { "type": "integer", "format": "int32" }, "downloadFormatSubTypeId": { "type": "integer", "format": "int32" }, "downloadSourceParentId": { "type": "integer", "format": "int32" }, "downloadFormat": { "$ref": "#/definitions/OAT.Confirmation.Model.IDownloadFormat" }, "downloadDescription": { "type": "string", "maxLength": 50, "minLength": 0 }, "transmitMethod": { "type": "string", "enum": [ "Empty", "None", "FTP", "DSTHTTP", "Network", "SFTP", "FTPS", "HTTPS", "S3" ] }, "url": { "type": "string", "maxLength": 255, "minLength": 0 }, "filePattern": { "type": "string", "maxLength": 1000, "minLength": 0 }, "transPercTolerance": { "type": "number", "format": "double" }, "transDaysTolerance": { "type": "integer", "format": "int32" }, "deleteSourceFile": { "type": "boolean" }, "cashCusip": { "type": "string" }, "allowPriceImport": { "type": "boolean" }, "allowSecondaryAcctCodeMatch": { "type": "boolean" }, "allowAcctCodeMatch": { "type": "boolean" }, "allowAcctCodeMatchWOZero": { "type": "boolean" }, "allowNameImport": { "type": "boolean" }, "allowPositionImport": { "type": "boolean" }, "allowTransactionImport": { "type": "boolean" }, "allowBeneficiaryImport": { "type": "boolean" }, "allowBankingImport": { "type": "boolean" }, "allowDuplicateAssets": { "type": "boolean" }, "allowProperName": { "type": "boolean" }, "advReportable": { "type": "boolean" }, "thirteenFReportable": { "type": "boolean" }, "principalAndIncome": { "type": "boolean" }, "autoCreateStartingValues": { "type": "boolean" }, "allowRMDImport": { "type": "boolean" }, "removeSettleDateTrades": { "type": "boolean" }, "allowSystematicImport": { "type": "boolean" }, "isOrionEnterpriseEnabled": { "type": "boolean" }, "allowSecurityImport": { "type": "boolean" }, "allowCorpActionImport": { "type": "boolean" }, "allowDivImport": { "type": "boolean" }, "patternMatchType": { "type": "string", "enum": [ "Included", "Excluded" ] }, "baseAcctLength": { "type": "integer", "format": "int32" }, "useReversal": { "type": "boolean" }, "isActive": { "type": "boolean" }, "underReview": { "type": "boolean" }, "allowTranDetailImport": { "type": "boolean" }, "allowGenericImport": { "type": "boolean" }, "allowCostBasisImport": { "type": "boolean" }, "isAutoHouseholding": { "type": "boolean" }, "isAcctCreation": { "type": "boolean" }, "isUnVerifiedSells": { "type": "boolean" }, "note": { "type": "string", "maxLength": 1000, "minLength": 0 }, "custodianCommonCode": { "type": "string", "maxLength": 10, "minLength": 0 }, "sourceConfig": { "type": "string" }, "custodianCommonId": { "type": "integer", "format": "int32" }, "ignoreRepVerify": { "type": "boolean" }, "doNotUseBulk": { "type": "boolean" }, "altFilePattern": { "type": "string", "maxLength": 1000, "minLength": 0 }, "allowPriceZero": { "type": "boolean" }, "createTransactionInPendingStatus": { "type": "boolean" }, "reconTargetTime": { "type": "string", "format": "date-time" }, "comparePositionValue": { "type": "boolean" }, "newAccounts": { "type": "string", "enum": [ "Default", "DoNotCreate", "Create", "AutoExclude" ] }, "runAssetValueComparison": { "type": "boolean" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "serviceTeamReconId": { "type": "integer", "format": "int32" }, "serviceTeamMemberId": { "type": "integer", "format": "int32" }, "downloadFiles": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadFile" }, "xml": { "name": "DownloadFile", "wrapped": true }, "type": "array" }, "downloadSourceInstructions": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadSourceInstruction" }, "xml": { "name": "DownloadSourceInstruction", "wrapped": true }, "type": "array" }, "isSourceExclusionCB": { "type": "boolean" }, "isSourceExclusionTran": { "type": "boolean" }, "newAccountCenterSuppression": { "type": "boolean" }, "positionOnlyReconcile": { "type": "string", "enum": [ "No", "Yes", "EnabledAccountsOnly", "AIP", "EnabledAccountsOnlyAIP", "EnabledAccountsOnlyHAA", "HAA" ] }, "isFixSmallBalance": { "type": "boolean" }, "alwaysCreateNewRegistration": { "type": "boolean" }, "noOrionPriceCopy": { "type": "boolean" }, "namePercentMatch": { "type": "number", "format": "double" }, "positionPercentMatch": { "type": "number", "format": "double" }, "transactionPercentMatch": { "type": "number", "format": "double" }, "archiveFiles": { "type": "boolean" }, "registrationBaseNumber": { "type": "integer", "format": "int32" }, "dailyAccrualTolerance": { "type": "number", "format": "double" }, "isDividendTransactionCombination": { "type": "boolean" }, "sftpKey": { "type": "string", "format": "byte" }, "nextScheduledRunDate": { "type": "string", "format": "date-time" }, "gpgKey": { "type": "string", "format": "byte" }, "gpgPassphrase": { "type": "string", "maxLength": 30, "minLength": 0 }, "transmitUserId_e": { "type": "string", "format": "byte" }, "transmitPassword_e": { "type": "string", "format": "byte" }, "zipPassword_e": { "type": "string", "format": "byte" }, "alClientId": { "type": "integer", "format": "int32" }, "config": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadSourceConfig" }, "downloadSourceOptionJSON": { "type": "string" }, "schedules": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadSourceSchedule" }, "xml": { "name": "DownloadSourceSchedule", "wrapped": true }, "type": "array" }, "logs": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadSourceQueueLog" }, "xml": { "name": "DownloadSourceQueueLog", "wrapped": true }, "type": "array" }, "defaults": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadSourceDefault" }, "downloadSourceNote": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadSourceNote" } }, "xml": { "name": "DownloadSource" }, "type": "object" }, "OAS.DataModel.Portfolio.AccountRmdCalculationSummary": { "required": [ "accountId", "endOfPreviousYearAccountValue", "endOfPreviousYearAccountValueIsCalculated", "calculatedEndOfPreviousYearAccountValue", "rmdSatisfiedIsCalculated" ], "properties": { "accountId": { "type": "integer", "format": "int32" }, "rmdAmount": { "type": "number", "format": "double" }, "rmdOriginalAmount": { "type": "number", "format": "double" }, "ytdTotal": { "type": "number", "format": "double" }, "endOfPreviousYearAccountValue": { "type": "number", "format": "double" }, "endOfPreviousYearAccountValueIsCalculated": { "type": "boolean" }, "calculatedEndOfPreviousYearAccountValue": { "type": "number", "format": "double" }, "amountRemaining": { "type": "number", "format": "double" }, "amountRemainingGroup": { "type": "number", "format": "double" }, "amountRemainingGroupApplied": { "type": "number", "format": "double" }, "investorAge": { "type": "number", "format": "double" }, "primaryBeneficiaryName": { "type": "string", "maxLength": 255, "minLength": 0 }, "primaryBeneficiaryAge": { "type": "number", "format": "double" }, "primaryBeneficiaryRelation": { "type": "string", "maxLength": 30, "minLength": 0 }, "onTrack": { "type": "boolean" }, "rmdEligible": { "type": "boolean" }, "irsTable": { "type": "string", "maxLength": 26, "minLength": 0 }, "factor": { "type": "number", "format": "double" }, "rmdSatisfied": { "type": "boolean" }, "rmdSatisfiedIsCalculated": { "type": "boolean" }, "rmdNotes": { "type": "string" }, "recalculated": { "type": "boolean" }, "secureActRule": { "type": "string", "enum": [ "IraSpouseBeneficiary10YearsYounger", "IraTraditional", "Unknown", "DecedentPreSecureAct", "SpouseDecedentDiedBeforeRBD", "SpouseDecedentDiedAfterRBDYounger", "SpouseDecedentDiedAfterRBDOlder", "NonSpouseDecedentDiedBeforeRBD", "NonSpouseDecedentDiedAfterRBDYounger", "NonSpouseDecedentDiedAfterRBDOlder", "MinorYoungerThan31", "MinorNotYoungerThan31", "NotEligibleDesignatedBeneficiaryDeathBeforeRbd", "NonPersonDecedentDiedBeforeRBD", "NonPersonDecedentDiedAfterRBD", "ForcedEDBDiedBeforeRBD0To10Younger", "ForcedEDBDiedAfterRBD0To10Younger", "TenYearOverride", "NonEdbDeathAfter2020", "TenYearOverrideDeathBeforeRbd", "TenYearOverrideDeathAfterRbd", "NotEligibleDesignatedBeneficiaryDeathAfterRbd", "SpouseAsSoleBeneficieryButNotReachedRmdAge73", "SpouseAsSoleBeneficieryButNotReachedRmdAge75", "NonInitialInheritorBira", "PreSecureActNonSpouseDecedentDiedAfterRbd" ] }, "source": { "type": "string" }, "isCustodial": { "type": "boolean" }, "custodialAccountNumber": { "type": "string", "maxLength": 50, "minLength": 0 }, "moneyMarketValue": { "type": "number", "format": "double" }, "rmdNote": { "type": "string" } }, "xml": { "name": "AccountRmdCalculationSummary" }, "type": "object" }, "OAS.DataModel.Billing.AccountReferral": { "required": [ "id", "accountId", "billEntityId", "payeeId", "startDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "billEntityId": { "type": "integer", "format": "int32" }, "payeeId": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "referralPayoutId": { "type": "integer", "format": "int32" }, "completeDate": { "type": "string", "format": "date-time" }, "audit": { "$ref": "#/definitions/OAT.DataModel.ComplexTypes.BasicAuditNotNullNotNull" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" }, "refferalPayments": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.ReferralPayment" }, "xml": { "name": "ReferralPayment", "wrapped": true }, "type": "array" }, "payee": { "$ref": "#/definitions/OAS.DataModel.Billing.Payee" }, "billEntity": { "$ref": "#/definitions/OAS.DataModel.Billing.BillEntity" }, "referralPayout": { "$ref": "#/definitions/OAS.DataModel.Billing.ReferralPayout" } }, "xml": { "name": "AccountReferral" }, "type": "object" }, "OAS.DataModel.Portfolio.AccountAudit": { "required": [ "accountId", "registrationId", "fundFamilyId", "isActive", "isSweepAcct", "createdDate", "accountStatusId", "isPhoneAuthorized", "auditDate", "auditBy", "changeType" ], "properties": { "accountId": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "fundFamilyId": { "type": "integer", "format": "int32" }, "shareClassId": { "type": "integer", "format": "int32" }, "platformId": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "isSweepAcct": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "provider": { "type": "string", "maxLength": 10, "minLength": 0 }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "cancelDate": { "type": "string", "format": "date-time" }, "cancelValue": { "type": "number", "format": "double" }, "isTradingBlocked": { "type": "boolean" }, "tradingInstructions": { "type": "string", "maxLength": 512, "minLength": 0 }, "outsideId": { "type": "string", "maxLength": 50, "minLength": 0 }, "groupNumber": { "type": "string", "maxLength": 25, "minLength": 0 }, "subAdvisorId": { "type": "integer", "format": "int32" }, "importKey": { "type": "string", "maxLength": 20, "minLength": 0 }, "accountStartDate": { "type": "string", "format": "date-time" }, "accountStartValue": { "type": "number", "format": "double" }, "isOrigSMCAcct": { "type": "boolean" }, "planId": { "type": "integer", "format": "int32" }, "accountStatusId": { "type": "integer", "format": "int32" }, "isPhoneAuthorized": { "type": "boolean" }, "accountHistoryId": { "type": "integer", "format": "int32" }, "sweepAssetId": { "type": "integer", "format": "int32" }, "initialPurchaseDate": { "type": "string", "format": "date-time" }, "auditDate": { "type": "string", "format": "date-time" }, "auditBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "changeType": { "type": "string", "maxLength": 30, "minLength": 0 }, "isManaged": { "type": "boolean" }, "isOps": { "type": "boolean" }, "registration": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Registration" }, "fundFamily": { "$ref": "#/definitions/OAS.DataModel.Portfolio.FundFamilyLocal" }, "shareClass": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ShareClass" }, "custodian": { "$ref": "#/definitions/OAS.DataModel.Portfolio.CustodianLocal" }, "platform": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Platform" }, "subAdvisor": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SubAdvisor" } }, "xml": { "name": "AccountAudit" }, "type": "object" }, "OAS.DataModel.Portfolio.AccountExtSwpDcaSummary": { "required": [ "accountId" ], "properties": { "accountId": { "type": "integer", "format": "int32" }, "swpAmount": { "type": "number", "format": "double" }, "swpFrequency": { "type": "string", "enum": [ "Monthly", "Quarterly", "Semiannually", "Annually" ] }, "nextSwpDate": { "type": "string", "format": "date-time" }, "cashNeededNext4Months": { "type": "number", "format": "double" } }, "xml": { "name": "AccountExtSwpDcaSummary" }, "type": "object" }, "OAS.DataModel.Portfolio.AccountExtTargetCashSummary": { "required": [ "accountId" ], "properties": { "accountId": { "type": "integer", "format": "int32" }, "targetCashPerc": { "type": "number", "format": "double" } }, "xml": { "name": "AccountExtTargetCashSummary" }, "type": "object" }, "OAS.DataModel.Portfolio.MissingAccountInfo": { "required": [ "accountId" ], "properties": { "accountId": { "type": "integer", "format": "int32" }, "missingInfoErrorText": { "type": "string" } }, "xml": { "name": "MissingAccountInfo" }, "type": "object" }, "OAS.DataModel.Portfolio.AccountFilterLinkedToHistoryAccountWithValue": { "required": [ "accountId" ], "properties": { "accountId": { "type": "integer", "format": "int32" } }, "xml": { "name": "AccountFilterLinkedToHistoryAccountWithValue" }, "type": "object" }, "OAS.DataModel.Portfolio.AccountFilterRecursivelyLinked": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "accountsInLink": { "type": "string" } }, "xml": { "name": "AccountFilterRecursivelyLinked" }, "type": "object" }, "OAS.DataModel.Portfolio.AccountFilterLinkedWithNoTransactions": { "required": [ "clientId", "accountId", "acctTrans", "linkTrans" ], "properties": { "rn": { "type": "integer", "format": "int64" }, "clientId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "acctTrans": { "type": "string", "maxLength": 8, "minLength": 0 }, "accountHistoryId": { "type": "integer", "format": "int32" }, "linkTrans": { "type": "string", "maxLength": 12, "minLength": 0 }, "linktype": { "type": "string" } }, "xml": { "name": "AccountFilterLinkedWithNoTransactions" }, "type": "object" }, "OAS.DataModel.Portfolio.AccountFilterStrewnAcrossMultipleAccounts": { "required": [ "registrationName", "ssn", "fundFamilyId", "isAnnuity", "accountId", "accountNumber" ], "properties": { "rn": { "type": "integer", "format": "int64" }, "registrationName": { "type": "string", "maxLength": 255, "minLength": 0 }, "ssn": { "type": "string", "maxLength": 11, "minLength": 0 }, "fileRegCode": { "type": "string", "maxLength": 255, "minLength": 0 }, "fundFamilyId": { "type": "integer", "format": "int32" }, "fundName": { "type": "string", "maxLength": 255, "minLength": 0 }, "isAnnuity": { "type": "boolean" }, "accountId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string", "maxLength": 50, "minLength": 0 } }, "xml": { "name": "AccountFilterStrewnAcrossMultipleAccounts" }, "type": "object" }, "OAS.DataModel.Portfolio.AccountRmdYearOverride": { "required": [ "accountId", "year" ], "properties": { "accountId": { "type": "integer", "format": "int32" }, "year": { "type": "integer", "format": "int32" }, "value": { "type": "number", "format": "double" }, "isSatisfied": { "type": "boolean" }, "audit": { "$ref": "#/definitions/OAT.DataModel.ComplexTypes.BasicAuditNotNullNotNull" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" }, "rmdNotes": { "type": "string" }, "overrideRMDAmount": { "type": "number", "format": "double" } }, "xml": { "name": "AccountRmdYearOverride" }, "type": "object" }, "OAS.DataModel.Portfolio.AccountRmdYearOverrideAudit": { "required": [ "accountId", "year", "createdBy", "createdDate", "editedBy", "editedDate", "auditDate", "auditBy", "changeType" ], "properties": { "accountId": { "type": "integer", "format": "int32" }, "year": { "type": "integer", "format": "int32" }, "value": { "type": "number", "format": "double" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "auditDate": { "type": "string", "format": "date-time" }, "auditBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "changeType": { "type": "string", "maxLength": 30, "minLength": 0 }, "isSatisfied": { "type": "boolean" }, "auditDataArchiveBatchId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "rmdNotes": { "type": "string", "maxLength": 512, "minLength": 0 }, "overrideRMDAmount": { "type": "number", "format": "double" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" } }, "xml": { "name": "AccountRmdYearOverrideAudit" }, "type": "object" }, "OAS.DataModel.Portfolio.AccountTargetAllocation": { "required": [ "id", "accountId", "entity", "entityId", "weight", "createdBy", "createdDate", "editedBy", "editedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "weight": { "type": "number", "format": "double" }, "minimumRange": { "type": "number", "format": "double" }, "maximumRange": { "type": "number", "format": "double" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" } }, "xml": { "name": "AccountTargetAllocation" }, "type": "object" }, "OAS.DataModel.Portfolio.AccountProductEquivalent": { "required": [ "id", "productModelId", "productId", "sortOrder" ], "properties": { "accountId": { "type": "integer", "format": "int32" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" }, "id": { "type": "integer", "format": "int32" }, "productModelId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "sortOrder": { "type": "integer", "format": "int32" }, "product": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductLocal" }, "productModel": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductLocal" } }, "xml": { "name": "AccountProductEquivalent" }, "type": "object" }, "OAS.DataModel.Portfolio.AccountExtSma": { "required": [ "accountId", "isSma", "smaAssetId", "createdBy", "createdDate", "editedBy", "editedDate", "eclipseSMA" ], "properties": { "accountId": { "type": "integer", "format": "int32" }, "isSma": { "type": "boolean" }, "smaAssetId": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedByOverride": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "smaAsset": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Asset" }, "eclipseSMA": { "type": "string", "enum": [ "False", "True", "FollowOrion" ] } }, "xml": { "name": "AccountExtSma" }, "type": "object" }, "OAS.DataModel.Trading.AccountBondTrade": { "required": [ "accountBondTradeId", "accountId", "excludeBondsFromRebalance", "excludeEquitiesFromRebalance", "createdBy", "createdDate", "editedBy", "editedDate" ], "properties": { "accountBondTradeId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "excludeUntilDate": { "type": "string", "format": "date-time" }, "excludeUntilNotes": { "type": "string", "maxLength": 200, "minLength": 0 }, "shortTermBondPercent": { "type": "number", "format": "double" }, "intermediateTermBondPercent": { "type": "number", "format": "double" }, "equityPercent": { "type": "number", "format": "double" }, "bondPercent": { "type": "number", "format": "double" }, "cashPercent": { "type": "number", "format": "double" }, "excludeBondsFromRebalance": { "type": "boolean" }, "excludeEquitiesFromRebalance": { "type": "boolean" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "AccountBondTrade" }, "type": "object" }, "OAS.DataModel.Billing.CompositeAccountExclude": { "required": [ "id", "accountId", "startDate", "endDate", "reason", "createdDate", "createdBy", "editedBy" ], "properties": { "id": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "reason": { "type": "string", "maxLength": 255, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" } }, "xml": { "name": "CompositeAccountExclude" }, "type": "object" }, "OAS.DataModel.Trading.ModelRestrictionEligibleAccount": { "required": [ "modelId", "accountId" ], "properties": { "modelId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" }, "model": { "$ref": "#/definitions/OAS.DataModel.Trading.Model" } }, "xml": { "name": "ModelRestrictionEligibleAccount" }, "type": "object" }, "OAS.DataModel.Trading.ModelAggregateRestrictionEligibleAccount": { "required": [ "aggregateModelId", "accountId" ], "properties": { "aggregateModelId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" }, "aggregateModel": { "$ref": "#/definitions/OAS.DataModel.Trading.AggregateModel" } }, "xml": { "name": "ModelAggregateRestrictionEligibleAccount" }, "type": "object" }, "OAS.DataModel.Settings.AccountUserDefinedPageCode": { "required": [ "accountId", "pageCode" ], "properties": { "accountId": { "type": "integer", "format": "int32" }, "pageCode": { "type": "string", "maxLength": 50, "minLength": 0 }, "udf1": { "type": "integer", "format": "int32" }, "value1": { "type": "string" }, "code1": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition1": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf2": { "type": "integer", "format": "int32" }, "value2": { "type": "string" }, "code2": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition2": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf3": { "type": "integer", "format": "int32" }, "value3": { "type": "string" }, "code3": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition3": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf4": { "type": "integer", "format": "int32" }, "value4": { "type": "string" }, "code4": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition4": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf5": { "type": "integer", "format": "int32" }, "value5": { "type": "string" }, "code5": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition5": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf6": { "type": "integer", "format": "int32" }, "value6": { "type": "string" }, "code6": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition6": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf7": { "type": "integer", "format": "int32" }, "value7": { "type": "string" }, "code7": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition7": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf8": { "type": "integer", "format": "int32" }, "value8": { "type": "string" }, "code8": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition8": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf9": { "type": "integer", "format": "int32" }, "value9": { "type": "string" }, "code9": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition9": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf10": { "type": "integer", "format": "int32" }, "value10": { "type": "string" }, "code10": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition10": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf11": { "type": "integer", "format": "int32" }, "value11": { "type": "string" }, "code11": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition11": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf12": { "type": "integer", "format": "int32" }, "value12": { "type": "string" }, "code12": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition12": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf13": { "type": "integer", "format": "int32" }, "value13": { "type": "string" }, "code13": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition13": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf14": { "type": "integer", "format": "int32" }, "value14": { "type": "string" }, "code14": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition14": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf15": { "type": "integer", "format": "int32" }, "value15": { "type": "string" }, "code15": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition15": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf16": { "type": "integer", "format": "int32" }, "value16": { "type": "string" }, "code16": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition16": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf17": { "type": "integer", "format": "int32" }, "value17": { "type": "string" }, "code17": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition17": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf18": { "type": "integer", "format": "int32" }, "value18": { "type": "string" }, "code18": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition18": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf19": { "type": "integer", "format": "int32" }, "value19": { "type": "string" }, "code19": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition19": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf20": { "type": "integer", "format": "int32" }, "value20": { "type": "string" }, "code20": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition20": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "AccountUserDefinedPageCode" }, "type": "object" }, "OAS.DataModel.Theoretical.AccountFutureCashflow": { "required": [ "accountId", "accountFutureCashflowId", "name", "startDate", "endDate", "frequency", "daysIntoPeriod", "amount" ], "properties": { "accountId": { "type": "integer", "format": "int32" }, "accountFutureCashflowId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "frequency": { "type": "string", "enum": [ "Weekly", "Monthly", "Quarterly", "SemiAnnually", "Annually" ] }, "daysIntoPeriod": { "type": "integer", "format": "int32" }, "amount": { "type": "number", "format": "double" } }, "xml": { "name": "AccountFutureCashflow" }, "type": "object" }, "OAS.DataModel.Theoretical.AccountGrowthRate": { "required": [ "accountId", "asOfDate", "annualGrowthRate" ], "properties": { "accountId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "annualGrowthRate": { "type": "number", "format": "double" } }, "xml": { "name": "AccountGrowthRate" }, "type": "object" }, "OAS.DataModel.Portfolio.AccountTaxRate": { "required": [ "id", "accountId", "asOfDate", "shortTermTaxRate", "longTermTaxRate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "shortTermTaxRate": { "type": "number", "format": "double" }, "longTermTaxRate": { "type": "number", "format": "double" }, "maxRealizedGain": { "type": "number", "format": "double" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" }, "currentTrackingError": { "type": "number", "format": "double" }, "proposedTrackingError": { "type": "number", "format": "double" }, "initialTrackingError": { "type": "number", "format": "double" } }, "xml": { "name": "AccountTaxRate" }, "type": "object" }, "OAS.DataModel.Theoretical.AccountGoal": { "required": [ "accountId", "accountGoalId", "name", "startDate", "endDate", "amount" ], "properties": { "accountId": { "type": "integer", "format": "int32" }, "accountGoalId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "amount": { "type": "number", "format": "double" } }, "xml": { "name": "AccountGoal" }, "type": "object" }, "OAS.DataModel.Portfolio.DailyAnnuityValue": { "properties": { "id": { "type": "integer", "format": "int64" }, "accountId": { "type": "integer", "format": "int32" }, "effectiveDate": { "type": "string", "format": "date-time" }, "securityName": { "type": "string" }, "downloadSymbol": { "type": "string" }, "downloadSymbolId": { "type": "integer", "format": "int32" }, "marketValue": { "type": "number", "format": "double" }, "incomeValue": { "type": "number", "format": "double" }, "surrenderValue": { "type": "number", "format": "double" }, "costBasisForNQ": { "type": "number", "format": "double" }, "assetClass": { "type": "string" }, "assetCategory": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "processLogId": { "type": "integer", "format": "int64" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" } }, "xml": { "name": "DailyAnnuityValue" }, "type": "object" }, "OAS.DataModel.Portfolio.AccountExtSuitability": { "required": [ "accountId", "riskScore" ], "properties": { "accountId": { "type": "integer", "format": "int32" }, "riskScore": { "type": "number", "format": "double" } }, "xml": { "name": "AccountExtSuitability" }, "type": "object" }, "OAS.DataModel.Portfolio.AccountAnnuity": { "required": [ "id", "accountId", "asOfDate" ], "properties": { "id": { "type": "integer", "format": "int64" }, "accountId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "incomeValue": { "type": "number", "format": "double" }, "surrenderValue": { "type": "number", "format": "double" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" } }, "xml": { "name": "AccountAnnuity" }, "type": "object" }, "OAS.DataModel.Portfolio.AccountRiskScoreTable": { "required": [ "id", "asOfDate", "auditedDate" ], "properties": { "accountId": { "type": "integer", "format": "int32" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" }, "id": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "portfolioRiskScore": { "type": "integer", "format": "int32" }, "targetRiskScore": { "type": "integer", "format": "int32" }, "currentRiskScore": { "type": "integer", "format": "int32" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedBy": { "type": "string", "maxLength": 127, "minLength": 0 }, "riskScoreProvider": { "type": "string" } }, "xml": { "name": "AccountRiskScoreTable" }, "type": "object" }, "OAS.DataModel.Portfolio.AccountSloa": { "required": [ "id", "accountId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "sloaDate": { "type": "string", "format": "date-time" }, "thirdParty": { "type": "string", "maxLength": 50, "minLength": 0 }, "isAffiliated": { "type": "boolean" }, "distributionType": { "type": "string", "enum": [ "Wire", "Journal", "EFT", "Check", "Other" ] }, "isActive": { "type": "boolean" }, "notes": { "type": "string" } }, "xml": { "name": "AccountSloa" }, "type": "object" }, "OAS.DataModel.Portfolio.AccountPermissibleAggregateModel": { "required": [ "accountId", "aggregateModelId" ], "properties": { "accountId": { "type": "integer", "format": "int32" }, "aggregateModelId": { "type": "integer", "format": "int32" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" }, "aggregateModel": { "$ref": "#/definitions/OAS.DataModel.Trading.AggregateModel" } }, "xml": { "name": "AccountPermissibleAggregateModel" }, "type": "object" }, "OAS.DataModel.Portfolio.PortfolioGroupAccount": { "required": [ "portfolioGroupId", "accountId" ], "properties": { "portfolioGroupId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "portfolioGroup": { "$ref": "#/definitions/OAS.DataModel.Portfolio.PortfolioGroup" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" } }, "xml": { "name": "PortfolioGroupAccount" }, "type": "object" }, "OAS.DataModel.Portfolio.PortfolioGroupSrcAccount": { "properties": { "portfolioGroupId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "portfolioGroup": { "$ref": "#/definitions/OAS.DataModel.Portfolio.PortfolioGroup" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" } }, "xml": { "name": "PortfolioGroupSrcAccount" }, "type": "object" }, "OAS.DataModel.Integration.Astro.AstroAccountTaxSchedule": { "required": [ "accountId", "year", "annualCapGain" ], "properties": { "accountId": { "type": "integer", "format": "int32" }, "year": { "type": "integer", "format": "int32" }, "annualCapGain": { "type": "number", "format": "double" }, "q1Percent": { "type": "number", "format": "double" }, "q2Percent": { "type": "number", "format": "double" }, "q3Percent": { "type": "number", "format": "double" }, "q4Percent": { "type": "number", "format": "double" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" } }, "xml": { "name": "AstroAccountTaxSchedule" }, "type": "object" }, "OAS.DataModel.Integration.Astro.AstroAccount": { "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int32" }, "maxRealizedGain": { "type": "number", "format": "double" }, "fedShortTaxRate": { "type": "number", "format": "double" }, "fedLongTaxRate": { "type": "number", "format": "double" }, "shortTermTaxRate": { "type": "number", "format": "double" }, "longTermTaxRate": { "type": "number", "format": "double" }, "ticketCharge": { "type": "number", "format": "double" }, "assets": { "items": { "$ref": "#/definitions/OAS.DataModel.Integration.Astro.AstroAsset" }, "xml": { "name": "AstroAsset", "wrapped": true }, "type": "array" } }, "xml": { "name": "AstroAccount" }, "type": "object" }, "OAS.DataModel.Billing.FeeHierarchyAccount": { "required": [ "accountId" ], "properties": { "accountId": { "type": "integer", "format": "int32" }, "billEntityId": { "type": "integer", "format": "int32" }, "billScheduleId": { "type": "integer", "format": "int32" }, "entityName": { "type": "string", "maxLength": 255, "minLength": 0 }, "level": { "type": "integer", "format": "int32" }, "status": { "type": "boolean" }, "id": { "type": "integer", "format": "int32" }, "productType": { "type": "integer", "format": "int32" }, "billProductGroupId": { "type": "integer", "format": "int32" }, "sleeveType": { "type": "integer", "format": "int32" }, "billEntityCollectFromId": { "type": "integer", "format": "int32" }, "type": { "type": "string", "enum": [ "Regular", "AssetLevel", "SleeveLevel" ] }, "billEntity": { "$ref": "#/definitions/OAS.DataModel.Billing.BillEntity" }, "billSchedule": { "$ref": "#/definitions/OAS.DataModel.Billing.BillSchedule" } }, "xml": { "name": "FeeHierarchyAccount" }, "type": "object" }, "OAS.DataModel.Portfolio.AccountBalanceStatus": { "required": [ "accountId", "effectiveDate", "inBalance", "hasNonDownloadingAsset" ], "properties": { "accountId": { "type": "integer", "format": "int32" }, "effectiveDate": { "type": "string", "format": "date-time" }, "inBalance": { "type": "boolean" }, "hasNonDownloadingAsset": { "type": "boolean" }, "lastReconciledEffectiveDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "AccountBalanceStatus" }, "type": "object" }, "OAS.DataModel.Portfolio.RegistrationCustodianBeneficiary": { "required": [ "id", "accountId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "accountHolderId": { "type": "string", "maxLength": 50, "minLength": 0 }, "accountHolderType": { "type": "string", "maxLength": 50, "minLength": 0 }, "role": { "type": "string", "maxLength": 50, "minLength": 0 }, "isPrimaryContact": { "type": "boolean" }, "beneficiaryRelationship": { "type": "string", "maxLength": 100, "minLength": 0 }, "beneficiaryAssetPercentage": { "type": "integer", "format": "int32" }, "title": { "type": "string", "maxLength": 20, "minLength": 0 }, "firstName": { "type": "string", "maxLength": 100, "minLength": 0 }, "middleName": { "type": "string", "maxLength": 100, "minLength": 0 }, "lastName": { "type": "string", "maxLength": 100, "minLength": 0 }, "suffix": { "type": "string", "maxLength": 20, "minLength": 0 }, "nickName": { "type": "string", "maxLength": 100, "minLength": 0 }, "organizationName": { "type": "string", "maxLength": 255, "minLength": 0 }, "dateOfBirth": { "type": "string", "format": "date-time" }, "formattedTaxpayerId": { "type": "string", "maxLength": 20, "minLength": 0 }, "taxpayerIdType": { "type": "string", "maxLength": 20, "minLength": 0 }, "emailAddress": { "type": "string", "maxLength": 255, "minLength": 0 }, "homePhone": { "type": "string", "maxLength": 20, "minLength": 0 }, "mobilePhone": { "type": "string", "maxLength": 20, "minLength": 0 }, "businessPhone": { "type": "string", "maxLength": 20, "minLength": 0 }, "employmentStatus": { "type": "string", "maxLength": 50, "minLength": 0 }, "employerName": { "type": "string", "maxLength": 255, "minLength": 0 }, "citizenship1": { "type": "string", "maxLength": 50, "minLength": 0 }, "citizenship2": { "type": "string", "maxLength": 50, "minLength": 0 }, "fkCustodianCommon": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" }, "custodian": { "$ref": "#/definitions/OAS.DataModel.Portfolio.CustodianLocal" }, "registration": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Registration" }, "signatureStatus": { "type": "string", "maxLength": 100, "minLength": 0 }, "subAdvisorId": { "type": "integer", "format": "int32" }, "accountManagers": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AccountManager" }, "xml": { "name": "AccountManager", "wrapped": true }, "type": "array" }, "additionalClients": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ClientAccountAdditional" }, "xml": { "name": "ClientAccountAdditional", "wrapped": true }, "type": "array" } }, "xml": { "name": "RegistrationCustodianBeneficiary" }, "type": "object" }, "OAS.DataModel.Settings.AccountEntityOption": { "required": [ "entityId", "userDefineDefinitionId", "userDefineDataId", "name", "code", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "AccountEntityOption" }, "type": "object" }, "OAS.DataModel.Settings.AccountUserDefinedField": { "required": [ "entityId", "userDefineDefinitionId", "userDefineDataId", "name", "code", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "AccountUserDefinedField" }, "type": "object" }, "OAS.DataModel.Portfolio.ProductClass": { "required": [ "id", "name", "category" ], "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "description": { "type": "string", "maxLength": 255, "minLength": 0 }, "category": { "type": "string", "maxLength": 20, "minLength": 0 }, "subCategory": { "type": "string", "maxLength": 50, "minLength": 0 }, "rowVersion": { "type": "string", "format": "byte" }, "isDefault": { "type": "boolean" }, "riskScore": { "type": "number", "format": "double" }, "color": { "type": "string", "maxLength": 50, "minLength": 0 }, "classLevel": { "type": "integer", "format": "int32" }, "sortOrder1": { "type": "integer", "format": "int32" }, "sortOrder2": { "type": "integer", "format": "int32" }, "productCategoryId": { "type": "integer", "format": "int32" }, "externalId": { "type": "string", "maxLength": 50, "minLength": 0 }, "importKey": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "productDescriptionProviderId": { "type": "integer", "format": "int32" }, "symbol": { "type": "string" }, "rebalancePriority": { "type": "integer", "format": "int32" }, "rebalanceSellPriority": { "type": "integer", "format": "int32" }, "productCategory": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductCategory" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "aumSummary": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AssetClassAumSummary" }, "provider": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductDescriptionProvider" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.ProductClassEntityOption" }, "xml": { "name": "ProductClassEntityOption", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProductClass" }, "type": "object" }, "OAS.DataModel.Portfolio.RiskCategory": { "required": [ "id", "abbreviation", "fullName" ], "properties": { "id": { "type": "integer", "format": "int32" }, "abbreviation": { "type": "string", "maxLength": 20, "minLength": 0 }, "fullName": { "type": "string", "maxLength": 50, "minLength": 0 }, "color": { "type": "string", "maxLength": 50, "minLength": 0 }, "rank": { "type": "integer", "format": "int32" }, "productDescriptionProviderId": { "type": "integer", "format": "int32" }, "symbol": { "type": "string" }, "isCategoryExcluded": { "type": "boolean" }, "aumSummary": { "$ref": "#/definitions/OAS.DataModel.Portfolio.RiskCategoryAumSummary" }, "provider": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductDescriptionProvider" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.RiskCategoryEntityOption" }, "xml": { "name": "RiskCategoryEntityOption", "wrapped": true }, "type": "array" } }, "xml": { "name": "RiskCategory" }, "type": "object" }, "OAS.DataModel.Portfolio.ProductCategory": { "required": [ "id", "categoryName", "parentCategory" ], "properties": { "id": { "type": "integer", "format": "int32" }, "abbreviation": { "type": "string", "maxLength": 50, "minLength": 0 }, "categoryName": { "type": "string", "maxLength": 100, "minLength": 0 }, "color": { "type": "string", "maxLength": 50, "minLength": 0 }, "parentCategory": { "type": "string", "maxLength": 20, "minLength": 0 }, "sortOrder": { "type": "integer", "format": "int32" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "aumSummary": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AssetCategoryAumSummary" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.ProductCategoryEntityOption" }, "xml": { "name": "ProductCategoryEntityOption", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProductCategory" }, "type": "object" }, "OAS.DataModel.Portfolio.SecurityClassification.MethodLocal": { "required": [ "classificationMethod", "classificationMethodDescription" ], "properties": { "id": { "type": "integer", "format": "int32" }, "classificationMethod": { "type": "string", "maxLength": 70, "minLength": 0 }, "classificationMethodDescription": { "type": "string", "maxLength": 1000, "minLength": 0 }, "securityClassificationType": { "type": "string", "enum": [ "Rules / Assigned", "Inherited", "Global", "Global Inherited", "Compounding", "GICS", "Product Description", "Product Description Weighted", "Product Exchange", "Global Weighted" ] }, "lastCalculated": { "type": "string", "format": "date-time" }, "recalculationHour": { "type": "integer", "format": "int32" }, "recalculationSchedule": { "type": "string", "enum": [ "On Demand", "Daily", "Weekly", "Monthly" ] }, "entityEnum": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "isTradingEnabled": { "type": "boolean" }, "isBillingEnabled": { "type": "boolean" }, "securityClassDefaultId": { "type": "integer", "format": "int32" }, "securityClassificationMethodBaseId": { "type": "integer", "format": "int32" }, "securityClassificationMethodGlobalId": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "useParentProductAssignment": { "type": "boolean" }, "lastUpdated": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "securityClassDefault": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SecurityClassification.SecurityClassLocal" }, "securityClassificationMethodBase": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SecurityClassification.MethodLocal" }, "securityClassesLocal": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SecurityClassification.SecurityClassLocal" }, "xml": { "name": "SecurityClassLocal", "wrapped": true }, "type": "array" }, "derivationsLocal": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SecurityClassification.DerivationLocal" }, "xml": { "name": "DerivationLocal", "wrapped": true }, "type": "array" }, "methodRulesLocal": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SecurityClassification.MethodRuleLocal" }, "xml": { "name": "MethodRuleLocal", "wrapped": true }, "type": "array" } }, "xml": { "name": "MethodLocal" }, "type": "object" }, "OAS.DataModel.Portfolio.SecurityClassification.SecurityClassLocal": { "properties": { "id": { "type": "integer", "format": "int32" }, "securityClassificationMethodId": { "type": "integer", "format": "int32" }, "securityClassCode": { "type": "string", "maxLength": 1000, "minLength": 0 }, "securityClass": { "type": "string", "maxLength": 1000, "minLength": 0 }, "excludeFromFeesAndPayouts": { "type": "boolean" }, "color": { "type": "string", "maxLength": 50, "minLength": 0 }, "sortOrder": { "type": "integer", "format": "int32" }, "riskScore": { "type": "number", "format": "double" }, "securityClassGlobalId": { "type": "integer", "format": "int32" }, "productDescriptionProviderId": { "type": "integer", "format": "int32" }, "localOverrideFieldList": { "type": "string", "maxLength": 1000, "minLength": 0 }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedBy": { "type": "string" }, "securityClassificationMethod": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SecurityClassification.MethodLocal" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.SecurityClassLocalEntityOption" }, "xml": { "name": "SecurityClassLocalEntityOption", "wrapped": true }, "type": "array" }, "userDefinedFields": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.SecurityClassLocalUserDefinedField" }, "xml": { "name": "SecurityClassLocalUserDefinedField", "wrapped": true }, "type": "array" } }, "xml": { "name": "SecurityClassLocal" }, "type": "object" }, "OAS.DataModel.Billing.BillMasterScheduleDetail": { "required": [ "id", "billMasterScheduleId", "billEntityId", "isRemainder", "editedDate", "editedBy", "createDate", "createdBy" ], "properties": { "id": { "type": "integer", "format": "int32" }, "billMasterScheduleId": { "type": "integer", "format": "int32" }, "billEntityId": { "type": "integer", "format": "int32" }, "billScheduleId": { "type": "integer", "format": "int32" }, "isRemainder": { "type": "boolean" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "createDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "timestamp": { "type": "string", "format": "byte" }, "masterSchedule": { "$ref": "#/definitions/OAS.DataModel.Billing.BillMasterSchedule" }, "billEntity": { "$ref": "#/definitions/OAS.DataModel.Billing.BillEntity" }, "billSchedule": { "$ref": "#/definitions/OAS.DataModel.Billing.BillSchedule" } }, "xml": { "name": "BillMasterScheduleDetail" }, "type": "object" }, "OAS.DataModel.Billing.BillScheduleDetail": { "required": [ "id", "billScheduleId", "minimumAmount", "maximumAmount", "rate", "flatFee" ], "properties": { "id": { "type": "integer", "format": "int32" }, "billScheduleId": { "type": "integer", "format": "int32" }, "minimumAmount": { "type": "number", "format": "double" }, "maximumAmount": { "type": "number", "format": "double" }, "rate": { "type": "number", "format": "double" }, "points": { "type": "number", "format": "double" }, "flatFee": { "type": "number", "format": "double" }, "reducedRate": { "type": "number", "format": "double" }, "reducedRateMinimumAmount": { "type": "number", "format": "double" }, "billSchedule": { "$ref": "#/definitions/OAS.DataModel.Billing.BillSchedule" } }, "xml": { "name": "BillScheduleDetail" }, "type": "object" }, "OAS.DataModel.Billing.BillTransmitMethod": { "required": [ "id", "transmitMethod" ], "properties": { "id": { "type": "integer", "format": "int32" }, "transmitMethod": { "type": "string", "maxLength": 20, "minLength": 0 }, "description": { "type": "string", "maxLength": 255, "minLength": 0 }, "statementDelivery": { "type": "boolean" } }, "xml": { "name": "BillTransmitMethod" }, "type": "object" }, "OAS.DataModel.Billing.BillClient": { "required": [ "id", "clientId", "billClientStatusId", "isRep", "isFlatFee", "flatFeeAmt", "minUnderMgt", "ignoreCustomInvoiceItems" ], "properties": { "id": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "billClientStatusId": { "type": "string", "enum": [ "ReadyToBill", "Hold", "PendingReview" ] }, "isRep": { "type": "boolean" }, "isFlatFee": { "type": "boolean" }, "flatFeeAmt": { "type": "number", "format": "double" }, "minUnderMgt": { "type": "number", "format": "double" }, "cancelDate": { "type": "string", "format": "date-time" }, "cancelAmount": { "type": "number", "format": "double" }, "oldReceivableID": { "type": "integer", "format": "int32" }, "feeScheduleId": { "type": "integer", "format": "int32" }, "masterPayoutScheduleId": { "type": "integer", "format": "int32" }, "ignoreCustomInvoiceItems": { "type": "boolean" }, "client": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Client" }, "bills": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.Bill" }, "xml": { "name": "Bill", "wrapped": true }, "type": "array" }, "billFeeSchedule": { "$ref": "#/definitions/OAS.DataModel.Billing.BillSchedule" }, "billMasterPayoutSchedule": { "$ref": "#/definitions/OAS.DataModel.Billing.BillMasterSchedule" }, "relatedClients": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillRelatedClient" }, "xml": { "name": "BillRelatedClient", "wrapped": true }, "type": "array" } }, "xml": { "name": "BillClient" }, "type": "object" }, "OAS.DataModel.Billing.BillType": { "required": [ "id", "type" ], "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "type": "string", "maxLength": 20, "minLength": 0 }, "description": { "type": "string", "maxLength": 255, "minLength": 0 } }, "xml": { "name": "BillType" }, "type": "object" }, "OAS.DataModel.Billing.BillInstance": { "required": [ "id", "runFor", "createdDate", "createdBy", "percentComplete", "isMockBill" ], "properties": { "id": { "type": "integer", "format": "int32" }, "nickName": { "type": "string", "maxLength": 250, "minLength": 0 }, "runFor": { "type": "string", "enum": [ "AllHouseholds", "FundFamily", "Custodian", "Representative", "BusinessLine", "SingleHHNewBill", "SingleHHRerun", "Accounts", "ImportedHouseholds", "ImportedHHRerun", "FinalBill" ] }, "runForKeyList": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 30, "minLength": 0 }, "status": { "type": "string", "maxLength": 150, "minLength": 0 }, "percentComplete": { "type": "integer", "format": "int32" }, "billTypeId": { "type": "string", "enum": [ "Unknown", "Renewal", "NewMoney", "NewAccount", "FinancialPlanningFee", "Performance", "AdvanceCreditDebit" ] }, "statusValue": { "type": "string", "enum": [ "NotGenerated", "BillDataFilesNeeded", "FeeFileNeeded", "WaitingforPostPayments", "AdvisoryFeeRptsNeeded", "UpdatePayablesNeeded", "Complete", "ForcedComplete", "FeeFileFailed", "FeeFileInProcess", "PendingDeletion", "DeletionInProgress", "ErrorDeletingInstance" ] }, "blobPayableReportId": { "type": "integer", "format": "int32" }, "isMockBill": { "type": "boolean" }, "hangfireJobId": { "type": "string" }, "hangfireJobType": { "type": "string", "enum": [ "GenerateReports", "SendEmails", "SendToPrintVendor", "BillingGenerator", "CompositeAccounts", "CompositeAdHocAccounts", "DetectAdditionalErrors", "DeleteBillInstance" ] }, "excludeAdjustments": { "type": "boolean" }, "asOfDate": { "type": "string", "format": "date-time" }, "billFrequency": { "type": "integer", "format": "int32" }, "billStyle": { "type": "integer", "format": "int32" }, "endDateOverride": { "type": "string", "format": "date-time" }, "valueDateOverride": { "type": "string", "format": "date-time" }, "entityOptions": { "type": "string" }, "trInstanceFee": { "type": "integer", "format": "int32" }, "includeCashFlows": { "type": "boolean" }, "allowDuplicateMockBills": { "type": "boolean" }, "runForAccounts": { "type": "string", "enum": [ "ActiveAccounts", "InActiveAccounts", "AllAccounts" ] }, "pendingsCreated": { "type": "boolean" }, "isLockdown": { "type": "boolean" }, "accountItems": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAccountItem" }, "xml": { "name": "BillAccountItem", "wrapped": true }, "type": "array" }, "bills": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.Bill" }, "xml": { "name": "Bill", "wrapped": true }, "type": "array" }, "billInstanceClients": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillInstanceClient" }, "xml": { "name": "BillInstanceClient", "wrapped": true }, "type": "array" }, "info": { "$ref": "#/definitions/OAS.DataModel.Billing.BillInstanceAdditionalInfo" } }, "xml": { "name": "BillInstance" }, "type": "object" }, "OAS.DataModel.Billing.BillAdditionalInfo": { "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "asOfDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "initialAmount": { "type": "number", "format": "double" }, "appliedAdjustment": { "type": "number", "format": "double" }, "balanceDue": { "type": "number", "format": "double" }, "isMockBill": { "type": "boolean" } }, "xml": { "name": "BillAdditionalInfo" }, "type": "object" }, "OAS.DataModel.Billing.BillLog": { "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int32" }, "logText": { "type": "string" } }, "xml": { "name": "BillLog" }, "type": "object" }, "OAT.DataModel.ComplexTypes.BasicAuditNotNullNull": { "properties": { "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 } }, "xml": { "name": "BasicAuditNotNullNull" }, "type": "object" }, "OAS.DataModel.Trading.TransactionType": { "required": [ "id", "name", "description", "isBreak", "netTransfer", "isNoUnits", "isNoPrice", "isNoAmount", "isBillable", "twrType", "financialType", "usagePriority" ], "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "type": "string", "maxLength": 50, "minLength": 0 }, "source": { "type": "string", "maxLength": 20, "minLength": 0 }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "description": { "type": "string", "maxLength": 255, "minLength": 0 }, "valueEffect": { "type": "integer", "format": "int32" }, "shareEffect": { "type": "integer", "format": "int32" }, "tranClassification": { "type": "string", "maxLength": 25, "minLength": 0 }, "isBreak": { "type": "boolean" }, "qsClassification": { "type": "string", "maxLength": 50, "minLength": 0 }, "netTransfer": { "type": "boolean" }, "transRpt": { "type": "integer", "format": "int32" }, "is1099B": { "type": "boolean" }, "is1099R": { "type": "boolean" }, "is1099Div": { "type": "boolean" }, "is1099Int": { "type": "boolean" }, "isBShare": { "type": "boolean" }, "signField": { "type": "string", "maxLength": 1, "minLength": 0 }, "isValid": { "type": "boolean" }, "distribClassification": { "type": "string", "maxLength": 50, "minLength": 0 }, "payoutOption": { "type": "string", "maxLength": 20, "minLength": 0 }, "isNoUnits": { "type": "boolean" }, "isNoPrice": { "type": "boolean" }, "isNoAmount": { "type": "boolean" }, "isBillable": { "type": "boolean" }, "twrType": { "type": "integer", "format": "int32" }, "financialType": { "type": "string", "enum": [ "None", "Contribution", "Distribution", "Exchange", "DivReinvest", "MgmntFees", "DivCash", "MiscFees", "Journal", "Merges" ] }, "usagePriority": { "type": "integer", "format": "int32" }, "cashOffsetTransType": { "type": "integer", "format": "int32" }, "performanceRollupType": { "type": "string", "enum": [ "CashDiv", "ReinvestedDiv", "Fee", "Cashflow", "CashDivNonMovable", "InceptingCashflow", "InterestCashflow" ] }, "performanceRollupDividendThreshold": { "type": "number", "format": "double" } }, "xml": { "name": "TransactionType" }, "type": "object" }, "OAS.DataModel.Trading.TransactionSubType": { "required": [ "id", "name", "transTypeCommonId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "maxLength": 100, "minLength": 0 }, "description": { "type": "string", "maxLength": 255, "minLength": 0 }, "transTypeCommonId": { "type": "integer", "format": "int32" } }, "xml": { "name": "TransactionSubType" }, "type": "object" }, "OAS.DataModel.Trading.FixTradeRequest": { "required": [ "id", "tradeIt", "productId", "accountId", "handlInst", "side", "ordType", "orderQty", "originalOrderQty", "isDiscretionary", "approvalStatus", "optionTradeType" ], "properties": { "id": { "type": "integer", "format": "int32" }, "tradeIt": { "type": "boolean" }, "productId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "assetId": { "type": "integer", "format": "int32" }, "transactionId": { "type": "integer", "format": "int32" }, "fixBlockOrderId": { "type": "integer", "format": "int32" }, "tradeRequestInstanceId": { "type": "integer", "format": "int32" }, "handlInst": { "type": "string", "maxLength": 1, "minLength": 0 }, "execInst": { "type": "string", "maxLength": 50, "minLength": 0 }, "side": { "type": "string", "maxLength": 1, "minLength": 0 }, "locateReqd": { "type": "boolean" }, "ordType": { "type": "string", "maxLength": 1, "minLength": 0 }, "limitPrice": { "type": "number", "format": "double" }, "stopPrice": { "type": "number", "format": "double" }, "timeInForce": { "type": "string", "maxLength": 1, "minLength": 0 }, "expireTime": { "type": "string", "format": "date-time" }, "warningMessage": { "type": "string", "maxLength": 255, "minLength": 0 }, "orderQty": { "type": "number", "format": "double" }, "originalOrderQty": { "type": "number", "format": "double" }, "orderAmt": { "type": "number", "format": "double" }, "orderPct": { "type": "number", "format": "double" }, "sharesOwned": { "type": "number", "format": "double" }, "mktValue": { "type": "number", "format": "double" }, "navPrice": { "type": "number", "format": "double" }, "audit": { "$ref": "#/definitions/OAT.DataModel.ComplexTypes.BasicAuditNullNull" }, "notes": { "type": "string", "maxLength": 255, "minLength": 0 }, "isDiscretionary": { "type": "boolean" }, "settlmntTyp": { "type": "string", "maxLength": 1, "minLength": 0 }, "futSettDate": { "type": "string", "format": "date-time" }, "rowVersion": { "type": "string", "format": "byte" }, "approvalStatus": { "type": "string", "enum": [ "Approved", "PendingApproval", "NotApproved" ] }, "exchangeId": { "type": "integer", "format": "int32" }, "solicited": { "type": "boolean" }, "vspDate": { "type": "string", "format": "date-time" }, "vspPrice": { "type": "number", "format": "double" }, "sellPriority": { "type": "integer", "format": "int32" }, "assetCostCustodianId": { "type": "integer", "format": "int32" }, "cashValuePostTradeExecution": { "type": "number", "format": "double" }, "eclipseOrderId": { "type": "integer", "format": "int32" }, "product": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductLocal" }, "blockOrder": { "$ref": "#/definitions/OAS.DataModel.Trading.FixBlockOrder" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" }, "asset": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Asset" }, "tradeRequestInstance": { "$ref": "#/definitions/OAS.DataModel.Trading.TradeRequestInstance" }, "transactions": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.Transaction" }, "xml": { "name": "Transaction", "wrapped": true }, "type": "array" }, "gainLoss": { "$ref": "#/definitions/OAS.DataModel.Trading.FixTradeRequestGainLoss" }, "orderFees": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.FixTradeRequestFee" }, "xml": { "name": "FixTradeRequestFee", "wrapped": true }, "type": "array" }, "commissions": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.FixTradeRequestCommissionBase" }, "xml": { "name": "FixTradeRequestCommissionBase", "wrapped": true }, "type": "array" }, "extension": { "$ref": "#/definitions/OAS.DataModel.Trading.FixTradeRequestExt" }, "exchangeFixTradeRequest": { "$ref": "#/definitions/OAS.DataModel.Trading.FixTradeRequest" }, "isPending": { "$ref": "#/definitions/OAS.DataModel.Trading.FixTradeRequestPending" }, "fixRoute": { "$ref": "#/definitions/OAS.DataModel.Trading.FixTradeRequestRoute" }, "accountOrderInfo": { "$ref": "#/definitions/OAS.DataModel.Trading.TradingAccountOrderInfo" }, "optionTradeType": { "type": "integer", "format": "int32" }, "optionDwnldMgrId": { "type": "integer", "format": "int32" }, "optionTRInterfaceId": { "type": "integer", "format": "int32" } }, "xml": { "name": "FixTradeRequest" }, "type": "object" }, "OAS.DataModel.Trading.ContributionCode": { "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string", "maxLength": 100, "minLength": 0 } }, "xml": { "name": "ContributionCode" }, "type": "object" }, "OAS.DataModel.Trading.DistributionCode": { "required": [ "id", "extId", "distCode" ], "properties": { "id": { "type": "integer", "format": "int32" }, "extId": { "type": "integer", "format": "int32" }, "distCode": { "type": "string", "maxLength": 50, "minLength": 0 }, "taxCode": { "type": "string", "maxLength": 50, "minLength": 0 }, "fedCode": { "type": "string", "maxLength": 1, "minLength": 0 }, "description": { "type": "string", "maxLength": 100, "minLength": 0 }, "transDesc": { "type": "string", "maxLength": 150, "minLength": 0 }, "distDesc": { "type": "string", "maxLength": 150, "minLength": 0 }, "isValid": { "type": "boolean" }, "isQualified": { "type": "boolean" } }, "xml": { "name": "DistributionCode" }, "type": "object" }, "OAS.DataModel.Trading.TransactionExt": { "required": [ "id", "transactionId", "isOID", "includeAsRmdDistributionIsSystemMaintained" ], "properties": { "id": { "type": "integer", "format": "int32" }, "transactionId": { "type": "integer", "format": "int32" }, "yieldToMaturity": { "type": "number", "format": "double" }, "isOID": { "type": "boolean" }, "tradeRequestId": { "type": "integer", "format": "int32" }, "commIndicator": { "type": "integer", "format": "int32" }, "orderType": { "type": "integer", "format": "int32" }, "marketCode": { "type": "integer", "format": "int32" }, "blotterCode": { "type": "integer", "format": "int32" }, "distIndicator": { "type": "integer", "format": "int32" }, "revenueType": { "type": "integer", "format": "int32" }, "spreadStraddle": { "type": "integer", "format": "int32" }, "brokerCode": { "type": "string", "maxLength": 50, "minLength": 0 }, "includeAsRmdDistribution": { "type": "boolean" }, "includeAsRmdDistributionIsSystemMaintained": { "type": "boolean" }, "divExDate": { "type": "string", "format": "date-time" }, "corporateActionProcessingId": { "type": "integer", "format": "int32" }, "oidInterest": { "type": "number", "format": "double" } }, "xml": { "name": "TransactionExt" }, "type": "object" }, "OAS.DataModel.Trading.TransactionExtAlternative": { "required": [ "id", "transactionId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "transactionId": { "type": "integer", "format": "int32" }, "equityActivityTypeId": { "type": "integer", "format": "int32" }, "equityFundingTypeId": { "type": "integer", "format": "int32" }, "impactsCommitment": { "type": "boolean" }, "impactsCapitalBalance": { "type": "boolean" }, "productTransactionId": { "type": "integer", "format": "int32" }, "cashDate": { "type": "string", "format": "date-time" }, "equityActivityType": { "$ref": "#/definitions/OAS.DataModel.Confirm.Alternative.EquityActivityType" }, "equityFundingType": { "$ref": "#/definitions/OAS.DataModel.Confirm.Alternative.EquityFundingType" }, "productTransaction": { "$ref": "#/definitions/OAS.DataModel.Confirm.Alternative.ProductTransaction" } }, "xml": { "name": "TransactionExtAlternative" }, "type": "object" }, "OAS.DataModel.Trading.TranCostBasis": { "required": [ "id", "transactionId", "costDate", "costUnits", "costPrice", "costTotal", "transTypeId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "transactionId": { "type": "integer", "format": "int32" }, "costDate": { "type": "string", "format": "date-time" }, "costUnits": { "type": "number", "format": "double" }, "costPrice": { "type": "number", "format": "double" }, "costTotal": { "type": "number", "format": "double" }, "costNotes": { "type": "string", "maxLength": 255, "minLength": 0 }, "transTypeId": { "type": "integer", "format": "int32" }, "holdingPeriodDate": { "type": "string", "format": "date-time" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "transaction": { "$ref": "#/definitions/OAS.DataModel.Trading.Transaction" } }, "xml": { "name": "TranCostBasis" }, "type": "object" }, "OAS.DataModel.Trading.TransactionCommission": { "required": [ "id", "transactionId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "transactionId": { "type": "integer", "format": "int32" }, "commRecordType": { "type": "integer", "format": "int32" }, "grossTransAmt": { "type": "number", "format": "double" }, "dealerCommAmt": { "type": "number", "format": "double" }, "commRate": { "type": "number", "format": "double" } }, "xml": { "name": "TransactionCommission" }, "type": "object" }, "OAS.DataModel.Trading.TransactionFee": { "required": [ "id", "transactionId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "transactionId": { "type": "integer", "format": "int32" }, "transactionFeeTypeId": { "type": "integer", "format": "int32" }, "feeAmount": { "type": "number", "format": "double" }, "fileFeeDescription": { "type": "string", "maxLength": 50, "minLength": 0 }, "feeType": { "type": "string", "maxLength": 50, "minLength": 0 } }, "xml": { "name": "TransactionFee" }, "type": "object" }, "OAS.DataModel.Settings.TransactionEntityOption": { "required": [ "entityId", "userDefineDefinitionId", "userDefineDataId", "name", "code", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "TransactionEntityOption" }, "type": "object" }, "OAS.DataModel.Trading.TransactionUnitBalance": { "required": [ "transactionId", "unitBalance" ], "properties": { "transactionId": { "type": "integer", "format": "int32" }, "unitBalance": { "type": "number", "format": "double" } }, "xml": { "name": "TransactionUnitBalance" }, "type": "object" }, "OAS.DataModel.Settings.TransactionUserDefinedField": { "required": [ "entityId", "userDefineDefinitionId", "userDefineDataId", "name", "code", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "TransactionUserDefinedField" }, "type": "object" }, "OAS.DataModel.Confirm.TransactionTaxError": { "required": [ "transactionId", "id", "auditType", "errorMessage", "resolutionMessage", "createdDate", "createdBy" ], "properties": { "transactionId": { "type": "integer", "format": "int32" }, "transaction": { "$ref": "#/definitions/OAS.DataModel.Trading.Transaction" }, "id": { "type": "integer", "format": "int32" }, "auditType": { "type": "string", "enum": [ "CustodialRealizedSharesDoNotMatch", "CustodialRealizedMissing", "CustodialUnrealizedMissing", "CustodialRealizedUnknownAcquiredDate", "CustodialUnrealizedUnknownAcquiredDate", "CustodialRealizedUnknownCostBasis", "CustodialUnrealizedUnknownCostBasis", "OrionUnknownCostBasis", "MoneyMarketProducts", "OrionMissingCostBasis" ] }, "assetId": { "type": "integer", "format": "int32" }, "errorMessage": { "type": "string", "maxLength": 255, "minLength": 0 }, "resolutionMessage": { "type": "string", "maxLength": 255, "minLength": 0 }, "expectedUnits": { "type": "number", "format": "double" }, "costUnits": { "type": "number", "format": "double" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "reviewed": { "type": "boolean" } }, "xml": { "name": "TransactionTaxError" }, "type": "object" }, "OAS.DataModel.Confirm.TransactionTaxErrorSummary": { "required": [ "parentId", "taxErrorIds" ], "properties": { "transaction": { "$ref": "#/definitions/OAS.DataModel.Trading.Transaction" }, "parentId": { "type": "integer", "format": "int32" }, "taxErrorIds": { "type": "string" } }, "xml": { "name": "TransactionTaxErrorSummary" }, "type": "object" }, "OAS.DataModel.Portfolio.Personal": { "required": [ "id", "lastName", "entityName", "entity", "isUSResident" ], "properties": { "id": { "type": "integer", "format": "int32" }, "firstName": { "type": "string", "maxLength": 30, "minLength": 0 }, "lastName": { "type": "string", "maxLength": 255, "minLength": 0 }, "entityName": { "type": "string", "maxLength": 255, "minLength": 0 }, "address": { "$ref": "#/definitions/OAS.DataModel.ComplexTypes.Address" }, "homePhone": { "$ref": "#/definitions/OAS.DataModel.ComplexTypes.FullPhoneNumber" }, "businessPhone": { "$ref": "#/definitions/OAS.DataModel.ComplexTypes.FullPhoneNumber" }, "mobilePhone": { "$ref": "#/definitions/OAS.DataModel.ComplexTypes.PhoneNumber" }, "fax": { "$ref": "#/definitions/OAS.DataModel.ComplexTypes.FullPhoneNumber" }, "otherPhone": { "$ref": "#/definitions/OAS.DataModel.ComplexTypes.FullPhoneNumber" }, "pager": { "$ref": "#/definitions/OAS.DataModel.ComplexTypes.FullPhoneNumber" }, "email": { "type": "string", "maxLength": 200, "minLength": 0 }, "webAddress": { "type": "string", "maxLength": 255, "minLength": 0 }, "salutation": { "type": "string", "maxLength": 50, "minLength": 0 }, "ssN_TaxID": { "type": "string", "maxLength": 15, "minLength": 0 }, "deceasedSSN_TaxID": { "type": "string", "maxLength": 15, "minLength": 0 }, "dob": { "type": "string", "maxLength": 20, "minLength": 0 }, "birthDate": { "readOnly": true, "type": "string", "format": "date-time" }, "isSmoker": { "type": "boolean" }, "gender": { "type": "string", "maxLength": 1, "minLength": 0 }, "marital": { "type": "string", "maxLength": 50, "minLength": 0 }, "prefix": { "type": "string", "maxLength": 50, "minLength": 0 }, "suffix": { "type": "string", "maxLength": 50, "minLength": 0 }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "audit": { "$ref": "#/definitions/OAT.DataModel.ComplexTypes.BasicAuditNullNull" }, "personalDesc": { "type": "string", "maxLength": 50, "minLength": 0 }, "isActive": { "type": "boolean" }, "jobTitle": { "type": "string", "maxLength": 200, "minLength": 0 }, "isBlockedPersonOverride": { "type": "boolean" }, "isUSCitizen": { "type": "boolean" }, "company": { "type": "string", "maxLength": 255, "minLength": 0 }, "twitterUsername": { "type": "string", "maxLength": 50, "minLength": 0 }, "facebookUrl": { "type": "string", "maxLength": 8000, "minLength": 0 }, "blobPhotoId": { "type": "integer", "format": "int32" }, "reportName": { "type": "string", "maxLength": 255, "minLength": 0 }, "isUSResident": { "type": "boolean" }, "country": { "type": "string", "maxLength": 150, "minLength": 0 }, "isMobileVerified": { "type": "boolean" } }, "xml": { "name": "Personal" }, "type": "object" }, "OAS.DataModel.Billing.PayeeBlob": { "required": [ "isViewable", "isViewableAdvisor", "isViewableRepresentative", "id", "isZip", "uniqueID" ], "properties": { "payeeId": { "type": "integer", "format": "int32" }, "isViewable": { "type": "boolean" }, "isViewableAdvisor": { "type": "boolean" }, "isViewableRepresentative": { "type": "boolean" }, "crmDocuments": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.CrmDocument" }, "xml": { "name": "CrmDocument", "wrapped": true }, "type": "array" }, "payee": { "$ref": "#/definitions/OAS.DataModel.Billing.Payee" }, "id": { "type": "integer", "format": "int32" }, "openWith": { "type": "string", "maxLength": 200, "minLength": 0 }, "fileName": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "rowVersion": { "type": "string", "format": "byte" }, "blobDesc": { "type": "string", "maxLength": 200, "minLength": 0 }, "blobText": { "type": "string" }, "isZip": { "type": "boolean" }, "fileNETidmId": { "type": "string", "maxLength": 9, "minLength": 0 }, "filePath": { "type": "string", "maxLength": 500, "minLength": 0 }, "eFileLocation": { "type": "string", "enum": [ "Undefined", "Database", "FileServer", "AmazonS3", "HttpGet", "RedtailIms", "Communities" ] }, "rootPath": { "type": "string", "maxLength": 100, "minLength": 0 }, "uniqueID": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "PayeeBlob" }, "type": "object" }, "OAS.DataModel.Portfolio.Representative": { "required": [ "id", "personalId", "copyToRep", "isRIA", "hasADV", "hasU4", "isActive", "isDstDwnld" ], "properties": { "id": { "type": "integer", "format": "int32" }, "personalId": { "type": "integer", "format": "int32" }, "brokerDealerId": { "type": "integer", "format": "int32" }, "wholesalerId": { "type": "integer", "format": "int32" }, "payeeId": { "type": "integer", "format": "int32" }, "riaId": { "type": "integer", "format": "int32" }, "wholesaler401KId": { "type": "integer", "format": "int32" }, "planAdministratorId": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "createdDate": { "type": "string", "format": "date-time" }, "copyToRep": { "type": "boolean" }, "isRIA": { "type": "boolean" }, "riaName": { "type": "string", "maxLength": 100, "minLength": 0 }, "royalTCode": { "type": "string", "maxLength": 5, "minLength": 0 }, "hasADV": { "type": "boolean" }, "hasU4": { "type": "boolean" }, "isActive": { "type": "boolean" }, "isDstDwnld": { "type": "boolean" }, "branchID": { "type": "string", "maxLength": 50, "minLength": 0 }, "oldRep_ID": { "type": "integer", "format": "int32" }, "number": { "type": "string", "maxLength": 1000, "minLength": 0 }, "impDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "startDate": { "type": "string", "format": "date-time" }, "repStatus": { "type": "string", "enum": [ "ActiveNoIssues", "HoldForCompliance", "ActiveNoNewClients", "InActive", "Pending", "Limited", "Prospect", "Rejected" ] }, "firmName": { "type": "string", "maxLength": 50, "minLength": 0 }, "actgLedgerNum": { "type": "string", "maxLength": 50, "minLength": 0 }, "isDefault": { "type": "boolean" }, "importKey": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "raAmount": { "type": "number", "format": "double" }, "raDate": { "type": "string", "format": "date-time" }, "isRAActive": { "type": "boolean" }, "repRestrict": { "type": "string", "maxLength": 150, "minLength": 0 }, "custodianPortalId": { "type": "string" }, "repCRDNumber": { "type": "string", "maxLength": 50, "minLength": 0 }, "globalId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "alClient": { "type": "integer", "format": "int32" }, "billRepresentatives": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillRepresentative" }, "xml": { "name": "BillRepresentative", "wrapped": true }, "type": "array" }, "clients": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Client" }, "xml": { "name": "Client", "wrapped": true }, "type": "array" }, "additionalClientAssignments": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AdditionalRepAssignment" }, "xml": { "name": "AdditionalRepAssignment", "wrapped": true }, "type": "array" }, "clientRepAdditional": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ClientRepAdditional" }, "xml": { "name": "ClientRepAdditional", "wrapped": true }, "type": "array" }, "additionalRepAssignmentsPercent": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AdditionalRepAssignmentPercent" }, "xml": { "name": "AdditionalRepAssignmentPercent", "wrapped": true }, "type": "array" }, "changes": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.RepresentativeChange" }, "xml": { "name": "RepresentativeChange", "wrapped": true }, "type": "array" }, "repBrokerDealers": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.RepBrokerDealer" }, "xml": { "name": "RepBrokerDealer", "wrapped": true }, "type": "array" }, "photo": { "$ref": "#/definitions/OAS.DataModel.Portfolio.RepresentativePhoto" }, "reportImage": { "$ref": "#/definitions/OAS.DataModel.Portfolio.RepresentativeImageBlob" }, "ria": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Ria" }, "brokerDealer": { "$ref": "#/definitions/OAS.DataModel.Portfolio.BrokerDealer" }, "wholesaler": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Wholesaler" }, "aumSummary": { "$ref": "#/definitions/OAS.DataModel.Portfolio.RepresentativeAumSummary" }, "payee": { "$ref": "#/definitions/OAS.DataModel.Billing.Payee" }, "blobs": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.RepresentativeBlob" }, "xml": { "name": "RepresentativeBlob", "wrapped": true }, "type": "array" }, "notes": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.RepresentativeNote" }, "xml": { "name": "RepresentativeNote", "wrapped": true }, "type": "array" }, "repNasds": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.RepNasd" }, "xml": { "name": "RepNasd", "wrapped": true }, "type": "array" }, "repOnHolds": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.RepOnHold" }, "xml": { "name": "RepOnHold", "wrapped": true }, "type": "array" }, "repStates": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.RepState" }, "xml": { "name": "RepState", "wrapped": true }, "type": "array" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.RepresentativeEntityOption" }, "xml": { "name": "RepresentativeEntityOption", "wrapped": true }, "type": "array" }, "personal": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Personal" }, "userDefinedFields": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.RepresentativeUserDefinedField" }, "xml": { "name": "RepresentativeUserDefinedField", "wrapped": true }, "type": "array" }, "billProductException": { "$ref": "#/definitions/OAS.DataModel.Billing.RepresentativeBillProductException" }, "reportRepresentativeVersionAssignments": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Envision.ReportRepresentativeVersionAssignment" }, "xml": { "name": "ReportRepresentativeVersionAssignment", "wrapped": true }, "type": "array" } }, "xml": { "name": "Representative" }, "type": "object" }, "OAS.DataModel.Portfolio.AssetLevelStrategyAssign": { "required": [ "id", "assetLevelStrategyId", "createdBy", "createdDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "assetLevelStrategyId": { "type": "integer", "format": "int32" }, "platformId": { "type": "integer", "format": "int32" }, "assetClassId": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "platform": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Platform" }, "assetClass": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductClass" }, "assetLevelStrategy": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AssetLevelStrategy" } }, "xml": { "name": "AssetLevelStrategyAssign" }, "type": "object" }, "OAS.DataModel.Portfolio.ProductGroup": { "required": [ "id", "productId", "rank", "isActive" ], "properties": { "id": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "groupCode": { "type": "string", "maxLength": 50, "minLength": 0 }, "rank": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "product": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductLocal" }, "master": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductGroupMaster" } }, "xml": { "name": "ProductGroup" }, "type": "object" }, "OAS.DataModel.Portfolio.ProductExtension": { "required": [ "id", "assetClassId", "isDisabled", "isAutoAssign", "isCustodialCash", "isManaged", "is13fReportable", "isAdvReportable", "allowIntraDayPerformance", "hasFees", "useGlobalSetting", "isFederallyTaxable", "isStateTaxable", "useLocalPricesOnly", "useDailyInterestAccrual", "excludeBondAccrualFromValuations", "paymentCycleDateType" ], "properties": { "id": { "type": "integer", "format": "int32" }, "assetClassId": { "type": "integer", "format": "int32" }, "riskCategoryId": { "type": "integer", "format": "int32" }, "isDisabled": { "type": "boolean" }, "productStatus": { "type": "string", "enum": [ "Open", "SoftClose", "HardClose", "SellOnly", "PurchaseOnly", "Exclude" ] }, "snPRatingId": { "type": "integer", "format": "int32" }, "productRiskAltId": { "type": "integer", "format": "int32" }, "isAutoAssign": { "type": "boolean" }, "isUsed": { "type": "string", "enum": [ "UsedInCurrentDB", "UsedInOtherDB", "NotUsed" ] }, "moodyRatingId": { "type": "integer", "format": "int32" }, "isCustodialCash": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "is13fReportable": { "type": "boolean" }, "isAdvReportable": { "type": "boolean" }, "allowIntraDayPerformance": { "type": "boolean" }, "hasFees": { "type": "boolean" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "useGlobalSetting": { "type": "boolean" }, "isFederallyTaxable": { "type": "boolean" }, "isStateTaxable": { "type": "boolean" }, "useLocalPricesOnly": { "type": "boolean" }, "annualIncomeRate": { "type": "number", "format": "double" }, "paymentFrequency": { "type": "string", "enum": [ "AtMaturity", "Monthly", "BiMonthly", "Quarterly", "Triannually", "Semiannually", "Annually", "Biennially" ] }, "color": { "type": "string", "maxLength": 50, "minLength": 0 }, "advAssetCategoryId": { "type": "integer", "format": "int32" }, "useDailyInterestAccrual": { "type": "boolean" }, "excludeBondAccrualFromValuations": { "type": "boolean" }, "productNameOverride": { "type": "string", "maxLength": 150, "minLength": 0 }, "paymentCycleDateType": { "type": "string", "enum": [ "Normal", "NextBusinessDay", "PreviousBusinessDay" ] }, "assetClass": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductClass" }, "riskCategory": { "$ref": "#/definitions/OAS.DataModel.Portfolio.RiskCategory" }, "snPRating": { "$ref": "#/definitions/OAS.DataModel.Portfolio.BondRating" }, "moodyRating": { "$ref": "#/definitions/OAS.DataModel.Portfolio.BondRating" }, "billProducts": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillProduct" }, "xml": { "name": "BillProduct", "wrapped": true }, "type": "array" }, "alternative": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductExtensionAlternative" } }, "xml": { "name": "ProductExtension" }, "type": "object" }, "OAS.DataModel.Portfolio.ProductSubType": { "required": [ "id", "productType", "isAlternative" ], "properties": { "id": { "type": "integer", "format": "int32" }, "productType": { "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, "productSubTypeName": { "type": "string", "maxLength": 50, "minLength": 0 }, "isAlternative": { "type": "boolean" } }, "xml": { "name": "ProductSubType" }, "type": "object" }, "OAS.DataModel.Portfolio.FundFamilyGlobalInLocal": { "required": [ "id", "personalId", "isAnnuity", "isCanBeDownLoad", "isActive" ], "properties": { "id": { "type": "integer", "format": "int32" }, "personalId": { "type": "integer", "format": "int32" }, "isAnnuity": { "type": "boolean" }, "isCanBeDownLoad": { "type": "boolean" }, "oldGroup": { "type": "string", "maxLength": 5, "minLength": 0 }, "oldFFId": { "type": "integer", "format": "int32" }, "persContactId": { "type": "integer", "format": "int32" }, "persOverNTId": { "type": "integer", "format": "int32" }, "speedDial": { "type": "string", "maxLength": 10, "minLength": 0 }, "tradeInstr": { "type": "string", "maxLength": 255, "minLength": 0 }, "isActive": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 20, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 20, "minLength": 0 }, "timestamp": { "type": "string", "format": "byte" }, "vendor": { "type": "string", "maxLength": 50, "minLength": 0 }, "status": { "type": "string", "maxLength": 50, "minLength": 0 }, "restrictionNotes": { "type": "string", "maxLength": 500, "minLength": 0 }, "reregistrationNotes": { "type": "string", "maxLength": 500, "minLength": 0 }, "cstOperationHours": { "type": "string", "maxLength": 20, "minLength": 0 }, "isPhoneTrade": { "type": "boolean" }, "isFaxTrade": { "type": "boolean" }, "isUploadTrade": { "type": "boolean" }, "isConfirmPhone": { "type": "boolean" }, "isConfirmInternet": { "type": "boolean" }, "isConfirmFundServ": { "type": "boolean" }, "isConfirmAps": { "type": "boolean" }, "isConfirmOther": { "type": "boolean" }, "confirmNotes": { "type": "string", "maxLength": 500, "minLength": 0 }, "downloadMethod": { "type": "string", "maxLength": 10, "minLength": 0 }, "downloadNotes": { "type": "string", "maxLength": 500, "minLength": 0 }, "custFundServe": { "type": "string", "maxLength": 20, "minLength": 0 }, "directFundServe": { "type": "string", "maxLength": 20, "minLength": 0 }, "trader": { "type": "string", "maxLength": 20, "minLength": 0 }, "unitBalanceScale": { "type": "integer", "format": "int32" }, "priceScale": { "type": "integer", "format": "int32" }, "isAcctNumUnique": { "type": "boolean" }, "isNetworkingEligible": { "type": "boolean" }, "fundName": { "type": "string", "maxLength": 255, "minLength": 0 }, "isShareClassSensitive": { "type": "boolean" } }, "xml": { "name": "FundFamilyGlobalInLocal" }, "type": "object" }, "OAS.DataModel.Portfolio.PriceLocal": { "required": [ "productId", "priceDate", "navPrice", "auditedDate" ], "properties": { "productId": { "type": "integer", "format": "int32" }, "priceDate": { "type": "string", "format": "date-time" }, "navPrice": { "type": "number", "format": "double" }, "priceSource": { "type": "string", "enum": [ "NotSpecified", "ManuallyEntered", "OrionCopy", "ConversionData" ] }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "PriceLocal" }, "type": "object" }, "OAS.DataModel.Portfolio.PriceCurrent": { "required": [ "custodianCommonId", "productId", "priceDate", "navPrice", "isValidated" ], "properties": { "custodianCommonId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "priceDate": { "type": "string", "format": "date-time" }, "navPrice": { "type": "number", "format": "double" }, "isValidated": { "type": "boolean" } }, "xml": { "name": "PriceCurrent" }, "type": "object" }, "OAS.DataModel.Portfolio.ProductDescriptionProviderFlat": { "required": [ "productId" ], "properties": { "productId": { "type": "integer", "format": "int32" }, "orionSub": { "type": "string", "maxLength": 50, "minLength": 0 }, "orionCat": { "type": "string", "maxLength": 50, "minLength": 0 }, "morningstarSector": { "type": "string", "maxLength": 255, "minLength": 0 }, "morningstarGroup": { "type": "string", "maxLength": 255, "minLength": 0 }, "morningstarIndustry": { "type": "string", "maxLength": 255, "minLength": 0 }, "morningstarStyle": { "type": "string", "maxLength": 255, "minLength": 0 }, "morningstarCategoryCode": { "type": "string", "maxLength": 50, "minLength": 0 }, "morningstarCategory": { "type": "string", "maxLength": 255, "minLength": 0 }, "lipperIOBClass": { "type": "string", "maxLength": 50, "minLength": 0 }, "lipperIOBDescription": { "type": "string", "maxLength": 255, "minLength": 0 }, "lipperIOBCategory": { "type": "string", "maxLength": 50, "minLength": 0 }, "lipperClass": { "type": "string", "maxLength": 50, "minLength": 0 }, "lipperClassDescription": { "type": "string", "maxLength": 255, "minLength": 0 }, "lipperClassCategory": { "type": "string", "maxLength": 50, "minLength": 0 }, "valueLineAbbrev": { "type": "string", "maxLength": 50, "minLength": 0 }, "valueLineDesc": { "type": "string", "maxLength": 255, "minLength": 0 } }, "xml": { "name": "ProductDescriptionProviderFlat" }, "type": "object" }, "OAS.DataModel.Portfolio.FundFamilyProductInLocal": { "required": [ "id", "productId", "fundFamilyId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "fundFamilyId": { "type": "integer", "format": "int32" }, "fundFamily": { "$ref": "#/definitions/OAS.DataModel.Portfolio.FundFamilyGlobalInLocal" } }, "xml": { "name": "FundFamilyProductInLocal" }, "type": "object" }, "OAS.DataModel.Portfolio.ProductAumSummary": { "required": [ "entityId", "createdDate" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "aum": { "type": "number", "format": "double" }, "createdDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "ProductAumSummary" }, "type": "object" }, "OAS.DataModel.Portfolio.AssumedRate": { "required": [ "productId", "rateType", "asOfDate", "value", "auditedDate" ], "properties": { "productId": { "type": "integer", "format": "int32" }, "rateType": { "type": "string", "enum": [ "AssumedDividend", "AssumedTurnover" ] }, "asOfDate": { "type": "string", "format": "date-time" }, "value": { "type": "number", "format": "double" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "AssumedRate" }, "type": "object" }, "OAS.DataModel.Portfolio.BondRate": { "required": [ "id", "productId", "datedDate", "couponRate", "maturityDate", "isFederallyTaxable", "isStateTaxable", "isVariableRate", "isInDefault" ], "properties": { "id": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "datedDate": { "type": "string", "format": "date-time" }, "couponRate": { "type": "number", "format": "double" }, "maturityDate": { "type": "string", "format": "date-time" }, "alternateMaturityDate": { "type": "string", "format": "date-time" }, "parValue": { "type": "number", "format": "double" }, "paymentFrequency": { "type": "string", "enum": [ "AtMaturity", "Monthly", "BiMonthly", "Quarterly", "Triannually", "Semiannually", "Annually", "Biennially" ] }, "isCompounding": { "type": "boolean" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 20, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 20, "minLength": 0 }, "issueDate": { "type": "string", "format": "date-time" }, "interestAccrualDate": { "type": "string", "format": "date-time" }, "isFederallyTaxable": { "type": "boolean" }, "isStateTaxable": { "type": "boolean" }, "stateId": { "type": "integer", "format": "int32" }, "dayCount": { "type": "string", "enum": [ "ThirtyThreeSixty", "ActualActual", "ActualThreeSixtyFive", "ActualThreeSixty", "ActualActualIsda" ] }, "isVariableRate": { "type": "boolean" }, "isInDefault": { "type": "boolean" }, "callDate": { "type": "string", "format": "date-time" }, "callPrice": { "type": "number", "format": "double" }, "initialCouponDate": { "type": "string", "format": "date-time" }, "isOID": { "type": "boolean" }, "isAMT": { "type": "boolean" }, "inDefaultDate": { "type": "string", "format": "date-time" }, "state": { "$ref": "#/definitions/OAS.DataModel.Portfolio.State" } }, "xml": { "name": "BondRate" }, "type": "object" }, "OAS.DataModel.Portfolio.ProductBondCall": { "required": [ "productId", "callDate", "callPrice" ], "properties": { "productId": { "type": "integer", "format": "int32" }, "callDate": { "type": "string", "format": "date-time" }, "callPrice": { "type": "number", "format": "double" }, "product": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductLocal" } }, "xml": { "name": "ProductBondCall" }, "type": "object" }, "OAS.DataModel.Billing.BillProduct": { "required": [ "id", "productId", "feeExcluded", "includeByDefault" ], "properties": { "id": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "feeExcluded": { "type": "boolean" }, "includeByDefault": { "type": "boolean" }, "feeBillExclusionMode": { "type": "string", "enum": [ "No", "YesAll", "SelectBillEntities" ] }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "product": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductLocal" } }, "xml": { "name": "BillProduct" }, "type": "object" }, "OAS.DataModel.Confirm.ProductTaxError": { "required": [ "productId", "id", "auditType", "errorMessage", "resolutionMessage", "createdDate", "createdBy" ], "properties": { "productId": { "type": "integer", "format": "int32" }, "product": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductLocal" }, "id": { "type": "integer", "format": "int32" }, "auditType": { "type": "string", "enum": [ "CustodialRealizedSharesDoNotMatch", "CustodialRealizedMissing", "CustodialUnrealizedMissing", "CustodialRealizedUnknownAcquiredDate", "CustodialUnrealizedUnknownAcquiredDate", "CustodialRealizedUnknownCostBasis", "CustodialUnrealizedUnknownCostBasis", "OrionUnknownCostBasis", "MoneyMarketProducts", "OrionMissingCostBasis" ] }, "assetId": { "type": "integer", "format": "int32" }, "errorMessage": { "type": "string", "maxLength": 255, "minLength": 0 }, "resolutionMessage": { "type": "string", "maxLength": 255, "minLength": 0 }, "expectedUnits": { "type": "number", "format": "double" }, "costUnits": { "type": "number", "format": "double" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "reviewed": { "type": "boolean" } }, "xml": { "name": "ProductTaxError" }, "type": "object" }, "OAS.DataModel.Confirm.ProductTaxErrorSummary": { "required": [ "parentId", "taxErrorIds" ], "properties": { "product": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductLocal" }, "parentId": { "type": "integer", "format": "int32" }, "taxErrorIds": { "type": "string" } }, "xml": { "name": "ProductTaxErrorSummary" }, "type": "object" }, "OAS.DataModel.Confirm.Alternative.ExpectedReturn": { "required": [ "startDate", "productId", "auditedDate" ], "properties": { "startDate": { "type": "string", "format": "date-time" }, "productId": { "type": "integer", "format": "int32" }, "high": { "type": "number", "format": "double" }, "low": { "type": "number", "format": "double" }, "comment": { "type": "string", "maxLength": 250, "minLength": 0 }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "productLocal": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductLocal" } }, "xml": { "name": "ExpectedReturn" }, "type": "object" }, "OAS.DataModel.Portfolio.ProductLocalAdditionalInfo": { "required": [ "productId" ], "properties": { "productId": { "type": "integer", "format": "int32" }, "currentOrionPrice": { "type": "number", "format": "double" }, "currentOrionPriceDate": { "type": "string", "format": "date-time" }, "expectedReturnLow": { "type": "number", "format": "double" }, "expectedReturnHigh": { "type": "number", "format": "double" }, "expectedReturnStartDate": { "type": "string", "format": "date-time" }, "currHeldAssetCount": { "type": "integer", "format": "int32" } }, "xml": { "name": "ProductLocalAdditionalInfo" }, "type": "object" }, "OAS.DataModel.Portfolio.ProductLocalFilter": { "required": [ "productId" ], "properties": { "productId": { "type": "integer", "format": "int32" }, "everHeld": { "type": "boolean" }, "currentlyHeld": { "type": "boolean" } }, "xml": { "name": "ProductLocalFilter" }, "type": "object" }, "OAS.DataModel.Settings.ProductEntityOption": { "required": [ "entityId", "userDefineDefinitionId", "userDefineDataId", "name", "code", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "ProductEntityOption" }, "type": "object" }, "OAS.DataModel.Settings.ProductUserDefinedField": { "required": [ "entityId", "userDefineDefinitionId", "userDefineDataId", "name", "code", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "ProductUserDefinedField" }, "type": "object" }, "OAS.DataModel.Settings.ProductUserDefinedTimeField": { "required": [ "entityId", "userDefineDefinitionId", "name", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "values": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.ProductUserDefinedTimeFieldValue" }, "xml": { "name": "ProductUserDefinedTimeFieldValue", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProductUserDefinedTimeField" }, "type": "object" }, "OAS.DataModel.Portfolio.SystematicAccountAudit": { "required": [ "systematicAccountId", "isProrated", "dataEntryMethod", "swpFrequency", "swpCycleMonth", "startDate", "transactionDay", "isActive", "swpAmount", "swpSource", "isTaxWithType", "editedDate", "editedBy", "createdDate", "createdBy", "isRecalc", "isSpouse", "type", "isCashFundingIgnored", "isAutoRmd" ], "properties": { "systematicAccountId": { "type": "integer", "format": "int32" }, "auditDate": { "type": "string", "format": "date-time" }, "accountId": { "type": "integer", "format": "int32" }, "isProrated": { "type": "boolean" }, "dataEntryMethod": { "type": "integer", "format": "int32" }, "swpFrequency": { "type": "string", "enum": [ "Monthly", "Quarterly", "Semiannually", "Annually" ] }, "swpCycleMonth": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "transactionDay": { "type": "integer", "format": "int32" }, "custodialSWPDate": { "type": "integer", "format": "int32" }, "inActiveDate": { "type": "string", "format": "date-time" }, "isActive": { "type": "boolean" }, "swpAmount": { "type": "number", "format": "double" }, "howTransfered": { "type": "integer", "format": "int32" }, "bankOfRecord": { "type": "string", "maxLength": 50, "minLength": 0 }, "addressOfRecord": { "type": "string", "maxLength": 100, "minLength": 0 }, "bankAcctNum": { "type": "string", "maxLength": 50, "minLength": 0 }, "abaNum": { "type": "string", "maxLength": 50, "minLength": 0 }, "taxesWithheld": { "type": "number", "format": "double" }, "swpSource": { "type": "integer", "format": "int32" }, "swpAcctNum": { "type": "string", "maxLength": 50, "minLength": 0 }, "notes": { "type": "string", "maxLength": 8000, "minLength": 0 }, "isTaxWithType": { "type": "string", "enum": [ "Undefined", "Dollar", "Percent", "Unknown", "None" ] }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "timestmp": { "type": "string", "format": "byte" }, "lifeType": { "type": "integer", "format": "int32" }, "isRecalc": { "type": "boolean" }, "beneficiaryName": { "type": "string", "maxLength": 50, "minLength": 0 }, "isSpouse": { "type": "boolean" }, "beneficiaryBDay": { "type": "string", "format": "date-time" }, "beneficiarySSN": { "type": "string", "maxLength": 15, "minLength": 0 }, "beneficiaryEncryptedSSN": { "type": "string", "format": "byte" }, "type": { "type": "string", "enum": [ "None", "Withdrawal", "Rmd", "Purchase", "Dca" ] }, "isCashFundingIgnored": { "type": "boolean" }, "assetId": { "type": "integer", "format": "int32" }, "endDate": { "type": "string", "format": "date-time" }, "stateTax": { "type": "number", "format": "double" }, "isDoubleCheck": { "type": "boolean" }, "doubleCheckDate": { "type": "string", "format": "date-time" }, "doubleCheckBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "reconcileStatus": { "type": "string", "maxLength": 15, "minLength": 0 }, "reconcileDate": { "type": "string", "format": "date-time" }, "lastReconcile": { "type": "string", "format": "date-time" }, "distributionCodeId": { "type": "integer", "format": "int32" }, "importKey": { "type": "string", "maxLength": 15, "minLength": 0 }, "custodialSystematicId": { "type": "string", "maxLength": 500, "minLength": 0 }, "isAutoRmd": { "type": "boolean" }, "auditBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "changeType": { "type": "string", "maxLength": 30, "minLength": 0 }, "systematicAccount": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SystematicAccount" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" } }, "xml": { "name": "SystematicAccountAudit" }, "type": "object" }, "OAS.DataModel.Portfolio.DownloadSymbolHistory": { "required": [ "downloadSymbolId", "changeType" ], "properties": { "id": { "type": "integer", "format": "int32" }, "downloadSymbolId": { "type": "integer", "format": "int32" }, "changeType": { "type": "string", "maxLength": 1, "minLength": 0 }, "auditedByDisplay": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "DownloadSymbolHistory" }, "type": "object" }, "OAS.DataModel.Settings.UserDefineDefinition": { "required": [ "id", "entity", "isTimeSensitive" ], "properties": { "id": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "type": { "type": "string", "enum": [ "MultiLineEditor", "DropDownEditor", "DropDownList", "CheckBox", "Currency", "Date", "DateTime", "Integer", "String", "Double", "Time", "Long", "CustomObject", "Email" ] }, "description": { "type": "string", "maxLength": 50, "minLength": 0 }, "mask": { "type": "string", "maxLength": 255, "minLength": 0 }, "defaultValue": { "type": "string" }, "sequence": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "category": { "type": "string", "maxLength": 30, "minLength": 0 }, "customObject": { "type": "string", "maxLength": 255, "minLength": 0 }, "controlProperties": { "type": "string" }, "securityCode": { "type": "string", "maxLength": 38, "minLength": 0 }, "isTimeSensitive": { "type": "boolean" }, "data": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineData" }, "xml": { "name": "UserDefineData", "wrapped": true }, "type": "array" }, "timeData": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineTimeData" }, "xml": { "name": "UserDefineTimeData", "wrapped": true }, "type": "array" }, "options": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineOption" }, "xml": { "name": "UserDefineOption", "wrapped": true }, "type": "array" }, "pageCodes": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinitionPageCode" }, "xml": { "name": "UserDefineDefinitionPageCode", "wrapped": true }, "type": "array" }, "allowedEntityOptionEntities": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.EntityOptionAllowEntity" }, "xml": { "name": "EntityOptionAllowEntity", "wrapped": true }, "type": "array" } }, "xml": { "name": "UserDefineDefinition" }, "type": "object" }, "OAS.DataModel.Settings.AssetUserDefinedTimeFieldValue": { "required": [ "entityId", "userDefineDefinitionId", "userDefineTimeDataId" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineTimeDataId": { "type": "integer", "format": "int32" }, "effectiveDate": { "type": "string", "format": "date-time" }, "value": { "type": "string" } }, "xml": { "name": "AssetUserDefinedTimeFieldValue" }, "type": "object" }, "OAS.DataModel.Portfolio.CustodianAumSummary": { "required": [ "entityId", "createdDate" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "aum": { "type": "number", "format": "double" }, "createdDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "CustodianAumSummary" }, "type": "object" }, "OAS.DataModel.Settings.CustodianEntityOption": { "required": [ "entityId", "userDefineDefinitionId", "userDefineDataId", "name", "code", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "CustodianEntityOption" }, "type": "object" }, "OAS.DataModel.Portfolio.CustodianFixTradeSetting": { "required": [ "custodianId", "productType", "blockMethod" ], "properties": { "custodianId": { "type": "integer", "format": "int32" }, "productType": { "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, "fixVersion": { "type": "string", "maxLength": 25, "minLength": 0 }, "fixRouting": { "type": "string", "maxLength": 15, "minLength": 0 }, "blockMethod": { "type": "string", "enum": [ "Default", "FixEft", "OneToOne" ] }, "fkTRInterface": { "type": "integer", "format": "int32" } }, "xml": { "name": "CustodianFixTradeSetting" }, "type": "object" }, "OAS.DataModel.Portfolio.CustodianAlgorithm": { "required": [ "custodianId", "tag" ], "properties": { "custodianId": { "type": "integer", "format": "int32" }, "tag": { "type": "string", "maxLength": 1, "minLength": 0 }, "algorithmCode": { "type": "string", "maxLength": 20, "minLength": 0 } }, "xml": { "name": "CustodianAlgorithm" }, "type": "object" }, "OAS.DataModel.Portfolio.CustComplex": { "required": [ "id", "custodianId", "isDefault", "collectFormatId", "collectMethodId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "isDefault": { "type": "boolean" }, "fundFamilyId": { "type": "integer", "format": "int32" }, "collectFormatId": { "type": "integer", "format": "int32" }, "collectMethodId": { "type": "integer", "format": "int32" }, "custodian": { "$ref": "#/definitions/OAS.DataModel.Portfolio.CustodianLocal" }, "fundFamily": { "$ref": "#/definitions/OAS.DataModel.Portfolio.FundFamilyLocal" }, "collectFormat": { "$ref": "#/definitions/OAS.DataModel.Portfolio.CollectFormat" }, "collectMethod": { "$ref": "#/definitions/OAS.DataModel.Portfolio.CollectMethod" } }, "xml": { "name": "CustComplex" }, "type": "object" }, "OAS.DataModel.Portfolio.RegistrationType": { "required": [ "id", "accountType", "isQualified", "isIRA", "isMultipleOwners", "is403b", "isBIRA", "includeInRMD", "excludeFromRMDAggregation", "isERISA", "excludeFromProspectus" ], "properties": { "id": { "type": "integer", "format": "int32" }, "accountType": { "type": "string", "maxLength": 255, "minLength": 0 }, "code": { "type": "string", "maxLength": 10, "minLength": 0 }, "isQualified": { "type": "boolean" }, "isIRA": { "type": "boolean" }, "isMultipleOwners": { "type": "boolean" }, "is403b": { "type": "boolean" }, "planType": { "type": "string", "maxLength": 10, "minLength": 0 }, "isDefault": { "type": "boolean" }, "externalCode": { "type": "string", "maxLength": 3, "minLength": 0 }, "socialCode": { "type": "string", "maxLength": 3, "minLength": 0 }, "commonCode": { "type": "string", "maxLength": 10, "minLength": 0 }, "category": { "type": "string", "enum": [ "Organization", "Minor", "Individual", "Trust", "MultipleApplicants" ] }, "benTypes": { "type": "string", "maxLength": 200, "minLength": 0 }, "isBIRA": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "includeInRMD": { "type": "boolean" }, "excludeFromRMDAggregation": { "type": "boolean" }, "proposalCode": { "type": "string", "maxLength": 20, "minLength": 0 }, "taxType": { "type": "string", "enum": [ "Taxable", "TaxDeferred", "TaxFree" ] }, "isERISA": { "type": "boolean" }, "globalId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "excludeFromProspectus": { "type": "boolean" }, "registrations": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Registration" }, "xml": { "name": "Registration", "wrapped": true }, "type": "array" } }, "xml": { "name": "RegistrationType" }, "type": "object" }, "OAS.DataModel.Portfolio.Client": { "required": [ "id", "personalId", "isActive", "storePerformance", "videoStatementDeliveryMethod", "isQualifiedInvestor", "loginCount" ], "properties": { "id": { "type": "integer", "format": "int32" }, "personalId": { "type": "integer", "format": "int32" }, "representativeId": { "type": "integer", "format": "int32" }, "clientCategoryId": { "type": "integer", "format": "int32" }, "riaId": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "startDate": { "type": "string", "format": "date-time" }, "audit": { "$ref": "#/definitions/OAT.DataModel.ComplexTypes.BasicAuditNotNullNotNull" }, "billTransmitMethodId": { "type": "integer", "format": "int32" }, "lastStatementSent": { "type": "string", "format": "date-time" }, "lastStatementSentTo": { "type": "string", "maxLength": 255, "minLength": 0 }, "importKey": { "type": "string", "maxLength": 15, "minLength": 0 }, "storePerformance": { "type": "string", "enum": [ "DoNotStore", "Store", "StoreForever", "ExpireClientAllowedStorePerformance" ] }, "videoStatementDeliveryMethod": { "type": "string", "enum": [ "Unassigned", "NoVideoStatement", "WebsiteOnly", "Email" ] }, "isQualifiedInvestor": { "type": "boolean" }, "riskScore": { "type": "number", "format": "double" }, "loginCount": { "type": "integer", "format": "int32" }, "ccType": { "type": "string", "maxLength": 50, "minLength": 0 }, "ccNum": { "type": "string", "maxLength": 50, "minLength": 0 }, "ccToken": { "type": "string", "maxLength": 100, "minLength": 0 }, "ccIsValid": { "type": "boolean" }, "probabilityOfSuccess": { "type": "number", "format": "double" }, "advClientCategoryId": { "type": "integer", "format": "int32" }, "isRTQLocked": { "type": "boolean" }, "globalId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "representative": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Representative" }, "registrations": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Registration" }, "xml": { "name": "Registration", "wrapped": true }, "type": "array" }, "additionalAccounts": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ClientAccountAdditional" }, "xml": { "name": "ClientAccountAdditional", "wrapped": true }, "type": "array" }, "additionalRepAssignments": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AdditionalRepAssignment" }, "xml": { "name": "AdditionalRepAssignment", "wrapped": true }, "type": "array" }, "clientRepAdditional": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ClientRepAdditional" }, "xml": { "name": "ClientRepAdditional", "wrapped": true }, "type": "array" }, "blobs": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ClientBlob" }, "xml": { "name": "ClientBlob", "wrapped": true }, "type": "array" }, "billTransmitMethod": { "$ref": "#/definitions/OAS.DataModel.Billing.BillTransmitMethod" }, "billClients": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillClient" }, "xml": { "name": "BillClient", "wrapped": true }, "type": "array" }, "cloudStorageFolders": { "items": { "$ref": "#/definitions/OAS.DataModel.Integration.ClientCloudStorageFolder" }, "xml": { "name": "ClientCloudStorageFolder", "wrapped": true }, "type": "array" }, "billAdditionalAnnualAmounts": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillClientAdditionalAnnualAmount" }, "xml": { "name": "BillClientAdditionalAnnualAmount", "wrapped": true }, "type": "array" }, "changes": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ClientChange" }, "xml": { "name": "ClientChange", "wrapped": true }, "type": "array" }, "notes": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ClientNote" }, "xml": { "name": "ClientNote", "wrapped": true }, "type": "array" }, "householdMembers": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.HouseholdMember" }, "xml": { "name": "HouseholdMember", "wrapped": true }, "type": "array" }, "additionalAddresses": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AdditionalAddress" }, "xml": { "name": "AdditionalAddress", "wrapped": true }, "type": "array" }, "aumSummary": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ClientAumSummary" }, "category": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ClientCategory" }, "models": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ClientModel" }, "xml": { "name": "ClientModel", "wrapped": true }, "type": "array" }, "balanceSheets": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.BalanceSheet" }, "xml": { "name": "BalanceSheet", "wrapped": true }, "type": "array" }, "balanceSheetCategories": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.BalanceSheetCategory" }, "xml": { "name": "BalanceSheetCategory", "wrapped": true }, "type": "array" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.ClientEntityOption" }, "xml": { "name": "ClientEntityOption", "wrapped": true }, "type": "array" }, "clientValues": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ClientValue" }, "xml": { "name": "ClientValue", "wrapped": true }, "type": "array" }, "personal": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Personal" }, "userDefinedFields": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.ClientUserDefinedField" }, "xml": { "name": "ClientUserDefinedField", "wrapped": true }, "type": "array" }, "targetAllocations": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ClientTargetAllocation" }, "xml": { "name": "ClientTargetAllocation", "wrapped": true }, "type": "array" }, "reportListVersionAssigments": { "items": { "$ref": "#/definitions/OAS.DataModel.ReportAdministration.ReportListVersionClientAssignment" }, "xml": { "name": "ReportListVersionClientAssignment", "wrapped": true }, "type": "array" }, "reportClientVersionAssignments": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Envision.ReportClientVersionAssignment" }, "xml": { "name": "ReportClientVersionAssignment", "wrapped": true }, "type": "array" }, "portfolioGroups": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.PortfolioGroup" }, "xml": { "name": "PortfolioGroup", "wrapped": true }, "type": "array" }, "assetExclusions": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ClientAssetExclusion" }, "xml": { "name": "ClientAssetExclusion", "wrapped": true }, "type": "array" }, "userDefinedPageCodes": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.ClientUserDefinedPageCode" }, "xml": { "name": "ClientUserDefinedPageCode", "wrapped": true }, "type": "array" }, "riskScoreTable": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ClientRiskScoreTable" }, "xml": { "name": "ClientRiskScoreTable", "wrapped": true }, "type": "array" }, "appLinks": { "items": { "$ref": "#/definitions/OAS.DataModel.Integration.ClientAppLink" }, "xml": { "name": "ClientAppLink", "wrapped": true }, "type": "array" }, "info": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ClientInfo" } }, "xml": { "name": "Client" }, "type": "object" }, "OAS.DataModel.Billing.BillRegistration": { "required": [ "id", "registrationId", "editedDate", "editedBy", "createdDate", "createdBy" ], "properties": { "id": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "timestamp": { "type": "string", "format": "byte" }, "registration": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Registration" } }, "xml": { "name": "BillRegistration" }, "type": "object" }, "OAS.DataModel.Portfolio.RegistrationBlob": { "required": [ "id", "isZip", "uniqueID" ], "properties": { "registrationId": { "type": "integer", "format": "int32" }, "registration": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Registration" }, "id": { "type": "integer", "format": "int32" }, "openWith": { "type": "string", "maxLength": 200, "minLength": 0 }, "fileName": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "rowVersion": { "type": "string", "format": "byte" }, "blobDesc": { "type": "string", "maxLength": 200, "minLength": 0 }, "blobText": { "type": "string" }, "isZip": { "type": "boolean" }, "fileNETidmId": { "type": "string", "maxLength": 9, "minLength": 0 }, "filePath": { "type": "string", "maxLength": 500, "minLength": 0 }, "eFileLocation": { "type": "string", "enum": [ "Undefined", "Database", "FileServer", "AmazonS3", "HttpGet", "RedtailIms", "Communities" ] }, "rootPath": { "type": "string", "maxLength": 100, "minLength": 0 }, "uniqueID": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "RegistrationBlob" }, "type": "object" }, "OAS.DataModel.Portfolio.RegistrationNote": { "required": [ "id", "createdDate", "createdBy", "systemGenerated", "isWebVisible" ], "properties": { "registrationId": { "type": "integer", "format": "int32" }, "registration": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Registration" }, "id": { "type": "integer", "format": "int32" }, "text": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "rowVersion": { "type": "string", "format": "byte" }, "category": { "type": "string", "maxLength": 25, "minLength": 0 }, "userOwnerId": { "type": "integer", "format": "int32" }, "systemGenerated": { "type": "boolean" }, "isWebVisible": { "type": "boolean" }, "requestFollowup": { "type": "boolean" } }, "xml": { "name": "RegistrationNote" }, "type": "object" }, "OAS.DataModel.Portfolio.RegistrationBeneficiary": { "required": [ "id", "registrationId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "benefitName": { "type": "string", "maxLength": 255, "minLength": 0 }, "ssn": { "type": "string", "maxLength": 12, "minLength": 0 }, "dob": { "type": "string", "format": "date-time" }, "type": { "type": "string", "maxLength": 20, "minLength": 0 }, "relation": { "type": "string", "maxLength": 30, "minLength": 0 }, "percentage": { "type": "number", "format": "double" }, "address": { "type": "string", "maxLength": 255, "minLength": 0 }, "city": { "type": "string", "maxLength": 30, "minLength": 0 }, "state": { "type": "string", "maxLength": 2, "minLength": 0 }, "zip": { "type": "string", "maxLength": 20, "minLength": 0 }, "importKey": { "type": "string", "maxLength": 15, "minLength": 0 }, "encryptedSSN": { "type": "string", "format": "byte" }, "percentageTemp": { "type": "number", "format": "double" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "perStirpes": { "type": "boolean" }, "registration": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Registration" } }, "xml": { "name": "RegistrationBeneficiary" }, "type": "object" }, "OAS.DataModel.Portfolio.RegistrationDecedent": { "properties": { "registrationId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "maxLength": 255, "minLength": 0 }, "dateOfBirth": { "type": "string", "format": "date-time" }, "relationToBeneficiary": { "type": "string", "maxLength": 30, "minLength": 0 }, "registration": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Registration" } }, "xml": { "name": "RegistrationDecedent" }, "type": "object" }, "OAS.DataModel.Portfolio.AdditionalRepAssignmentPercent": { "required": [ "representativeId", "registrationId" ], "properties": { "representativeId": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "percentage": { "type": "number", "format": "double" }, "audit": { "$ref": "#/definitions/OAT.DataModel.ComplexTypes.BasicAuditNotNullNotNull" }, "representative": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Representative" }, "registration": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Registration" } }, "xml": { "name": "AdditionalRepAssignmentPercent" }, "type": "object" }, "OAS.DataModel.Portfolio.RegistrationRepAdditional": { "required": [ "clientRepAdditionalId", "registrationId", "payoutRate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "clientRepAdditionalId": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "payoutRate": { "type": "number", "format": "double" }, "notes": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "auditedBy": { "type": "string", "format": "byte" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "clientRepAdditional": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ClientRepAdditional" }, "registration": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Registration" } }, "xml": { "name": "RegistrationRepAdditional" }, "type": "object" }, "OAS.DataModel.Portfolio.RegistrationSuitability": { "required": [ "registrationId" ], "properties": { "registrationId": { "type": "integer", "format": "int32" }, "netWorthIncludingResidence": { "type": "number", "format": "double" }, "netWorthExcludingResidence": { "type": "number", "format": "double" }, "liquidNetWorth": { "type": "number", "format": "double" }, "investmentKnowledge": { "type": "string", "maxLength": 30, "minLength": 0 }, "riskExposure": { "type": "string", "maxLength": 30, "minLength": 0 }, "investmentExperience": { "type": "string", "maxLength": 255, "minLength": 0 }, "registration": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Registration" }, "reviewCompleted": { "type": "boolean" }, "reviewCompletedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "RegistrationSuitability" }, "type": "object" }, "OAS.DataModel.Portfolio.RegistrationChange": { "required": [ "id", "registrationId", "asOfDate", "changesCompressedJson", "auditedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "changesCompressedJson": { "type": "string", "format": "byte" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "registration": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Registration" } }, "xml": { "name": "RegistrationChange" }, "type": "object" }, "OAS.DataModel.Trading.RegistrationSleeve": { "required": [ "registrationId", "isActive", "isDoNotTrade", "custodialAccountNumber", "contributionAllocationMethod", "distributionAllocationMethod", "corporateActionAllocationMethod", "autoRebalFrequency", "autoRebalMonth", "autoRebalDay", "mandate", "upcomingSWP" ], "properties": { "registrationId": { "type": "integer", "format": "int32" }, "sleeveStrategyAggId": { "type": "integer", "format": "int32" }, "sleeveStrategyId": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "isDoNotTrade": { "type": "boolean" }, "custodialAccountNumber": { "type": "string", "maxLength": 50, "minLength": 0 }, "contributionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "distributionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "corporateActionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "lastSuffixUsed": { "type": "integer", "format": "int32" }, "autoRebalFrequency": { "type": "string", "enum": [ "None", "Monthly", "Quarterly", "Semiannual", "Annual" ] }, "autoRebalMonth": { "type": "integer", "format": "int32", "maximum": 12, "minimum": 1 }, "autoRebalDay": { "type": "integer", "format": "int32", "maximum": 31, "minimum": 1 }, "mandate": { "type": "boolean" }, "eclipseFirmId": { "type": "integer", "format": "int32" }, "tolerancePercent": { "type": "number", "format": "double" }, "billFeeScheduleId": { "type": "integer", "format": "int32" }, "billMasterPayoutScheduleId": { "type": "integer", "format": "int32" }, "_sleeveRecurringAdjInfo": { "type": "string" }, "needsUpdate": { "type": "boolean" }, "needsUpdateReason": { "type": "string" }, "isPendingAccount": { "type": "boolean" }, "audit": { "$ref": "#/definitions/OAT.DataModel.ComplexTypes.BasicAuditNotNullNotNull" }, "registration": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Registration" }, "sleeveStrategy": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategy" }, "sleeveStrategyAgg": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategyAggregate" }, "custodialBillingInfo": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveCustodialBillingInfo" }, "custodialRecurringAdjInfo": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveRecurringAdjInfo" }, "xml": { "name": "SleeveRecurringAdjInfo", "wrapped": true }, "type": "array" }, "history": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.RegistrationSleeveHistory" }, "xml": { "name": "RegistrationSleeveHistory", "wrapped": true }, "type": "array" }, "upcomingSWP": { "type": "boolean" }, "sleeveRecurringAdjInfo": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveRecurringAdjInfo" }, "xml": { "name": "SleeveRecurringAdjInfo", "wrapped": true }, "type": "array" }, "deletedSleeveTargets": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.DeletedSleeveTarget" }, "xml": { "name": "DeletedSleeveTarget", "wrapped": true }, "type": "array" } }, "xml": { "name": "RegistrationSleeve" }, "type": "object" }, "OAS.DataModel.Portfolio.OfacCheck": { "required": [ "id", "ofacId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "ofacId": { "type": "integer", "format": "int32" }, "ofacName": { "type": "string", "maxLength": 200, "minLength": 0 }, "notes": { "type": "string", "maxLength": 5000, "minLength": 0 }, "isOk": { "type": "boolean" }, "dateChecked": { "type": "string", "format": "date-time" }, "blockedPerson": { "$ref": "#/definitions/OAS.DataModel.Portfolio.BlockedPerson" }, "registration": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Registration" } }, "xml": { "name": "OfacCheck" }, "type": "object" }, "OAS.DataModel.Portfolio.RegistrationRmdCalculationSummary": { "required": [ "registrationId" ], "properties": { "registrationId": { "type": "integer", "format": "int32" }, "rmdAmount": { "type": "number", "format": "double" }, "rmdOriginalAmount": { "type": "number", "format": "double" }, "ytdTotal": { "type": "number", "format": "double" }, "endOfPreviousYearRegistrationValue": { "type": "number", "format": "double" }, "amountRemaining": { "type": "number", "format": "double" }, "amountRemainingGroup": { "type": "number", "format": "double" }, "amountRemainingGroupApplied": { "type": "number", "format": "double" }, "investorAge": { "type": "number", "format": "double" }, "primaryBeneficiaryName": { "type": "string", "maxLength": 255, "minLength": 0 }, "primaryBeneficiaryAge": { "type": "number", "format": "double" }, "primaryBeneficiaryRelation": { "type": "string", "maxLength": 30, "minLength": 0 }, "onTrack": { "type": "boolean" }, "rmdEligible": { "type": "boolean" }, "irsTable": { "type": "string", "maxLength": 26, "minLength": 0 }, "factor": { "type": "number", "format": "double" }, "custodialAccountNumber": { "type": "string", "maxLength": 50, "minLength": 0 }, "moneyMarketValue": { "type": "number", "format": "double" }, "satisfiedStatus": { "type": "string", "enum": [ "RmdNotSatisfied", "RmdSatisfied", "ManuallySatisfied", "RmdSatisfiedByBuffer" ] }, "accountNumbers": { "type": "string" } }, "xml": { "name": "RegistrationRmdCalculationSummary" }, "type": "object" }, "OAS.DataModel.Settings.RegistrationEntityOption": { "required": [ "entityId", "userDefineDefinitionId", "userDefineDataId", "name", "code", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "RegistrationEntityOption" }, "type": "object" }, "OAS.DataModel.Portfolio.RegistrationAdditionalInfo": { "required": [ "fkRegistration" ], "properties": { "fkRegistration": { "type": "integer", "format": "int32" }, "currValue": { "type": "number", "format": "double" } }, "xml": { "name": "RegistrationAdditionalInfo" }, "type": "object" }, "OAS.DataModel.Portfolio.RegistrationValue": { "required": [ "registrationId", "asOfDate" ], "properties": { "registrationId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "integer", "format": "int32" }, "value": { "type": "number", "format": "double" }, "cashValue": { "type": "number", "format": "double" } }, "xml": { "name": "RegistrationValue" }, "type": "object" }, "OAS.DataModel.Portfolio.RegistrationTargetAllocation": { "required": [ "id", "registrationId", "entity", "entityId", "weight", "createdBy", "createdDate", "editedBy", "editedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "weight": { "type": "number", "format": "double" }, "minimumRange": { "type": "number", "format": "double" }, "maximumRange": { "type": "number", "format": "double" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "registration": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Registration" } }, "xml": { "name": "RegistrationTargetAllocation" }, "type": "object" }, "OAS.DataModel.Settings.RegistrationUserDefinedField": { "required": [ "entityId", "userDefineDefinitionId", "userDefineDataId", "name", "code", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "RegistrationUserDefinedField" }, "type": "object" }, "OAS.DataModel.Settings.RegistrationUserDefinedPageCode": { "required": [ "registrationId", "pageCode" ], "properties": { "registrationId": { "type": "integer", "format": "int32" }, "pageCode": { "type": "string", "maxLength": 50, "minLength": 0 }, "udf1": { "type": "integer", "format": "int32" }, "value1": { "type": "string" }, "code1": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition1": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf2": { "type": "integer", "format": "int32" }, "value2": { "type": "string" }, "code2": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition2": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf3": { "type": "integer", "format": "int32" }, "value3": { "type": "string" }, "code3": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition3": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf4": { "type": "integer", "format": "int32" }, "value4": { "type": "string" }, "code4": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition4": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf5": { "type": "integer", "format": "int32" }, "value5": { "type": "string" }, "code5": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition5": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf6": { "type": "integer", "format": "int32" }, "value6": { "type": "string" }, "code6": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition6": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf7": { "type": "integer", "format": "int32" }, "value7": { "type": "string" }, "code7": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition7": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf8": { "type": "integer", "format": "int32" }, "value8": { "type": "string" }, "code8": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition8": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf9": { "type": "integer", "format": "int32" }, "value9": { "type": "string" }, "code9": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition9": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf10": { "type": "integer", "format": "int32" }, "value10": { "type": "string" }, "code10": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition10": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf11": { "type": "integer", "format": "int32" }, "value11": { "type": "string" }, "code11": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition11": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf12": { "type": "integer", "format": "int32" }, "value12": { "type": "string" }, "code12": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition12": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf13": { "type": "integer", "format": "int32" }, "value13": { "type": "string" }, "code13": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition13": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf14": { "type": "integer", "format": "int32" }, "value14": { "type": "string" }, "code14": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition14": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf15": { "type": "integer", "format": "int32" }, "value15": { "type": "string" }, "code15": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition15": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf16": { "type": "integer", "format": "int32" }, "value16": { "type": "string" }, "code16": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition16": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf17": { "type": "integer", "format": "int32" }, "value17": { "type": "string" }, "code17": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition17": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf18": { "type": "integer", "format": "int32" }, "value18": { "type": "string" }, "code18": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition18": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf19": { "type": "integer", "format": "int32" }, "value19": { "type": "string" }, "code19": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition19": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf20": { "type": "integer", "format": "int32" }, "value20": { "type": "string" }, "code20": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition20": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "RegistrationUserDefinedPageCode" }, "type": "object" }, "OAS.DataModel.Portfolio.FundFamilyExt": { "required": [ "id", "isDefault" ], "properties": { "id": { "type": "integer", "format": "int32" }, "isDefault": { "type": "boolean" }, "isCreateDistribution": { "type": "boolean" }, "blobSignatureId": { "type": "integer", "format": "int32" } }, "xml": { "name": "FundFamilyExt" }, "type": "object" }, "OAS.DataModel.Settings.FundFamilyEntityOption": { "required": [ "entityId", "userDefineDefinitionId", "userDefineDataId", "name", "code", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "FundFamilyEntityOption" }, "type": "object" }, "OAS.DataModel.Portfolio.CustodianTradeFileFormat": { "properties": { "id": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "fundFamilyId": { "type": "integer", "format": "int32" }, "registrationTypeId": { "type": "integer", "format": "int32" }, "platformId": { "type": "integer", "format": "int32" }, "trExFmtId": { "type": "integer", "format": "int32" }, "tPlusDays": { "type": "integer", "format": "int32" }, "isNAAllowed": { "type": "boolean" }, "trExFmtEndResultId": { "type": "integer", "format": "int32" } }, "xml": { "name": "CustodianTradeFileFormat" }, "type": "object" }, "OAS.DataModel.Settings.FundFamilyUserDefinedField": { "required": [ "entityId", "userDefineDefinitionId", "userDefineDataId", "name", "code", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "FundFamilyUserDefinedField" }, "type": "object" }, "OAS.DataModel.Portfolio.SubAdvisorAumSummary": { "required": [ "entityId", "createdDate" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "aum": { "type": "number", "format": "double" }, "createdDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "SubAdvisorAumSummary" }, "type": "object" }, "OAS.DataModel.Portfolio.SubAdvisorEntity": { "required": [ "id", "subAdvisorId", "entityId", "entity" ], "properties": { "id": { "type": "integer", "format": "int32" }, "subAdvisorId": { "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "subAdvisor": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SubAdvisor" } }, "xml": { "name": "SubAdvisorEntity" }, "type": "object" }, "OAS.DataModel.Trading.ModelRestriction": { "required": [ "id", "entityId", "entity", "modelId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "modelId": { "type": "integer", "format": "int32" }, "subAdvisorDefaultId": { "type": "integer", "format": "int32" }, "subAdvisorDefault": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SubAdvisor" }, "model": { "$ref": "#/definitions/OAS.DataModel.Trading.Model" } }, "xml": { "name": "ModelRestriction" }, "type": "object" }, "OAS.DataModel.Portfolio.SubAdvisorNote": { "required": [ "id", "createdDate", "createdBy", "systemGenerated", "isWebVisible" ], "properties": { "subAdvisorId": { "type": "integer", "format": "int32" }, "subAdvisor": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SubAdvisor" }, "id": { "type": "integer", "format": "int32" }, "text": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "rowVersion": { "type": "string", "format": "byte" }, "category": { "type": "string", "maxLength": 25, "minLength": 0 }, "userOwnerId": { "type": "integer", "format": "int32" }, "systemGenerated": { "type": "boolean" }, "isWebVisible": { "type": "boolean" }, "requestFollowup": { "type": "boolean" } }, "xml": { "name": "SubAdvisorNote" }, "type": "object" }, "OAS.DataModel.Portfolio.SubAdvisorBlob": { "required": [ "id", "isZip", "uniqueID" ], "properties": { "subAdvisorId": { "type": "integer", "format": "int32" }, "crmDocuments": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.CrmDocument" }, "xml": { "name": "CrmDocument", "wrapped": true }, "type": "array" }, "subAdvisor": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SubAdvisor" }, "id": { "type": "integer", "format": "int32" }, "openWith": { "type": "string", "maxLength": 200, "minLength": 0 }, "fileName": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "rowVersion": { "type": "string", "format": "byte" }, "blobDesc": { "type": "string", "maxLength": 200, "minLength": 0 }, "blobText": { "type": "string" }, "isZip": { "type": "boolean" }, "fileNETidmId": { "type": "string", "maxLength": 9, "minLength": 0 }, "filePath": { "type": "string", "maxLength": 500, "minLength": 0 }, "eFileLocation": { "type": "string", "enum": [ "Undefined", "Database", "FileServer", "AmazonS3", "HttpGet", "RedtailIms", "Communities" ] }, "rootPath": { "type": "string", "maxLength": 100, "minLength": 0 }, "uniqueID": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "SubAdvisorBlob" }, "type": "object" }, "OAS.DataModel.Settings.SubAdvisorEntityOption": { "required": [ "entityId", "userDefineDefinitionId", "userDefineDataId", "name", "code", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "SubAdvisorEntityOption" }, "type": "object" }, "OAS.DataModel.Settings.SubAdvisorUserDefinedField": { "required": [ "entityId", "userDefineDefinitionId", "userDefineDataId", "name", "code", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "SubAdvisorUserDefinedField" }, "type": "object" }, "OAS.DataModel.Portfolio.PlatformAumSummary": { "required": [ "entityId", "createdDate" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "aum": { "type": "number", "format": "double" }, "createdDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "PlatformAumSummary" }, "type": "object" }, "OAS.DataModel.Portfolio.PlatformType": { "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "type": "string", "maxLength": 100, "minLength": 0 } }, "xml": { "name": "PlatformType" }, "type": "object" }, "OAS.DataModel.Trading.AggregateModel": { "required": [ "id", "aggregationName", "keepAlways", "isSystemMaintained", "proposalEnabled", "advisoryWorldModel", "hasManagerFactSheet", "auditedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "aggregationName": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "keepAlways": { "type": "boolean" }, "isSystemMaintained": { "type": "boolean" }, "accountNumberSuffix": { "type": "string", "maxLength": 20, "minLength": 0 }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "entityId": { "type": "integer", "format": "int32" }, "entityEnum": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "include": { "type": "boolean" }, "modelAggTypeId": { "type": "integer", "format": "int32" }, "riskScore": { "type": "number", "format": "double" }, "proposalEnabled": { "type": "boolean" }, "advisoryWorldModel": { "type": "boolean" }, "hasManagerFactSheet": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" }, "color": { "type": "string", "maxLength": 50, "minLength": 0 }, "eclipseFirmIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "eclipseFirmId": { "type": "integer", "format": "int32" }, "eclipseFirmIds_csv": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "tagsList": { "items": { "type": "string" }, "type": "array" }, "tags_csv": { "type": "string" }, "eclipseModelId": { "type": "integer", "format": "int32" }, "minimumInvestmentAmount": { "type": "number", "format": "double" }, "billFeeSchedule": { "type": "integer", "format": "int32" }, "payoutSchedule": { "type": "integer", "format": "int32" }, "modelAssetType": { "type": "string" }, "modelRiskCategory": { "type": "string" }, "modelAssetClass": { "type": "string" }, "modelStrategyType": { "type": "string" }, "taxManaged": { "type": "boolean" }, "isSociallyResponsible": { "type": "boolean" }, "morningstarId": { "type": "string" }, "indexBlendId": { "type": "integer", "format": "int32" }, "morningstarProductId": { "type": "integer", "format": "int32" }, "isAstroEnabled": { "type": "boolean" }, "syncToAstro": { "type": "boolean" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "worstReturn": { "type": "number", "format": "double" }, "averageReturn": { "type": "number", "format": "double" }, "bestReturn": { "type": "number", "format": "double" }, "associatedModelAggId": { "type": "integer", "format": "int32" }, "astroTemplate": { "type": "string" }, "portfolioOverview": { "type": "string" }, "portfolioManagementTeam": { "type": "string" }, "excludeRebalanceSleeve": { "type": "boolean" }, "excludeFromComposites": { "type": "boolean" }, "eclipseModelType": { "type": "string", "enum": [ "Normal", "Unmanaged", "SelfDirected", "SMA", "Optimizer" ] }, "researchedStatus": { "type": "string" }, "investmentObjectiveId": { "type": "integer", "format": "int32" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.ModelAggEntityOption" }, "xml": { "name": "ModelAggEntityOption", "wrapped": true }, "type": "array" }, "modelingInfos": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.ModelAccount" }, "xml": { "name": "ModelAccount", "wrapped": true }, "type": "array" }, "modelingInfosNewMoney": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.ModelAccount" }, "xml": { "name": "ModelAccount", "wrapped": true }, "type": "array" }, "aggregateModelDetails": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.AggregateModelDetail" }, "xml": { "name": "AggregateModelDetail", "wrapped": true }, "type": "array" }, "aumSummary": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AggregateModelAumSummary" }, "historyAudit": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.AggregateModelHistoryAudit" }, "xml": { "name": "AggregateModelHistoryAudit", "wrapped": true }, "type": "array" }, "entities": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.AggregateModelEntity" }, "xml": { "name": "AggregateModelEntity", "wrapped": true }, "type": "array" }, "type": { "$ref": "#/definitions/OAS.DataModel.Trading.AggregateModelType" }, "investmentObjective": { "$ref": "#/definitions/OAS.DataModel.Portfolio.InvestmentObjective" }, "aggregateModelProductTypes": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.AggregateModelProductType" }, "xml": { "name": "AggregateModelProductType", "wrapped": true }, "type": "array" }, "compositeModelRollingReturns": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.CompositeModelRollingReturn" }, "xml": { "name": "CompositeModelRollingReturn", "wrapped": true }, "type": "array" }, "compositeModelReturns": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.CompositeModelReturn" }, "xml": { "name": "CompositeModelReturn", "wrapped": true }, "type": "array" }, "info": { "$ref": "#/definitions/OAS.DataModel.Trading.AggregateModelInfo" } }, "xml": { "name": "AggregateModel" }, "type": "object" }, "OAS.DataModel.Settings.PlatformEntityOption": { "required": [ "entityId", "userDefineDefinitionId", "userDefineDataId", "name", "code", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "PlatformEntityOption" }, "type": "object" }, "OAT.DataModel.ComplexTypes.BasicAuditNotNullNotNull": { "properties": { "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 } }, "xml": { "name": "BasicAuditNotNullNotNull" }, "type": "object" }, "OAS.DataModel.Trading.ModelAccountHistory": { "required": [ "id", "accountId", "rebalanceYN", "isOutsideModel", "createdDate", "createdBy", "editedDate", "editedBy", "minCashBalanceType", "autoRebalFreq", "autoRebalMonth", "autoRebalDay", "replenishMinCash", "dollarModelAmount", "auditDate", "auditBy", "expireMinCashType" ], "properties": { "id": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" }, "rebalanceYN": { "type": "boolean" }, "isOutsideModel": { "type": "boolean" }, "minCashBalance": { "type": "number", "format": "double" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "timestamp": { "type": "string", "format": "byte" }, "oldClientID": { "type": "integer", "format": "int32" }, "modelAggId": { "type": "integer", "format": "int32" }, "modelAgg": { "$ref": "#/definitions/OAS.DataModel.Trading.AggregateModel" }, "fundList": { "type": "string", "maxLength": 50, "minLength": 0 }, "minCashBalanceType": { "type": "integer", "format": "int32" }, "modelAggNewMoneyId": { "type": "integer", "format": "int32" }, "autoRebalFreq": { "type": "integer", "format": "int32" }, "autoRebalMonth": { "type": "integer", "format": "int32" }, "autoRebalDay": { "type": "integer", "format": "int32" }, "lastRebalanced": { "type": "string", "format": "date-time" }, "replenishMinCash": { "type": "boolean" }, "dollarModelId": { "type": "integer", "format": "int32" }, "dollarModelAmount": { "type": "number", "format": "double" }, "cashLiability": { "type": "number", "format": "double" }, "auditDate": { "type": "string", "format": "date-time" }, "auditBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "changeType": { "type": "boolean" }, "expireMinCash": { "type": "number", "format": "double" }, "expireMinCashType": { "type": "integer", "format": "int32" }, "expireMinCashDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "ModelAccountHistory" }, "type": "object" }, "OAS.DataModel.Portfolio.BusinessLine": { "required": [ "id", "personalId", "employeeCount" ], "properties": { "id": { "type": "integer", "format": "int32" }, "personalId": { "type": "integer", "format": "int32" }, "employeeCount": { "type": "integer", "format": "int32", "maximum": 2147483647, "minimum": 0 }, "startDate": { "type": "string", "format": "date-time" }, "personal": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Personal" } }, "xml": { "name": "BusinessLine" }, "type": "object" }, "OAS.DataModel.Portfolio.PlanAumSummary": { "required": [ "entityId", "createdDate" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "aum": { "type": "number", "format": "double" }, "createdDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "PlanAumSummary" }, "type": "object" }, "OAS.DataModel.Portfolio.PlanAdministrator": { "required": [ "id", "personalId", "adminNumber" ], "properties": { "id": { "type": "integer", "format": "int32" }, "personalId": { "type": "integer", "format": "int32" }, "adminNumber": { "type": "string", "maxLength": 50, "minLength": 0 }, "contact": { "type": "string", "maxLength": 80, "minLength": 0 }, "agreementSigned": { "type": "string", "format": "date-time" }, "importKey": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "personal": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Personal" }, "plans": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Plan" }, "xml": { "name": "Plan", "wrapped": true }, "type": "array" } }, "xml": { "name": "PlanAdministrator" }, "type": "object" }, "OAS.DataModel.Portfolio.PlanFee": { "required": [ "id", "planId", "party", "feePercent" ], "properties": { "id": { "type": "integer", "format": "int32" }, "planId": { "type": "integer", "format": "int32" }, "party": { "type": "string", "maxLength": 20, "minLength": 0 }, "feePercent": { "type": "number", "format": "double" } }, "xml": { "name": "PlanFee" }, "type": "object" }, "OAS.DataModel.Portfolio.PlanTask": { "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int32" }, "planId": { "type": "integer", "format": "int32" }, "task": { "type": "string", "maxLength": 255, "minLength": 0 }, "category": { "type": "string", "maxLength": 60, "minLength": 0 }, "sequenceNumber": { "type": "integer", "format": "int32" }, "assignedTo": { "type": "string", "maxLength": 40, "minLength": 0 }, "notes": { "type": "string", "maxLength": 255, "minLength": 0 }, "isCompleted": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "completedDate": { "type": "string", "format": "date-time" }, "type": { "type": "string", "maxLength": 10, "minLength": 0 }, "description": { "type": "string", "maxLength": 500, "minLength": 0 }, "displayType": { "type": "string", "maxLength": 10, "minLength": 0 }, "code": { "type": "string", "maxLength": 50, "minLength": 0 } }, "xml": { "name": "PlanTask" }, "type": "object" }, "OAS.DataModel.Portfolio.PlanPlatform": { "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int32" }, "planId": { "type": "integer", "format": "int32" }, "platformId": { "type": "integer", "format": "int32" }, "feePercent": { "type": "number", "format": "double" }, "feeScheduleId": { "type": "integer", "format": "int32" }, "platform": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Platform" }, "feeSchedule": { "$ref": "#/definitions/OAS.DataModel.Billing.BillSchedule" } }, "xml": { "name": "PlanPlatform" }, "type": "object" }, "OAS.DataModel.Portfolio.PlanRepresentative": { "required": [ "id", "planId", "representativeId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "planId": { "type": "integer", "format": "int32" }, "representativeId": { "type": "integer", "format": "int32" }, "representative": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Representative" } }, "xml": { "name": "PlanRepresentative" }, "type": "object" }, "OAS.DataModel.Portfolio.PlanNote": { "required": [ "id", "createdDate", "createdBy", "systemGenerated", "isWebVisible" ], "properties": { "planId": { "type": "integer", "format": "int32" }, "plan": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Plan" }, "id": { "type": "integer", "format": "int32" }, "text": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "rowVersion": { "type": "string", "format": "byte" }, "category": { "type": "string", "maxLength": 25, "minLength": 0 }, "userOwnerId": { "type": "integer", "format": "int32" }, "systemGenerated": { "type": "boolean" }, "isWebVisible": { "type": "boolean" }, "requestFollowup": { "type": "boolean" } }, "xml": { "name": "PlanNote" }, "type": "object" }, "OAS.DataModel.Billing.GeneralAccount": { "required": [ "id", "parentId", "entity", "applicationLevel", "editedDate", "editedBy", "createdDate", "createdBy", "asOfDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "parentId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "applicationLevel": { "type": "integer", "format": "int32" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "timestamp": { "type": "string", "format": "byte" }, "asOfDate": { "type": "string", "format": "date-time" }, "details": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.GeneralAccountDetail" }, "xml": { "name": "GeneralAccountDetail", "wrapped": true }, "type": "array" } }, "xml": { "name": "GeneralAccount" }, "type": "object" }, "OAS.DataModel.Portfolio.CrmDocument": { "required": [ "id", "category", "createdBy", "createdDate", "blobId", "isWebVisible" ], "properties": { "id": { "type": "integer", "format": "int32" }, "category": { "type": "string", "maxLength": 25, "minLength": 0 }, "createdBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "blobId": { "type": "integer", "format": "int32" }, "editedBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "isWebVisible": { "type": "boolean" }, "secureDocumentId": { "type": "integer", "format": "int32" }, "clientBlob": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ClientBlob" }, "accountBlob": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AccountBlob" }, "brokerDealerBlob": { "$ref": "#/definitions/OAS.DataModel.Portfolio.BrokerDealerBlob" }, "representativeBlob": { "$ref": "#/definitions/OAS.DataModel.Portfolio.RepresentativeBlob" }, "payeeBlob": { "$ref": "#/definitions/OAS.DataModel.Billing.PayeeBlob" }, "subAdvisorBlob": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SubAdvisorBlob" }, "wholesalerBlob": { "$ref": "#/definitions/OAS.DataModel.Portfolio.WholesalerBlob" } }, "xml": { "name": "CrmDocument" }, "type": "object" }, "OAS.DataModel.Trading.SleeveStrategy": { "required": [ "id", "name", "contributionAllocationMethod", "distributionAllocationMethod", "createdBy", "createdDate", "editedBy", "editedDate", "autoRebalFreq", "autoRebalMonth", "autoRebalDay", "mandate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "contributionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "distributionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "autoRebalFreq": { "type": "string", "enum": [ "None", "Monthly", "Quarterly", "Semiannual", "Annual" ] }, "autoRebalMonth": { "type": "integer", "format": "int32" }, "autoRebalDay": { "type": "integer", "format": "int32" }, "mandate": { "type": "boolean" }, "tolerancePercent": { "type": "number", "format": "double" }, "entityId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "riskScore": { "type": "number", "format": "double" }, "originalRiskScore": { "type": "number", "format": "double" }, "beta": { "type": "number", "format": "double" }, "alpha": { "type": "number", "format": "double" }, "rSquared": { "type": "number", "format": "double" }, "drawdown": { "type": "number", "format": "double" }, "ytd": { "type": "number", "format": "double" }, "oneYr": { "type": "number", "format": "double" }, "threeYr": { "type": "number", "format": "double" }, "fiveYr": { "type": "number", "format": "double" }, "sleeveStrategyRiskTypeId": { "type": "integer", "format": "int32" }, "strategyType": { "type": "string", "enum": [ "Undefined", "Single", "Multi" ] }, "include": { "type": "boolean" }, "useRestrictions": { "type": "boolean" }, "assetLevelAllowed": { "type": "string", "enum": [ "Default", "AssetCategory", "AssetClass", "RiskCategory" ] }, "assetLevelsAllowed": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategyAssetLevelAllowed" }, "xml": { "name": "SleeveStrategyAssetLevelAllowed", "wrapped": true }, "type": "array" }, "details": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategyDetail" }, "xml": { "name": "SleeveStrategyDetail", "wrapped": true }, "type": "array" }, "detailHistories": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategyDetailHistory" }, "xml": { "name": "SleeveStrategyDetailHistory", "wrapped": true }, "type": "array" }, "histories": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategyHistory" }, "xml": { "name": "SleeveStrategyHistory", "wrapped": true }, "type": "array" }, "entities": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategyEntity" }, "xml": { "name": "SleeveStrategyEntity", "wrapped": true }, "type": "array" }, "riskType": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategyRiskType" }, "mandates": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategyMandate" }, "xml": { "name": "SleeveStrategyMandate", "wrapped": true }, "type": "array" }, "sleeveStrategyRestrictions": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategyRestriction" }, "xml": { "name": "SleeveStrategyRestriction", "wrapped": true }, "type": "array" }, "deletedSleeveTargets": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategyDeletedSleeveTarget" }, "xml": { "name": "SleeveStrategyDeletedSleeveTarget", "wrapped": true }, "type": "array" }, "sleeveStrategyAggregateDetails": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategyAggregateDetail" }, "xml": { "name": "SleeveStrategyAggregateDetail", "wrapped": true }, "type": "array" } }, "xml": { "name": "SleeveStrategy" }, "type": "object" }, "OAS.DataModel.Trading.TradeBlockModel": { "properties": { "astroModel": { "type": "boolean" }, "modelAggregateId": { "type": "integer", "format": "int32" }, "action": { "type": "string" } }, "xml": { "name": "TradeBlockModel" }, "type": "object" }, "OAS.DataModel.Trading.AccountSleeveHistory": { "required": [ "id", "changeType", "accountId", "targetAllocation", "contributionAllocation", "distributionAllocation", "corporateActionAllocation", "toleranceUpper", "toleranceLower", "editedBy", "editedDate", "sleeveType", "autoTradeTypes" ], "properties": { "id": { "type": "integer", "format": "int32" }, "changeType": { "type": "string", "maxLength": 1, "minLength": 0 }, "accountId": { "type": "integer", "format": "int32" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" }, "targetAllocation": { "type": "number", "format": "double" }, "targetBalanceType": { "type": "string", "enum": [ "Dollars", "Percent" ] }, "contributionAllocation": { "type": "number", "format": "double" }, "distributionAllocation": { "type": "number", "format": "double" }, "corporateActionAllocation": { "type": "number", "format": "double" }, "toleranceUpper": { "type": "number", "format": "double" }, "toleranceLower": { "type": "number", "format": "double" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "sleeveType": { "type": "string", "enum": [ "Normal sleeve", "Custodial account", "Contribution sleeve", "Distribution sleeve", "Unmanaged sleeve" ] }, "autoTradeTypes": { "type": "string", "enum": [ "None", "RegistrationRebalance", "SleeveRebalance", "ContributionAllocation", "TransferInRebalance" ] }, "autoTradeRequested": { "type": "string", "format": "date-time" }, "autoTradeRequestedBy": { "type": "string" }, "autoTradeProcessed": { "type": "string", "format": "date-time" }, "suspendAutoContribUntil": { "type": "string", "format": "date-time" }, "doNotTrade": { "type": "boolean" }, "sleeveStrategyToleranceUpper": { "type": "number", "format": "double" }, "sleeveStrategyToleranceLower": { "type": "number", "format": "double" } }, "xml": { "name": "AccountSleeveHistory" }, "type": "object" }, "OAT.Confirmation.Model.IDownloadFormat": { "required": [ "id", "formatName", "assemblyName" ], "properties": { "id": { "type": "integer", "format": "int32" }, "formatName": { "type": "string", "maxLength": 50, "minLength": 0 }, "assemblyName": { "type": "string", "maxLength": 150, "minLength": 0 }, "xmlFileName": { "type": "string", "maxLength": 150, "minLength": 0 }, "xmlFile": { "type": "string" }, "pricePriority": { "type": "integer", "format": "int32" }, "formatInformation": { "type": "string" }, "isNonFileFormat": { "type": "boolean" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "isForInform": { "type": "boolean" }, "downloadFormatConfigJSON": { "type": "string" } }, "xml": { "name": "IDownloadFormat" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadFile": { "required": [ "id", "downloadSourceId", "fileName", "fileDate", "recordType", "createdDate", "createdBy", "totalRecords", "totalRecordsImported", "isNewPrice" ], "properties": { "id": { "type": "integer", "format": "int32" }, "downloadSourceId": { "type": "integer", "format": "int32" }, "blobId": { "type": "integer", "format": "int32" }, "fileName": { "type": "string", "maxLength": 255, "minLength": 0 }, "fileDate": { "type": "string", "format": "date-time" }, "recordType": { "type": "string", "enum": [ "Name", "Position", "Transaction", "Price", "Dividend", "Product", "NotImported", "Header", "Security", "CorpAction", "TranDetail", "Generic", "CostBasis", "Beneficiary", "StoredPerformance", "Systematic", "RMD", "Banking" ] }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "totalRecords": { "type": "integer", "format": "int32" }, "totalRecordsImported": { "type": "integer", "format": "int32" }, "totalImportDurationInMilliseconds": { "type": "integer", "format": "int32" }, "message": { "type": "string", "maxLength": 8000, "minLength": 0 }, "sectionLink": { "type": "string", "maxLength": 40, "minLength": 0 }, "dateConfirmed": { "type": "string", "format": "date-time" }, "notConfirmed": { "type": "integer", "format": "int32" }, "confirmed": { "type": "integer", "format": "int32" }, "custodianCommonId": { "type": "integer", "format": "int32" }, "isNewPrice": { "type": "boolean" }, "filesUsed": { "type": "string" }, "fileIdsUsed": { "items": { "type": "integer", "format": "int32" }, "readOnly": true, "type": "array" }, "isImportComplete": { "type": "boolean" }, "excluded": { "type": "integer", "format": "int32" }, "costBasisType": { "type": "string", "enum": [ "None", "Unrealized", "Realized", "Both" ] }, "batchProcessingId": { "type": "integer", "format": "int32" }, "fileStatus": { "type": "integer", "format": "int32" }, "agentAnalysisStatus": { "type": "string", "enum": [ "NA", "NotStarted", "Running", "Complete" ] }, "downloadSource": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadSource" }, "positions": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadPosition" }, "xml": { "name": "DownloadPosition", "wrapped": true }, "type": "array" }, "names": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadName" }, "xml": { "name": "DownloadName", "wrapped": true }, "type": "array" }, "beneficiaries": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadBeneficiary" }, "xml": { "name": "DownloadBeneficiary", "wrapped": true }, "type": "array" }, "bankings": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadBanking" }, "xml": { "name": "DownloadBanking", "wrapped": true }, "type": "array" }, "rmDs": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadRMD" }, "xml": { "name": "DownloadRMD", "wrapped": true }, "type": "array" }, "systematics": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadSystematic" }, "xml": { "name": "DownloadSystematic", "wrapped": true }, "type": "array" }, "transactions": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadTransaction" }, "xml": { "name": "DownloadTransaction", "wrapped": true }, "type": "array" }, "costBasises": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadCostBasis" }, "xml": { "name": "DownloadCostBasis", "wrapped": true }, "type": "array" }, "prices": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadPrice" }, "xml": { "name": "DownloadPrice", "wrapped": true }, "type": "array" }, "dividends": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadDividend" }, "xml": { "name": "DownloadDividend", "wrapped": true }, "type": "array" }, "corporateActions": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadCorporateAction" }, "xml": { "name": "DownloadCorporateAction", "wrapped": true }, "type": "array" }, "securities": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadSecurity" }, "xml": { "name": "DownloadSecurity", "wrapped": true }, "type": "array" }, "generics": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadGeneric" }, "xml": { "name": "DownloadGeneric", "wrapped": true }, "type": "array" }, "fileBlob": { "$ref": "#/definitions/OAS.DataModel.Portfolio.DownloadConfirmationFile" }, "memos": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadMemo" }, "xml": { "name": "DownloadMemo", "wrapped": true }, "type": "array" }, "downloadFileExtensions": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadFileExtension" }, "xml": { "name": "DownloadFileExtension", "wrapped": true }, "type": "array" }, "downloadRecordSuggestions": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadRecordSuggestion" }, "xml": { "name": "DownloadRecordSuggestion", "wrapped": true }, "type": "array" }, "tradeFormat": { "readOnly": true, "type": "string" }, "transmitMethod": { "readOnly": true, "type": "string", "enum": [ "Empty", "None", "FTP", "DSTHTTP", "Network", "SFTP", "FTPS", "S3" ] }, "statusText": { "readOnly": true, "type": "string" }, "processBy": { "readOnly": true, "type": "string" }, "processDate": { "readOnly": true, "type": "string", "format": "date-time" }, "uploadTargetId": { "readOnly": true, "type": "integer", "format": "int32" } }, "xml": { "name": "DownloadFile" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadSourceInstruction": { "required": [ "id", "downloadSourceId", "recordType", "recordTypeLink", "field", "code", "value", "createdDate", "createdBy", "editedDate", "editedBy" ], "properties": { "id": { "type": "integer", "format": "int32" }, "downloadSourceId": { "type": "integer", "format": "int32" }, "recordType": { "type": "integer", "format": "int32" }, "recordTypeLink": { "type": "string", "maxLength": 50, "minLength": 0 }, "field": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 50, "minLength": 0 }, "value": { "type": "string", "maxLength": 150, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "downloadSource": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadSource" } }, "xml": { "name": "DownloadSourceInstruction" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadSourceConfig": { "properties": { "lastGoodSync": { "type": "string", "format": "date-time" }, "useLegacy": { "type": "boolean" }, "timeOut": { "type": "number", "format": "double" } }, "xml": { "name": "DownloadSourceConfig" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadSourceSchedule": { "required": [ "id", "downloadSourceId", "time", "skipHolidays", "scheduleConfiguration" ], "properties": { "id": { "type": "integer", "format": "int32" }, "downloadSourceId": { "type": "integer", "format": "int32" }, "time": { "type": "string" }, "skipHolidays": { "type": "boolean" }, "scheduleConfiguration": { "type": "string", "maxLength": 4000, "minLength": 0 }, "downloadSource": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadSource" } }, "xml": { "name": "DownloadSourceSchedule" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadSourceQueueLog": { "required": [ "id", "downloadSourceId", "logMessage", "jobId", "startDate", "auditedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "downloadSourceId": { "type": "integer", "format": "int32" }, "logMessage": { "type": "string", "format": "byte" }, "logMessages": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadSourceQueueLogMessage" }, "xml": { "name": "DownloadSourceQueueLogMessage", "wrapped": true }, "type": "array" }, "jobId": { "type": "string", "maxLength": 50, "minLength": 0 }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "logConfig": { "type": "string" }, "downloadSource": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadSource" } }, "xml": { "name": "DownloadSourceQueueLog" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadSourceDefault": { "required": [ "downloadSourceDefaultId", "downloadSourceId", "createSweepAccts", "createTradeBlock", "isDiscretionary", "isManaged" ], "properties": { "downloadSourceDefaultId": { "type": "integer", "format": "int32" }, "downloadSourceId": { "type": "integer", "format": "int32" }, "representativeId": { "type": "integer", "format": "int32" }, "riaId": { "type": "integer", "format": "int32" }, "fundFamilyId": { "type": "integer", "format": "int32" }, "registrationTypeId": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "shareClassId": { "type": "integer", "format": "int32" }, "platformId": { "type": "integer", "format": "int32" }, "subAdvisorId": { "type": "integer", "format": "int32" }, "createSweepAccts": { "type": "boolean" }, "createTradeBlock": { "type": "boolean" }, "notes": { "type": "string", "maxLength": 2000, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "isDiscretionary": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "modelAggId": { "type": "integer", "format": "int32" }, "businessLineId": { "type": "integer", "format": "int32" }, "isWrapManaged": { "type": "boolean" }, "isWrapSponsored": { "type": "boolean" }, "isAuaReportable": { "type": "boolean" } }, "xml": { "name": "DownloadSourceDefault" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadSourceNote": { "required": [ "downloadSourceId" ], "properties": { "downloadSourceId": { "type": "integer", "format": "int32" }, "advisorNote": { "type": "string" }, "advisorNoteEditedDate": { "type": "string", "format": "date-time" }, "advisorNoteEditedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "analystNote": { "type": "string" }, "analystNoteEditedDate": { "type": "string", "format": "date-time" }, "analystNoteEditedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "downloadSource": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadSource" } }, "xml": { "name": "DownloadSourceNote" }, "type": "object" }, "OAS.DataModel.Billing.ReferralPayment": { "required": [ "id", "referralPaymentBatchId", "accountReferralId", "transactionDate", "feeAmount", "paymentAmount" ], "properties": { "id": { "type": "integer", "format": "int32" }, "referralPaymentBatchId": { "type": "integer", "format": "int32" }, "accountReferralId": { "type": "integer", "format": "int32" }, "transactionDate": { "type": "string", "format": "date-time" }, "feeAmount": { "type": "number", "format": "double" }, "tierYear": { "type": "integer", "format": "int32" }, "paymentAmount": { "type": "number", "format": "double" }, "audit": { "$ref": "#/definitions/OAT.DataModel.ComplexTypes.BasicAuditNotNullNotNull" }, "referralPaymentBatch": { "$ref": "#/definitions/OAS.DataModel.Billing.ReferralPaymentBatch" }, "accountReferral": { "$ref": "#/definitions/OAS.DataModel.Billing.AccountReferral" } }, "xml": { "name": "ReferralPayment" }, "type": "object" }, "OAS.DataModel.Billing.ReferralPayout": { "required": [ "id", "payoutName", "payoutType", "amountType", "payoutFrequency", "amounts" ], "properties": { "id": { "type": "integer", "format": "int32" }, "payoutName": { "type": "string", "maxLength": 100, "minLength": 1 }, "payoutType": { "type": "string", "enum": [ "Perpetual", "Tiers", "OneTime" ] }, "amountType": { "type": "string", "enum": [ "Percent", "Dollars", "Shares" ] }, "payoutFrequency": { "type": "string", "enum": [ "Quarterly", "Annually" ] }, "amounts": { "type": "string", "maxLength": 255, "minLength": 0 }, "audit": { "$ref": "#/definitions/OAT.DataModel.ComplexTypes.BasicAuditNotNullNotNull" }, "accountReferrals": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.AccountReferral" }, "xml": { "name": "AccountReferral", "wrapped": true }, "type": "array" } }, "xml": { "name": "ReferralPayout" }, "type": "object" }, "OAS.DataModel.Trading.Model": { "required": [ "id", "shareClassId", "modelName", "modelTol", "cashPerc", "cashTol", "isActive", "createdDate", "createdBy", "editedDate", "editedBy", "isListTraded", "modelLevels" ], "properties": { "id": { "type": "integer", "format": "int32" }, "fundFamilyId": { "type": "integer", "format": "int32" }, "shareClassId": { "type": "integer", "format": "int32" }, "platformId": { "type": "integer", "format": "int32" }, "modelNum": { "type": "integer", "format": "int32" }, "percEquity": { "type": "integer", "format": "int32" }, "modelName": { "type": "string", "maxLength": 100, "minLength": 0 }, "modelType": { "type": "string", "maxLength": 20, "minLength": 0 }, "fundList": { "type": "string", "maxLength": 20, "minLength": 0 }, "modelTol": { "type": "integer", "format": "int32" }, "cashPerc": { "type": "integer", "format": "int32" }, "cashTol": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "lastEditedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "lastEditedBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "rowVersion": { "type": "string", "format": "byte" }, "oldModelID": { "type": "integer", "format": "int32" }, "isListTraded": { "type": "boolean" }, "groupNum": { "type": "string", "maxLength": 25, "minLength": 0 }, "subAdvisorId": { "type": "integer", "format": "int32" }, "modNotes": { "type": "string", "maxLength": 2000, "minLength": 0 }, "representativeId": { "type": "integer", "format": "int32" }, "rulesManagementId": { "type": "integer", "format": "int32" }, "sequence": { "type": "integer", "format": "int32" }, "modelCode": { "type": "string", "maxLength": 50, "minLength": 0 }, "entityEnum": { "type": "integer", "format": "int32" }, "parentId": { "type": "integer", "format": "int32" }, "lastRebalanced": { "type": "string", "format": "date-time" }, "changeReason": { "type": "string", "maxLength": 255, "minLength": 0 }, "lastChangeReason": { "type": "string", "maxLength": 255, "minLength": 0 }, "modelLevels": { "type": "integer", "format": "int32" }, "useRestrictions": { "type": "boolean" }, "isDynamic": { "type": "boolean" }, "isSMA": { "type": "boolean" }, "dynamicEffectiveDate": { "type": "string", "format": "date-time" }, "custodianId": { "type": "integer", "format": "int32" }, "assetClassId": { "type": "integer", "format": "int32" }, "riskCategoryId": { "type": "integer", "format": "int32" }, "fundFamily": { "$ref": "#/definitions/OAS.DataModel.Portfolio.FundFamilyLocal" }, "platform": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Platform" }, "shareClass": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ShareClass" }, "subAdvisor": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SubAdvisor" }, "custodian": { "$ref": "#/definitions/OAS.DataModel.Portfolio.CustodianLocal" }, "aggregateModelDetails": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.AggregateModelDetail" }, "xml": { "name": "AggregateModelDetail", "wrapped": true }, "type": "array" }, "aumSummary": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ModelAumSummary" }, "items": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.ModelItem" }, "xml": { "name": "ModelItem", "wrapped": true }, "type": "array" }, "fundLists": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.ModelFundList" }, "xml": { "name": "ModelFundList", "wrapped": true }, "type": "array" }, "ranges": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.ModelRange" }, "xml": { "name": "ModelRange", "wrapped": true }, "type": "array" }, "restrictions": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.ModelRestriction" }, "xml": { "name": "ModelRestriction", "wrapped": true }, "type": "array" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.ModelEntityOption" }, "xml": { "name": "ModelEntityOption", "wrapped": true }, "type": "array" }, "communityModel": { "$ref": "#/definitions/OAS.DataModel.Integration.Communities.CommunityModel" } }, "xml": { "name": "Model" }, "type": "object" }, "OAS.DataModel.Portfolio.PortfolioGroup": { "required": [ "id", "name", "clientId", "createdDate", "createdBy" ], "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "maxLength": 250, "minLength": 0 }, "clientId": { "type": "integer", "format": "int32" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "portfolioType": { "type": "string", "enum": [ "Composite", "Reporting", "Trading" ] }, "repId": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "modelAggId": { "type": "integer", "format": "int32" }, "platformId": { "type": "integer", "format": "int32" }, "planId": { "type": "integer", "format": "int32" }, "fundFamilyId": { "type": "integer", "format": "int32" }, "stockRange": { "type": "integer", "format": "int32" }, "riskTolerance": { "type": "integer", "format": "int32" }, "riskBudgetRange": { "type": "integer", "format": "int32" }, "eclipsePortfolioId": { "type": "integer", "format": "int32" }, "client": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Client" }, "accounts": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.PortfolioGroupAccount" }, "xml": { "name": "PortfolioGroupAccount", "wrapped": true }, "type": "array" }, "srcAccounts": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.PortfolioGroupSrcAccount" }, "xml": { "name": "PortfolioGroupSrcAccount", "wrapped": true }, "type": "array" }, "srcRegistrations": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.PortfolioGroupSrcRegistration" }, "xml": { "name": "PortfolioGroupSrcRegistration", "wrapped": true }, "type": "array" }, "changes": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.PortfolioGroupChange" }, "xml": { "name": "PortfolioGroupChange", "wrapped": true }, "type": "array" }, "reportPortfolioGroupVersionAssignments": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Envision.ReportPortfolioGroupVersionAssignment" }, "xml": { "name": "ReportPortfolioGroupVersionAssignment", "wrapped": true }, "type": "array" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.PortfolioGroupEntityOption" }, "xml": { "name": "PortfolioGroupEntityOption", "wrapped": true }, "type": "array" }, "targetAllocations": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.PortfolioGroupTargetAllocation" }, "xml": { "name": "PortfolioGroupTargetAllocation", "wrapped": true }, "type": "array" }, "userDefinedFields": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.PortfolioGroupUserDefinedField" }, "xml": { "name": "PortfolioGroupUserDefinedField", "wrapped": true }, "type": "array" } }, "xml": { "name": "PortfolioGroup" }, "type": "object" }, "OAS.DataModel.Integration.Astro.AstroAsset": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "maxPercentWeight": { "type": "number", "format": "double" }, "minPercentWeight": { "type": "number", "format": "double" }, "maxShares": { "type": "integer", "format": "int32" }, "minShares": { "type": "integer", "format": "int32" }, "minTradeSize": { "type": "integer", "format": "int32" }, "transactionCostBuy": { "type": "number", "format": "double" }, "transactionCostSell": { "type": "number", "format": "double" }, "prospectId": { "type": "string" }, "source": { "type": "string" }, "restrictionType": { "type": "string", "enum": [ "None", "DoNotBuy", "DoNotSell", "DoNotTrade", "SellAllShares", "BringWeightTo", "Percent" ] }, "product": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductLocal" } }, "xml": { "name": "AstroAsset" }, "type": "object" }, "OAS.DataModel.Portfolio.AssetClassAumSummary": { "required": [ "entityId", "createdDate" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "aum": { "type": "number", "format": "double" }, "createdDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "AssetClassAumSummary" }, "type": "object" }, "OAS.DataModel.Portfolio.ProductDescriptionProvider": { "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int32" }, "providerName": { "type": "string", "maxLength": 50, "minLength": 0 } }, "xml": { "name": "ProductDescriptionProvider" }, "type": "object" }, "OAS.DataModel.Settings.ProductClassEntityOption": { "required": [ "entityId", "userDefineDefinitionId", "userDefineDataId", "name", "code", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "ProductClassEntityOption" }, "type": "object" }, "OAS.DataModel.Portfolio.RiskCategoryAumSummary": { "required": [ "entityId", "createdDate" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "aum": { "type": "number", "format": "double" }, "createdDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "RiskCategoryAumSummary" }, "type": "object" }, "OAS.DataModel.Settings.RiskCategoryEntityOption": { "required": [ "entityId", "userDefineDefinitionId", "userDefineDataId", "name", "code", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "RiskCategoryEntityOption" }, "type": "object" }, "OAS.DataModel.Portfolio.AssetCategoryAumSummary": { "required": [ "entityId", "createdDate" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "aum": { "type": "number", "format": "double" }, "createdDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "AssetCategoryAumSummary" }, "type": "object" }, "OAS.DataModel.Settings.ProductCategoryEntityOption": { "required": [ "entityId", "userDefineDefinitionId", "userDefineDataId", "name", "code", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "ProductCategoryEntityOption" }, "type": "object" }, "OAS.DataModel.Portfolio.SecurityClassification.DerivationLocal": { "properties": { "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "methodLocal": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SecurityClassification.MethodLocal" }, "baseSecurityClassLocal": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SecurityClassification.SecurityClassLocal" }, "derivedSecurityClassLocal": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SecurityClassification.SecurityClassLocal" }, "securityClassificationMethodId": { "type": "integer", "format": "int32" }, "securityClassBaseId": { "type": "integer", "format": "int32" }, "securityClassDerivedId": { "type": "integer", "format": "int32" } }, "xml": { "name": "DerivationLocal" }, "type": "object" }, "OAS.DataModel.Portfolio.SecurityClassification.MethodRuleLocal": { "properties": { "ruleConfigurationJSON": { "type": "string" }, "securityClassId": { "type": "integer", "format": "int32" }, "securityClassificationMethodForRuleId": { "type": "integer", "format": "int32" }, "securityClassificationMethodRuleType": { "type": "string", "enum": [ "Security Class", "Classification Method" ] }, "securityClassificationMethodGlobalId": { "type": "integer", "format": "int32" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "methodLocal": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SecurityClassification.MethodLocal" }, "securityClassLocal": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SecurityClassification.SecurityClassLocal" }, "methodLocalForRule": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SecurityClassification.MethodLocal" }, "securityClassificationMethodId": { "type": "integer", "format": "int32" }, "runOrder": { "type": "integer", "format": "int32" } }, "xml": { "name": "MethodRuleLocal" }, "type": "object" }, "OAS.DataModel.Settings.SecurityClassLocalEntityOption": { "required": [ "entityId", "userDefineDefinitionId", "userDefineDataId", "name", "code", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "SecurityClassLocalEntityOption" }, "type": "object" }, "OAS.DataModel.Settings.SecurityClassLocalUserDefinedField": { "required": [ "entityId", "userDefineDefinitionId", "userDefineDataId", "name", "code", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "SecurityClassLocalUserDefinedField" }, "type": "object" }, "OAS.DataModel.Billing.BillRelatedClient": { "required": [ "id", "billClientId", "clientId", "isActive" ], "properties": { "id": { "type": "integer", "format": "int32" }, "billClientId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "client": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Client" }, "billClient": { "$ref": "#/definitions/OAS.DataModel.Billing.BillClient" } }, "xml": { "name": "BillRelatedClient" }, "type": "object" }, "OAS.DataModel.Billing.BillInstanceClient": { "required": [ "id", "billInstanceId", "clientId", "status", "feeFileGenerated", "startDate", "endDate", "initialAmt", "adjAmt", "createdBy", "createdDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "billInstanceId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "status": { "type": "string", "enum": [ "NotGenerated", "Generated", "Errored", "PendingGeneration", "OnHold", "Warning", "FeeFileError", "ReconError" ] }, "feeFileGenerated": { "type": "boolean" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "initialAmt": { "type": "number", "format": "double" }, "adjAmt": { "type": "number", "format": "double" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "errorMessage": { "type": "string" }, "billId": { "type": "integer", "format": "int32" }, "marketValue": { "type": "number", "format": "double" }, "feeAmount": { "type": "number", "format": "double" }, "lastUpdatedBy": { "type": "string" }, "bluePayPaymentId": { "type": "integer", "format": "int32" }, "client": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Client" }, "billInstance": { "$ref": "#/definitions/OAS.DataModel.Billing.BillInstance" }, "bill": { "$ref": "#/definitions/OAS.DataModel.Billing.Bill" }, "bluePayPayment": { "$ref": "#/definitions/OAS.DataModel.Integration.BluePay.BluePayPayment" }, "relatedClients": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillInstanceClientRelated" }, "xml": { "name": "BillInstanceClientRelated", "wrapped": true }, "type": "array" }, "relatedClientStringList": { "$ref": "#/definitions/OAS.DataModel.Billing.RelatedHouseholdsList" } }, "xml": { "name": "BillInstanceClient" }, "type": "object" }, "OAS.DataModel.Billing.BillInstanceAdditionalInfo": { "required": [ "id", "hasValidItems" ], "properties": { "id": { "type": "integer", "format": "int32" }, "minStartDate": { "type": "string", "format": "date-time" }, "maxEndDate": { "type": "string", "format": "date-time" }, "clientCount": { "type": "integer", "format": "int32" }, "totalMarketValue": { "type": "number", "format": "double" }, "totalBalanceDue": { "type": "number", "format": "double" }, "hasValidItems": { "type": "boolean" } }, "xml": { "name": "BillInstanceAdditionalInfo" }, "type": "object" }, "OAT.DataModel.ComplexTypes.BasicAuditNullNull": { "properties": { "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 } }, "xml": { "name": "BasicAuditNullNull" }, "type": "object" }, "OAS.DataModel.Trading.FixBlockOrder": { "required": [ "id", "fixBatchId", "productId", "handlInst", "side", "orderQty", "estimatedAmount", "ordType", "cumQty", "leavesQty", "msgSequenceNumber", "autoAllocate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "lockId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "fixBatchId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "fixVersion": { "type": "string", "maxLength": 15, "minLength": 0 }, "execBroker": { "type": "string", "maxLength": 50, "minLength": 0 }, "clOrdID": { "type": "string", "maxLength": 35, "minLength": 0 }, "handlInst": { "type": "string", "maxLength": 1, "minLength": 0 }, "execInst": { "type": "string", "maxLength": 50, "minLength": 0 }, "side": { "type": "string", "maxLength": 1, "minLength": 0 }, "locateReqd": { "type": "boolean" }, "orderQty": { "type": "number", "format": "double" }, "estimatedAmount": { "type": "number", "format": "double" }, "ordType": { "type": "string", "maxLength": 1, "minLength": 0 }, "limitPrice": { "type": "number", "format": "double" }, "stopPrice": { "type": "number", "format": "double" }, "timeInForce": { "type": "string", "maxLength": 1, "minLength": 0 }, "expireTime": { "type": "string", "format": "date-time" }, "audit": { "$ref": "#/definitions/OAT.DataModel.ComplexTypes.BasicAuditNotNullNull" }, "tradedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "transactTime": { "type": "string", "format": "date-time" }, "orderID": { "type": "string", "maxLength": 50, "minLength": 0 }, "ordStatus": { "type": "string", "maxLength": 1, "minLength": 0 }, "cumQty": { "type": "number", "format": "double" }, "avgPrice": { "type": "number", "format": "double" }, "leavesQty": { "type": "number", "format": "double" }, "ordRejReason": { "type": "string", "maxLength": 1, "minLength": 0 }, "cxlRejReason": { "type": "string", "maxLength": 1, "minLength": 0 }, "allocRejCode": { "type": "string", "maxLength": 1, "minLength": 0 }, "lastShares": { "type": "number", "format": "double" }, "lastPrice": { "type": "number", "format": "double" }, "msgSequenceNumber": { "type": "integer", "format": "int32" }, "allocID": { "type": "string", "maxLength": 35, "minLength": 0 }, "refAllocID": { "type": "string", "maxLength": 35, "minLength": 0 }, "allocStatus": { "type": "string", "maxLength": 1, "minLength": 0 }, "lastText": { "type": "string", "maxLength": 255, "minLength": 0 }, "lastTextType": { "type": "integer", "format": "int32" }, "autoAllocate": { "type": "boolean" }, "pendingOrdStatus": { "type": "string", "maxLength": 1, "minLength": 0 }, "settlmntTyp": { "type": "string", "maxLength": 1, "minLength": 0 }, "futSettDate": { "type": "string", "format": "date-time" }, "masterAccountNumber": { "type": "string", "maxLength": 50, "minLength": 0 }, "batch": { "$ref": "#/definitions/OAS.DataModel.Trading.FixBatch" }, "product": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductLocal" }, "custodian": { "$ref": "#/definitions/OAS.DataModel.Portfolio.CustodianLocal" }, "gainLoss": { "$ref": "#/definitions/OAS.DataModel.Trading.FixBlockOrderGainLoss" }, "dwnldMgrId": { "type": "integer", "format": "int32" }, "trInterfaceId": { "type": "integer", "format": "int32" }, "parentId": { "type": "integer", "format": "int32" }, "tradeType": { "type": "integer", "format": "int32" }, "strikePrice": { "type": "number", "format": "double" }, "cfiCode": { "type": "string", "maxLength": 6, "minLength": 0 }, "orderCapacity": { "type": "string", "maxLength": 1, "minLength": 0 }, "positionEffect": { "type": "string", "maxLength": 1, "minLength": 0 }, "maturityDate": { "type": "string", "format": "date-time" }, "solicited": { "type": "boolean" }, "reportBlockStatus": { "type": "string", "maxLength": 1, "minLength": 0 }, "algorithmTag": { "type": "string", "maxLength": 20, "minLength": 0 }, "fixLogs": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.FixBlockOrderLog" }, "xml": { "name": "FixBlockOrderLog", "wrapped": true }, "type": "array" }, "blockFees": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.FixBlockOrderFeeBase" }, "xml": { "name": "FixBlockOrderFeeBase", "wrapped": true }, "type": "array" }, "orders": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.FixTradeRequest" }, "xml": { "name": "FixTradeRequest", "wrapped": true }, "type": "array" }, "commissions": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.FixBlockOrderCommissionBase" }, "xml": { "name": "FixBlockOrderCommissionBase", "wrapped": true }, "type": "array" }, "extension": { "$ref": "#/definitions/OAS.DataModel.Trading.FixBlockOrderExtension" }, "orderHistories": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.FixTradeRequestHistory" }, "xml": { "name": "FixTradeRequestHistory", "wrapped": true }, "type": "array" }, "isOpen": { "type": "boolean", "default": "true" }, "isClosed": { "type": "boolean", "default": "false" } }, "xml": { "name": "FixBlockOrder" }, "type": "object" }, "OAS.DataModel.Trading.TradeRequestInstance": { "required": [ "id", "requestType", "isReady", "hasUpdatedFees", "isNewVersion" ], "properties": { "id": { "type": "integer", "format": "int32" }, "requestType": { "type": "string", "enum": [ "Undefined", "GlobalTrade", "Modeling", "CheckReq", "FeeReq", "BuySell", "ACHReq", "EligibleTrades", "All", "CashFundADV", "CashFundSWD", "SWPDCA", "SysPurchTrade", "Distribution", "Contribution" ] }, "custodianId": { "type": "integer", "format": "int32" }, "audit": { "$ref": "#/definitions/OAT.DataModel.ComplexTypes.BasicAuditNotNullNull" }, "rowVersion": { "type": "string", "format": "byte" }, "caption": { "type": "string", "maxLength": 150, "minLength": 0 }, "downloadManagerId": { "type": "integer", "format": "int32" }, "isReady": { "type": "boolean" }, "entityId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "status": { "type": "string", "maxLength": 10, "minLength": 0 }, "hasUpdatedFees": { "type": "boolean" }, "blobId": { "type": "integer", "format": "int32" }, "errorMessage": { "type": "string", "maxLength": 500, "minLength": 0 }, "endDate": { "type": "string", "format": "date-time" }, "notes": { "type": "string", "maxLength": 255, "minLength": 0 }, "isNewVersion": { "type": "boolean" }, "minRunDate": { "type": "string", "format": "date-time" }, "userId": { "type": "integer", "format": "int32" }, "isEndResult": { "type": "boolean" }, "rebalanceLevel": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "executeStatus": { "type": "string", "maxLength": 18, "minLength": 0 }, "isError": { "type": "boolean" }, "tradeApplication": { "type": "integer", "format": "int32" }, "approvalStatus": { "type": "string", "enum": [ "Approved", "PendingApproval", "NotApproved" ] }, "fixTradeRequests": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.FixTradeRequest" }, "xml": { "name": "FixTradeRequest", "wrapped": true }, "type": "array" }, "fixTradeRequestHistories": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.FixTradeRequestHistory" }, "xml": { "name": "FixTradeRequestHistory", "wrapped": true }, "type": "array" } }, "xml": { "name": "TradeRequestInstance" }, "type": "object" }, "OAS.DataModel.Trading.FixTradeRequestGainLoss": { "required": [ "id", "calculationMethod" ], "properties": { "id": { "type": "integer", "format": "int32" }, "shortTermGain": { "type": "number", "format": "double" }, "longTermGain": { "type": "number", "format": "double" }, "daysUntilLongTerm": { "type": "integer", "format": "int32" }, "calculationMethod": { "type": "string", "maxLength": 50, "minLength": 0 }, "washAmount": { "type": "number", "format": "double" }, "washUnits": { "type": "number", "format": "double" } }, "xml": { "name": "FixTradeRequestGainLoss" }, "type": "object" }, "OAS.DataModel.Trading.FixTradeRequestFee": { "required": [ "id", "tradeRequestFixId", "miscFeeAmt" ], "properties": { "id": { "type": "integer", "format": "int32" }, "tradeRequestFixId": { "type": "integer", "format": "int32" }, "miscFeeAmt": { "type": "number", "format": "double" }, "audit": { "$ref": "#/definitions/OAT.DataModel.ComplexTypes.BasicAuditNotNullNotNull" } }, "xml": { "name": "FixTradeRequestFee" }, "type": "object" }, "OAS.DataModel.Trading.FixTradeRequestCommissionBase": { "required": [ "id", "tradeRequestFixId", "commission" ], "properties": { "id": { "type": "integer", "format": "int32" }, "tradeRequestFixId": { "type": "integer", "format": "int32" }, "commission": { "type": "number", "format": "double" }, "audit": { "$ref": "#/definitions/OAT.DataModel.ComplexTypes.BasicAuditNotNullNotNull" } }, "xml": { "name": "FixTradeRequestCommissionBase" }, "type": "object" }, "OAS.DataModel.Trading.FixTradeRequestExt": { "required": [ "tradeRequestFixId", "tradeType", "okToFeePost", "nsccTradeType", "cdscFree", "taxAmountType", "reinvestDividends", "reinvestLTCapGains", "reinvestSTCapGains", "clientDirected" ], "properties": { "tradeRequestFixId": { "type": "integer", "format": "int32" }, "interfaceId": { "type": "integer", "format": "int32" }, "productExchangeId": { "type": "integer", "format": "int32" }, "assetExchangeId": { "type": "integer", "format": "int32" }, "billAccountItemId": { "type": "integer", "format": "int32" }, "tradeType": { "type": "integer", "format": "int32" }, "distCodeId": { "type": "integer", "format": "int32" }, "contribCode": { "type": "string", "maxLength": 20, "minLength": 0 }, "commissionCharge": { "type": "number", "format": "double" }, "miscFees": { "type": "number", "format": "double" }, "navCode": { "type": "string", "maxLength": 1, "minLength": 0 }, "tradeNotes": { "type": "string", "maxLength": 255, "minLength": 0 }, "commissionChargeSell": { "type": "number", "format": "double" }, "miscFeeSell": { "type": "number", "format": "double" }, "okToFeePost": { "type": "boolean" }, "nsccTradeType": { "type": "string", "enum": [ "UseDefault", "NormalPurchase", "Nav", "Roa", "Loi" ] }, "cdscFree": { "type": "boolean" }, "taxAmount": { "type": "number", "format": "double" }, "taxAmountType": { "type": "integer", "format": "int32" }, "stateTaxAmount": { "type": "number", "format": "double" }, "reinvestDividends": { "type": "boolean" }, "reinvestLTCapGains": { "type": "boolean" }, "reinvestSTCapGains": { "type": "boolean" }, "aggregateModelId": { "type": "integer", "format": "int32" }, "repNotes": { "type": "string", "maxLength": 255, "minLength": 0 }, "clientDirected": { "type": "boolean" }, "roaAmount": { "type": "number", "format": "double" }, "aggregateModel": { "$ref": "#/definitions/OAS.DataModel.Trading.AggregateModel" } }, "xml": { "name": "FixTradeRequestExt" }, "type": "object" }, "OAS.DataModel.Trading.FixTradeRequestPending": { "required": [ "fixTradeRequestId", "cnt" ], "properties": { "fixTradeRequestId": { "type": "integer", "format": "int32" }, "cnt": { "type": "integer", "format": "int32" } }, "xml": { "name": "FixTradeRequestPending" }, "type": "object" }, "OAS.DataModel.Trading.FixTradeRequestRoute": { "required": [ "fixTradeRequestId", "instanceId", "accountId" ], "properties": { "fixTradeRequestId": { "type": "integer", "format": "int32" }, "instanceId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "custodianCode": { "type": "string" }, "productType": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "fixRouting": { "type": "string" } }, "xml": { "name": "FixTradeRequestRoute" }, "type": "object" }, "OAS.DataModel.Trading.TradingAccountOrderInfo": { "required": [ "accountId" ], "properties": { "accountId": { "type": "integer", "format": "int32" }, "lastTransDate": { "type": "string", "format": "date-time" }, "accountNumber": { "type": "string", "maxLength": 50, "minLength": 0 }, "cashValueCurrent": { "type": "number", "format": "double" }, "cashValuePostTrade": { "type": "number", "format": "double" }, "currValue": { "type": "number", "format": "double" }, "pendValue": { "type": "number", "format": "double" }, "registrationId": { "type": "integer", "format": "int32" }, "regName": { "type": "string" }, "tradingInstr": { "type": "string" }, "accountType": { "type": "string" }, "custodianName": { "type": "string" }, "custodianId": { "type": "integer", "format": "int32" }, "trustType": { "type": "string", "enum": [ "None", "CTC", "EAS" ] }, "subAdvisorName": { "type": "string" }, "masterAccountNumber": { "type": "string" }, "platformName": { "type": "string" }, "groupNum": { "type": "string" }, "isQual": { "type": "boolean" }, "repName": { "type": "string" }, "minCashBalance": { "type": "number", "format": "double" }, "minCashBalanceType": { "type": "string", "enum": [ "Dollars", "Percent" ] }, "replenishMinCash": { "type": "boolean" }, "dollarModelAmount": { "type": "number", "format": "double" }, "aggregationName": { "type": "string" }, "riskBudget": { "type": "integer", "format": "int32" }, "currValueWithoutExcludedAssets": { "type": "number", "format": "double" }, "pendValueWithoutExcludedAssets": { "type": "number", "format": "double" } }, "xml": { "name": "TradingAccountOrderInfo" }, "type": "object" }, "OAS.DataModel.Confirm.Alternative.EquityActivityType": { "required": [ "id", "description" ], "properties": { "id": { "type": "integer", "format": "int32" }, "transactionSubTypeId": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "impactsCommitmentDefault": { "type": "boolean" }, "impactsCapitalBalanceDefault": { "type": "boolean" }, "transactionSubType": { "$ref": "#/definitions/OAS.DataModel.Trading.TransactionSubType" }, "capitalBalanceImpact": { "type": "integer", "format": "int32" }, "isGlobalDefault": { "type": "boolean" }, "enabledForClient": { "type": "boolean" } }, "xml": { "name": "EquityActivityType" }, "type": "object" }, "OAS.DataModel.Confirm.Alternative.EquityFundingType": { "required": [ "id", "description" ], "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string" } }, "xml": { "name": "EquityFundingType" }, "type": "object" }, "OAS.DataModel.Confirm.Alternative.ProductTransaction": { "required": [ "id", "productId", "transactionDate", "percentOfCommitmentAmount", "auditedDate", "alternativeEquityFundingTypeId", "impactsCommitment", "impactsCapitalBalance" ], "properties": { "id": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "transactionTypeId": { "type": "integer", "format": "int32" }, "alternativeEquityActivityTypeId": { "type": "integer", "format": "int32" }, "transactionDate": { "type": "string", "format": "date-time" }, "percentOfCommitmentAmount": { "type": "number", "format": "double" }, "notes": { "type": "string", "maxLength": 255, "minLength": 0 }, "auditedDate": { "type": "string", "format": "date-time" }, "alternativeEquityFundingTypeId": { "type": "integer", "format": "int32" }, "impactsCommitment": { "type": "boolean" }, "impactsCapitalBalance": { "type": "boolean" }, "auditedByDisplay": { "type": "string" }, "product": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductLocal" }, "transactionType": { "$ref": "#/definitions/OAS.DataModel.Trading.TransactionType" } }, "xml": { "name": "ProductTransaction" }, "type": "object" }, "OAS.DataModel.ComplexTypes.Address": { "properties": { "line1": { "type": "string", "maxLength": 255, "minLength": 0 }, "line2": { "type": "string", "maxLength": 255, "minLength": 0 }, "line3": { "type": "string", "maxLength": 255, "minLength": 0 }, "city": { "type": "string", "maxLength": 30, "minLength": 0 }, "state": { "type": "string", "maxLength": 2, "minLength": 0 }, "zip": { "type": "string", "maxLength": 10, "minLength": 0 } }, "xml": { "name": "Address" }, "type": "object" }, "OAS.DataModel.ComplexTypes.FullPhoneNumber": { "properties": { "extension": { "type": "string", "maxLength": 10, "minLength": 0 }, "hasValue": { "readOnly": true, "type": "boolean" }, "number": { "type": "string", "maxLength": 15, "minLength": 0 } }, "xml": { "name": "FullPhoneNumber" }, "type": "object" }, "OAS.DataModel.ComplexTypes.PhoneNumber": { "properties": { "number": { "type": "string", "maxLength": 15, "minLength": 0 }, "hasValue": { "readOnly": true, "type": "boolean" } }, "xml": { "name": "PhoneNumber" }, "type": "object" }, "OAS.DataModel.Billing.BillRepresentative": { "required": [ "id", "representativeId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "representativeId": { "type": "integer", "format": "int32" }, "representative": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Representative" }, "billRepresentativePlatforms": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.BillRepPlatform" }, "xml": { "name": "BillRepPlatform", "wrapped": true }, "type": "array" } }, "xml": { "name": "BillRepresentative" }, "type": "object" }, "OAS.DataModel.Portfolio.AdditionalRepAssignment": { "required": [ "representativeId", "clientId", "repTitleId" ], "properties": { "representativeId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "repTitleId": { "type": "integer", "format": "int32" }, "audit": { "$ref": "#/definitions/OAT.DataModel.ComplexTypes.BasicAuditNotNullNotNull" }, "representative": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Representative" }, "client": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Client" }, "repTitle": { "$ref": "#/definitions/OAS.DataModel.Portfolio.RepTitle" } }, "xml": { "name": "AdditionalRepAssignment" }, "type": "object" }, "OAS.DataModel.Portfolio.ClientRepAdditional": { "required": [ "clientId", "representativeId", "payoutRate", "isPrimary", "startDate", "endDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "representativeId": { "type": "integer", "format": "int32" }, "representativeTitleId": { "type": "integer", "format": "int32" }, "payoutRate": { "type": "number", "format": "double" }, "notes": { "type": "string" }, "isPrimary": { "type": "boolean" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "isActive": { "type": "boolean" }, "representative": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Representative" } }, "xml": { "name": "ClientRepAdditional" }, "type": "object" }, "OAS.DataModel.Portfolio.RepresentativeChange": { "required": [ "id", "representativeId", "asOfDate", "changesCompressedJson", "auditedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "representativeId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "changesCompressedJson": { "type": "string", "format": "byte" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "representative": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Representative" } }, "xml": { "name": "RepresentativeChange" }, "type": "object" }, "OAS.DataModel.Portfolio.RepBrokerDealer": { "required": [ "representativeId", "startDate", "endDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "representativeId": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "brokerDealerId": { "type": "integer", "format": "int32" }, "isSystemGenerated": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "isActive": { "type": "boolean" }, "representative": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Representative" } }, "xml": { "name": "RepBrokerDealer" }, "type": "object" }, "OAS.DataModel.Portfolio.RepresentativePhoto": { "required": [ "id", "isZip", "uniqueID" ], "properties": { "representativeId": { "type": "integer", "format": "int32" }, "data": { "type": "string", "format": "byte" }, "id": { "type": "integer", "format": "int32" }, "openWith": { "type": "string", "maxLength": 200, "minLength": 0 }, "fileName": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "rowVersion": { "type": "string", "format": "byte" }, "blobDesc": { "type": "string", "maxLength": 200, "minLength": 0 }, "blobText": { "type": "string" }, "isZip": { "type": "boolean" }, "fileNETidmId": { "type": "string", "maxLength": 9, "minLength": 0 }, "filePath": { "type": "string", "maxLength": 500, "minLength": 0 }, "eFileLocation": { "type": "string", "enum": [ "Undefined", "Database", "FileServer", "AmazonS3", "HttpGet", "RedtailIms", "Communities" ] }, "rootPath": { "type": "string", "maxLength": 100, "minLength": 0 }, "uniqueID": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "RepresentativePhoto" }, "type": "object" }, "OAS.DataModel.Portfolio.RepresentativeImageBlob": { "required": [ "id", "isZip", "uniqueID" ], "properties": { "representativeId": { "type": "integer", "format": "int32" }, "height": { "type": "number", "format": "double" }, "width": { "type": "number", "format": "double" }, "barColor": { "type": "string", "maxLength": 50, "minLength": 0 }, "data": { "type": "string", "format": "byte" }, "id": { "type": "integer", "format": "int32" }, "openWith": { "type": "string", "maxLength": 200, "minLength": 0 }, "fileName": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "rowVersion": { "type": "string", "format": "byte" }, "blobDesc": { "type": "string", "maxLength": 200, "minLength": 0 }, "blobText": { "type": "string" }, "isZip": { "type": "boolean" }, "fileNETidmId": { "type": "string", "maxLength": 9, "minLength": 0 }, "filePath": { "type": "string", "maxLength": 500, "minLength": 0 }, "eFileLocation": { "type": "string", "enum": [ "Undefined", "Database", "FileServer", "AmazonS3", "HttpGet", "RedtailIms", "Communities" ] }, "rootPath": { "type": "string", "maxLength": 100, "minLength": 0 }, "uniqueID": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "RepresentativeImageBlob" }, "type": "object" }, "OAS.DataModel.Portfolio.Ria": { "required": [ "id", "billingStyle", "isActive" ], "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "description": { "type": "string", "maxLength": 200, "minLength": 0 }, "personalId": { "type": "integer", "format": "int32" }, "billingStyle": { "type": "integer", "format": "int32" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "isSolicitor": { "type": "boolean" }, "payeeId": { "type": "integer", "format": "int32" }, "fiscalStartDate": { "type": "string", "maxLength": 5, "minLength": 0 }, "fiscalEndDate": { "type": "string", "maxLength": 5, "minLength": 0 }, "isDefault": { "type": "boolean" }, "isActive": { "type": "boolean" }, "importKey": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "globalId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "personal": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Personal" } }, "xml": { "name": "Ria" }, "type": "object" }, "OAS.DataModel.Portfolio.BrokerDealer": { "required": [ "id", "personalId", "isActive", "bdStatus", "clearingFirm", "isAdvOnFile", "isProductionReported", "frequency", "isMktingMaterialSent", "isSendingQuestionaire", "transmissionMethod", "transmissionFormat" ], "properties": { "id": { "type": "integer", "format": "int32" }, "personalId": { "type": "integer", "format": "int32" }, "overideCode": { "type": "string", "maxLength": 50, "minLength": 0 }, "overidePerc": { "type": "number", "format": "double" }, "agentID": { "type": "string", "maxLength": 10, "minLength": 0 }, "rowVersion": { "type": "string", "format": "byte" }, "oldBD_ID": { "type": "integer", "format": "int32" }, "oldBDCode": { "type": "string", "maxLength": 10, "minLength": 0 }, "impDate": { "type": "string", "format": "date-time" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 20, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 20, "minLength": 0 }, "isActive": { "type": "boolean" }, "bdStatus": { "type": "string", "enum": [ "NoIssues", "Limited", "Pending", "Prospect", "Rejected", "Inactive" ] }, "clearingFirm": { "type": "string", "enum": [ "SelfClearing", "Pershing", "NationalFinancial", "Unknown", "TDAmeritrade", "Schwab", "TrustCompanyOfAmerica", "Foliofn", "Fidelity", "RBCCapitalMarkets", "SouthwestSecuritiesInc" ] }, "crdNumber": { "type": "string", "maxLength": 50, "minLength": 0 }, "howIsAdvRegistered": { "type": "string", "enum": [ "Unknown", "SECRegistered", "StateRegistered", "Unregistered", "Other" ] }, "isAdvOnFile": { "type": "boolean" }, "isProductionReported": { "type": "boolean" }, "frequency": { "type": "integer", "format": "int32" }, "isMktingMaterialSent": { "type": "boolean" }, "isSendingQuestionaire": { "type": "boolean" }, "transmissionMethod": { "type": "integer", "format": "int32" }, "transmissionFormat": { "type": "integer", "format": "int32" }, "riaId": { "type": "integer", "format": "int32" }, "payeeId": { "type": "integer", "format": "int32" }, "billPayoutScheduleId": { "type": "integer", "format": "int32" }, "actgLedgerNum": { "type": "string", "maxLength": 50, "minLength": 0 }, "isAdvOneAgree": { "type": "boolean" }, "advOneRestrictions": { "type": "string", "maxLength": 500, "minLength": 0 }, "advOneAgreeDate": { "type": "string", "format": "date-time" }, "agreeDate": { "type": "string", "format": "date-time" }, "agreeRestrictions": { "type": "string", "maxLength": 500, "minLength": 0 }, "repListRecvDate": { "type": "string", "format": "date-time" }, "natConference": { "type": "string", "maxLength": 200, "minLength": 0 }, "regConference": { "type": "string", "maxLength": 200, "minLength": 0 }, "marketingNotes": { "type": "string", "maxLength": 500, "minLength": 0 }, "advYear": { "type": "integer", "format": "int32" }, "clsSendAdvTo": { "type": "string", "maxLength": 50, "minLength": 0 }, "reportsSendTo": { "type": "string", "maxLength": 500, "minLength": 0 }, "reportsFax": { "type": "string", "maxLength": 15, "minLength": 0 }, "reportsEmail": { "type": "string", "maxLength": 500, "minLength": 0 }, "mktMaterialSendTo": { "type": "string", "maxLength": 500, "minLength": 0 }, "mktMaterialEmail": { "type": "string", "maxLength": 500, "minLength": 0 }, "mktMaterialFax": { "type": "string", "maxLength": 15, "minLength": 0 }, "bdRepRestrict": { "type": "string", "maxLength": 150, "minLength": 0 }, "importKey": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "albridgeID": { "type": "integer", "format": "int32" }, "dazlid": { "type": "string", "maxLength": 50, "minLength": 0 }, "alClientId": { "type": "integer", "format": "int32" }, "isValueEditLockedDown": { "type": "boolean" }, "blobs": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.BrokerDealerBlob" }, "xml": { "name": "BrokerDealerBlob", "wrapped": true }, "type": "array" }, "notes": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.BrokerDealerNote" }, "xml": { "name": "BrokerDealerNote", "wrapped": true }, "type": "array" }, "representatives": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Representative" }, "xml": { "name": "Representative", "wrapped": true }, "type": "array" }, "aumSummary": { "$ref": "#/definitions/OAS.DataModel.Portfolio.BrokerDealerAumSummary" }, "additionalContacts": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AdditionalContact" }, "xml": { "name": "AdditionalContact", "wrapped": true }, "type": "array" }, "brokerDealerRevenueShares": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.BrokerDealerRevenueShare" }, "xml": { "name": "BrokerDealerRevenueShare", "wrapped": true }, "type": "array" }, "brokerDealerRevenueShareAccountTypeExclusions": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.BrokerDealerRevenueShareAccountTypeExclusion" }, "xml": { "name": "BrokerDealerRevenueShareAccountTypeExclusion", "wrapped": true }, "type": "array" }, "brokerDealerRevenueShareRepresentativeExclusions": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.BrokerDealerRevenueShareRepresentativeExclusion" }, "xml": { "name": "BrokerDealerRevenueShareRepresentativeExclusion", "wrapped": true }, "type": "array" }, "brokerDealerRevenueShareBusinessLineExclusions": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.BrokerDealerRevenueShareBusinessLineExclusion" }, "xml": { "name": "BrokerDealerRevenueShareBusinessLineExclusion", "wrapped": true }, "type": "array" }, "personal": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Personal" }, "reportImage": { "$ref": "#/definitions/OAS.DataModel.Portfolio.BrokerDealerImageBlob" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.BrokerDealerEntityOption" }, "xml": { "name": "BrokerDealerEntityOption", "wrapped": true }, "type": "array" }, "userDefinedFields": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.BrokerDealerUserDefinedField" }, "xml": { "name": "BrokerDealerUserDefinedField", "wrapped": true }, "type": "array" }, "reportBrokerDealerVersionAssignments": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Envision.ReportBrokerDealerVersionAssignment" }, "xml": { "name": "ReportBrokerDealerVersionAssignment", "wrapped": true }, "type": "array" }, "globalId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "BrokerDealer" }, "type": "object" }, "OAS.DataModel.Portfolio.Wholesaler": { "required": [ "id", "personalId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "personalId": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "notes": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.WholesalerNote" }, "xml": { "name": "WholesalerNote", "wrapped": true }, "type": "array" }, "blobs": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.WholesalerBlob" }, "xml": { "name": "WholesalerBlob", "wrapped": true }, "type": "array" }, "rowVersion": { "type": "string", "format": "byte" }, "impDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "importKey": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "representatives": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Representative" }, "xml": { "name": "Representative", "wrapped": true }, "type": "array" }, "aumSummary": { "$ref": "#/definitions/OAS.DataModel.Portfolio.WholesalerAumSummary" }, "personal": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Personal" }, "userDefinedFields": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.WholesalerUserDefinedField" }, "xml": { "name": "WholesalerUserDefinedField", "wrapped": true }, "type": "array" }, "wholesalerStates": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.WholesalerState" }, "xml": { "name": "WholesalerState", "wrapped": true }, "type": "array" } }, "xml": { "name": "Wholesaler" }, "type": "object" }, "OAS.DataModel.Portfolio.RepresentativeAumSummary": { "required": [ "entityId", "createdDate" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "aum": { "type": "number", "format": "double" }, "createdDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "RepresentativeAumSummary" }, "type": "object" }, "OAS.DataModel.Portfolio.RepresentativeBlob": { "required": [ "isViewable", "isViewableAdvisor", "isViewableRepresentative", "id", "isZip", "uniqueID" ], "properties": { "representativeId": { "type": "integer", "format": "int32" }, "isViewable": { "type": "boolean" }, "isViewableAdvisor": { "type": "boolean" }, "isViewableRepresentative": { "type": "boolean" }, "crmDocuments": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.CrmDocument" }, "xml": { "name": "CrmDocument", "wrapped": true }, "type": "array" }, "representative": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Representative" }, "id": { "type": "integer", "format": "int32" }, "openWith": { "type": "string", "maxLength": 200, "minLength": 0 }, "fileName": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "rowVersion": { "type": "string", "format": "byte" }, "blobDesc": { "type": "string", "maxLength": 200, "minLength": 0 }, "blobText": { "type": "string" }, "isZip": { "type": "boolean" }, "fileNETidmId": { "type": "string", "maxLength": 9, "minLength": 0 }, "filePath": { "type": "string", "maxLength": 500, "minLength": 0 }, "eFileLocation": { "type": "string", "enum": [ "Undefined", "Database", "FileServer", "AmazonS3", "HttpGet", "RedtailIms", "Communities" ] }, "rootPath": { "type": "string", "maxLength": 100, "minLength": 0 }, "uniqueID": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "RepresentativeBlob" }, "type": "object" }, "OAS.DataModel.Portfolio.RepresentativeNote": { "required": [ "id", "createdDate", "createdBy", "systemGenerated", "isWebVisible" ], "properties": { "representativeId": { "type": "integer", "format": "int32" }, "representative": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Representative" }, "id": { "type": "integer", "format": "int32" }, "text": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "rowVersion": { "type": "string", "format": "byte" }, "category": { "type": "string", "maxLength": 25, "minLength": 0 }, "userOwnerId": { "type": "integer", "format": "int32" }, "systemGenerated": { "type": "boolean" }, "isWebVisible": { "type": "boolean" }, "requestFollowup": { "type": "boolean" } }, "xml": { "name": "RepresentativeNote" }, "type": "object" }, "OAS.DataModel.Portfolio.RepNasd": { "required": [ "representativeId", "nasdId" ], "properties": { "representativeId": { "type": "integer", "format": "int32" }, "nasdId": { "type": "integer", "format": "int32" }, "timeStamp": { "type": "string", "format": "byte" }, "nasd": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Nasd" } }, "xml": { "name": "RepNasd" }, "type": "object" }, "OAS.DataModel.Portfolio.RepOnHold": { "required": [ "id", "representativeId", "entityEnum", "holdDate", "holdStatus" ], "properties": { "id": { "type": "integer", "format": "int32" }, "representativeId": { "type": "integer", "format": "int32" }, "entityEnum": { "type": "integer", "format": "int32" }, "holdDate": { "type": "string", "format": "date-time" }, "holdStatus": { "type": "string", "maxLength": 50, "minLength": 0 }, "audit": { "$ref": "#/definitions/OAT.DataModel.ComplexTypes.BasicAuditNotNullNotNull" } }, "xml": { "name": "RepOnHold" }, "type": "object" }, "OAS.DataModel.Portfolio.RepState": { "required": [ "id", "representativeId", "stateId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "representativeId": { "type": "integer", "format": "int32" }, "stateId": { "type": "integer", "format": "int32" }, "oldRepState_ID": { "type": "integer", "format": "int32" }, "state": { "$ref": "#/definitions/OAS.DataModel.Portfolio.State" } }, "xml": { "name": "RepState" }, "type": "object" }, "OAS.DataModel.Settings.RepresentativeEntityOption": { "required": [ "entityId", "userDefineDefinitionId", "userDefineDataId", "name", "code", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "RepresentativeEntityOption" }, "type": "object" }, "OAS.DataModel.Settings.RepresentativeUserDefinedField": { "required": [ "entityId", "userDefineDefinitionId", "userDefineDataId", "name", "code", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "RepresentativeUserDefinedField" }, "type": "object" }, "OAS.DataModel.Billing.RepresentativeBillProductException": { "required": [ "representativeId", "id" ], "properties": { "representativeId": { "type": "integer", "format": "int32" }, "representative": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Representative" }, "id": { "type": "integer", "format": "int32" }, "billProductId": { "type": "integer", "format": "int32" }, "editedDate": { "type": "string", "format": "date-time" }, "editedby": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "billProduct": { "$ref": "#/definitions/OAS.DataModel.Billing.BillProduct" } }, "xml": { "name": "RepresentativeBillProductException" }, "type": "object" }, "OAS.DataModel.Reporting.Envision.ReportRepresentativeVersionAssignment": { "required": [ "representativeId", "reportId", "id", "reportVersionId" ], "properties": { "representativeId": { "type": "integer", "format": "int32" }, "representative": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Representative" }, "reportId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "reportVersionId": { "type": "integer", "format": "int32" }, "auditedByDisplay": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "ReportRepresentativeVersionAssignment" }, "type": "object" }, "OAS.DataModel.Portfolio.ProductGroupMaster": { "required": [ "groupCode" ], "properties": { "groupCode": { "type": "string", "maxLength": 50, "minLength": 0 }, "isActive": { "type": "boolean" }, "items": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductGroup" }, "xml": { "name": "ProductGroup", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProductGroupMaster" }, "type": "object" }, "OAS.DataModel.Portfolio.BondRating": { "required": [ "id", "code", "ratingNumber", "description" ], "properties": { "id": { "type": "integer", "format": "int32" }, "code": { "type": "string", "maxLength": 30, "minLength": 0 }, "ratingNumber": { "type": "integer", "format": "int32" }, "description": { "type": "string", "maxLength": 1000, "minLength": 0 }, "source": { "type": "string", "maxLength": 60, "minLength": 0 } }, "xml": { "name": "BondRating" }, "type": "object" }, "OAS.DataModel.Portfolio.ProductExtensionAlternative": { "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int32" }, "managerId": { "type": "integer", "format": "int32" }, "isDirectInvestment": { "type": "boolean" }, "vintageYear": { "type": "integer", "format": "int32" }, "comment": { "type": "string", "maxLength": 128, "minLength": 0 }, "isK1": { "type": "boolean" }, "k1DeliveryDate": { "type": "string", "format": "date-time" }, "k1EstimatedDeliveryDate": { "type": "string", "format": "date-time" }, "isOrionVisionPending": { "type": "boolean" }, "isOrionVision": { "type": "boolean" }, "manager": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Manager" } }, "xml": { "name": "ProductExtensionAlternative" }, "type": "object" }, "OAS.DataModel.Portfolio.State": { "required": [ "id", "abbreviation", "hamptonEligible" ], "properties": { "id": { "type": "integer", "format": "int32" }, "abbreviation": { "type": "string", "maxLength": 2, "minLength": 0 }, "fullName": { "type": "string", "maxLength": 30, "minLength": 0 }, "teamNo": { "type": "integer", "format": "int32" }, "forDomestic": { "type": "string", "maxLength": 2, "minLength": 0 }, "hamptonEligible": { "type": "boolean" } }, "xml": { "name": "State" }, "type": "object" }, "OAS.DataModel.Settings.ProductUserDefinedTimeFieldValue": { "required": [ "entityId", "userDefineDefinitionId", "userDefineTimeDataId" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineTimeDataId": { "type": "integer", "format": "int32" }, "effectiveDate": { "type": "string", "format": "date-time" }, "value": { "type": "string" } }, "xml": { "name": "ProductUserDefinedTimeFieldValue" }, "type": "object" }, "OAS.DataModel.Settings.UserDefineData": { "required": [ "id", "entity", "parentId", "userDefinedDefinitionId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "parentId": { "type": "integer", "format": "int32" }, "userDefinedDefinitionId": { "type": "integer", "format": "int32" }, "fieldValue": { "type": "string" }, "fieldValueMask": { "type": "string", "maxLength": 255, "minLength": 0 }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedByOverride": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "UserDefineData" }, "type": "object" }, "OAS.DataModel.Settings.UserDefineTimeData": { "required": [ "id", "entity", "parentId", "userDefinedDefinitionId", "effectiveDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "parentId": { "type": "integer", "format": "int32" }, "userDefinedDefinitionId": { "type": "integer", "format": "int32" }, "effectiveDate": { "type": "string", "format": "date-time" }, "fieldValue": { "type": "string" }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "UserDefineTimeData" }, "type": "object" }, "OAS.DataModel.Settings.UserDefineOption": { "required": [ "id", "userDefineDefinitionId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "listValue": { "type": "string", "maxLength": 255, "minLength": 0 }, "isDefault": { "type": "boolean" }, "sequence": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "UserDefineOption" }, "type": "object" }, "OAS.DataModel.Settings.UserDefineDefinitionPageCode": { "required": [ "userDefineDefinitionId", "pageCode" ], "properties": { "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "pageCode": { "type": "string", "maxLength": 50, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "UserDefineDefinitionPageCode" }, "type": "object" }, "OAS.DataModel.Settings.EntityOptionAllowEntity": { "required": [ "userDefinedDefinitionId", "entity", "inheritOrder" ], "properties": { "userDefinedDefinitionId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "inheritOrder": { "type": "integer", "format": "int32" } }, "xml": { "name": "EntityOptionAllowEntity" }, "type": "object" }, "OAS.DataModel.Portfolio.CollectFormat": { "required": [ "id", "collectMethodId", "trInterfaceId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "collectMethodId": { "type": "integer", "format": "int32" }, "trInterfaceId": { "type": "integer", "format": "int32" }, "developer": { "type": "string", "maxLength": 255, "minLength": 0 }, "custComplexes": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.CustComplex" }, "xml": { "name": "CustComplex", "wrapped": true }, "type": "array" } }, "xml": { "name": "CollectFormat" }, "type": "object" }, "OAS.DataModel.Portfolio.CollectMethod": { "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int32" }, "method": { "type": "string", "maxLength": 50, "minLength": 0 }, "description": { "type": "string", "maxLength": 50, "minLength": 0 }, "custComplexes": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.CustComplex" }, "xml": { "name": "CustComplex", "wrapped": true }, "type": "array" } }, "xml": { "name": "CollectMethod" }, "type": "object" }, "OAS.DataModel.Portfolio.ClientBlob": { "required": [ "isViewable", "isViewableAdvisor", "isViewableRepresentative", "id", "isZip", "uniqueID" ], "properties": { "clientId": { "type": "integer", "format": "int32" }, "isViewable": { "type": "boolean" }, "isViewableAdvisor": { "type": "boolean" }, "isViewableRepresentative": { "type": "boolean" }, "crmDocuments": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.CrmDocument" }, "xml": { "name": "CrmDocument", "wrapped": true }, "type": "array" }, "client": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Client" }, "folder": { "type": "string" }, "createdByOverride": { "type": "string", "maxLength": 100, "minLength": 0 }, "id": { "type": "integer", "format": "int32" }, "openWith": { "type": "string", "maxLength": 200, "minLength": 0 }, "fileName": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "rowVersion": { "type": "string", "format": "byte" }, "blobDesc": { "type": "string", "maxLength": 200, "minLength": 0 }, "blobText": { "type": "string" }, "isZip": { "type": "boolean" }, "fileNETidmId": { "type": "string", "maxLength": 9, "minLength": 0 }, "filePath": { "type": "string", "maxLength": 500, "minLength": 0 }, "eFileLocation": { "type": "string", "enum": [ "Undefined", "Database", "FileServer", "AmazonS3", "HttpGet", "RedtailIms", "Communities" ] }, "rootPath": { "type": "string", "maxLength": 100, "minLength": 0 }, "uniqueID": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "ClientBlob" }, "type": "object" }, "OAS.DataModel.Integration.ClientCloudStorageFolder": { "required": [ "id", "clientId", "provider", "folderId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "provider": { "type": "integer", "format": "int32" }, "folderId": { "type": "string", "maxLength": 255, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "createdByDisplay": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedByDisplay": { "type": "string" }, "client": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Client" } }, "xml": { "name": "ClientCloudStorageFolder" }, "type": "object" }, "OAS.DataModel.Billing.BillClientAdditionalAnnualAmount": { "required": [ "clientId", "id", "additionalAnnualAmount", "additionalAnnualAmountType", "billAdjTypeId", "billEntityId", "ignoreThreshold", "requiresEA" ], "properties": { "clientId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "additionalAnnualAmount": { "type": "number", "format": "double" }, "additionalAnnualAmountType": { "type": "integer", "format": "int32" }, "billAdjTypeId": { "type": "integer", "format": "int32" }, "billEntityId": { "type": "integer", "format": "int32" }, "ignoreThreshold": { "type": "number", "format": "double" }, "requiresEA": { "type": "boolean" }, "billScheduleId": { "type": "integer", "format": "int32" }, "endDate": { "type": "string", "format": "date-time" }, "startDate": { "type": "string", "format": "date-time" }, "adjustmentType": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAdjustmentType" }, "billEntity": { "$ref": "#/definitions/OAS.DataModel.Billing.BillEntity" }, "billSchedule": { "$ref": "#/definitions/OAS.DataModel.Billing.BillSchedule" } }, "xml": { "name": "BillClientAdditionalAnnualAmount" }, "type": "object" }, "OAS.DataModel.Portfolio.ClientChange": { "required": [ "id", "clientId", "asOfDate", "changesCompressedJson", "auditedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "changesCompressedJson": { "type": "string", "format": "byte" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "client": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Client" } }, "xml": { "name": "ClientChange" }, "type": "object" }, "OAS.DataModel.Portfolio.ClientNote": { "required": [ "id", "createdDate", "createdBy", "systemGenerated", "isWebVisible" ], "properties": { "clientId": { "type": "integer", "format": "int32" }, "client": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Client" }, "id": { "type": "integer", "format": "int32" }, "text": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "rowVersion": { "type": "string", "format": "byte" }, "category": { "type": "string", "maxLength": 25, "minLength": 0 }, "userOwnerId": { "type": "integer", "format": "int32" }, "systemGenerated": { "type": "boolean" }, "isWebVisible": { "type": "boolean" }, "requestFollowup": { "type": "boolean" } }, "xml": { "name": "ClientNote" }, "type": "object" }, "OAS.DataModel.Portfolio.HouseholdMember": { "required": [ "id", "clientId", "personalId", "sendStatement" ], "properties": { "id": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "personalId": { "type": "integer", "format": "int32" }, "typeDesc": { "type": "string", "maxLength": 25, "minLength": 0 }, "sendStatement": { "type": "boolean" }, "globalId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "client": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Client" }, "personal": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Personal" }, "additionalAddresses": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AdditionalAddress" }, "xml": { "name": "AdditionalAddress", "wrapped": true }, "type": "array" } }, "xml": { "name": "HouseholdMember" }, "type": "object" }, "OAS.DataModel.Portfolio.AdditionalAddress": { "required": [ "id", "clientId", "personalId", "sendStatement" ], "properties": { "id": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "personalId": { "type": "integer", "format": "int32" }, "householdMemberId": { "type": "integer", "format": "int32" }, "typeDesc": { "type": "string", "maxLength": 25, "minLength": 0 }, "sendStatement": { "type": "boolean" }, "client": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Client" }, "personal": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Personal" }, "basicRecord": { "$ref": "#/definitions/OAS.DataModel.Portfolio.HouseholdMember" } }, "xml": { "name": "AdditionalAddress" }, "type": "object" }, "OAS.DataModel.Portfolio.ClientAumSummary": { "required": [ "entityId", "createdDate" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "aum": { "type": "number", "format": "double" }, "createdDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "ClientAumSummary" }, "type": "object" }, "OAS.DataModel.Portfolio.ClientCategory": { "required": [ "id", "abbreviation", "isDefault", "isEmployeeAccount" ], "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "maxLength": 255, "minLength": 0 }, "abbreviation": { "type": "string", "maxLength": 40, "minLength": 0 }, "rowVersion": { "type": "string", "format": "byte" }, "isDefault": { "type": "boolean" }, "isEmployeeAccount": { "type": "boolean" } }, "xml": { "name": "ClientCategory" }, "type": "object" }, "OAS.DataModel.Portfolio.ClientModel": { "required": [ "id", "clientId", "aggregateModelId", "minCashBalanceType", "createdDate", "createdBy", "editedDate", "editedBy" ], "properties": { "id": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "aggregateModelId": { "type": "integer", "format": "int32" }, "minCashBalance": { "type": "number", "format": "double" }, "minCashBalanceType": { "type": "integer", "format": "int32" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "lastRebalanced": { "type": "string", "format": "date-time" }, "client": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Client" }, "aggregateModel": { "$ref": "#/definitions/OAS.DataModel.Trading.AggregateModel" } }, "xml": { "name": "ClientModel" }, "type": "object" }, "OAS.DataModel.Portfolio.BalanceSheet": { "required": [ "id", "clientId", "categoryId", "createdBy", "createdDate", "editedBy", "editedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "intuitId": { "type": "integer", "format": "int32" }, "intuitAccountId": { "type": "integer", "format": "int64" }, "clientId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "maxLength": 255, "minLength": 0 }, "value": { "type": "number", "format": "double" }, "isLiability": { "type": "boolean" }, "categoryId": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "byAllId": { "type": "integer", "format": "int64" }, "byAllAccountId": { "type": "integer", "format": "int64" }, "client": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Client" }, "category": { "$ref": "#/definitions/OAS.DataModel.Portfolio.BalanceSheetCategory" } }, "xml": { "name": "BalanceSheet" }, "type": "object" }, "OAS.DataModel.Portfolio.BalanceSheetCategory": { "required": [ "id", "createdBy", "createdDate", "editedBy", "editedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "client": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Client" }, "balanceSheets": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.BalanceSheet" }, "xml": { "name": "BalanceSheet", "wrapped": true }, "type": "array" } }, "xml": { "name": "BalanceSheetCategory" }, "type": "object" }, "OAS.DataModel.Settings.ClientEntityOption": { "required": [ "entityId", "userDefineDefinitionId", "userDefineDataId", "name", "code", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "ClientEntityOption" }, "type": "object" }, "OAS.DataModel.Portfolio.ClientValue": { "required": [ "clientId", "asOfDate" ], "properties": { "clientId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "integer", "format": "int32" }, "value": { "type": "number", "format": "double" }, "cashValue": { "type": "number", "format": "double" } }, "xml": { "name": "ClientValue" }, "type": "object" }, "OAS.DataModel.Settings.ClientUserDefinedField": { "required": [ "entityId", "userDefineDefinitionId", "userDefineDataId", "name", "code", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "ClientUserDefinedField" }, "type": "object" }, "OAS.DataModel.Portfolio.ClientTargetAllocation": { "required": [ "id", "clientId", "entity", "entityId", "weight", "createdBy", "createdDate", "editedBy", "editedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "weight": { "type": "number", "format": "double" }, "minimumRange": { "type": "number", "format": "double" }, "maximumRange": { "type": "number", "format": "double" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedByOverride": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "client": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Client" } }, "xml": { "name": "ClientTargetAllocation" }, "type": "object" }, "OAS.DataModel.ReportAdministration.ReportListVersionClientAssignment": { "required": [ "versionReportListId", "clientId" ], "properties": { "versionReportListId": { "type": "integer", "format": "int32" }, "versionDescription": { "type": "string", "maxLength": 200, "minLength": 0 }, "parentReportListId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" } }, "xml": { "name": "ReportListVersionClientAssignment" }, "type": "object" }, "OAS.DataModel.Reporting.Envision.ReportClientVersionAssignment": { "required": [ "clientId", "reportId", "id", "reportVersionId" ], "properties": { "clientId": { "type": "integer", "format": "int32" }, "client": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Client" }, "reportId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "reportVersionId": { "type": "integer", "format": "int32" }, "auditedByDisplay": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "ReportClientVersionAssignment" }, "type": "object" }, "OAS.DataModel.Portfolio.ClientAssetExclusion": { "required": [ "id", "clientId", "exclusionType", "exclusionValue", "isExcluded", "createdBy", "createdDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "exclusionType": { "type": "integer", "format": "int32" }, "exclusionValue": { "type": "integer", "format": "int32" }, "isExcluded": { "type": "boolean" }, "securityClassificationMethodId": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string", "maxLength": 120, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 120, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "client": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Client" } }, "xml": { "name": "ClientAssetExclusion" }, "type": "object" }, "OAS.DataModel.Settings.ClientUserDefinedPageCode": { "required": [ "clientId", "pageCode" ], "properties": { "clientId": { "type": "integer", "format": "int32" }, "pageCode": { "type": "string", "maxLength": 50, "minLength": 0 }, "udf1": { "type": "integer", "format": "int32" }, "value1": { "type": "string" }, "code1": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition1": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf2": { "type": "integer", "format": "int32" }, "value2": { "type": "string" }, "code2": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition2": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf3": { "type": "integer", "format": "int32" }, "value3": { "type": "string" }, "code3": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition3": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf4": { "type": "integer", "format": "int32" }, "value4": { "type": "string" }, "code4": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition4": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf5": { "type": "integer", "format": "int32" }, "value5": { "type": "string" }, "code5": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition5": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf6": { "type": "integer", "format": "int32" }, "value6": { "type": "string" }, "code6": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition6": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf7": { "type": "integer", "format": "int32" }, "value7": { "type": "string" }, "code7": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition7": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf8": { "type": "integer", "format": "int32" }, "value8": { "type": "string" }, "code8": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition8": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf9": { "type": "integer", "format": "int32" }, "value9": { "type": "string" }, "code9": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition9": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf10": { "type": "integer", "format": "int32" }, "value10": { "type": "string" }, "code10": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition10": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf11": { "type": "integer", "format": "int32" }, "value11": { "type": "string" }, "code11": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition11": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf12": { "type": "integer", "format": "int32" }, "value12": { "type": "string" }, "code12": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition12": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf13": { "type": "integer", "format": "int32" }, "value13": { "type": "string" }, "code13": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition13": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf14": { "type": "integer", "format": "int32" }, "value14": { "type": "string" }, "code14": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition14": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf15": { "type": "integer", "format": "int32" }, "value15": { "type": "string" }, "code15": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition15": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf16": { "type": "integer", "format": "int32" }, "value16": { "type": "string" }, "code16": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition16": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf17": { "type": "integer", "format": "int32" }, "value17": { "type": "string" }, "code17": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition17": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf18": { "type": "integer", "format": "int32" }, "value18": { "type": "string" }, "code18": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition18": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf19": { "type": "integer", "format": "int32" }, "value19": { "type": "string" }, "code19": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition19": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" }, "udf20": { "type": "integer", "format": "int32" }, "value20": { "type": "string" }, "code20": { "type": "string", "maxLength": 25, "minLength": 0 }, "definition20": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "ClientUserDefinedPageCode" }, "type": "object" }, "OAS.DataModel.Portfolio.ClientRiskScoreTable": { "required": [ "id", "asOfDate", "auditedDate" ], "properties": { "clientId": { "type": "integer", "format": "int32" }, "client": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Client" }, "id": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "portfolioRiskScore": { "type": "integer", "format": "int32" }, "targetRiskScore": { "type": "integer", "format": "int32" }, "currentRiskScore": { "type": "integer", "format": "int32" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedBy": { "type": "string", "maxLength": 127, "minLength": 0 }, "riskScoreProvider": { "type": "string" } }, "xml": { "name": "ClientRiskScoreTable" }, "type": "object" }, "OAS.DataModel.Integration.ClientAppLink": { "required": [ "clientId", "appLinkId", "auditedDate" ], "properties": { "clientId": { "type": "integer", "format": "int32" }, "appLinkId": { "type": "integer", "format": "int32" }, "externalIntId": { "type": "integer", "format": "int32" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "appLink": { "$ref": "#/definitions/OAS.DataModel.Integrations.AppLinkLocal" }, "client": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Client" } }, "xml": { "name": "ClientAppLink" }, "type": "object" }, "OAS.DataModel.Portfolio.ClientInfo": { "required": [ "clientId" ], "properties": { "clientId": { "type": "integer", "format": "int32" }, "repCanWorkInClientState": { "type": "boolean" } }, "xml": { "name": "ClientInfo" }, "type": "object" }, "OAS.DataModel.Trading.SleeveStrategyAggregate": { "required": [ "id", "name", "contributionAllocationMethod", "distributionAllocationMethod", "autoRebalFreq", "autoRebalMonth", "autoRebalDay", "createdDate", "createdBy", "auditedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "maxLength": 100, "minLength": 0 }, "contributionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "distributionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "autoRebalFreq": { "type": "string", "enum": [ "None", "Monthly", "Quarterly", "Semiannual", "Annual" ] }, "autoRebalMonth": { "type": "integer", "format": "int32" }, "autoRebalDay": { "type": "integer", "format": "int32" }, "investmentObjectiveId": { "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "include": { "type": "boolean" }, "allowCustomization": { "type": "boolean" }, "riskScore": { "readOnly": true, "type": "number", "format": "double" }, "useRestrictions": { "type": "boolean" }, "eclipseFirmId": { "type": "integer", "format": "int32" }, "associatedModelAggId": { "type": "integer", "format": "int32" }, "details": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategyAggregateDetail" }, "xml": { "name": "SleeveStrategyAggregateDetail", "wrapped": true }, "type": "array" }, "detailHistories": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategyAggregateDetailHistory" }, "xml": { "name": "SleeveStrategyAggregateDetailHistory", "wrapped": true }, "type": "array" }, "specialDetails": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategyAggregateSpecialDetail" }, "xml": { "name": "SleeveStrategyAggregateSpecialDetail", "wrapped": true }, "type": "array" }, "histories": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategyAggregateHistory" }, "xml": { "name": "SleeveStrategyAggregateHistory", "wrapped": true }, "type": "array" }, "registrationSleeves": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.RegistrationSleeve" }, "xml": { "name": "RegistrationSleeve", "wrapped": true }, "type": "array" }, "entities": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategyAggregateEntity" }, "xml": { "name": "SleeveStrategyAggregateEntity", "wrapped": true }, "type": "array" }, "restrictions": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategyAggregateRestriction" }, "xml": { "name": "SleeveStrategyAggregateRestriction", "wrapped": true }, "type": "array" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.SleeveStrategyAggregateEntityOption" }, "xml": { "name": "SleeveStrategyAggregateEntityOption", "wrapped": true }, "type": "array" } }, "xml": { "name": "SleeveStrategyAggregate" }, "type": "object" }, "OAS.DataModel.Trading.SleeveCustodialBillingInfo": { "required": [ "registrationId", "billFeeScheduleId", "billMasterPayoutScheduleId", "sleeveType" ], "properties": { "registrationId": { "type": "integer", "format": "int32" }, "billFeeScheduleId": { "type": "integer", "format": "int32" }, "billFeeScheduleName": { "type": "string", "maxLength": 50, "minLength": 0 }, "billMasterPayoutScheduleId": { "type": "integer", "format": "int32" }, "billMasterPayoutScheduleName": { "type": "string", "maxLength": 50, "minLength": 0 }, "sleeveType": { "type": "integer", "format": "int32" } }, "xml": { "name": "SleeveCustodialBillingInfo" }, "type": "object" }, "OAS.DataModel.Trading.SleeveRecurringAdjInfo": { "required": [ "registrationId", "sleeveType", "annualAmount", "type", "adjustmentType", "responsibleEntity" ], "properties": { "registrationId": { "type": "integer", "format": "int32" }, "sleeveType": { "type": "string", "enum": [ "Normal sleeve", "Custodial account", "Contribution sleeve", "Distribution sleeve", "Unmanaged sleeve" ] }, "id": { "type": "integer", "format": "int32" }, "annualAmount": { "type": "number", "format": "double" }, "type": { "type": "integer", "format": "int32" }, "schedule": { "type": "integer", "format": "int32" }, "adjustmentType": { "type": "integer", "format": "int32" }, "responsibleEntity": { "type": "integer", "format": "int32" }, "endDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "SleeveRecurringAdjInfo" }, "type": "object" }, "OAS.DataModel.Trading.RegistrationSleeveHistory": { "required": [ "id", "changeType", "registrationId", "isActive", "isDoNotTrade", "custodialAccountNumber", "contributionAllocationMethod", "distributionAllocationMethod", "corporateActionAllocationMethod", "editedBy", "editedDate", "autoRebalFrequency", "autoRebalMonth", "autoRebalDay", "mandate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "changeType": { "type": "string", "maxLength": 1, "minLength": 0 }, "registrationId": { "type": "integer", "format": "int32" }, "sleeveStrategyId": { "type": "integer", "format": "int32" }, "sleeveStrategyAggregateId": { "type": "integer", "format": "int32" }, "sleeveStrategyAggregate": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategyAggregate" }, "isActive": { "type": "boolean" }, "isDoNotTrade": { "type": "boolean" }, "custodialAccountNumber": { "type": "string", "maxLength": 50, "minLength": 0 }, "contributionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "distributionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "corporateActionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "lastSuffixUsed": { "type": "integer", "format": "int32" }, "autoRebalFrequency": { "type": "string", "enum": [ "None", "Monthly", "Quarterly", "Semiannual", "Annual" ] }, "autoRebalMonth": { "type": "integer", "format": "int32", "maximum": 12, "minimum": 1 }, "autoRebalDay": { "type": "integer", "format": "int32", "maximum": 31, "minimum": 1 }, "mandate": { "type": "boolean" }, "tolerancePercent": { "type": "number", "format": "double" } }, "xml": { "name": "RegistrationSleeveHistory" }, "type": "object" }, "OAS.DataModel.Trading.DeletedSleeveTarget": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "deletedModelId": { "type": "integer", "format": "int32" }, "targetModelId": { "type": "integer", "format": "int32" } }, "xml": { "name": "DeletedSleeveTarget" }, "type": "object" }, "OAS.DataModel.Portfolio.BlockedPerson": { "required": [ "id", "ofacId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "ofacId": { "type": "integer", "format": "int32" }, "sdnName": { "type": "string", "maxLength": 200, "minLength": 0 }, "sdnType": { "type": "string", "maxLength": 12, "minLength": 0 }, "program": { "type": "string", "maxLength": 20, "minLength": 0 }, "title": { "type": "string", "maxLength": 180, "minLength": 0 }, "remarks": { "type": "string", "maxLength": 300, "minLength": 0 }, "createdBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "blockedPersonAddresses": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.BlockedPersonAddress" }, "xml": { "name": "BlockedPersonAddress", "wrapped": true }, "type": "array" }, "blockedPersonAlts": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.BlockedPersonAlt" }, "xml": { "name": "BlockedPersonAlt", "wrapped": true }, "type": "array" } }, "xml": { "name": "BlockedPerson" }, "type": "object" }, "OAS.DataModel.Settings.ModelAggEntityOption": { "required": [ "entityId", "userDefineDefinitionId", "userDefineDataId", "name", "code", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "ModelAggEntityOption" }, "type": "object" }, "OAS.DataModel.Trading.AggregateModelDetail": { "required": [ "aggregateModelId", "modelId", "weightPercent" ], "properties": { "aggregateModelId": { "type": "integer", "format": "int32" }, "modelId": { "type": "integer", "format": "int32" }, "weightPercent": { "type": "number", "format": "double" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "model": { "$ref": "#/definitions/OAS.DataModel.Trading.Model" }, "aggregateModel": { "$ref": "#/definitions/OAS.DataModel.Trading.AggregateModel" }, "historyAudit": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.AggregateModelDetailHistoryAudit" }, "xml": { "name": "AggregateModelDetailHistoryAudit", "wrapped": true }, "type": "array" } }, "xml": { "name": "AggregateModelDetail" }, "type": "object" }, "OAS.DataModel.Portfolio.AggregateModelAumSummary": { "required": [ "entityId", "createdDate" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "aum": { "type": "number", "format": "double" }, "createdDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "AggregateModelAumSummary" }, "type": "object" }, "OAS.DataModel.Trading.AggregateModelHistoryAudit": { "required": [ "id", "aggregateModelId", "aggregationName", "keepAlways", "isSystemMaintained" ], "properties": { "id": { "type": "integer", "format": "int32" }, "aggregateModelId": { "type": "integer", "format": "int32" }, "aggregationName": { "type": "string", "maxLength": 255, "minLength": 0 }, "keepAlways": { "type": "boolean" }, "isSystemMaintained": { "type": "boolean" }, "accountNumberSuffix": { "type": "string", "maxLength": 20, "minLength": 0 }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "entityId": { "type": "integer", "format": "int32" }, "entityEnum": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "include": { "type": "boolean" }, "modelAggTypeId": { "type": "integer", "format": "int32" }, "changeType": { "type": "string", "maxLength": 1, "minLength": 0 }, "riskScore": { "type": "number", "format": "double" }, "type": { "$ref": "#/definitions/OAS.DataModel.Trading.AggregateModelType" }, "worstReturn": { "type": "number", "format": "double" }, "averageReturn": { "type": "number", "format": "double" }, "bestReturn": { "type": "number", "format": "double" }, "associatedModelAggId": { "type": "integer", "format": "int32" }, "astroTemplate": { "type": "string" } }, "xml": { "name": "AggregateModelHistoryAudit" }, "type": "object" }, "OAS.DataModel.Trading.AggregateModelEntity": { "required": [ "aggregateModelId", "entityId", "entityEnum", "createdBy", "createdDate" ], "properties": { "aggregateModelId": { "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" }, "entityEnum": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "history": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.AggregateModelEntityHistory" }, "xml": { "name": "AggregateModelEntityHistory", "wrapped": true }, "type": "array" } }, "xml": { "name": "AggregateModelEntity" }, "type": "object" }, "OAS.DataModel.Trading.AggregateModelType": { "required": [ "id", "name" ], "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "aggregateModel": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.AggregateModel" }, "xml": { "name": "AggregateModel", "wrapped": true }, "type": "array" }, "aggregateModelHistoryAudit": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.AggregateModelHistoryAudit" }, "xml": { "name": "AggregateModelHistoryAudit", "wrapped": true }, "type": "array" } }, "xml": { "name": "AggregateModelType" }, "type": "object" }, "OAS.DataModel.Portfolio.InvestmentObjective": { "required": [ "id", "description" ], "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string", "maxLength": 25, "minLength": 0 }, "sequenceNumber": { "type": "integer", "format": "int32" }, "riskRangeLow": { "type": "integer", "format": "int32" }, "riskRangeHigh": { "type": "integer", "format": "int32" }, "driftRangeLow": { "type": "integer", "format": "int32" }, "driftRangeHigh": { "type": "integer", "format": "int32" }, "detail": { "type": "string", "maxLength": 700, "minLength": 0 }, "hypotheticalMonthlyPerformanceValues": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.InvestmentObjectiveHypotheticalMonthlyPerformanceValue" }, "xml": { "name": "InvestmentObjectiveHypotheticalMonthlyPerformanceValue", "wrapped": true }, "type": "array" }, "aggregateModels": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.AggregateModel" }, "xml": { "name": "AggregateModel", "wrapped": true }, "type": "array" } }, "xml": { "name": "InvestmentObjective" }, "type": "object" }, "OAS.DataModel.Trading.AggregateModelProductType": { "required": [ "aggregateModelId", "productTypeId" ], "properties": { "aggregateModelId": { "type": "integer", "format": "int32" }, "productTypeId": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "aggregateModel": { "$ref": "#/definitions/OAS.DataModel.Trading.AggregateModel" }, "historyAudit": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.AggregateModelProductTypeHistory" }, "xml": { "name": "AggregateModelProductTypeHistory", "wrapped": true }, "type": "array" } }, "xml": { "name": "AggregateModelProductType" }, "type": "object" }, "OAS.DataModel.Trading.CompositeModelRollingReturn": { "required": [ "aggregateModelId", "startDate", "endDate", "statisticType", "timeframeEnum", "modelName", "inceptionDate" ], "properties": { "aggregateModelId": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "statisticType": { "type": "integer", "format": "int32" }, "timeframeEnum": { "type": "integer", "format": "int32" }, "modelName": { "type": "string", "maxLength": 255, "minLength": 0 }, "inceptionDate": { "type": "string", "format": "date-time" }, "netFeeUnannualized": { "type": "number", "format": "double" }, "netFeeAnnualized": { "type": "number", "format": "double" }, "statisticResult": { "type": "number", "format": "double" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedBy": { "type": "string", "format": "byte" }, "auditedByDisplay": { "type": "string" }, "aggregateModel": { "$ref": "#/definitions/OAS.DataModel.Trading.AggregateModel" } }, "xml": { "name": "CompositeModelRollingReturn" }, "type": "object" }, "OAS.DataModel.Trading.CompositeModelReturn": { "required": [ "aggregateModelId", "timeframe", "startDate", "endDate", "modelName" ], "properties": { "aggregateModelId": { "type": "integer", "format": "int32" }, "timeframe": { "type": "string", "maxLength": 10, "minLength": 0 }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "modelName": { "type": "string", "maxLength": 255, "minLength": 0 }, "netFeePerformance": { "type": "number", "format": "double" }, "grossFeePerformance": { "type": "number", "format": "double" }, "isImported": { "type": "boolean" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedBy": { "type": "string", "format": "byte" }, "auditedByDisplay": { "type": "string" }, "aggregateModel": { "$ref": "#/definitions/OAS.DataModel.Trading.AggregateModel" } }, "xml": { "name": "CompositeModelReturn" }, "type": "object" }, "OAS.DataModel.Trading.AggregateModelInfo": { "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int32" }, "oldestHistoryEditedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "AggregateModelInfo" }, "type": "object" }, "OAS.DataModel.Portfolio.BrokerDealerBlob": { "required": [ "isViewable", "isViewableAdvisor", "isViewableRepresentative", "id", "isZip", "uniqueID" ], "properties": { "brokerDealerId": { "type": "integer", "format": "int32" }, "isViewable": { "type": "boolean" }, "isViewableAdvisor": { "type": "boolean" }, "isViewableRepresentative": { "type": "boolean" }, "crmDocuments": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.CrmDocument" }, "xml": { "name": "CrmDocument", "wrapped": true }, "type": "array" }, "brokerDealer": { "$ref": "#/definitions/OAS.DataModel.Portfolio.BrokerDealer" }, "id": { "type": "integer", "format": "int32" }, "openWith": { "type": "string", "maxLength": 200, "minLength": 0 }, "fileName": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "rowVersion": { "type": "string", "format": "byte" }, "blobDesc": { "type": "string", "maxLength": 200, "minLength": 0 }, "blobText": { "type": "string" }, "isZip": { "type": "boolean" }, "fileNETidmId": { "type": "string", "maxLength": 9, "minLength": 0 }, "filePath": { "type": "string", "maxLength": 500, "minLength": 0 }, "eFileLocation": { "type": "string", "enum": [ "Undefined", "Database", "FileServer", "AmazonS3", "HttpGet", "RedtailIms", "Communities" ] }, "rootPath": { "type": "string", "maxLength": 100, "minLength": 0 }, "uniqueID": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "BrokerDealerBlob" }, "type": "object" }, "OAS.DataModel.Portfolio.WholesalerBlob": { "required": [ "id", "isZip", "uniqueID" ], "properties": { "wholesalerId": { "type": "integer", "format": "int32" }, "crmDocuments": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.CrmDocument" }, "xml": { "name": "CrmDocument", "wrapped": true }, "type": "array" }, "wholesaler": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Wholesaler" }, "id": { "type": "integer", "format": "int32" }, "openWith": { "type": "string", "maxLength": 200, "minLength": 0 }, "fileName": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "rowVersion": { "type": "string", "format": "byte" }, "blobDesc": { "type": "string", "maxLength": 200, "minLength": 0 }, "blobText": { "type": "string" }, "isZip": { "type": "boolean" }, "fileNETidmId": { "type": "string", "maxLength": 9, "minLength": 0 }, "filePath": { "type": "string", "maxLength": 500, "minLength": 0 }, "eFileLocation": { "type": "string", "enum": [ "Undefined", "Database", "FileServer", "AmazonS3", "HttpGet", "RedtailIms", "Communities" ] }, "rootPath": { "type": "string", "maxLength": 100, "minLength": 0 }, "uniqueID": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "WholesalerBlob" }, "type": "object" }, "OAS.DataModel.Trading.SleeveStrategyAssetLevelAllowed": { "required": [ "id", "sleeveStrategyId", "assetLevelId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "sleeveStrategyId": { "type": "integer", "format": "int32" }, "assetLevelType": { "type": "string", "enum": [ "Default", "AssetCategory", "AssetClass", "RiskCategory" ] }, "assetLevelId": { "type": "integer", "format": "int32" }, "sleeveStrategy": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategy" } }, "xml": { "name": "SleeveStrategyAssetLevelAllowed" }, "type": "object" }, "OAS.DataModel.Trading.SleeveStrategyDetail": { "required": [ "id", "sleeveStrategyId", "targetAllocation", "contributionAllocation", "distributionAllocation", "toleranceUpper", "toleranceLower", "createdBy", "createdDate", "editedBy", "editedDate", "sleeveType", "autoTradeTypes", "doNotTrade" ], "properties": { "id": { "type": "integer", "format": "int32" }, "sleeveStrategyId": { "type": "integer", "format": "int32" }, "aggregateModelId": { "type": "integer", "format": "int32" }, "platformId": { "type": "integer", "format": "int32" }, "subAdvisorId": { "type": "integer", "format": "int32" }, "targetAllocation": { "type": "number", "format": "double" }, "contributionAllocation": { "type": "number", "format": "double" }, "distributionAllocation": { "type": "number", "format": "double" }, "toleranceUpper": { "type": "number", "format": "double" }, "toleranceLower": { "type": "number", "format": "double" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "sleeveType": { "type": "string", "enum": [ "Normal sleeve", "Custodial account", "Contribution sleeve", "Distribution sleeve", "Unmanaged sleeve" ] }, "autoTradeTypes": { "type": "string", "enum": [ "None", "RegistrationRebalance", "SleeveRebalance", "ContributionAllocation", "TransferInRebalance" ] }, "doNotTrade": { "type": "boolean" }, "substitutes": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.AggregateModelSubstitute" }, "xml": { "name": "AggregateModelSubstitute", "wrapped": true }, "type": "array" }, "riskScore": { "type": "number", "format": "double" }, "sleeveStrategy": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategy" }, "aggregateModel": { "$ref": "#/definitions/OAS.DataModel.Trading.AggregateModel" }, "platform": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Platform" }, "subAdvisor": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SubAdvisor" }, "history": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategyDetailHistory" }, "xml": { "name": "SleeveStrategyDetailHistory", "wrapped": true }, "type": "array" } }, "xml": { "name": "SleeveStrategyDetail" }, "type": "object" }, "OAS.DataModel.Trading.SleeveStrategyDetailHistory": { "required": [ "id", "sleeveStrategyDetailId", "sleeveStrategyId", "targetAllocation", "targetBalanceType", "contributionAllocation", "distributionAllocation", "toleranceUpper", "toleranceLower", "editedBy", "editedDate", "sleeveType", "autoTradeTypes", "changeType" ], "properties": { "id": { "type": "integer", "format": "int32" }, "sleeveStrategyDetailId": { "type": "integer", "format": "int32" }, "sleeveStrategyId": { "type": "integer", "format": "int32" }, "modelAggId": { "type": "integer", "format": "int32" }, "managementStyleId": { "type": "integer", "format": "int32" }, "subAdvisorId": { "type": "integer", "format": "int32" }, "targetAllocation": { "type": "number", "format": "double" }, "targetBalanceType": { "type": "string", "enum": [ "Dollars", "Percent" ] }, "contributionAllocation": { "type": "number", "format": "double" }, "distributionAllocation": { "type": "number", "format": "double" }, "toleranceUpper": { "type": "number", "format": "double" }, "toleranceLower": { "type": "number", "format": "double" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "sleeveType": { "type": "integer", "format": "int32" }, "autoTradeTypes": { "type": "string", "enum": [ "None", "RegistrationRebalance", "SleeveRebalance", "ContributionAllocation", "TransferInRebalance" ] }, "doNotTrade": { "type": "boolean" }, "riskScore": { "type": "number", "format": "double" }, "changeType": { "type": "string", "maxLength": 1, "minLength": 0 }, "modelAggregate": { "$ref": "#/definitions/OAS.DataModel.Trading.AggregateModel" }, "subAdvisor": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SubAdvisor" }, "managementStyle": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Platform" } }, "xml": { "name": "SleeveStrategyDetailHistory" }, "type": "object" }, "OAS.DataModel.Trading.SleeveStrategyHistory": { "required": [ "id", "sleeveStrategyId", "name", "contributionAllocationMethod", "distributionAllocationMethod", "editedBy", "editedDate", "autoRebalFreq", "autoRebalMonth", "autoRebalDay", "mandate", "changeType" ], "properties": { "id": { "type": "integer", "format": "int32" }, "sleeveStrategyId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "contributionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "distributionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "autoRebalFreq": { "type": "string", "enum": [ "None", "Monthly", "Quarterly", "Semiannual", "Annual" ] }, "autoRebalMonth": { "type": "integer", "format": "int32" }, "autoRebalDay": { "type": "integer", "format": "int32" }, "mandate": { "type": "boolean" }, "tolerancePercent": { "type": "number", "format": "double" }, "changeType": { "type": "string", "maxLength": 1, "minLength": 0 }, "entityId": { "type": "integer", "format": "int32" }, "entityEnum": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "riskScore": { "type": "number", "format": "double" }, "sleeveStrategyRiskTypeId": { "type": "integer", "format": "int32" }, "include": { "type": "boolean" } }, "xml": { "name": "SleeveStrategyHistory" }, "type": "object" }, "OAS.DataModel.Trading.SleeveStrategyEntity": { "required": [ "sleeveStrategyId", "entityId", "entityEnum", "createdBy", "createdDate" ], "properties": { "sleeveStrategyId": { "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" }, "entityEnum": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "history": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategyEntityHistory" }, "xml": { "name": "SleeveStrategyEntityHistory", "wrapped": true }, "type": "array" } }, "xml": { "name": "SleeveStrategyEntity" }, "type": "object" }, "OAS.DataModel.Trading.SleeveStrategyRiskType": { "required": [ "id", "riskTypeName", "isPtModel" ], "properties": { "id": { "type": "integer", "format": "int32" }, "riskTypeName": { "type": "string" }, "lowerLimit": { "type": "number", "format": "double" }, "upperLimit": { "type": "number", "format": "double" }, "isPtModel": { "type": "boolean" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "sleeveStrategy": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategy" }, "xml": { "name": "SleeveStrategy", "wrapped": true }, "type": "array" }, "riskTypeAllocations": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategyRiskTypeAllocation" }, "xml": { "name": "SleeveStrategyRiskTypeAllocation", "wrapped": true }, "type": "array" } }, "xml": { "name": "SleeveStrategyRiskType" }, "type": "object" }, "OAS.DataModel.Trading.SleeveStrategyMandate": { "required": [ "sleeveStrategyId", "modelAggTypeId" ], "properties": { "sleeveStrategyId": { "type": "integer", "format": "int32" }, "modelAggTypeId": { "type": "integer", "format": "int32" }, "riskScore": { "type": "number", "format": "double" }, "allocation": { "type": "number", "format": "double" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "sleeveStrategy": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategy" }, "aggregateModelType": { "$ref": "#/definitions/OAS.DataModel.Trading.AggregateModelType" } }, "xml": { "name": "SleeveStrategyMandate" }, "type": "object" }, "OAS.DataModel.Trading.SleeveStrategyRestriction": { "required": [ "id", "entityId", "entity", "sleeveStrategyId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "sleeveStrategyId": { "type": "integer", "format": "int32" }, "sleeveStrategy": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategy" } }, "xml": { "name": "SleeveStrategyRestriction" }, "type": "object" }, "OAS.DataModel.Trading.SleeveStrategyDeletedSleeveTarget": { "required": [ "id", "sleeveStrategyId", "deletedModelAggId", "targetModelAggId", "createdBy", "createdDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "sleeveStrategyId": { "type": "integer", "format": "int32" }, "deletedModelAggId": { "type": "integer", "format": "int32" }, "targetModelAggId": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "sleeveStrategy": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategy" }, "aggregateModel": { "$ref": "#/definitions/OAS.DataModel.Trading.AggregateModel" } }, "xml": { "name": "SleeveStrategyDeletedSleeveTarget" }, "type": "object" }, "OAS.DataModel.Trading.SleeveStrategyAggregateDetail": { "required": [ "id", "sleeveStrategyAggregateId", "sleeveStrategyId", "targetAllocation", "contributionAllocation", "distributionAllocation", "toleranceUpper", "toleranceLower", "createdDate", "createdBy", "auditedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "sleeveStrategyAggregateId": { "type": "integer", "format": "int32" }, "sleeveStrategyId": { "type": "integer", "format": "int32" }, "riskScore": { "type": "number", "format": "double" }, "targetAllocation": { "type": "number", "format": "double" }, "contributionAllocation": { "type": "number", "format": "double" }, "distributionAllocation": { "type": "number", "format": "double" }, "toleranceUpper": { "type": "number", "format": "double" }, "toleranceLower": { "type": "number", "format": "double" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "strategy": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategy" }, "strategyAggregate": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategyAggregate" }, "detailHistories": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategyAggregateDetailHistory" }, "xml": { "name": "SleeveStrategyAggregateDetailHistory", "wrapped": true }, "type": "array" } }, "xml": { "name": "SleeveStrategyAggregateDetail" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadPosition": { "required": [ "id", "downloadFileId", "accountNumber", "unitBalance", "price", "effectiveDate", "status", "lineNumber", "fileAssetValue" ], "properties": { "id": { "type": "integer", "format": "int32" }, "downloadFileId": { "type": "integer", "format": "int32" }, "cusip": { "type": "string", "maxLength": 50, "minLength": 0 }, "ticker": { "type": "string", "maxLength": 50, "minLength": 0 }, "accountNumber": { "type": "string", "maxLength": 50, "minLength": 0 }, "unitBalance": { "type": "number", "format": "double" }, "price": { "type": "number", "format": "double" }, "effectiveDate": { "type": "string", "format": "date-time" }, "ssn": { "type": "string", "maxLength": 11, "minLength": 0 }, "firmParseCode": { "type": "string", "maxLength": 100, "minLength": 0 }, "status": { "type": "string", "enum": [ "NotConfirmed", "Confirmed", "Excluded", "AggregationOnly" ] }, "lineNumber": { "type": "integer", "format": "int32" }, "fileAssetValue": { "type": "number", "format": "double" }, "systemUnits": { "type": "number", "format": "double" }, "secondaryAccountNumber": { "type": "string", "maxLength": 50, "minLength": 0 }, "statusReason": { "type": "string", "maxLength": 250, "minLength": 0 }, "systemValue": { "type": "number", "format": "double" }, "notes": { "type": "string", "maxLength": 255, "minLength": 0 }, "isEstimated": { "type": "boolean" }, "commitmentAmount": { "type": "number", "format": "double" }, "commitmentDate": { "type": "string", "format": "date-time" }, "capitalInvestedValue": { "type": "number", "format": "double" }, "unfundedCommitment": { "type": "number", "format": "double" }, "shortUnits": { "type": "number", "format": "double" }, "longUnits": { "type": "number", "format": "double" }, "memos": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadMemo" }, "xml": { "name": "DownloadMemo", "wrapped": true }, "type": "array" }, "memoDefault": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadMemoDefault" }, "link": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadLinkView" }, "file": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadFile" }, "downloadCustoms": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadCustom" }, "xml": { "name": "DownloadCustom", "wrapped": true }, "type": "array" } }, "xml": { "name": "DownloadPosition" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadName": { "required": [ "id", "downloadFileId", "accountNumber", "status", "lineNumber" ], "properties": { "id": { "type": "integer", "format": "int32" }, "downloadFileId": { "type": "integer", "format": "int32" }, "cusip": { "type": "string", "maxLength": 50, "minLength": 0 }, "ticker": { "type": "string", "maxLength": 50, "minLength": 0 }, "accountNumber": { "type": "string", "maxLength": 50, "minLength": 0 }, "effectiveDate": { "type": "string", "format": "date-time" }, "ssn": { "type": "string", "maxLength": 15, "minLength": 0 }, "clientName": { "type": "string", "maxLength": 255, "minLength": 0 }, "address1": { "type": "string", "maxLength": 255, "minLength": 0 }, "address2": { "type": "string", "maxLength": 255, "minLength": 0 }, "address3": { "type": "string", "maxLength": 255, "minLength": 0 }, "city": { "type": "string", "maxLength": 30, "minLength": 0 }, "state": { "type": "string", "maxLength": 2, "minLength": 0 }, "zip": { "type": "string", "maxLength": 10, "minLength": 0 }, "representativeNumber": { "type": "string", "maxLength": 50, "minLength": 0 }, "status": { "type": "string", "enum": [ "NotConfirmed", "Confirmed", "Excluded", "AggregationOnly" ] }, "lineNumber": { "type": "integer", "format": "int32" }, "fundFamilyId": { "type": "integer", "format": "int32" }, "fileFundCode": { "type": "string", "maxLength": 20, "minLength": 0 }, "registrationTypeId": { "type": "integer", "format": "int32" }, "fileRegCode": { "type": "string", "maxLength": 50, "minLength": 0 }, "secondaryAccountNumber": { "type": "string", "maxLength": 50, "minLength": 0 }, "fileShareClass": { "type": "string", "maxLength": 20, "minLength": 0 }, "firstName": { "type": "string", "maxLength": 30, "minLength": 0 }, "lastName": { "type": "string", "maxLength": 255, "minLength": 0 }, "note": { "type": "string", "maxLength": 3000, "minLength": 0 }, "isTin": { "type": "boolean" }, "agencyCode": { "type": "string", "maxLength": 20, "minLength": 0 }, "primeBrokerageAgreement": { "type": "boolean" }, "marginAgreement": { "type": "boolean" }, "optionLevel": { "type": "string", "maxLength": 50, "minLength": 0 }, "firmParseCode": { "type": "string", "maxLength": 100, "minLength": 0 }, "memos": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadMemo" }, "xml": { "name": "DownloadMemo", "wrapped": true }, "type": "array" }, "memoDefault": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadMemoDefault" }, "link": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadLinkView" }, "fundFamily": { "$ref": "#/definitions/OAS.DataModel.Portfolio.FundFamilyLocal" }, "registrationType": { "$ref": "#/definitions/OAS.DataModel.Portfolio.RegistrationType" }, "file": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadFile" }, "downloadCustoms": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadCustom" }, "xml": { "name": "DownloadCustom", "wrapped": true }, "type": "array" } }, "xml": { "name": "DownloadName" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadBeneficiary": { "required": [ "id", "downloadFileId", "acctCode", "relation", "type", "percentage", "status", "lineNumber", "beneficiaryName" ], "properties": { "id": { "type": "integer", "format": "int32" }, "downloadFileId": { "type": "integer", "format": "int32" }, "acctCode": { "type": "string", "maxLength": 50, "minLength": 0 }, "relation": { "type": "string", "maxLength": 30, "minLength": 0 }, "type": { "type": "string", "maxLength": 20, "minLength": 0 }, "percentage": { "type": "number", "format": "double" }, "status": { "type": "string", "enum": [ "NotConfirmed", "Confirmed", "Excluded", "AggregationOnly" ] }, "lineNumber": { "type": "integer", "format": "int32" }, "beneficiaryName": { "type": "string", "maxLength": 255, "minLength": 0 }, "beneficiaryStatus": { "type": "string", "maxLength": 1, "minLength": 0 }, "address": { "type": "string", "maxLength": 255, "minLength": 0 }, "dob": { "type": "string", "format": "date-time" }, "ssn": { "type": "string", "maxLength": 12, "minLength": 0 }, "city": { "type": "string", "maxLength": 30, "minLength": 0 }, "state": { "type": "string", "maxLength": 2, "minLength": 0 }, "zip": { "type": "string", "maxLength": 12, "minLength": 0 }, "firmParseCode": { "type": "string", "maxLength": 100, "minLength": 0 }, "memos": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadMemo" }, "xml": { "name": "DownloadMemo", "wrapped": true }, "type": "array" }, "memoDefault": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadMemoDefault" }, "link": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadLinkView" }, "file": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadFile" }, "downloadCustoms": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadCustom" }, "xml": { "name": "DownloadCustom", "wrapped": true }, "type": "array" } }, "xml": { "name": "DownloadBeneficiary" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadBanking": { "required": [ "id", "downloadFileId", "effectiveDate", "acctCode", "status", "lineNumber" ], "properties": { "id": { "type": "integer", "format": "int32" }, "downloadFileId": { "type": "integer", "format": "int32" }, "effectiveDate": { "type": "string", "format": "date-time" }, "acctCode": { "type": "string", "maxLength": 50, "minLength": 0 }, "repNo": { "type": "string", "maxLength": 50, "minLength": 0 }, "accountType": { "type": "string", "maxLength": 50, "minLength": 0 }, "accountTitle": { "type": "string", "maxLength": 50, "minLength": 0 }, "transferType": { "type": "string", "maxLength": 50, "minLength": 0 }, "advMvMny": { "type": "string", "maxLength": 50, "minLength": 0 }, "bankNickName": { "type": "string", "maxLength": 255, "minLength": 0 }, "bankName": { "type": "string", "maxLength": 255, "minLength": 0 }, "bankRoutingNo": { "type": "string", "maxLength": 255, "minLength": 0 }, "bankAccountLastFour": { "type": "string", "maxLength": 255, "minLength": 0 }, "bankAccountType": { "type": "string", "maxLength": 255, "minLength": 0 }, "nameOnAccount": { "type": "string", "maxLength": 255, "minLength": 0 }, "firmParseCode": { "type": "string", "maxLength": 100, "minLength": 0 }, "status": { "type": "string", "enum": [ "NotConfirmed", "Confirmed", "Excluded", "AggregationOnly" ] }, "lineNumber": { "type": "integer", "format": "int32" }, "memos": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadMemo" }, "xml": { "name": "DownloadMemo", "wrapped": true }, "type": "array" }, "memoDefault": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadMemoDefault" }, "link": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadLinkView" }, "file": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadFile" }, "downloadCustoms": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadCustom" }, "xml": { "name": "DownloadCustom", "wrapped": true }, "type": "array" } }, "xml": { "name": "DownloadBanking" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadRMD": { "required": [ "id", "downloadFileId", "effectiveDate", "acctCode", "status", "lineNumber" ], "properties": { "id": { "type": "integer", "format": "int32" }, "downloadFileId": { "type": "integer", "format": "int32" }, "effectiveDate": { "type": "string", "format": "date-time" }, "acctCode": { "type": "string", "maxLength": 50, "minLength": 0 }, "repNo": { "type": "string", "maxLength": 50, "minLength": 0 }, "description": { "type": "string", "maxLength": 255, "minLength": 0 }, "openDate": { "type": "string", "format": "date-time" }, "closeDate": { "type": "string", "format": "date-time" }, "shortName": { "type": "string", "maxLength": 255, "minLength": 0 }, "name1": { "type": "string", "maxLength": 255, "minLength": 0 }, "name2": { "type": "string", "maxLength": 255, "minLength": 0 }, "name3": { "type": "string", "maxLength": 255, "minLength": 0 }, "birthDate": { "type": "string", "format": "date-time" }, "prEOYVal": { "type": "number", "format": "double" }, "cyDistribution": { "type": "number", "format": "double" }, "remaining": { "type": "number", "format": "double" }, "rmd": { "type": "number", "format": "double" }, "lifeExpectancyFactor": { "type": "number", "format": "double" }, "lifeExpectancyFactorType": { "type": "string", "maxLength": 100, "minLength": 0 }, "firmParseCode": { "type": "string", "maxLength": 100, "minLength": 0 }, "status": { "type": "string", "enum": [ "NotConfirmed", "Confirmed", "Excluded", "AggregationOnly" ] }, "lineNumber": { "type": "integer", "format": "int32" }, "memos": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadMemo" }, "xml": { "name": "DownloadMemo", "wrapped": true }, "type": "array" }, "memoDefault": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadMemoDefault" }, "link": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadLinkView" }, "file": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadFile" }, "downloadCustoms": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadCustom" }, "xml": { "name": "DownloadCustom", "wrapped": true }, "type": "array" } }, "xml": { "name": "DownloadRMD" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadSystematic": { "required": [ "id", "downloadFileId", "effectiveDate", "systematicID", "repNo", "acctCode", "openDate", "name1", "frequency", "systematicStatus", "amount", "periodicType", "type", "nextDate", "lineNumber", "status" ], "properties": { "id": { "type": "integer", "format": "int32" }, "downloadFileId": { "type": "integer", "format": "int32" }, "effectiveDate": { "type": "string", "format": "date-time" }, "systematicID": { "type": "string" }, "repNo": { "type": "string" }, "acctCode": { "type": "string", "maxLength": 50, "minLength": 0 }, "openDate": { "type": "string", "format": "date-time" }, "closeDate": { "type": "string", "format": "date-time" }, "name1": { "type": "string", "maxLength": 255, "minLength": 0 }, "name2": { "type": "string", "maxLength": 255, "minLength": 0 }, "name3": { "type": "string", "maxLength": 255, "minLength": 0 }, "frequency": { "type": "string", "maxLength": 20, "minLength": 0 }, "systematicStatus": { "type": "string", "maxLength": 50, "minLength": 0 }, "stateWithholding": { "type": "number", "format": "double" }, "federalWithholding": { "type": "number", "format": "double" }, "amount": { "type": "number", "format": "double" }, "periodicType": { "type": "string", "maxLength": 50, "minLength": 0 }, "type": { "type": "string", "maxLength": 10, "minLength": 0 }, "nextDate": { "type": "string", "format": "date-time" }, "firmParseCode": { "type": "string", "maxLength": 100, "minLength": 0 }, "lineNumber": { "type": "integer", "format": "int32" }, "status": { "type": "string", "enum": [ "NotConfirmed", "Confirmed", "Excluded", "AggregationOnly" ] }, "memos": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadMemo" }, "xml": { "name": "DownloadMemo", "wrapped": true }, "type": "array" }, "memoDefault": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadMemoDefault" }, "link": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadLinkView" }, "file": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadFile" }, "downloadCustoms": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadCustom" }, "xml": { "name": "DownloadCustom", "wrapped": true }, "type": "array" } }, "xml": { "name": "DownloadSystematic" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadTransaction": { "required": [ "id", "downloadFileId", "accountNumber", "effectiveDate", "noUnits", "price", "status", "lineNumber", "netTransactionAmount" ], "properties": { "id": { "type": "integer", "format": "int32" }, "downloadFileId": { "type": "integer", "format": "int32" }, "transTypeId": { "type": "integer", "format": "int32" }, "transactionSubTypeId": { "type": "integer", "format": "int32" }, "cusip": { "type": "string", "maxLength": 50, "minLength": 0 }, "ticker": { "type": "string", "maxLength": 50, "minLength": 0 }, "accountNumber": { "type": "string", "maxLength": 50, "minLength": 0 }, "effectiveDate": { "type": "string", "format": "date-time" }, "fileTranCode": { "type": "string", "maxLength": 50, "minLength": 0 }, "fileTransactionSubType": { "type": "string", "maxLength": 50, "minLength": 0 }, "noUnits": { "type": "number", "format": "double" }, "price": { "type": "number", "format": "double" }, "representativeNumber": { "type": "string", "maxLength": 20, "minLength": 0 }, "ssn": { "type": "string", "maxLength": 15, "minLength": 0 }, "status": { "type": "string", "enum": [ "NotConfirmed", "Confirmed", "Excluded", "AggregationOnly" ] }, "settleDate": { "type": "string", "format": "date-time" }, "lineNumber": { "type": "integer", "format": "int32" }, "netTransactionAmount": { "type": "number", "format": "double" }, "grossTransactionAmount": { "type": "number", "format": "double" }, "note": { "type": "string", "maxLength": 3000, "minLength": 0 }, "secondaryAccountNumber": { "type": "string", "maxLength": 50, "minLength": 0 }, "tradeRefNum": { "type": "string", "maxLength": 40, "minLength": 0 }, "downloadTransactionOriginalId": { "type": "integer", "format": "int32" }, "divExDate": { "type": "string", "format": "date-time" }, "fundingType": { "type": "string", "maxLength": 150, "minLength": 0 }, "impactsCommitment": { "type": "boolean" }, "impactsCapitalBalance": { "type": "boolean" }, "tranCostBasis": { "type": "number", "format": "double" }, "tranCostDate": { "type": "string", "format": "date-time" }, "alternativeEquityFundingTypeId": { "type": "integer", "format": "int32" }, "firmParseCode": { "type": "string", "maxLength": 100, "minLength": 0 }, "memos": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadMemo" }, "xml": { "name": "DownloadMemo", "wrapped": true }, "type": "array" }, "memoDefault": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadMemoDefault" }, "link": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadLinkView" }, "downloadSymbol": { "$ref": "#/definitions/OAS.DataModel.Portfolio.DownloadSymbolBySymbolLocal" }, "transactionType": { "$ref": "#/definitions/OAS.DataModel.Trading.TransactionType" }, "transactionSubType": { "$ref": "#/definitions/OAS.DataModel.Trading.TransactionSubType" }, "file": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadFile" }, "downloadCustoms": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadCustom" }, "xml": { "name": "DownloadCustom", "wrapped": true }, "type": "array" }, "tranSleeveAllocation": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadTranSleeveAllocation" } }, "xml": { "name": "DownloadTransaction" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadCostBasis": { "required": [ "id", "downloadFileId", "cusip", "accountNumber", "effectiveDate", "status", "lineNumber" ], "properties": { "id": { "type": "integer", "format": "int32" }, "downloadFileId": { "type": "integer", "format": "int32" }, "cusip": { "type": "string", "maxLength": 50, "minLength": 0 }, "accountNumber": { "type": "string", "maxLength": 50, "minLength": 0 }, "effectiveDate": { "type": "string", "format": "date-time" }, "acquiredDate": { "type": "string", "format": "date-time" }, "sellDate": { "type": "string", "format": "date-time" }, "holdPeriodDate": { "type": "string", "format": "date-time" }, "costPerShare": { "type": "number", "format": "double" }, "costAmount": { "type": "number", "format": "double" }, "originalCostPerShare": { "type": "number", "format": "double" }, "originalCostAmount": { "type": "number", "format": "double" }, "amortizationAmount": { "type": "number", "format": "double" }, "noUnits": { "type": "number", "format": "double" }, "method": { "type": "string", "maxLength": 50, "minLength": 0 }, "costBasisMethod": { "type": "integer", "format": "int32" }, "custodianRecordId": { "type": "string", "maxLength": 100, "minLength": 0 }, "isRealized": { "type": "boolean" }, "proceedAmount": { "type": "number", "format": "double" }, "status": { "type": "string", "enum": [ "NotConfirmed", "Confirmed", "Excluded", "AggregationOnly" ] }, "lineNumber": { "type": "integer", "format": "int32" }, "transactionCode": { "type": "string", "maxLength": 10, "minLength": 0 }, "washSaleImpacted": { "type": "boolean" }, "amortizedCostPerShare": { "type": "number", "format": "double" }, "originalFace": { "type": "number", "format": "double" }, "isFullyKnown": { "type": "boolean" }, "yieldToMaturity": { "type": "number", "format": "double" }, "accruedInterest": { "type": "number", "format": "double" }, "underlyingSymbol": { "type": "string", "maxLength": 50, "minLength": 0 }, "isUseWashSale": { "type": "boolean" }, "totalTransactionUnits": { "type": "number", "format": "double" }, "totalAssetUnits": { "type": "number", "format": "double" }, "totalFileUnits": { "type": "number", "format": "double" }, "isWashSale": { "type": "boolean" }, "isLongTerm": { "type": "boolean" }, "isInherited": { "type": "boolean" }, "isUnknown": { "type": "boolean" }, "isVarious": { "type": "boolean" }, "longShortPosition": { "type": "number", "format": "double" }, "alternativeAmortizationAmount": { "type": "number", "format": "double" }, "firmParseCode": { "type": "string", "maxLength": 100, "minLength": 0 }, "isDeltaDelete": { "type": "boolean" }, "memos": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadMemo" }, "xml": { "name": "DownloadMemo", "wrapped": true }, "type": "array" }, "memoDefault": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadMemoDefault" }, "link": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadLinkView" }, "file": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadFile" }, "downloadCustoms": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadCustom" }, "xml": { "name": "DownloadCustom", "wrapped": true }, "type": "array" } }, "xml": { "name": "DownloadCostBasis" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadPrice": { "required": [ "id", "downloadFileId", "price", "effectiveDate", "status" ], "properties": { "id": { "type": "integer", "format": "int32" }, "downloadFileId": { "type": "integer", "format": "int32" }, "cusip": { "type": "string", "maxLength": 50, "minLength": 0 }, "ticker": { "type": "string", "maxLength": 50, "minLength": 0 }, "price": { "type": "number", "format": "double" }, "effectiveDate": { "type": "string", "format": "date-time" }, "productName": { "type": "string", "maxLength": 150, "minLength": 0 }, "status": { "type": "string", "enum": [ "NotConfirmed", "Confirmed", "Excluded", "AggregationOnly" ] }, "lineNumber": { "type": "integer", "format": "int32" }, "systemPrice": { "type": "number", "format": "double" }, "factor": { "type": "number", "format": "double" }, "systemPriceCreatedBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "memos": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadMemo" }, "xml": { "name": "DownloadMemo", "wrapped": true }, "type": "array" }, "memoDefault": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadMemoDefault" }, "link": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadLinkView" }, "file": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadFile" }, "downloadCustoms": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadCustom" }, "xml": { "name": "DownloadCustom", "wrapped": true }, "type": "array" } }, "xml": { "name": "DownloadPrice" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadDividend": { "required": [ "id", "downloadFileId", "lineNumber", "status" ], "properties": { "id": { "type": "integer", "format": "int32" }, "downloadFileId": { "type": "integer", "format": "int32" }, "fileDividendType": { "type": "string", "maxLength": 50, "minLength": 0 }, "dividendTypeId": { "type": "integer", "format": "int32" }, "payDate": { "type": "string", "format": "date-time" }, "effectiveDate": { "type": "string", "format": "date-time" }, "oldSymbol": { "type": "string", "maxLength": 50, "minLength": 0 }, "newSymbol": { "type": "string", "maxLength": 50, "minLength": 0 }, "oldName": { "type": "string", "maxLength": 150, "minLength": 0 }, "newName": { "type": "string", "maxLength": 150, "minLength": 0 }, "grossDividendRate": { "type": "number", "format": "double" }, "shortTermRate": { "type": "number", "format": "double" }, "longTermRate": { "type": "number", "format": "double" }, "splitFactor": { "type": "number", "format": "double" }, "shareFactor": { "type": "number", "format": "double" }, "costFactor": { "type": "number", "format": "double" }, "cashInLieuPrice": { "type": "number", "format": "double" }, "cash": { "type": "number", "format": "double" }, "note": { "type": "string", "maxLength": 3000, "minLength": 0 }, "isCorrection": { "type": "boolean" }, "lineNumber": { "type": "integer", "format": "int32" }, "status": { "type": "string", "enum": [ "NotConfirmed", "Confirmed", "Excluded", "AggregationOnly" ] }, "netDividendRate": { "type": "number", "format": "double" }, "dividendFeeRate": { "type": "number", "format": "double" }, "specialDividendRate": { "type": "number", "format": "double" }, "approvalStatus": { "type": "string", "maxLength": 1, "minLength": 0 }, "capitalRate": { "type": "number", "format": "double" }, "qualifiedRateDollar": { "type": "number", "format": "double" }, "qualifiedRatePercent": { "type": "number", "format": "double" }, "qualifiedStatus": { "type": "integer", "format": "int32" }, "declarationDate": { "type": "string", "format": "date-time" }, "declarationType": { "type": "integer", "format": "int32" }, "currencyCode": { "type": "string", "maxLength": 3, "minLength": 0 }, "taxStatusCode": { "type": "string", "maxLength": 1, "minLength": 0 }, "taxStatusCodeId": { "type": "integer", "format": "int32" }, "announcementType": { "type": "integer", "format": "int32" }, "frequency": { "type": "string", "maxLength": 3, "minLength": 0 }, "recordDate": { "type": "string", "format": "date-time" }, "indicatedAnnualDividend": { "type": "number", "format": "double" }, "iadFootnote": { "type": "string", "maxLength": 1, "minLength": 0 }, "fileRecordId": { "type": "string", "maxLength": 60, "minLength": 0 }, "supPaymentCode": { "type": "string", "maxLength": 5, "minLength": 0 }, "memos": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadMemo" }, "xml": { "name": "DownloadMemo", "wrapped": true }, "type": "array" }, "memoDefault": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadMemoDefault" }, "link": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadLinkView" }, "dividendType": { "$ref": "#/definitions/OAS.DataModel.Portfolio.DividendType" }, "file": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadFile" } }, "xml": { "name": "DownloadDividend" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadCorporateAction": { "required": [ "id", "downloadFileId", "lineNumber", "status" ], "properties": { "id": { "type": "integer", "format": "int32" }, "downloadFileId": { "type": "integer", "format": "int32" }, "entryDate": { "type": "string", "format": "date-time" }, "remarks": { "type": "string", "maxLength": 50, "minLength": 0 }, "notifyType": { "type": "string", "maxLength": 1, "minLength": 0 }, "notifyTypeUpdate": { "type": "string", "maxLength": 1, "minLength": 0 }, "recordStatus": { "type": "string", "maxLength": 1, "minLength": 0 }, "numberOfOptions": { "type": "integer", "format": "int32" }, "securityType": { "type": "string", "maxLength": 1, "minLength": 0 }, "effectiveDate": { "type": "string", "format": "date-time" }, "cusip": { "type": "string", "maxLength": 50, "minLength": 0 }, "oldCusip": { "type": "string", "maxLength": 50, "minLength": 0 }, "ticker": { "type": "string", "maxLength": 50, "minLength": 0 }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "oldName": { "type": "string", "maxLength": 50, "minLength": 0 }, "expireDate": { "type": "string", "format": "date-time" }, "cash": { "type": "number", "format": "double" }, "cashCode": { "type": "string", "maxLength": 1, "minLength": 0 }, "stateCode": { "type": "string", "maxLength": 2, "minLength": 0 }, "tenderAgent": { "type": "string", "maxLength": 4, "minLength": 0 }, "infoAgent": { "type": "string", "maxLength": 4, "minLength": 0 }, "maturityDate": { "type": "string", "format": "date-time" }, "rate1": { "type": "number", "format": "double" }, "rate2": { "type": "number", "format": "double" }, "rateCode": { "type": "string", "maxLength": 1, "minLength": 0 }, "voluntaryOrMandatory": { "type": "string", "maxLength": 1, "minLength": 0 }, "dtc": { "type": "string", "maxLength": 1, "minLength": 0 }, "prorationRate": { "type": "string", "maxLength": 20, "minLength": 0 }, "prorationDate": { "type": "string", "format": "date-time" }, "note": { "type": "string", "maxLength": 3000, "minLength": 0 }, "lineNumber": { "type": "integer", "format": "int32" }, "status": { "type": "string", "enum": [ "NotConfirmed", "Confirmed", "Excluded", "AggregationOnly" ] }, "textNumber": { "type": "integer", "format": "int32" }, "dealNumber": { "type": "integer", "format": "int32" }, "textNumberUpdate": { "type": "integer", "format": "int32" }, "costBasisFactor": { "type": "number", "format": "double" }, "memos": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadMemo" }, "xml": { "name": "DownloadMemo", "wrapped": true }, "type": "array" }, "memoDefault": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadMemoDefault" }, "link": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadLinkView" }, "file": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadFile" } }, "xml": { "name": "DownloadCorporateAction" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadSecurity": { "required": [ "id", "downloadFileId", "effectiveDate", "status" ], "properties": { "id": { "type": "integer", "format": "int32" }, "downloadFileId": { "type": "integer", "format": "int32" }, "cusip": { "type": "string", "maxLength": 50, "minLength": 0 }, "ticker": { "type": "string", "maxLength": 50, "minLength": 0 }, "effectiveDate": { "type": "string", "format": "date-time" }, "productName": { "type": "string", "maxLength": 150, "minLength": 0 }, "fileFundCode": { "type": "string", "maxLength": 20, "minLength": 0 }, "fundFamilyId": { "type": "integer", "format": "int32" }, "fileProductType": { "type": "string", "maxLength": 20, "minLength": 0 }, "productType": { "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, "fileProductSubType": { "type": "string", "maxLength": 20, "minLength": 0 }, "productSubTypeId": { "type": "integer", "format": "int32" }, "fileDayCount": { "type": "string", "maxLength": 5, "minLength": 0 }, "dayCount": { "type": "integer", "format": "int32" }, "issueDate": { "type": "string", "format": "date-time" }, "datedDate": { "type": "string", "format": "date-time" }, "fileInterestFrequency": { "type": "string", "maxLength": 5, "minLength": 0 }, "interestFrequency": { "type": "string", "enum": [ "None", "Weekly", "Monthly", "Quarterly", "SemiAnnually", "Annually", "AtMaturity" ] }, "couponRate": { "type": "number", "format": "double" }, "interestAccrualDate": { "type": "string", "format": "date-time" }, "maturityDate": { "type": "string", "format": "date-time" }, "factor": { "type": "number", "format": "double" }, "factorDate": { "type": "string", "format": "date-time" }, "firstCouponDate": { "type": "string", "format": "date-time" }, "issueState": { "type": "string", "maxLength": 2, "minLength": 0 }, "isFederallyTaxable": { "type": "boolean" }, "isStateTaxable": { "type": "boolean" }, "exchange": { "type": "string", "maxLength": 20, "minLength": 0 }, "isForeign": { "type": "boolean" }, "shareClass": { "type": "string", "maxLength": 10, "minLength": 0 }, "productLineName": { "type": "string", "maxLength": 150, "minLength": 0 }, "productClassification": { "type": "string", "maxLength": 20, "minLength": 0 }, "status": { "type": "string", "enum": [ "NotConfirmed", "Confirmed", "Excluded", "AggregationOnly" ] }, "lineNumber": { "type": "integer", "format": "int32" }, "fundManager": { "type": "string", "maxLength": 255, "minLength": 0 }, "directInvestment": { "type": "boolean" }, "vintageYear": { "type": "integer", "format": "int32" }, "propertyType": { "type": "string", "maxLength": 255, "minLength": 0 }, "region": { "type": "string", "maxLength": 255, "minLength": 0 }, "isK1": { "type": "boolean" }, "managerId": { "type": "integer", "format": "int32" }, "isin": { "type": "string", "maxLength": 50, "minLength": 0 }, "memos": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadMemo" }, "xml": { "name": "DownloadMemo", "wrapped": true }, "type": "array" }, "memoDefault": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadMemoDefault" }, "link": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadLinkView" }, "productSubType": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductSubType" }, "fundFamily": { "$ref": "#/definitions/OAS.DataModel.Portfolio.FundFamilyLocal" }, "file": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadFile" }, "downloadCustoms": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadCustom" }, "xml": { "name": "DownloadCustom", "wrapped": true }, "type": "array" } }, "xml": { "name": "DownloadSecurity" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadGeneric": { "required": [ "id", "downloadFileId", "downloadGenericType", "firmParseCode", "lineNumber" ], "properties": { "id": { "type": "integer", "format": "int32" }, "downloadFileId": { "type": "integer", "format": "int32" }, "downloadGenericType": { "type": "string", "maxLength": 10, "minLength": 0 }, "cusip": { "type": "string", "maxLength": 50, "minLength": 0 }, "ticker": { "type": "string", "maxLength": 50, "minLength": 0 }, "acctCode": { "type": "string", "maxLength": 50, "minLength": 0 }, "effectiveDate": { "type": "string", "format": "date-time" }, "firmParseCode": { "type": "string", "maxLength": 100, "minLength": 0 }, "status": { "type": "integer", "format": "int32" }, "lineNumber": { "type": "integer", "format": "int32" }, "file": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadFile" }, "memos": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadMemo" }, "xml": { "name": "DownloadMemo", "wrapped": true }, "type": "array" }, "memoDefault": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadMemoDefault" }, "link": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadLinkView" } }, "xml": { "name": "DownloadGeneric" }, "type": "object" }, "OAS.DataModel.Portfolio.DownloadConfirmationFile": { "required": [ "id", "isZip", "uniqueID" ], "properties": { "id": { "type": "integer", "format": "int32" }, "openWith": { "type": "string", "maxLength": 200, "minLength": 0 }, "fileName": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "rowVersion": { "type": "string", "format": "byte" }, "blobDesc": { "type": "string", "maxLength": 200, "minLength": 0 }, "blobText": { "type": "string" }, "isZip": { "type": "boolean" }, "fileNETidmId": { "type": "string", "maxLength": 9, "minLength": 0 }, "filePath": { "type": "string", "maxLength": 500, "minLength": 0 }, "eFileLocation": { "type": "string", "enum": [ "Undefined", "Database", "FileServer", "AmazonS3", "HttpGet", "RedtailIms", "Communities" ] }, "rootPath": { "type": "string", "maxLength": 100, "minLength": 0 }, "uniqueID": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "DownloadConfirmationFile" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadMemo": { "required": [ "id", "downloadRecordId", "downloadFileId", "recordType", "memoCode", "isDefault" ], "properties": { "id": { "type": "integer", "format": "int32" }, "downloadRecordId": { "type": "integer", "format": "int32" }, "downloadFileId": { "type": "integer", "format": "int32" }, "recordType": { "type": "string", "enum": [ "Name", "Position", "Transaction", "Price", "Dividend", "Product", "NotImported", "Header", "Security", "CorpAction", "TranDetail", "Generic", "CostBasis", "Beneficiary", "StoredPerformance", "Systematic", "RMD", "Banking" ] }, "memoCode": { "type": "integer", "format": "int32" }, "isDefault": { "type": "boolean" }, "description": { "type": "string", "maxLength": 255, "minLength": 0 } }, "xml": { "name": "DownloadMemo" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadFileExtension": { "required": [ "id", "downloadFileId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "downloadFileId": { "type": "integer", "format": "int32" }, "downloadFile": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadFile" }, "fileJSONCompressed": { "type": "string", "format": "byte" } }, "xml": { "name": "DownloadFileExtension" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadRecordSuggestion": { "required": [ "downloadFileId", "downloadRecordId", "recordType", "suggestion" ], "properties": { "id": { "type": "integer", "format": "int64" }, "downloadFileId": { "type": "integer", "format": "int32" }, "downloadRecordId": { "type": "integer", "format": "int32" }, "recordType": { "type": "string", "enum": [ "Name", "Position", "Transaction", "Price", "Dividend", "Product", "NotImported", "Header", "Security", "CorpAction", "TranDetail", "Generic", "CostBasis", "Beneficiary", "StoredPerformance", "Systematic", "RMD", "Banking" ] }, "createdDate": { "type": "string", "format": "date-time" }, "suggestion": { "type": "string" }, "analystRating": { "type": "string", "enum": [ "NotAccurate", "PartiallyAccurate", "IsAccurate" ] }, "analystFeedback": { "type": "string" }, "issueType": { "type": "string" }, "importId": { "type": "integer", "format": "int32" }, "auditedBy": { "type": "string" }, "import": { "$ref": "#/definitions/OAS.DataModel.Utility.Import" } }, "xml": { "name": "DownloadRecordSuggestion" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadSourceQueueLogMessage": { "required": [ "id", "time", "message" ], "properties": { "id": { "type": "string" }, "time": { "type": "string", "format": "date-time" }, "message": { "type": "string" } }, "xml": { "name": "DownloadSourceQueueLogMessage" }, "type": "object" }, "OAS.DataModel.Billing.ReferralPaymentBatch": { "required": [ "id", "batchName", "dateRangeStart", "dateRangeEnd" ], "properties": { "id": { "type": "integer", "format": "int32" }, "batchName": { "type": "string", "maxLength": 100, "minLength": 0 }, "dateRangeStart": { "type": "string", "format": "date-time" }, "dateRangeEnd": { "type": "string", "format": "date-time" }, "billPeriodStartDate": { "type": "string", "format": "date-time" }, "audit": { "$ref": "#/definitions/OAT.DataModel.ComplexTypes.BasicAuditNotNullNotNull" }, "referralPayments": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.ReferralPayment" }, "xml": { "name": "ReferralPayment", "wrapped": true }, "type": "array" } }, "xml": { "name": "ReferralPaymentBatch" }, "type": "object" }, "OAS.DataModel.Portfolio.ModelAumSummary": { "required": [ "entityId", "createdDate" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "aum": { "type": "number", "format": "double" }, "createdDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "ModelAumSummary" }, "type": "object" }, "OAS.DataModel.Trading.ModelItem": { "required": [ "id", "productId", "modelId", "percBE", "createdDate", "createdBy", "editedDate", "editedBy", "isDeleted" ], "properties": { "id": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "modelId": { "type": "integer", "format": "int32" }, "percBE": { "type": "number", "format": "double" }, "itemTol": { "type": "integer", "format": "int32" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "rowVersion": { "type": "string", "format": "byte" }, "isDeleted": { "type": "boolean" }, "itemTolUpper": { "type": "number", "format": "double" }, "itemTolLower": { "type": "number", "format": "double" }, "oub": { "type": "number", "format": "double" }, "dynamicShares": { "type": "number", "format": "double" }, "product": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductLocal" }, "model": { "$ref": "#/definitions/OAS.DataModel.Trading.Model" } }, "xml": { "name": "ModelItem" }, "type": "object" }, "OAS.DataModel.Trading.ModelFundList": { "required": [ "id", "modelId", "fundList" ], "properties": { "id": { "type": "integer", "format": "int32" }, "modelId": { "type": "integer", "format": "int32" }, "fundList": { "type": "string", "maxLength": 50, "minLength": 0 } }, "xml": { "name": "ModelFundList" }, "type": "object" }, "OAS.DataModel.Trading.ModelRange": { "required": [ "id", "createdDate", "createdBy", "editedDate", "editedBy" ], "properties": { "id": { "type": "integer", "format": "int32" }, "modelId": { "type": "integer", "format": "int32" }, "summary": { "type": "string", "maxLength": 255, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "upperScore": { "type": "integer", "format": "int32" }, "lowerScore": { "type": "integer", "format": "int32" }, "userDefinedFields": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.ModelRangeUserDefinedField" }, "xml": { "name": "ModelRangeUserDefinedField", "wrapped": true }, "type": "array" } }, "xml": { "name": "ModelRange" }, "type": "object" }, "OAS.DataModel.Settings.ModelEntityOption": { "required": [ "entityId", "userDefineDefinitionId", "userDefineDataId", "name", "code", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "ModelEntityOption" }, "type": "object" }, "OAS.DataModel.Integration.Communities.CommunityModel": { "required": [ "modelId", "communityModelId", "strategistId" ], "properties": { "modelId": { "type": "integer", "format": "int32" }, "communityModelId": { "type": "integer", "format": "int64" }, "targetRiskUpper": { "type": "number", "format": "double" }, "targetRiskLower": { "type": "number", "format": "double" }, "style": { "type": "string", "maxLength": 100, "minLength": 0 }, "advisorFee": { "type": "number", "format": "double" }, "weightedAvgNetExpenses": { "type": "number", "format": "double" }, "currentRisk": { "type": "number", "format": "double" }, "minimumAmount": { "type": "number", "format": "double" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "dateRebalanceRequested": { "type": "string", "format": "date-time" }, "lastRebalanceDate": { "type": "string", "format": "date-time" }, "strategistId": { "type": "integer", "format": "int32" }, "modelManagerId": { "type": "integer", "format": "int32" }, "indexBlendId": { "type": "integer", "format": "int32" }, "benchmarkInceptionDate": { "type": "string", "format": "date-time" }, "astroUsage": { "type": "integer", "format": "int32" }, "dateRebalanceExecutionRequested": { "type": "string", "format": "date-time" }, "benchmark": { "type": "string" }, "model": { "$ref": "#/definitions/OAS.DataModel.Trading.Model" }, "strategist": { "$ref": "#/definitions/OAS.DataModel.Integration.Communities.Strategist" }, "modelManager": { "$ref": "#/definitions/OAS.DataModel.Integration.Communities.ModelManager" }, "indexBlend": { "$ref": "#/definitions/OAS.DataModel.Portfolio.IndexBlend" } }, "xml": { "name": "CommunityModel" }, "type": "object" }, "OAS.DataModel.Portfolio.PortfolioGroupSrcRegistration": { "properties": { "portfolioGroupId": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "portfolioGroup": { "$ref": "#/definitions/OAS.DataModel.Portfolio.PortfolioGroup" } }, "xml": { "name": "PortfolioGroupSrcRegistration" }, "type": "object" }, "OAS.DataModel.Portfolio.PortfolioGroupChange": { "required": [ "id", "portfolioGroupId", "effectiveDate", "entity", "action", "createdDate", "monthsExclude" ], "properties": { "id": { "type": "integer", "format": "int32" }, "portfolioGroupId": { "type": "integer", "format": "int32" }, "effectiveDate": { "type": "string", "format": "date-time" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "action": { "type": "string", "enum": [ "Add", "Update", "Delete" ] }, "createdByDisplay": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "monthsExclude": { "type": "integer", "format": "int32" }, "editedByDisplay": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "entityId": { "type": "integer", "format": "int32" }, "entityName": { "type": "string" }, "portfolioGroup": { "$ref": "#/definitions/OAS.DataModel.Portfolio.PortfolioGroup" }, "groupName": { "type": "string" } }, "xml": { "name": "PortfolioGroupChange" }, "type": "object" }, "OAS.DataModel.Reporting.Envision.ReportPortfolioGroupVersionAssignment": { "required": [ "portfolioGroupId", "reportId", "id", "reportVersionId" ], "properties": { "portfolioGroupId": { "type": "integer", "format": "int32" }, "portfolioGroup": { "$ref": "#/definitions/OAS.DataModel.Portfolio.PortfolioGroup" }, "reportId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "reportVersionId": { "type": "integer", "format": "int32" }, "auditedByDisplay": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "ReportPortfolioGroupVersionAssignment" }, "type": "object" }, "OAS.DataModel.Settings.PortfolioGroupEntityOption": { "required": [ "entityId", "userDefineDefinitionId", "userDefineDataId", "name", "code", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "PortfolioGroupEntityOption" }, "type": "object" }, "OAS.DataModel.Portfolio.PortfolioGroupTargetAllocation": { "required": [ "id", "portfolioGroupId", "entity", "entityId", "weight", "createdBy", "createdDate", "editedBy", "editedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "portfolioGroupId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "weight": { "type": "number", "format": "double" }, "minimumRange": { "type": "number", "format": "double" }, "maximumRange": { "type": "number", "format": "double" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedByOverride": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "portfolioGroup": { "$ref": "#/definitions/OAS.DataModel.Portfolio.PortfolioGroup" } }, "xml": { "name": "PortfolioGroupTargetAllocation" }, "type": "object" }, "OAS.DataModel.Settings.PortfolioGroupUserDefinedField": { "required": [ "entityId", "userDefineDefinitionId", "userDefineDataId", "name", "code", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "PortfolioGroupUserDefinedField" }, "type": "object" }, "OAS.DataModel.Integration.BluePay.BluePayPayment": { "required": [ "id", "ccToken", "balanceDue", "billPayMethodId", "status", "createdDate", "createdBy", "editedDate", "editedBy" ], "properties": { "id": { "type": "integer", "format": "int32" }, "ccToken": { "type": "string", "maxLength": 100, "minLength": 0 }, "balanceDue": { "type": "number", "format": "double" }, "billPayMethodId": { "type": "integer", "format": "int32" }, "status": { "type": "string", "enum": [ "NotSent", "Sent", "Paid", "Error", "ValidationRequired", "Rollback" ] }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 255, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 255, "minLength": 0 }, "error": { "type": "string", "maxLength": 250, "minLength": 0 }, "payMethod": { "$ref": "#/definitions/OAS.DataModel.Billing.BillPayMethod" } }, "xml": { "name": "BluePayPayment" }, "type": "object" }, "OAS.DataModel.Billing.BillInstanceClientRelated": { "required": [ "billInstanceClientId", "clientId" ], "properties": { "billInstanceClientId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "billInstanceClient": { "$ref": "#/definitions/OAS.DataModel.Billing.BillInstanceClient" }, "client": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Client" } }, "xml": { "name": "BillInstanceClientRelated" }, "type": "object" }, "OAS.DataModel.Billing.RelatedHouseholdsList": { "required": [ "billInstanceClientId", "billInstanceId" ], "properties": { "billInstanceClientId": { "type": "integer", "format": "int32" }, "billInstanceId": { "type": "integer", "format": "int32" }, "clientList": { "type": "string" }, "billInstanceClient": { "$ref": "#/definitions/OAS.DataModel.Billing.BillInstanceClient" } }, "xml": { "name": "RelatedHouseholdsList" }, "type": "object" }, "OAS.DataModel.Trading.FixBatch": { "required": [ "id", "batchName", "createdBy", "createdDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "batchName": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "FixBatch" }, "type": "object" }, "OAS.DataModel.Trading.FixBlockOrderGainLoss": { "properties": { "id": { "type": "integer", "format": "int32" }, "shortTermGain": { "type": "number", "format": "double" }, "longTermGain": { "type": "number", "format": "double" }, "gainLossMessage": { "type": "string", "maxLength": 56, "minLength": 0 }, "tradesGainLossNotCalcedCount": { "type": "integer", "format": "int32" } }, "xml": { "name": "FixBlockOrderGainLoss" }, "type": "object" }, "OAS.DataModel.Trading.FixBlockOrderLog": { "required": [ "id", "fixBlockOrderId", "logType", "logText", "createdDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "fixBlockOrderId": { "type": "integer", "format": "int32" }, "logType": { "type": "integer", "format": "int32" }, "execID": { "type": "string", "maxLength": 50, "minLength": 0 }, "logText": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "msgType": { "type": "string", "maxLength": 2, "minLength": 0 } }, "xml": { "name": "FixBlockOrderLog" }, "type": "object" }, "OAS.DataModel.Trading.FixBlockOrderFeeBase": { "required": [ "id", "fixBlockOrderId", "miscFeeAmt", "execID" ], "properties": { "id": { "type": "integer", "format": "int32" }, "fixBlockOrderId": { "type": "integer", "format": "int32" }, "miscFeeAmt": { "type": "number", "format": "double" }, "miscFeeCurr": { "type": "string", "maxLength": 3, "minLength": 0 }, "execID": { "type": "string", "maxLength": 50, "minLength": 0 } }, "xml": { "name": "FixBlockOrderFeeBase" }, "type": "object" }, "OAS.DataModel.Trading.FixBlockOrderCommissionBase": { "required": [ "id", "fixBlockOrderId", "commission", "execID" ], "properties": { "id": { "type": "integer", "format": "int32" }, "fixBlockOrderId": { "type": "integer", "format": "int32" }, "commission": { "type": "number", "format": "double" }, "execID": { "type": "string", "maxLength": 50, "minLength": 0 } }, "xml": { "name": "FixBlockOrderCommissionBase" }, "type": "object" }, "OAS.DataModel.Trading.FixBlockOrderExtension": { "required": [ "fixBlockOrderId" ], "properties": { "fixBlockOrderId": { "type": "integer", "format": "int32" }, "totalOrderQuantity": { "type": "number", "format": "double" } }, "xml": { "name": "FixBlockOrderExtension" }, "type": "object" }, "OAS.DataModel.Trading.FixTradeRequestHistory": { "required": [ "id", "tradeRequestFixId", "tradeIt", "productId", "accountId", "handlInst", "side", "ordType", "orderQty", "originalOrderQty", "createdDate", "createdBy", "isDiscretionary", "changeType", "recalcState", "approvalStatus", "sellPriority" ], "properties": { "id": { "type": "integer", "format": "int32" }, "tradeRequestFixId": { "type": "integer", "format": "int32" }, "tradeIt": { "type": "boolean" }, "productId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "assetId": { "type": "integer", "format": "int32" }, "transactionId": { "type": "integer", "format": "int32" }, "fixBlockOrderId": { "type": "integer", "format": "int32" }, "trInstanceId": { "type": "integer", "format": "int32" }, "handlInst": { "type": "string", "maxLength": 1, "minLength": 0 }, "execInst": { "type": "string", "maxLength": 50, "minLength": 0 }, "side": { "type": "string", "maxLength": 1, "minLength": 0 }, "locateReqd": { "type": "boolean" }, "ordType": { "type": "string", "maxLength": 1, "minLength": 0 }, "limitPrice": { "type": "number", "format": "double" }, "stopPrice": { "type": "number", "format": "double" }, "timeInForce": { "type": "string", "maxLength": 1, "minLength": 0 }, "expireTime": { "type": "string", "format": "date-time" }, "warningMessage": { "type": "string", "maxLength": 255, "minLength": 0 }, "orderQty": { "type": "number", "format": "double" }, "originalOrderQty": { "type": "number", "format": "double" }, "orderAmt": { "type": "number", "format": "double" }, "orderPct": { "type": "number", "format": "double" }, "sharesOwned": { "type": "number", "format": "double" }, "mktValue": { "type": "number", "format": "double" }, "navPrice": { "type": "number", "format": "double" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "notes": { "type": "string", "maxLength": 255, "minLength": 0 }, "isDiscretionary": { "type": "boolean" }, "settlmntTyp": { "type": "string", "maxLength": 1, "minLength": 0 }, "futSettDate": { "type": "string", "format": "date-time" }, "changeType": { "type": "string", "maxLength": 1, "minLength": 0 }, "recalcState": { "type": "integer", "format": "int32" }, "approvalStatus": { "type": "integer", "format": "int32" }, "tradeRequestFixExchangeId": { "type": "integer", "format": "int32" }, "solicited": { "type": "boolean" }, "vspDate": { "type": "string", "format": "date-time" }, "vspPrice": { "type": "number", "format": "double" }, "sellPriority": { "type": "integer", "format": "int32" }, "cashValuePostTradeExecution": { "type": "number", "format": "double" }, "tradeRequestInstance": { "$ref": "#/definitions/OAS.DataModel.Trading.TradeRequestInstance" }, "product": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductLocal" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" }, "blockOrder": { "$ref": "#/definitions/OAS.DataModel.Trading.FixBlockOrder" }, "asset": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Asset" } }, "xml": { "name": "FixTradeRequestHistory" }, "type": "object" }, "OAS.DataModel.Billing.BillRepPlatform": { "required": [ "id", "billRepId", "platformId", "editedDate", "editedBy", "createDate", "createdBy" ], "properties": { "id": { "type": "integer", "format": "int32" }, "billRepId": { "type": "integer", "format": "int32" }, "billFeeScheduleId": { "type": "integer", "format": "int32" }, "platformId": { "type": "integer", "format": "int32" }, "billPayoutScheduleId": { "type": "integer", "format": "int32" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "createDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "billMasterPayoutScheduleId": { "type": "integer", "format": "int32" }, "billRepresentative": { "$ref": "#/definitions/OAS.DataModel.Billing.BillRepresentative" }, "platform": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Platform" }, "feeSchedule": { "$ref": "#/definitions/OAS.DataModel.Billing.BillSchedule" } }, "xml": { "name": "BillRepPlatform" }, "type": "object" }, "OAS.DataModel.Portfolio.RepTitle": { "properties": { "id": { "type": "integer", "format": "int32" }, "title": { "type": "string" }, "audit": { "$ref": "#/definitions/OAT.DataModel.ComplexTypes.BasicAuditNotNullNotNull" }, "additionalRepAssignments": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.AdditionalRepAssignment" }, "xml": { "name": "AdditionalRepAssignment", "wrapped": true }, "type": "array" } }, "xml": { "name": "RepTitle" }, "type": "object" }, "OAS.DataModel.Portfolio.BrokerDealerNote": { "required": [ "id", "createdDate", "createdBy", "systemGenerated", "isWebVisible" ], "properties": { "brokerDealerId": { "type": "integer", "format": "int32" }, "brokerDealer": { "$ref": "#/definitions/OAS.DataModel.Portfolio.BrokerDealer" }, "id": { "type": "integer", "format": "int32" }, "text": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "rowVersion": { "type": "string", "format": "byte" }, "category": { "type": "string", "maxLength": 25, "minLength": 0 }, "userOwnerId": { "type": "integer", "format": "int32" }, "systemGenerated": { "type": "boolean" }, "isWebVisible": { "type": "boolean" }, "requestFollowup": { "type": "boolean" } }, "xml": { "name": "BrokerDealerNote" }, "type": "object" }, "OAS.DataModel.Portfolio.BrokerDealerAumSummary": { "required": [ "entityId", "createdDate" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "aum": { "type": "number", "format": "double" }, "createdDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "BrokerDealerAumSummary" }, "type": "object" }, "OAS.DataModel.Portfolio.AdditionalContact": { "required": [ "id", "lastName", "entityName", "entityType" ], "properties": { "id": { "type": "integer", "format": "int32" }, "firstName": { "type": "string", "maxLength": 30, "minLength": 0 }, "lastName": { "type": "string", "maxLength": 255, "minLength": 0 }, "entityName": { "type": "string", "maxLength": 255, "minLength": 0 }, "address": { "$ref": "#/definitions/OAS.DataModel.ComplexTypes.Address" }, "homePhone": { "$ref": "#/definitions/OAS.DataModel.ComplexTypes.FullPhoneNumber" }, "businessPhone": { "$ref": "#/definitions/OAS.DataModel.ComplexTypes.FullPhoneNumber" }, "mobilePhone": { "$ref": "#/definitions/OAS.DataModel.ComplexTypes.PhoneNumber" }, "fax": { "$ref": "#/definitions/OAS.DataModel.ComplexTypes.FullPhoneNumber" }, "otherPhone": { "$ref": "#/definitions/OAS.DataModel.ComplexTypes.FullPhoneNumber" }, "pager": { "$ref": "#/definitions/OAS.DataModel.ComplexTypes.FullPhoneNumber" }, "email": { "type": "string", "maxLength": 200, "minLength": 0 }, "webAddress": { "type": "string", "maxLength": 255, "minLength": 0 }, "salutation": { "type": "string", "maxLength": 50, "minLength": 0 }, "ssN_TaxID": { "type": "string", "maxLength": 15, "minLength": 0 }, "dob": { "type": "string", "maxLength": 20, "minLength": 0 }, "birthDate": { "readOnly": true, "type": "string", "format": "date-time" }, "isSmoker": { "type": "boolean" }, "gender": { "type": "string", "maxLength": 1, "minLength": 0 }, "marital": { "type": "string", "maxLength": 50, "minLength": 0 }, "prefix": { "type": "string", "maxLength": 50, "minLength": 0 }, "suffix": { "type": "string", "maxLength": 50, "minLength": 0 }, "entityType": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "audit": { "$ref": "#/definitions/OAT.DataModel.ComplexTypes.BasicAuditNullNull" }, "parentId": { "type": "integer", "format": "int32" }, "personalDesc": { "type": "string", "maxLength": 50, "minLength": 0 }, "isActive": { "type": "boolean" }, "jobTitle": { "type": "string", "maxLength": 200, "minLength": 0 }, "isBlockedPersonOverride": { "type": "boolean" }, "isUSCitizen": { "type": "boolean" }, "company": { "type": "string", "maxLength": 255, "minLength": 0 }, "twitterUsername": { "type": "string", "maxLength": 50, "minLength": 0 }, "facebookUrl": { "type": "string", "maxLength": 8000, "minLength": 0 }, "blobPhotoId": { "type": "integer", "format": "int32" }, "reportName": { "type": "string", "maxLength": 255, "minLength": 0 } }, "xml": { "name": "AdditionalContact" }, "type": "object" }, "OAS.DataModel.Portfolio.BrokerDealerRevenueShare": { "required": [ "id", "brokerDealerId", "billScheduleId", "startDate", "endDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "brokerDealerId": { "type": "integer", "format": "int32" }, "billScheduleId": { "type": "integer", "format": "int32" }, "payoutRate": { "type": "string", "maxLength": 100, "minLength": 0 }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "BrokerDealerRevenueShare" }, "type": "object" }, "OAS.DataModel.Portfolio.BrokerDealerRevenueShareAccountTypeExclusion": { "required": [ "id", "brokerDealerId", "accountTypeId", "accountType" ], "properties": { "id": { "type": "integer", "format": "int32" }, "brokerDealerId": { "type": "integer", "format": "int32" }, "accountTypeId": { "type": "integer", "format": "int32" }, "accountType": { "type": "string" } }, "xml": { "name": "BrokerDealerRevenueShareAccountTypeExclusion" }, "type": "object" }, "OAS.DataModel.Portfolio.BrokerDealerRevenueShareRepresentativeExclusion": { "required": [ "id", "brokerDealerId", "repId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "brokerDealerId": { "type": "integer", "format": "int32" }, "repId": { "type": "integer", "format": "int32" }, "repName": { "type": "string" } }, "xml": { "name": "BrokerDealerRevenueShareRepresentativeExclusion" }, "type": "object" }, "OAS.DataModel.Portfolio.BrokerDealerRevenueShareBusinessLineExclusion": { "required": [ "id", "brokerDealerId", "businessLineId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "brokerDealerId": { "type": "integer", "format": "int32" }, "businessLineId": { "type": "integer", "format": "int32" }, "businessLine": { "type": "string" } }, "xml": { "name": "BrokerDealerRevenueShareBusinessLineExclusion" }, "type": "object" }, "OAS.DataModel.Portfolio.BrokerDealerImageBlob": { "required": [ "id", "isZip", "uniqueID" ], "properties": { "brokerDealerId": { "type": "integer", "format": "int32" }, "height": { "type": "number", "format": "double" }, "width": { "type": "number", "format": "double" }, "barColor": { "type": "string", "maxLength": 50, "minLength": 0 }, "data": { "type": "string", "format": "byte" }, "id": { "type": "integer", "format": "int32" }, "openWith": { "type": "string", "maxLength": 200, "minLength": 0 }, "fileName": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "rowVersion": { "type": "string", "format": "byte" }, "blobDesc": { "type": "string", "maxLength": 200, "minLength": 0 }, "blobText": { "type": "string" }, "isZip": { "type": "boolean" }, "fileNETidmId": { "type": "string", "maxLength": 9, "minLength": 0 }, "filePath": { "type": "string", "maxLength": 500, "minLength": 0 }, "eFileLocation": { "type": "string", "enum": [ "Undefined", "Database", "FileServer", "AmazonS3", "HttpGet", "RedtailIms", "Communities" ] }, "rootPath": { "type": "string", "maxLength": 100, "minLength": 0 }, "uniqueID": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "BrokerDealerImageBlob" }, "type": "object" }, "OAS.DataModel.Settings.BrokerDealerEntityOption": { "required": [ "entityId", "userDefineDefinitionId", "userDefineDataId", "name", "code", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "BrokerDealerEntityOption" }, "type": "object" }, "OAS.DataModel.Settings.BrokerDealerUserDefinedField": { "required": [ "entityId", "userDefineDefinitionId", "userDefineDataId", "name", "code", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "BrokerDealerUserDefinedField" }, "type": "object" }, "OAS.DataModel.Reporting.Envision.ReportBrokerDealerVersionAssignment": { "required": [ "brokerDealerId", "reportId", "id", "reportVersionId" ], "properties": { "brokerDealerId": { "type": "integer", "format": "int32" }, "brokerDealer": { "$ref": "#/definitions/OAS.DataModel.Portfolio.BrokerDealer" }, "reportId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "reportVersionId": { "type": "integer", "format": "int32" }, "auditedByDisplay": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "ReportBrokerDealerVersionAssignment" }, "type": "object" }, "OAS.DataModel.Portfolio.WholesalerNote": { "required": [ "id", "createdDate", "createdBy", "systemGenerated", "isWebVisible" ], "properties": { "wholesalerId": { "type": "integer", "format": "int32" }, "wholesaler": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Wholesaler" }, "id": { "type": "integer", "format": "int32" }, "text": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "rowVersion": { "type": "string", "format": "byte" }, "category": { "type": "string", "maxLength": 25, "minLength": 0 }, "userOwnerId": { "type": "integer", "format": "int32" }, "systemGenerated": { "type": "boolean" }, "isWebVisible": { "type": "boolean" }, "requestFollowup": { "type": "boolean" } }, "xml": { "name": "WholesalerNote" }, "type": "object" }, "OAS.DataModel.Portfolio.WholesalerAumSummary": { "required": [ "entityId", "createdDate" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "aum": { "type": "number", "format": "double" }, "createdDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "WholesalerAumSummary" }, "type": "object" }, "OAS.DataModel.Settings.WholesalerUserDefinedField": { "required": [ "entityId", "userDefineDefinitionId", "userDefineDataId", "name", "code", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "WholesalerUserDefinedField" }, "type": "object" }, "OAS.DataModel.Portfolio.WholesalerState": { "required": [ "id", "wholesalerId", "stateId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "wholesalerId": { "type": "integer", "format": "int32" }, "stateId": { "type": "integer", "format": "int32" }, "state": { "$ref": "#/definitions/OAS.DataModel.Portfolio.State" } }, "xml": { "name": "WholesalerState" }, "type": "object" }, "OAS.DataModel.Portfolio.Nasd": { "required": [ "id", "number" ], "properties": { "id": { "type": "integer", "format": "int32" }, "number": { "type": "string", "maxLength": 20, "minLength": 0 }, "name": { "type": "string", "maxLength": 40, "minLength": 0 }, "description": { "type": "string", "maxLength": 255, "minLength": 0 }, "timeStamp": { "type": "string", "format": "byte" } }, "xml": { "name": "Nasd" }, "type": "object" }, "OAS.DataModel.Portfolio.Manager": { "required": [ "id", "name", "auditedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "maxLength": 255, "minLength": 0 }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "Manager" }, "type": "object" }, "OAS.DataModel.Integrations.AppLinkLocal": { "required": [ "id", "appCode", "credentialLevel" ], "properties": { "id": { "type": "integer", "format": "int32" }, "appCode": { "type": "string", "maxLength": 30, "minLength": 0 }, "appDescription": { "type": "string", "maxLength": 100, "minLength": 0 }, "registrationLink": { "type": "string", "maxLength": 255, "minLength": 0 }, "loginLink": { "type": "string", "maxLength": 255, "minLength": 0 }, "loginCredentials": { "type": "string" }, "publicRSAKeyValueXml": { "type": "string", "maxLength": 500, "minLength": 0 }, "partnerAppId": { "type": "integer", "format": "int32" }, "credentialLevel": { "type": "integer", "format": "int32" } }, "xml": { "name": "AppLinkLocal" }, "type": "object" }, "OAS.DataModel.Trading.SleeveStrategyAggregateDetailHistory": { "required": [ "id", "changeType", "sleeveStrategyAggregateDtlId", "sleeveStrategyAggregateId", "sleeveStrategyId", "targetAllocation", "contributionAllocation", "distributionAllocation", "toleranceUpper", "toleranceLower", "createdDate", "createdBy", "auditedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "changeType": { "type": "string", "maxLength": 1, "minLength": 0 }, "sleeveStrategyAggregateDtlId": { "type": "integer", "format": "int32" }, "sleeveStrategyAggregateId": { "type": "integer", "format": "int32" }, "sleeveStrategyId": { "type": "integer", "format": "int32" }, "targetAllocation": { "type": "number", "format": "double" }, "contributionAllocation": { "type": "number", "format": "double" }, "distributionAllocation": { "type": "number", "format": "double" }, "toleranceUpper": { "type": "number", "format": "double" }, "toleranceLower": { "type": "number", "format": "double" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "strategy": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategy" } }, "xml": { "name": "SleeveStrategyAggregateDetailHistory" }, "type": "object" }, "OAS.DataModel.Trading.SleeveStrategyAggregateSpecialDetail": { "required": [ "id", "sleeveStrategyAggregateId", "sleeveType", "createdDate", "createdBy", "auditedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "sleeveStrategyAggregateId": { "type": "integer", "format": "int32" }, "aggregateModelId": { "type": "integer", "format": "int32" }, "aggregateModel": { "$ref": "#/definitions/OAS.DataModel.Trading.AggregateModel" }, "platformId": { "type": "integer", "format": "int32" }, "platform": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Platform" }, "sleeveType": { "type": "string", "enum": [ "Normal sleeve", "Custodial account", "Contribution sleeve", "Distribution sleeve", "Unmanaged sleeve" ] }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "SleeveStrategyAggregateSpecialDetail" }, "type": "object" }, "OAS.DataModel.Trading.SleeveStrategyAggregateHistory": { "required": [ "id", "changeType", "sleeveStrategyAggregateId", "name", "contributionAllocationMethod", "distributionAllocationMethod", "autoRebalFreq", "autoRebalMonth", "autoRebalDay", "createdDate", "createdBy", "auditedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "changeType": { "type": "string", "maxLength": 1, "minLength": 0 }, "sleeveStrategyAggregateId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "maxLength": 100, "minLength": 0 }, "contributionAllocationMethod": { "type": "integer", "format": "int32" }, "distributionAllocationMethod": { "type": "integer", "format": "int32" }, "autoRebalFreq": { "type": "string", "enum": [ "None", "Monthly", "Quarterly", "Semiannual", "Annual" ] }, "autoRebalMonth": { "type": "integer", "format": "int32" }, "autoRebalDay": { "type": "integer", "format": "int32" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "allowCustomization": { "type": "boolean" }, "useRestrictions": { "type": "boolean" }, "eclipseFirmId": { "type": "integer", "format": "int32" }, "associatedModelAggId": { "type": "integer", "format": "int32" } }, "xml": { "name": "SleeveStrategyAggregateHistory" }, "type": "object" }, "OAS.DataModel.Trading.SleeveStrategyAggregateEntity": { "required": [ "id", "sleeveStrategyAggregateId", "entityId", "entityEnum" ], "properties": { "id": { "type": "integer", "format": "int32" }, "sleeveStrategyAggregateId": { "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" }, "entityEnum": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "auditedByDisplay": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "history": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategyAggregateEntityHistory" }, "xml": { "name": "SleeveStrategyAggregateEntityHistory", "wrapped": true }, "type": "array" } }, "xml": { "name": "SleeveStrategyAggregateEntity" }, "type": "object" }, "OAS.DataModel.Trading.SleeveStrategyAggregateRestriction": { "required": [ "id", "sleeveStrategyAggregateId", "entityId", "entity", "createdBy", "createdDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "sleeveStrategyAggregateId": { "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "exceptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategyAggregateRestrictionException" }, "xml": { "name": "SleeveStrategyAggregateRestrictionException", "wrapped": true }, "type": "array" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "sleeveStrategyAggregate": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategyAggregate" } }, "xml": { "name": "SleeveStrategyAggregateRestriction" }, "type": "object" }, "OAS.DataModel.Settings.SleeveStrategyAggregateEntityOption": { "required": [ "entityId", "userDefineDefinitionId", "userDefineDataId", "name", "code", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "SleeveStrategyAggregateEntityOption" }, "type": "object" }, "OAS.DataModel.Portfolio.BlockedPersonAddress": { "required": [ "id", "ofacId", "addNum" ], "properties": { "id": { "type": "integer", "format": "int32" }, "ofacId": { "type": "integer", "format": "int32" }, "addNum": { "type": "integer", "format": "int32" }, "address": { "type": "string", "maxLength": 125, "minLength": 0 }, "city": { "type": "string", "maxLength": 30, "minLength": 0 }, "country": { "type": "string", "maxLength": 40, "minLength": 0 }, "remarks": { "type": "string", "maxLength": 200, "minLength": 0 }, "createdBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "BlockedPersonAddress" }, "type": "object" }, "OAS.DataModel.Portfolio.BlockedPersonAlt": { "required": [ "id", "ofacId", "altNum" ], "properties": { "id": { "type": "integer", "format": "int32" }, "ofacId": { "type": "integer", "format": "int32" }, "altNum": { "type": "integer", "format": "int32" }, "type": { "type": "string", "maxLength": 8, "minLength": 0 }, "name": { "type": "string", "maxLength": 200, "minLength": 0 }, "remarks": { "type": "string", "maxLength": 200, "minLength": 0 }, "createdBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "BlockedPersonAlt" }, "type": "object" }, "OAS.DataModel.Trading.AggregateModelDetailHistoryAudit": { "required": [ "id", "aggregateModelId", "modelId", "weightPercent" ], "properties": { "id": { "type": "integer", "format": "int32" }, "aggregateModelId": { "type": "integer", "format": "int32" }, "modelId": { "type": "integer", "format": "int32" }, "weightPercent": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "changeType": { "type": "string", "maxLength": 1, "minLength": 0 } }, "xml": { "name": "AggregateModelDetailHistoryAudit" }, "type": "object" }, "OAS.DataModel.Trading.AggregateModelEntityHistory": { "required": [ "id", "aggregateModelId", "entityId", "entityEnum", "editedBy", "editedDate", "changeType" ], "properties": { "id": { "type": "integer", "format": "int32" }, "aggregateModelId": { "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" }, "entityEnum": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "changeType": { "type": "string", "maxLength": 1, "minLength": 0 } }, "xml": { "name": "AggregateModelEntityHistory" }, "type": "object" }, "OAS.DataModel.Portfolio.InvestmentObjectiveHypotheticalMonthlyPerformanceValue": { "required": [ "investmentObjectiveId", "month", "percentile5", "percentile50", "percentile95" ], "properties": { "investmentObjectiveId": { "type": "integer", "format": "int32" }, "month": { "type": "integer", "format": "int32", "maximum": 32767, "minimum": 1 }, "percentile5": { "type": "number", "format": "double", "maximum": 100, "minimum": -100 }, "percentile50": { "type": "number", "format": "double", "maximum": 100, "minimum": -100 }, "percentile95": { "type": "number", "format": "double", "maximum": 100, "minimum": -100 } }, "xml": { "name": "InvestmentObjectiveHypotheticalMonthlyPerformanceValue" }, "type": "object" }, "OAS.DataModel.Trading.AggregateModelProductTypeHistory": { "required": [ "id", "aggregateModelId", "productTypeId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "aggregateModelId": { "type": "integer", "format": "int32" }, "productTypeId": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "changeType": { "type": "string", "maxLength": 1, "minLength": 0 } }, "xml": { "name": "AggregateModelProductTypeHistory" }, "type": "object" }, "OAS.DataModel.Trading.AggregateModelSubstitute": { "required": [ "sleeveStrategyDetailId", "aggregateModelId" ], "properties": { "sleeveStrategyDetailId": { "type": "integer", "format": "int32" }, "aggregateModelId": { "type": "integer", "format": "int32" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "detail": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategyDetail" }, "aggregateModel": { "$ref": "#/definitions/OAS.DataModel.Trading.AggregateModel" } }, "xml": { "name": "AggregateModelSubstitute" }, "type": "object" }, "OAS.DataModel.Trading.SleeveStrategyEntityHistory": { "required": [ "id", "sleeveStrategyEntityId", "entityId", "entityEnum", "editedBy", "editedDate", "changeType" ], "properties": { "id": { "type": "integer", "format": "int32" }, "sleeveStrategyEntityId": { "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" }, "entityEnum": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "changeType": { "type": "string", "maxLength": 1, "minLength": 0 } }, "xml": { "name": "SleeveStrategyEntityHistory" }, "type": "object" }, "OAS.DataModel.Trading.SleeveStrategyRiskTypeAllocation": { "required": [ "allocation", "sleeveStrategyRiskTypeId", "modelAggTypeId" ], "properties": { "allocation": { "type": "number", "format": "double" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "aggregateModelType": { "$ref": "#/definitions/OAS.DataModel.Trading.AggregateModelType" }, "sleeveStrategyRiskTypeId": { "type": "integer", "format": "int32" }, "modelAggTypeId": { "type": "integer", "format": "int32" } }, "xml": { "name": "SleeveStrategyRiskTypeAllocation" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadMemoDefault": { "required": [ "downloadRecordId", "downloadFileId", "severity" ], "properties": { "id": { "type": "integer", "format": "int32" }, "downloadRecordId": { "type": "integer", "format": "int32" }, "downloadFileId": { "type": "integer", "format": "int32" }, "memoCount": { "type": "integer", "format": "int32" }, "description": { "type": "string", "maxLength": 255, "minLength": 0 }, "severity": { "type": "integer", "format": "int32" } }, "xml": { "name": "DownloadMemoDefault" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadLinkView": { "required": [ "downloadFileId", "downloadRecordId" ], "properties": { "downloadFileId": { "type": "integer", "format": "int32" }, "downloadRecordId": { "type": "integer", "format": "int32" }, "representativeId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "assetId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "transactionId": { "type": "integer", "format": "int32" }, "personalId": { "type": "integer", "format": "int32" }, "receivableId": { "type": "integer", "format": "int32" }, "dividendId": { "type": "integer", "format": "int32" }, "product": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductLocal" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" }, "asset": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Asset" } }, "xml": { "name": "DownloadLinkView" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadCustom": { "required": [ "downloadRecordId", "downloadFileId", "customName", "customType" ], "properties": { "downloadRecordId": { "type": "integer", "format": "int32" }, "downloadFileId": { "type": "integer", "format": "int32" }, "customName": { "type": "string", "maxLength": 40, "minLength": 0 }, "customValue": { "type": "string", "maxLength": 255, "minLength": 0 }, "customType": { "type": "integer", "format": "int32" }, "downloadFile": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadFile" } }, "xml": { "name": "DownloadCustom" }, "type": "object" }, "OAS.DataModel.Portfolio.DownloadSymbolBySymbolLocal": { "required": [ "symbol" ], "properties": { "symbol": { "type": "string", "maxLength": 50, "minLength": 0 }, "productId": { "type": "integer", "format": "int32" }, "product": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductLocal" } }, "xml": { "name": "DownloadSymbolBySymbolLocal" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadTranSleeveAllocation": { "required": [ "downloadTranId", "downloadFileId" ], "properties": { "downloadTranId": { "type": "integer", "format": "int32" }, "downloadFileId": { "type": "integer", "format": "int32" }, "allocationCount": { "type": "integer", "format": "int32" }, "transactionCount": { "type": "integer", "format": "int32" }, "isCustodial": { "type": "boolean" } }, "xml": { "name": "DownloadTranSleeveAllocation" }, "type": "object" }, "OAS.DataModel.Portfolio.DividendType": { "required": [ "id", "actionType" ], "properties": { "id": { "type": "integer", "format": "int32" }, "actionType": { "type": "string", "maxLength": 50, "minLength": 0 } }, "xml": { "name": "DividendType" }, "type": "object" }, "OAS.DataModel.Utility.Import": { "required": [ "id", "importTypeId", "importName", "validated", "imported", "reversed", "importStatus" ], "properties": { "id": { "type": "integer", "format": "int32" }, "importTypeId": { "type": "integer", "format": "int32" }, "importName": { "type": "string", "maxLength": 50, "minLength": 0 }, "originalDataJson_c": { "type": "string", "format": "byte" }, "workingDataJson_c": { "type": "string", "format": "byte" }, "preImportDataJson_c": { "type": "string", "format": "byte" }, "preImportData_isNull": { "type": "boolean" }, "postImportDataJson_c": { "type": "string", "format": "byte" }, "postImportData_isNull": { "type": "boolean" }, "startedByDisplay": { "type": "string" }, "startedDate": { "type": "string", "format": "date-time" }, "importedByDisplay": { "type": "string" }, "importedDate": { "type": "string", "format": "date-time" }, "auditInfoDisplay": { "type": "string" }, "validated": { "type": "boolean" }, "imported": { "type": "boolean" }, "reversed": { "type": "boolean" }, "importStatus": { "type": "string" }, "importParentId": { "type": "integer", "format": "int32" }, "rowCountsJson_c": { "type": "string", "format": "byte" }, "source": { "type": "string", "enum": [ "None", "OrionVision", "DataQuery" ] }, "importCommonId": { "type": "integer", "format": "int32" }, "preImportDataJson_cd": { "type": "string", "format": "byte" }, "postImportDataJson_cd": { "type": "string", "format": "byte" } }, "xml": { "name": "Import" }, "type": "object" }, "OAS.DataModel.Settings.ModelRangeUserDefinedField": { "required": [ "entityId", "userDefineDefinitionId", "userDefineDataId", "name", "code", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "ModelRangeUserDefinedField" }, "type": "object" }, "OAS.DataModel.Integration.Communities.Strategist": { "required": [ "id", "name", "abbreviation", "externalId", "strategistType" ], "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "maxLength": 255, "minLength": 0 }, "abbreviation": { "type": "string", "maxLength": 10, "minLength": 0 }, "externalId": { "type": "integer", "format": "int32" }, "strategistType": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "communityModels": { "items": { "$ref": "#/definitions/OAS.DataModel.Integration.Communities.CommunityModel" }, "xml": { "name": "CommunityModel", "wrapped": true }, "type": "array" } }, "xml": { "name": "Strategist" }, "type": "object" }, "OAS.DataModel.Integration.Communities.ModelManager": { "required": [ "id", "strategistId", "name", "abbreviation", "category", "externalId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "strategistId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "maxLength": 255, "minLength": 0 }, "abbreviation": { "type": "string", "maxLength": 10, "minLength": 0 }, "category": { "type": "string", "maxLength": 20, "minLength": 0 }, "externalId": { "type": "integer", "format": "int32" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "strategist": { "$ref": "#/definitions/OAS.DataModel.Integration.Communities.Strategist" }, "communityModels": { "items": { "$ref": "#/definitions/OAS.DataModel.Integration.Communities.CommunityModel" }, "xml": { "name": "CommunityModel", "wrapped": true }, "type": "array" } }, "xml": { "name": "ModelManager" }, "type": "object" }, "OAS.DataModel.Portfolio.IndexBlend": { "required": [ "id", "blendName", "createdBy", "createdDate", "editedBy", "editedDate", "represenativesExcludedByDefault" ], "properties": { "id": { "type": "integer", "format": "int32" }, "blendName": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "represenativesExcludedByDefault": { "type": "boolean" }, "assetClassId": { "type": "integer", "format": "int32" }, "color": { "type": "string", "maxLength": 50, "minLength": 0 }, "dynamicType": { "type": "string", "enum": [ "None", "AssetClass", "AssetCategory", "ManagementStyle", "AggregateModel", "RiskCategory" ] }, "representatives": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Representative" }, "xml": { "name": "Representative", "wrapped": true }, "type": "array" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Settings.IndexBlendEntityOption" }, "xml": { "name": "IndexBlendEntityOption", "wrapped": true }, "type": "array" }, "timeframes": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.IndexBlendTimeframe" }, "xml": { "name": "IndexBlendTimeframe", "wrapped": true }, "type": "array" }, "assetClass": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductClass" }, "dynamicDetails": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.IndexBlendDynamicDetail" }, "xml": { "name": "IndexBlendDynamicDetail", "wrapped": true }, "type": "array" } }, "xml": { "name": "IndexBlend" }, "type": "object" }, "OAS.DataModel.Trading.SleeveStrategyAggregateEntityHistory": { "required": [ "id", "sleeveStrategyAggregateEntityId", "sleeveStrategyAggregateId", "entityId", "entityEnum", "changeType" ], "properties": { "id": { "type": "integer", "format": "int32" }, "sleeveStrategyAggregateEntityId": { "type": "integer", "format": "int32" }, "sleeveStrategyAggregateId": { "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" }, "entityEnum": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "auditedByDisplay": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "changeType": { "type": "string", "maxLength": 1, "minLength": 0 } }, "xml": { "name": "SleeveStrategyAggregateEntityHistory" }, "type": "object" }, "OAS.DataModel.Trading.SleeveStrategyAggregateRestrictionException": { "required": [ "id", "entityId", "entity", "createdBy", "createdDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "restrictionId": { "type": "integer", "format": "int32" }, "restriction": { "$ref": "#/definitions/OAS.DataModel.Trading.SleeveStrategyAggregateRestriction" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "SleeveStrategyAggregateRestrictionException" }, "type": "object" }, "OAS.DataModel.Settings.IndexBlendEntityOption": { "required": [ "entityId", "userDefineDefinitionId", "userDefineDataId", "name", "code", "securityCode" ], "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 40, "minLength": 0 }, "definition": { "$ref": "#/definitions/OAS.DataModel.Settings.UserDefineDefinition" } }, "xml": { "name": "IndexBlendEntityOption" }, "type": "object" }, "OAS.DataModel.Portfolio.IndexBlendTimeframe": { "required": [ "id", "indexBlendId", "asOfDate", "target" ], "properties": { "id": { "type": "integer", "format": "int32" }, "indexBlendId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "target": { "type": "number", "format": "double", "maximum": 100.0, "minimum": 0.0 }, "details": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.IndexBlendDetail" }, "xml": { "name": "IndexBlendDetail", "wrapped": true }, "type": "array" } }, "xml": { "name": "IndexBlendTimeframe" }, "type": "object" }, "OAS.DataModel.Portfolio.IndexBlendDynamicDetail": { "required": [ "indexBlendId", "entityId", "productId" ], "properties": { "indexBlendId": { "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" } }, "xml": { "name": "IndexBlendDynamicDetail" }, "type": "object" }, "OAS.DataModel.Portfolio.IndexBlendDetail": { "required": [ "id", "indexBlendId", "asOfDate", "productId", "blendWeight" ], "properties": { "id": { "type": "integer", "format": "int32" }, "indexBlendTimeframeId": { "type": "integer", "format": "int32" }, "indexBlendId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "productId": { "type": "integer", "format": "int32" }, "blendWeight": { "type": "number", "format": "double" }, "product": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductLocal" }, "indexBlend": { "$ref": "#/definitions/OAS.DataModel.Portfolio.IndexBlend" } }, "xml": { "name": "IndexBlendDetail" }, "type": "object" }, "OAS.WebApi.DTO.Billing.PayableItemDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "payeeName": { "type": "string" }, "billStatus": { "type": "string" }, "payableType": { "type": "string" }, "initialAmt": { "type": "number", "format": "double" }, "balanceDue": { "type": "number", "format": "double" }, "aggValue": { "type": "number", "format": "double" }, "calcDate": { "type": "string", "format": "date-time" }, "percent": { "type": "number", "format": "double" }, "isPoints": { "type": "boolean" }, "editedBy": { "type": "string" }, "createdBy": { "type": "string" } }, "xml": { "name": "PayableItemDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillAccountItemAdjustmentDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "adjustmentTypeId": { "type": "integer", "format": "int32" }, "adjustmentType": { "type": "string" }, "fromBillEntityId": { "type": "integer", "format": "int32" }, "fromBillEntity": { "type": "string" }, "dateOccured": { "type": "string", "format": "date-time" }, "changeAmount": { "type": "number", "format": "double" }, "runningBal": { "type": "number", "format": "double" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "balanceDue": { "type": "number", "format": "double" }, "status": { "type": "string" }, "isLocked": { "type": "boolean" } }, "xml": { "name": "BillAccountItemAdjustmentDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.PayableItemAdjustmentDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "payableItemId": { "type": "integer", "format": "int32" }, "adjustmentType": { "type": "string" }, "adjustmentTypeId": { "type": "integer", "format": "int32" }, "fromBillEntity": { "type": "string" }, "fromBillEntityId": { "type": "integer", "format": "int32" }, "dateOccured": { "type": "string", "format": "date-time" }, "changeAmount": { "type": "number", "format": "double" }, "balanceDue": { "type": "number", "format": "double" }, "status": { "type": "string" }, "createdBy": { "type": "string" }, "editedBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "dtStartDate": { "type": "string", "format": "date-time" }, "dtEndDate": { "type": "string", "format": "date-time" }, "isLocked": { "type": "boolean" } }, "xml": { "name": "PayableItemAdjustmentDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.Charts.ChartDataDto": { "properties": { "name": { "type": "string" }, "chartType": { "description": "Old ChartType. Only used in Bill Summary. Do not use for future charts.", "type": "string" }, "value": { "type": "number", "format": "double" } }, "xml": { "name": "ChartDataDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillInstanceClientDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "billInstanceId": { "type": "integer", "format": "int32" }, "billType": { "type": "string", "enum": [ "Unknown", "Renewal", "NewMoney", "NewAccount", "FinancialPlanningFee", "Performance", "AdvanceCreditDebit" ] }, "clientId": { "type": "integer", "format": "int32" }, "clientName": { "type": "string" }, "status": { "type": "string", "enum": [ "NotGenerated", "Generated", "Errored", "PendingGeneration", "OnHold", "Warning", "FeeFileError", "ReconError" ] }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "initialAmt": { "type": "number", "format": "double" }, "adjAmt": { "type": "number", "format": "double" }, "balanceDue": { "type": "number", "format": "double" }, "marketValue": { "type": "number", "format": "double" }, "feeAmount": { "type": "number", "format": "double" }, "feeFileGenerated": { "type": "boolean" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string" }, "billId": { "type": "integer", "format": "int32" }, "errorMessage": { "type": "string" }, "repName": { "type": "string" }, "repID": { "type": "integer", "format": "int32" }, "repNumber": { "type": "string" }, "relatedHouseholds": { "readOnly": true, "type": "string" }, "isValid": { "type": "boolean" } }, "xml": { "name": "BillInstanceClientDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillGeneratorInfoDto": { "properties": { "dateRange": { "items": { "type": "string" }, "type": "array" }, "runFor": { "type": "string", "enum": [ "AllHouseholds", "FundFamily", "Custodian", "Representative", "BusinessLine", "SingleHHNewBill", "SingleHHRerun", "Accounts", "ImportedHouseholds", "ImportedHHRerun", "FinalBill" ] }, "runForAccounts": { "type": "string", "enum": [ "ActiveAccounts", "InActiveAccounts", "AllAccounts" ] }, "keys": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "asOfDate": { "type": "string", "format": "date-time" }, "billType": { "type": "string", "enum": [ "Unknown", "Renewal", "NewMoney", "NewAccount", "FinancialPlanningFee", "Performance", "AdvanceCreditDebit" ] }, "vHint": { "type": "integer", "format": "int32" }, "pkKey": { "type": "integer", "format": "int32" }, "endDateOverride": { "type": "string", "format": "date-time" }, "acctList": { "type": "string" }, "valueAsOfOverride": { "type": "string", "format": "date-time" }, "isMockBill": { "type": "boolean" }, "nickName": { "type": "string" }, "isFinalBill": { "type": "boolean" }, "includeCashFlow": { "type": "boolean" }, "allowDuplicateMockBills": { "type": "boolean" }, "recurringAdjustmentOverride": { "type": "boolean" }, "isLockdown": { "type": "boolean" } }, "xml": { "name": "BillGeneratorInfoDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillInstanceDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "nickName": { "type": "string" }, "statusValue": { "type": "string", "enum": [ "NotGenerated", "BillDataFilesNeeded", "FeeFileNeeded", "WaitingforPostPayments", "AdvisoryFeeRptsNeeded", "UpdatePayablesNeeded", "Complete", "ForcedComplete", "FeeFileFailed", "FeeFileInProcess", "PendingDeletion", "DeletionInProgress", "ErrorDeletingInstance" ] }, "runForGroup": { "type": "string", "enum": [ "AllHouseholds", "FundFamily", "Custodian", "Representative", "BusinessLine", "SingleHHNewBill", "SingleHHRerun", "Accounts", "ImportedHouseholds", "ImportedHHRerun", "FinalBill" ] }, "runForAccounts": { "type": "string", "enum": [ "ActiveAccounts", "InActiveAccounts", "AllAccounts" ] }, "billType": { "type": "string", "enum": [ "Unknown", "Renewal", "NewMoney", "NewAccount", "FinancialPlanningFee", "Performance", "AdvanceCreditDebit" ] }, "isMockBill": { "type": "boolean" }, "periodStart": { "type": "string", "format": "date-time" }, "periodEnd": { "type": "string", "format": "date-time" }, "householdCount": { "type": "integer", "format": "int32" }, "marketValue": { "type": "number", "format": "double" }, "balanceDue": { "type": "number", "format": "double" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "hasValidBills": { "type": "boolean" }, "allowDuplicateMockBills": { "type": "boolean" }, "endDateOverride": { "type": "string", "format": "date-time" }, "asOfDate": { "type": "string", "format": "date-time" }, "valueDateOverride": { "type": "string", "format": "date-time" }, "isLockdown": { "type": "boolean" }, "instanceType": { "type": "string", "enum": [ "Live", "Forecast" ] } }, "xml": { "name": "BillInstanceDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillRecalcInfoDto": { "properties": { "clientId": { "type": "integer", "format": "int32" }, "billIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "runForAccounts": { "type": "string", "enum": [ "ActiveAccounts", "InActiveAccounts", "AllAccounts" ] }, "billRecalcRepSplitInfo": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillRecalcRepSplitInfoDto" } }, "xml": { "name": "BillRecalcInfoDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillRecalcRepSplitInfoDto": { "properties": { "useDateRange": { "type": "boolean" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "billInstanceIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, "xml": { "name": "BillRecalcRepSplitInfoDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillPayableRecalcInfoDto": { "properties": { "billIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "billInstanceId": { "type": "integer", "format": "int32" }, "hangFireId": { "type": "string" } }, "xml": { "name": "BillPayableRecalcInfoDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillGeneratorCashFlowDto": { "properties": { "totalAccounts": { "type": "integer", "format": "int32" }, "inFlowAmt": { "type": "number", "format": "double" }, "outFlowAmt": { "type": "number", "format": "double" } }, "xml": { "name": "BillGeneratorCashFlowDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillGeneratorBillPeriodDetailDto": { "properties": { "billPeriods": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillPeriodDetailDto" }, "xml": { "name": "BillPeriodDetailDto", "wrapped": true }, "type": "array" }, "cashFlow": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillGeneratorCashFlowDto" }, "xml": { "name": "BillGeneratorCashFlowDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "BillGeneratorBillPeriodDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillPeriodDetailDto": { "properties": { "billFrequency": { "type": "string", "enum": [ "Undefined", "Monthly", "Quarterly", "Triannual", "Semiannually", "Annually", "AtMaturity" ] }, "billingStyle": { "type": "string", "enum": [ "Advance", "Arrears" ] }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "totalAccounts": { "type": "integer", "format": "int32" } }, "xml": { "name": "BillPeriodDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillingCompareDto": { "properties": { "clientId": { "type": "integer", "format": "int32" }, "repName": { "type": "string" }, "repNo": { "type": "string" }, "clientName": { "type": "string" }, "lName": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "regName": { "type": "string" }, "acctCode": { "type": "string" }, "fundName": { "type": "string" }, "isActive": { "type": "boolean" }, "feeSchedule": { "type": "string" }, "feePercent": { "type": "number", "format": "double" }, "payMethod": { "type": "string" }, "valueMethod": { "type": "string" }, "billStyle": { "type": "string" }, "billFrequency": { "type": "string" }, "billId": { "type": "integer", "format": "int32" }, "ofDate": { "type": "string", "format": "date-time" }, "flowValue": { "type": "number", "format": "double" }, "flowBalance": { "type": "number", "format": "double" }, "renewalValue": { "type": "number", "format": "double" }, "renewalAggregate": { "type": "number", "format": "double" }, "renewalInitialAmount": { "type": "number", "format": "double" }, "renewalAdjustments": { "type": "number", "format": "double" }, "renewalBalanceDue": { "type": "number", "format": "double" }, "previousDate": { "type": "string", "format": "date-time" }, "previousFlowValue": { "type": "number", "format": "double" }, "previousFlowBalance": { "type": "number", "format": "double" }, "previousValue": { "type": "number", "format": "double" }, "previousAggregate": { "type": "number", "format": "double" }, "previousInitialAmount": { "type": "number", "format": "double" }, "previousAdjustments": { "type": "number", "format": "double" }, "previousBalanceDue": { "type": "number", "format": "double" }, "differenceValue": { "type": "number", "format": "double" }, "differentInitial": { "type": "number", "format": "double" }, "differentBalanceDue": { "type": "number", "format": "double" }, "percentofValue": { "type": "number", "format": "double" }, "percentofFee": { "type": "number", "format": "double" } }, "xml": { "name": "BillingCompareDto" }, "type": "object" }, "OAS.DataModel.Billing.BillComboForHousehold": { "properties": { "billId": { "type": "integer", "format": "int32" }, "billType": { "type": "string" }, "dateRange": { "type": "string" } }, "xml": { "name": "BillComboForHousehold" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillingCompareEnhancedDto": { "description": "Enhanced billing compare response that includes both Receivables and Payables data", "properties": { "receivables": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillingCompareReceivablesDto" }, "xml": { "name": "BillingCompareReceivablesDto", "wrapped": true }, "type": "array" }, "payables": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillingComparePayablesDto" }, "xml": { "name": "BillingComparePayablesDto", "wrapped": true }, "type": "array" }, "payablesBillEntityColumns": { "items": { "type": "string" }, "type": "array" } }, "xml": { "name": "BillingCompareEnhancedDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillingCompareReceivablesDto": { "properties": { "clientId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "acctCode": { "type": "string" }, "regName": { "type": "string" }, "lName": { "type": "string" }, "fundName": { "type": "string" }, "isActive": { "type": "boolean" }, "instance1MarketValue": { "type": "number", "format": "double" }, "instance2MarketValue": { "type": "number", "format": "double" }, "marketValueDifference": { "type": "number", "format": "double" }, "instance1InitialAmount": { "type": "number", "format": "double" }, "instance2InitialAmount": { "type": "number", "format": "double" }, "initialDifference": { "type": "number", "format": "double" }, "instance1BalanceDue": { "type": "number", "format": "double" }, "instance2BalanceDue": { "type": "number", "format": "double" }, "balanceDueDifference": { "type": "number", "format": "double" }, "instance1FeeSchedule": { "type": "string" }, "instance2FeeSchedule": { "type": "string" }, "instance1AsOfDate": { "type": "string", "format": "date-time" }, "instance2AsOfDate": { "type": "string", "format": "date-time" }, "instance1Aggregate": { "type": "number", "format": "double" }, "instance2Aggregate": { "type": "number", "format": "double" }, "instance1FlowValue": { "type": "number", "format": "double" }, "instance2FlowValue": { "type": "number", "format": "double" }, "instance1FlowBalance": { "type": "number", "format": "double" }, "instance2FlowBalance": { "type": "number", "format": "double" }, "instance1Adjustments": { "type": "number", "format": "double" }, "instance2Adjustments": { "type": "number", "format": "double" }, "percentofFeeChange": { "type": "number", "format": "double" }, "repName": { "type": "string" }, "repNo": { "type": "string" }, "warningMessage": { "type": "string" }, "clientName": { "type": "string" } }, "xml": { "name": "BillingCompareReceivablesDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillingComparePayablesDto": { "properties": { "clientId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "regName": { "type": "string" }, "acctCode": { "type": "string" }, "instance1PayablesTotal": { "type": "number", "format": "double" }, "instance2PayablesTotal": { "type": "number", "format": "double" }, "payablesDifference": { "type": "number", "format": "double" }, "instance1PayoutSchedule": { "type": "string" }, "instance2PayoutSchedule": { "type": "string" }, "instance1BillEntities": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillEntityDetailDto" }, "xml": { "name": "BillEntityDetailDto", "wrapped": true }, "type": "array" }, "instance2BillEntities": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillEntityDetailDto" }, "xml": { "name": "BillEntityDetailDto", "wrapped": true }, "type": "array" }, "warningMessage": { "type": "string" }, "clientName": { "type": "string" }, "lName": { "type": "string" }, "repName": { "type": "string" }, "repNo": { "type": "string" } }, "xml": { "name": "BillingComparePayablesDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillEntityDetailDto": { "properties": { "billEntityName": { "type": "string" }, "payoutRate": { "type": "number", "format": "double" }, "payoutRateName": { "type": "string" }, "initialAmount": { "type": "number", "format": "double" }, "adjustmentAmount": { "type": "number", "format": "double" } }, "xml": { "name": "BillEntityDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.SimpleBillingEntityDto": { "properties": { "description": { "type": "string" }, "isPayableEntity": { "type": "boolean" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "SimpleBillingEntityDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillingSummaryDto": { "properties": { "clientId": { "type": "integer", "format": "int32" }, "representativeName": { "type": "string" }, "representativeNumber": { "type": "string" }, "clientName": { "type": "string" }, "clientLastName": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "accountNumber": { "type": "string" }, "custodianName": { "type": "string" }, "isActive": { "type": "boolean" }, "feeScheduleName": { "type": "string" }, "feeBasisPoints": { "type": "number", "format": "double" }, "basis": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "clientValue": { "type": "number", "format": "double" }, "date": { "type": "string", "format": "date-time" }, "accountValue": { "type": "number", "format": "double" }, "billedValue": { "type": "number", "format": "double" }, "aggregateValue": { "type": "number", "format": "double" }, "lastQuarterBillAmount": { "type": "number", "format": "double" }, "quarterBeforeLastQuarterBillAmount": { "type": "number", "format": "double" }, "billingDifference": { "type": "number", "format": "double" }, "percentDifference": { "type": "number", "format": "double" }, "payMethodDescription": { "type": "string" }, "accountNumberThatDoesPaying": { "type": "string" }, "registrationNameThatDoesPaying": { "type": "string" }, "statementDeliveryMethod": { "type": "string" }, "cashValue": { "type": "number", "format": "double" } }, "xml": { "name": "BillingSummaryDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillPayMethodDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "payInstruction": { "type": "string" }, "payDescription": { "type": "string" }, "invoiceText": { "type": "string" } }, "xml": { "name": "BillPayMethodDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillProductGroupDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "groupName": { "type": "string" }, "billProductGroupDetails": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillProductGroupDetailDto" }, "xml": { "name": "BillProductGroupDetailDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "BillProductGroupDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillProductGroupDetailDto": { "properties": { "billProductGroupId": { "type": "integer", "format": "int32" }, "groupName": { "type": "string" }, "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "ticker": { "type": "string" } }, "xml": { "name": "BillProductGroupDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "instanceId": { "type": "integer", "format": "int32" }, "billTransmitMethodId": { "type": "integer", "format": "int32" }, "invoiceNumber": { "type": "string" }, "clientId": { "type": "integer", "format": "int32" }, "clientName": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "isValid": { "type": "integer", "format": "int32" }, "billType": { "type": "string" }, "initialAmount": { "type": "number", "format": "double" }, "adjustments": { "type": "number", "format": "double" }, "balanceDue": { "type": "number", "format": "double" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "calcDate": { "type": "string", "format": "date-time" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "asOfDate": { "type": "string", "format": "date-time" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" } }, "xml": { "name": "BillDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillPaysForAccountValidateDto": { "properties": { "paidBy": { "type": "integer", "format": "int32" }, "paysTo": { "type": "integer", "format": "int32" }, "billInstance": { "type": "integer", "format": "int32" } }, "xml": { "name": "BillPaysForAccountValidateDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillLogDto": { "properties": { "logText": { "type": "string" } }, "xml": { "name": "BillLogDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillScheduleElementBrokerDealerRestrictionDto": { "properties": { "brokerDealerId": { "type": "integer", "format": "int32" }, "billScheduleId": { "type": "integer", "format": "int32" } }, "xml": { "name": "BillScheduleElementBrokerDealerRestrictionDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillTransmitMethodDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "transmitMethod": { "type": "string" }, "transmitDesc": { "type": "string" }, "statementDelivery": { "type": "boolean" } }, "xml": { "name": "BillTransmitMethodDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.CancellationFeeAdjustmentDefaultDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "qualified": { "type": "boolean" }, "custodian": { "type": "string" }, "adjustmentType": { "type": "string" }, "amount": { "type": "number", "format": "double" }, "responsibleEntity": { "type": "string" }, "disbursementMethod": { "type": "string" }, "isOvernightFee": { "type": "boolean" }, "custodianId": { "type": "integer", "format": "int32" }, "responsibleEntityId": { "type": "integer", "format": "int32" }, "adjustmentTypeId": { "type": "integer", "format": "int32" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" } }, "xml": { "name": "CancellationFeeAdjustmentDefaultDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.CancellationFeeAdjustmentDefaultHistoryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "qualified": { "type": "boolean" }, "custodianName": { "type": "string" }, "adjustmentTypeDisplay": { "type": "string" }, "amount": { "type": "integer", "format": "int32" }, "entityName": { "type": "string" }, "disbursementMethod": { "type": "string" }, "isOvernightFee": { "type": "boolean" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 } }, "xml": { "name": "CancellationFeeAdjustmentDefaultHistoryDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.CashFundingGridDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "registrationId": { "type": "integer", "format": "int32" }, "fundFamily": { "type": "string" }, "productName": { "type": "string" }, "moneyMarketBalance": { "type": "number", "format": "double" }, "balanceDue": { "type": "number", "format": "double" }, "difference": { "type": "number", "format": "double" }, "payMethod": { "type": "string" }, "instanceType": { "type": "string" }, "clientId": { "type": "integer", "format": "int32" }, "clientLastName": { "type": "string" }, "clientName": { "type": "string" }, "accountType": { "type": "string" }, "accountNumber": { "type": "string" }, "managementStyle": { "type": "string" }, "accountIsActive": { "type": "boolean" }, "representativeName": { "type": "string" }, "feeReqSrc": { "type": "string", "enum": [ "Invalid", "HighValueFund", "CashAccount", "ProRata" ] } }, "xml": { "name": "CashFundingGridDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillClientDto": { "properties": { "aum": { "type": "number", "format": "double" }, "id": { "type": "integer", "format": "int32" }, "billClientId": { "type": "integer", "format": "int32" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "type": "string" }, "statusType": { "type": "string", "enum": [ "ReadyToBill", "Hold", "PendingReview" ] }, "billStatusId": { "type": "integer", "format": "int32" }, "relatedClients": { "type": "integer", "format": "int32" }, "recurrentAdjustments": { "type": "integer", "format": "int32" }, "feePayingAccounts": { "type": "integer", "format": "int32" }, "representativeName": { "type": "string" }, "representativeNumber": { "type": "string" }, "feeScheduleId": { "type": "integer", "format": "int32" }, "feeSchedule": { "type": "string" }, "masterPayoutScheduleId": { "type": "integer", "format": "int32" }, "masterPayoutSchedule": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "isActive": { "type": "boolean" }, "additionalColumns": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Interface.AdditionalColumnDefinition" }, "xml": { "name": "AdditionalColumnDefinition", "wrapped": true }, "type": "array" } }, "xml": { "name": "BillClientDto" }, "type": "object" }, "OAS.WebApi.Code.Projection.ProjectionManipulatorOfOAS.WebApi.DTO.Billing.BillClientDto": { "properties": { "type": { "readOnly": true, "type": "string" }, "hasImpact": { "readOnly": true, "type": "boolean" }, "top": { "readOnly": true, "type": "integer", "format": "int32" }, "skip": { "readOnly": true, "type": "integer", "format": "int32" }, "requestedProperties": { "description": "The properties the user specifically asked for", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" }, "requiredProperties": { "description": "The properties that are required to fulfill the requested properties", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProjectionManipulator`1" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillClientGridDto": { "properties": { "aum": { "type": "number", "format": "double" }, "id": { "type": "integer", "format": "int32" }, "billClientId": { "type": "integer", "format": "int32" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "type": "string" }, "statusType": { "type": "string", "enum": [ "ReadyToBill", "Hold", "PendingReview" ] }, "billStatusId": { "type": "integer", "format": "int32" }, "relatedClients": { "type": "integer", "format": "int32" }, "recurrentAdjustments": { "type": "integer", "format": "int32" }, "feePayingAccounts": { "type": "integer", "format": "int32" }, "representativeName": { "type": "string" }, "representativeNumber": { "type": "string" }, "feeScheduleId": { "type": "integer", "format": "int32" }, "feeSchedule": { "type": "string" }, "masterPayoutScheduleId": { "type": "integer", "format": "int32" }, "masterPayoutSchedule": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "isActive": { "type": "boolean" }, "additionalColumns": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Interface.AdditionalColumnDefinition" }, "xml": { "name": "AdditionalColumnDefinition", "wrapped": true }, "type": "array" } }, "xml": { "name": "BillClientGridDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AccountDto": { "properties": { "isActive": { "type": "boolean" }, "custodian": { "type": "string" }, "custodianCode": { "type": "string" }, "managementStyle": { "type": "string" }, "currentValue": { "type": "number", "format": "double" }, "fundFamily": { "type": "string" }, "accountStartValue": { "type": "number", "format": "double" }, "createdDate": { "type": "string", "format": "date-time" }, "isManaged": { "type": "boolean" }, "isSweepAccount": { "type": "boolean" }, "isSleeveAccount": { "type": "boolean" }, "sleeveType": { "type": "string", "enum": [ "Normal sleeve", "Custodial account", "Contribution sleeve", "Distribution sleeve", "Unmanaged sleeve" ] }, "isAdvReportable": { "type": "boolean" }, "is13FReportable": { "type": "boolean" }, "isAuaReportable": { "type": "boolean" }, "advCustodyTypeId": { "type": "integer", "format": "int32" }, "custodialRepCode": { "type": "string" }, "brokerDealer": { "type": "string" }, "importKey": { "type": "string" }, "outsideId": { "type": "string" }, "secondaryAccountNumber": { "type": "string" }, "managementStyleId": { "type": "integer", "format": "int32" }, "fundFamilyId": { "type": "integer", "format": "int32" }, "accountHistoryId": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "shareClass": { "type": "string" }, "shareClassId": { "type": "integer", "format": "int32" }, "subAdvisorId": { "type": "integer", "format": "int32" }, "provider": { "type": "string" }, "plan": { "type": "integer", "format": "int32" }, "planName": { "type": "string" }, "modelGroupNumber": { "type": "string" }, "isOriginalSMCAccount": { "type": "boolean" }, "isTradingBlocked": { "type": "boolean" }, "tradingInstructions": { "type": "string" }, "downloadSource": { "type": "string" }, "businessLine": { "type": "string" }, "createdBy": { "type": "string" }, "accountStartDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "accountStatusId": { "type": "integer", "format": "int32" }, "accountStatus": { "type": "string" }, "accountStatusDescription": { "type": "string" }, "feeScheduleId": { "type": "integer", "format": "int32" }, "feeSchedule": { "type": "string" }, "masterPayoutScheduleId": { "type": "integer", "format": "int32" }, "masterPayoutSchedule": { "type": "string" }, "billFrequency": { "type": "string", "enum": [ "Undefined", "Monthly", "Quarterly", "Triannual", "Semiannually", "Annually", "AtMaturity" ] }, "representative": { "type": "string" }, "representativeNumber": { "type": "string" }, "representativeId": { "type": "integer", "format": "int32" }, "household": { "type": "string" }, "cancelDate": { "type": "string", "format": "date-time" }, "riskBudget": { "type": "integer", "format": "int32" }, "modelAggId": { "type": "integer", "format": "int32" }, "billPayMethod": { "type": "string" }, "acceptsList": { "type": "boolean" }, "billStartDate": { "type": "string", "format": "date-time" }, "missingInfoFromView": { "type": "string" }, "sweepAssetId": { "type": "integer", "format": "int32" }, "includeInAggregate": { "type": "boolean" }, "isDiscretionary": { "type": "boolean" }, "cashBalance": { "type": "number", "format": "double" }, "sleeveStrategy": { "type": "string" }, "isQualified": { "type": "boolean" }, "riskScore": { "type": "number", "format": "double" }, "isWrapManaged": { "type": "boolean" }, "isWrapSponsored": { "type": "boolean" }, "lastName": { "type": "string" }, "nickname": { "type": "string" }, "isPositionOnlyRecon": { "type": "boolean" }, "eclipseFirmId": { "type": "integer", "format": "int32" }, "isUnfunded": { "type": "boolean" }, "isBundled": { "type": "boolean" }, "isExcludedFromFirmAssets": { "type": "boolean" }, "annuityIncomeValue": { "type": "number", "format": "double" }, "currentRiskScore": { "type": "integer", "format": "int32" }, "targetRiskScore": { "type": "integer", "format": "int32" }, "riskScoreAsOfDate": { "type": "string", "format": "date-time" }, "riskScoreProvider": { "description": "The source of {OAS.WebApi.DTO.Portfolio.AccountDto.TargetRiskScore}{OAS.WebApi.DTO.Portfolio.AccountDto.CurrentRiskScore} and {OAS.WebApi.DTO.Portfolio.AccountDto.RiskScoreAsOfDate}", "type": "string" }, "riskTol": { "type": "integer", "format": "int32" }, "tieredFeePriority": { "type": "integer", "format": "int32" }, "additionalColumns": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Interface.AdditionalColumnDefinition" }, "xml": { "name": "AdditionalColumnDefinition", "wrapped": true }, "type": "array" }, "isOps": { "type": "boolean" }, "lastPositionDate": { "type": "string", "format": "date-time" }, "inBalance": { "type": "boolean" }, "lastReconciledEffectiveDate": { "type": "string", "format": "date-time" }, "clientGlobalId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "registrationGlobalId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "number": { "type": "string" }, "modelName": { "type": "string" }, "subAdvisor": { "type": "string" }, "accountType": { "type": "string" }, "isDataSharingEntity": { "type": "boolean" } }, "xml": { "name": "AccountDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.SimpleBillClientStatus": { "properties": { "description": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "SimpleBillClientStatus" }, "type": "object" }, "OAS.WebApi.DTO.Billing.PostAuditDataDto": { "properties": { "billData": { "description": "UNUSED", "type": "boolean" }, "payableSummary": { "description": "UNUSED", "type": "boolean" }, "billingAudit": { "description": "UNUSED", "type": "boolean" }, "startDate": { "description": "Start date of the bill instance date range to filter on", "type": "string", "format": "date-time" }, "endDate": { "description": "End date of the bill instance date range to filter on", "type": "string", "format": "date-time" }, "billInstanceIds": { "description": "A comma-separated list of bill instance IDs to include", "type": "string" }, "entityList": { "description": "List of payable entities to filter the accounts on", "items": { "$ref": "#/definitions/OAS.DataModel.Billing.PostAuditEntity" }, "xml": { "name": "PostAuditEntity", "wrapped": true }, "type": "array" } }, "xml": { "name": "PostAuditDataDto" }, "type": "object" }, "OAS.DataModel.Billing.PostAuditEntity": { "properties": { "entity": { "type": "string", "enum": [ "FundFamily", "Custodian", "BusinessLine" ] }, "ids": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "selected": { "type": "boolean" } }, "xml": { "name": "PostAuditEntity" }, "type": "object" }, "OAS.WebApi.DTO.Billing.PostPaymentsDto": { "properties": { "statusIcon": { "readOnly": true, "type": "string" }, "id": { "type": "integer", "format": "int32" }, "reason": { "type": "string" }, "clientName": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "active": { "type": "boolean" }, "registrationName": { "type": "string" }, "managementStyle": { "type": "string" }, "fundFamilyName": { "type": "string" }, "custodian": { "type": "string" }, "accountNumber": { "type": "string" }, "billDate": { "type": "string", "format": "date-time" }, "billType": { "type": "string" }, "balanceDue": { "type": "number", "format": "double" }, "amountToPost": { "type": "number", "format": "double" }, "registrationCode": { "type": "string" }, "paymentDate": { "type": "string", "format": "date-time" }, "paidByAccountNumber": { "type": "string" }, "payMethod": { "type": "string" }, "billId": { "type": "integer", "format": "int32" }, "billTypeId": { "type": "integer", "format": "int32" }, "receivableId": { "type": "string" }, "feeScheduleName": { "type": "string" }, "lastName": { "type": "string" }, "firstName": { "type": "string" }, "repName": { "type": "string" }, "note": { "type": "string" }, "householdId": { "type": "integer", "format": "int32" }, "billInstanceId": { "type": "integer", "format": "int32" } }, "xml": { "name": "PostPaymentsDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillEntityDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string" }, "isActive": { "type": "boolean" }, "isPayableEntity": { "type": "boolean" }, "isUserAdded": { "type": "boolean" }, "payeeId": { "type": "integer", "format": "int32" }, "isApplyToAstro": { "type": "boolean" }, "excludeFromRefundCalculations": { "description": "When null (JSON omitted), updates do not change the persisted value—used when the OC split for this UI is off.", "type": "boolean" }, "separateOnFeeFile": { "description": "When the Split Fee File by Bill Entity billing feature flag is off, updates do not change the persisted value.", "type": "boolean" }, "collectFromId": { "type": "integer", "format": "int32" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "createDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "billEntityReportAsId": { "type": "integer", "format": "int32" } }, "xml": { "name": "BillEntityDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillEntityAuditDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string" }, "isPayableEntity": { "type": "boolean" }, "isUserAdded": { "type": "boolean" }, "isApplyToAstro": { "type": "boolean" }, "payeeId": { "type": "integer", "format": "int32" }, "payeeName": { "type": "string" }, "isActive": { "type": "boolean" }, "collectFromId": { "type": "integer", "format": "int32" }, "collectFrom": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "changeType": { "type": "string" } }, "xml": { "name": "BillEntityAuditDto" }, "type": "object" }, "OAS.DataModel.FeatureFlagInputParameter": { "properties": { "featureFlagName": { "type": "string" }, "featureFlagValue": { "type": "string" } }, "xml": { "name": "FeatureFlagInputParameter" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillFeeCollectInstanceDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "BillFeeCollectInstanceDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillFeeCollectDetailDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "billFeeCollectInstanceId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "clientName": { "type": "string" }, "initialAmount": { "type": "number", "format": "double" }, "balanceDue": { "type": "number", "format": "double" }, "status": { "type": "string", "enum": [ "NotSent", "Sent", "Paid", "Error", "ValidationRequired", "Rollback" ] }, "error": { "type": "string" }, "billPayType": { "type": "string", "enum": [ "FeeFile", "Indirect", "Check", "ACH", "NonManaged", "CreditCard", "Special", "NoFee" ] }, "personalClientName": { "type": "string" }, "custodianCode": { "type": "string" }, "fundName": { "type": "string" } }, "xml": { "name": "BillFeeCollectDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillFeeCollectDetailCountDto": { "properties": { "consolidatedFeeCollectionTotal": { "type": "integer", "format": "int32" }, "consolidatedFeeCollectionSent": { "type": "integer", "format": "int32" }, "consolidatedFeeCollectionNotSent": { "type": "integer", "format": "int32" }, "consolidatedFeeCollectionPaid": { "type": "integer", "format": "int32" }, "consolidatedFeeCollectionErrored": { "type": "integer", "format": "int32" }, "consolidatedFeeCollectionValidation": { "type": "integer", "format": "int32" } }, "xml": { "name": "BillFeeCollectDetailCountDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillFeeCollectDetailPaymentCountDto": { "properties": { "consolidatedFeeFileTotal": { "type": "integer", "format": "int32" }, "consolidatedCreditCardTotal": { "type": "integer", "format": "int32" }, "consolidatedCheckPayTotal": { "type": "integer", "format": "int32" }, "consolidatedACHTotal": { "type": "integer", "format": "int32" }, "consolidateSpecialTotal": { "type": "integer", "format": "int32" } }, "xml": { "name": "BillFeeCollectDetailPaymentCountDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillFeeCollectGeneratorDto": { "properties": { "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "databases": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "custodians": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "fundFamilies": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "isFinancialPlanningFee": { "type": "boolean" } }, "xml": { "name": "BillFeeCollectGeneratorDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.TradeFileDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "tradeFormat": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "fileName": { "type": "string" }, "transmitMethod": { "type": "string", "enum": [ "Empty", "None", "FTP", "DSTHTTP", "Network", "SFTP", "FTPS", "S3" ] }, "status": { "type": "string" }, "processBy": { "type": "string" }, "processDate": { "type": "string", "format": "date-time" }, "uploadTargetId": { "type": "integer", "format": "int32" }, "instanceId": { "type": "integer", "format": "int32" } }, "xml": { "name": "TradeFileDto" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.SchwabSIIUploadFileDto": { "properties": { "sacoAuthToken": { "type": "string" }, "logOnUrl": { "type": "string" }, "masterAccountId": { "type": "string" }, "serviceMessages": { "items": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.SchwabSIIServiceMessageDto" }, "xml": { "name": "SchwabSIIServiceMessageDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "SchwabSIIUploadFileDto" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.SchwabSIIServiceMessageDto": { "properties": { "code": { "type": "string" }, "type": { "type": "string" }, "description": { "type": "string" } }, "xml": { "name": "SchwabSIIServiceMessageDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.FeeTypeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" } }, "xml": { "name": "FeeTypeDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.FinalBillInstanceDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "instanceName": { "type": "string" }, "billThroughDate": { "type": "string", "format": "date-time" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "isCompleted": { "type": "boolean" } }, "xml": { "name": "FinalBillInstanceDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.FinalBillInstanceItemAccountDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "finalBillInstanceItemId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "regId": { "type": "integer", "format": "int32" }, "regName": { "type": "string" }, "custodian": { "type": "string" }, "type": { "type": "string", "enum": [ "ACH", "Wire", "Check" ] }, "feeAmount": { "type": "number", "format": "double" }, "isQualified": { "type": "boolean" }, "auditedBy": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "FinalBillInstanceItemAccountDto" }, "type": "object" }, "OAS.DataModel.Billing.FinalBillInstanceItem": { "required": [ "id", "finalBillInstanceId", "disbursementType", "overnightDelivery" ], "properties": { "id": { "type": "integer", "format": "int32" }, "finalBillInstanceId": { "type": "integer", "format": "int32" }, "finalBillInstance": { "$ref": "#/definitions/OAS.DataModel.Billing.FinalBillInstance" }, "entityId": { "type": "integer", "format": "int32" }, "entityType": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "disbursementType": { "type": "string", "enum": [ "ACH", "Wire", "Check" ] }, "overnightDelivery": { "type": "boolean" }, "finalBillAccounts": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.FinalBillInstanceItemAccount" }, "xml": { "name": "FinalBillInstanceItemAccount", "wrapped": true }, "type": "array" }, "auditedBy": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "FinalBillInstanceItem" }, "type": "object" }, "OAS.DataModel.Billing.FinalBillInstance": { "required": [ "id", "instanceName", "billThroughDate", "isCompleted" ], "properties": { "id": { "type": "integer", "format": "int32" }, "instanceName": { "type": "string" }, "billThroughDate": { "type": "string", "format": "date-time" }, "isCompleted": { "type": "boolean" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "auditedBy": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "billInstanceId": { "type": "integer", "format": "int32" }, "billInstance": { "$ref": "#/definitions/OAS.DataModel.Billing.BillInstance" }, "finalBillInstanceItems": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.FinalBillInstanceItem" }, "xml": { "name": "FinalBillInstanceItem", "wrapped": true }, "type": "array" } }, "xml": { "name": "FinalBillInstance" }, "type": "object" }, "OAS.DataModel.Billing.FinalBillInstanceItemAccount": { "required": [ "id", "finalBillInstanceItemId", "accountId", "accountNumber" ], "properties": { "id": { "type": "integer", "format": "int32" }, "finalBillInstanceItemId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "registrationId": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "custodian": { "type": "string" }, "isQualified": { "type": "boolean" }, "responsibleEntityIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleAccount" }, "finalBillAccountAdjustments": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.FinalBillInstanceItemAccountAdjustment" }, "xml": { "name": "FinalBillInstanceItemAccountAdjustment", "wrapped": true }, "type": "array" }, "auditedBy": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "FinalBillInstanceItemAccount" }, "type": "object" }, "OAS.DataModel.Billing.FinalBillInstanceItemAccountAdjustment": { "required": [ "id", "finalBillInstanceItemAccountId", "adjustmentName", "amount", "isWaived" ], "properties": { "id": { "type": "integer", "format": "int32" }, "finalBillInstanceItemAccountId": { "type": "integer", "format": "int32" }, "billAdjustmentTypeId": { "type": "integer", "format": "int32" }, "billAdjustmentType": { "$ref": "#/definitions/OAS.DataModel.Billing.BillAdjustmentType" }, "cancellationFeeAdjustmentDefaultId": { "type": "integer", "format": "int32" }, "billEntityId": { "type": "integer", "format": "int32" }, "billEntity": { "$ref": "#/definitions/OAS.DataModel.Billing.BillEntity" }, "adjustmentName": { "type": "string" }, "amount": { "type": "number", "format": "double" }, "isWaived": { "type": "boolean" }, "isOvernightFee": { "type": "boolean" }, "isDisbursementMethod": { "type": "boolean" }, "auditedBy": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "FinalBillInstanceItemAccountAdjustment" }, "type": "object" }, "OAS.WebApi.DTO.Billing.FinancialPlanningFeeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "billInstanceId": { "type": "integer", "format": "int32" }, "billType": { "type": "string", "enum": [ "Unknown", "Renewal", "NewMoney", "NewAccount", "FinancialPlanningFee", "Performance", "AdvanceCreditDebit" ] }, "clientId": { "type": "integer", "format": "int32" }, "clientName": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "dateDue": { "readOnly": true, "type": "string", "format": "date-time" }, "paidDate": { "type": "string", "format": "date-time" }, "balanceDue": { "type": "number", "format": "double" }, "initialAmt": { "type": "number", "format": "double" }, "adjustmentAmount": { "type": "number", "format": "double" }, "repId": { "type": "integer", "format": "int32" }, "repName": { "type": "string" }, "repNumber": { "type": "string" }, "status": { "type": "string", "enum": [ "NotSent", "Sent", "Paid", "Error", "ValidationRequired", "Rollback" ] }, "statusIcon": { "readOnly": true, "type": "string" }, "billId": { "type": "integer", "format": "int32" }, "errorMessage": { "type": "string" }, "frequency": { "type": "string", "enum": [ "Undefined", "Monthly", "Quarterly", "Triannual", "Semiannually", "Annually", "AtMaturity" ] } }, "xml": { "name": "FinancialPlanningFeeDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.MockBillInfoDto": { "properties": { "asOfDate": { "type": "string", "format": "date-time" }, "billType": { "type": "string", "enum": [ "Unknown", "Renewal", "NewMoney", "NewAccount", "FinancialPlanningFee", "Performance", "AdvanceCreditDebit" ] }, "vHint": { "type": "integer", "format": "int32" }, "pkKey": { "type": "integer", "format": "int32" }, "endDateOveride": { "type": "string", "format": "date-time" }, "acctList": { "type": "string" }, "valueAsOfOveride": { "type": "string", "format": "date-time" } }, "xml": { "name": "MockBillInfoDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.FeeHierarchyTopLevelDto": { "description": "A top-level view of the entities at each hierarchy level", "properties": { "entity": { "description": "Entity type", "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "level": { "description": "Level within the hierarchy", "type": "string", "enum": [ "BrokerDealer", "RIA", "Representative", "Plan401k", "Platform", "Client", "Registration", "SubAdvisor", "AggregateModel", "Account", "Global" ] }, "memberCount": { "description": "Count of records for the entity and level", "type": "integer", "format": "int32" }, "type": { "description": "Type of fee hierarchy (Regular, Asset, Sleeve, et al.)", "type": "string", "enum": [ "Regular", "AssetLevel", "SleeveLevel" ] } }, "xml": { "name": "FeeHierarchyTopLevelDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.FeeHierarchyVerboseDto": { "properties": { "name": { "description": "Name of the fee hierarchy", "type": "string" }, "entityId": { "description": "Entity ID", "type": "integer", "format": "int32" }, "entity": { "description": "Entity type", "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "custodianId": { "description": "Custodian ID", "type": "integer", "format": "int32" }, "billProductGroupId": { "description": "Bill Product Group ID", "type": "integer", "format": "int32" }, "feeHierarchyDetails": { "description": "List of fee hierarchies for the entity/custodian combination", "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FeeHierarchyDetail" }, "xml": { "name": "FeeHierarchyDetail", "wrapped": true }, "type": "array" } }, "xml": { "name": "FeeHierarchyVerboseDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.FeeHierarchyDetail": { "properties": { "id": { "description": "Fee hierarchy ID", "type": "integer", "format": "int32" }, "billEntityId": { "description": "Bill entity ID", "type": "integer", "format": "int32" }, "billEntityName": { "description": "Bill entity name", "type": "string" }, "billScheduleId": { "description": "Bill schedule ID", "type": "integer", "format": "int32" }, "billEntityCollectFromId": { "description": "Bill entity ID paying the fee / collecting the payout", "type": "integer", "format": "int32" }, "status": { "description": "Whether the fee hierarchy is active", "type": "boolean" }, "type": { "description": "Type of fee hierarchy (Regular, Asset, Sleeve, et al.)", "type": "string" }, "productType": { "description": "Product type", "type": "integer", "format": "int32" }, "methodType": { "description": "Method type", "type": "string", "enum": [ "Additive", "Override" ] }, "sleeveType": { "description": "Sleeve type", "type": "integer", "format": "int32" }, "filterEntity": { "description": "Entity used to filter records for mass updates", "type": "integer", "format": "int32" }, "filterEntityId": { "description": "Entity ID used to filter records for mass updates", "type": "integer", "format": "int32" } }, "xml": { "name": "FeeHierarchyDetail" }, "type": "object" }, "OAS.WebApi.DTO.Billing.FeeHierarchyConsolidationAuditDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "householdId": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "accountName": { "type": "string" }, "fundName": { "type": "string" }, "accountNumber": { "type": "string" }, "level": { "type": "string" }, "type": { "type": "string" }, "accountStatus": { "type": "boolean" }, "billEntity": { "type": "string" }, "payoutRate": { "type": "string" }, "billProductGroupName": { "type": "string" }, "productType": { "type": "string" }, "collectFrom": { "type": "string" }, "feeHierarchyStatus": { "type": "boolean" }, "repName": { "type": "string" }, "repNumber": { "type": "string" } }, "xml": { "name": "FeeHierarchyConsolidationAuditDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillingEntitySearchItemDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "key": { "type": "string" }, "selectedItems": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } }, "xml": { "name": "BillingEntitySearchItemDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.FeeHierarchyConsolidationDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "orgHierarchy": { "items": { "type": "string" }, "readOnly": true, "type": "array" }, "entityId": { "type": "integer", "format": "int32" }, "entityName": { "type": "string" }, "level": { "type": "integer", "format": "int32" }, "status": { "type": "boolean" }, "payoutRateID": { "type": "integer", "format": "int32" }, "productTypeId": { "type": "integer", "format": "int32" }, "billEntity": { "type": "string" }, "payoutRate": { "type": "string" }, "type": { "type": "string" }, "typeId": { "type": "integer", "format": "int32" }, "custodian": { "type": "string" }, "methodType": { "type": "string" }, "productType": { "type": "string" }, "sleeveType": { "type": "string" }, "billEntityDetailId": { "type": "integer", "format": "int32" }, "custodianID": { "type": "integer", "format": "int32" }, "filterEntity": { "type": "integer", "format": "int32" }, "filterEntityId": { "type": "integer", "format": "int32" }, "filterEntityDisplayValue": { "type": "string" }, "billProductGroupId": { "type": "integer", "format": "int32" }, "billProductGroupName": { "type": "string" } }, "xml": { "name": "FeeHierarchyConsolidationDto" }, "type": "object" }, "OAS.DataModel.Billing.FeeHierarchyEstimate": { "properties": { "id": { "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" }, "entityName": { "type": "string" }, "entityEnum": { "type": "integer", "format": "int32" }, "billEntityId": { "type": "integer", "format": "int32" }, "billScheduleId": { "type": "integer", "format": "int32" }, "status": { "type": "boolean" }, "level": { "type": "integer", "format": "int32" }, "productType": { "type": "integer", "format": "int32" } }, "xml": { "name": "FeeHierarchyEstimate" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillHouseholdSummaryDto": { "properties": { "value": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.HouseholdSummaryValueDto" }, "billSchedules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillScheduleSummaryDto" }, "xml": { "name": "BillScheduleSummaryDto", "wrapped": true }, "type": "array" }, "payoutSchedules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillPayoutScheduleSummaryDto" }, "xml": { "name": "BillPayoutScheduleSummaryDto", "wrapped": true }, "type": "array" }, "billFrequencies": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillFrequencySummaryDto" }, "xml": { "name": "BillFrequencySummaryDto", "wrapped": true }, "type": "array" }, "billPayMethods": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillPayMethodSummaryDto" }, "xml": { "name": "BillPayMethodSummaryDto", "wrapped": true }, "type": "array" }, "accountSummaries": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.HouseholdAccountSummaryDto" }, "xml": { "name": "HouseholdAccountSummaryDto", "wrapped": true }, "type": "array" }, "billPaidForAccounts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PaidByAccountSummaryDto" }, "xml": { "name": "PaidByAccountSummaryDto", "wrapped": true }, "type": "array" }, "historicalBills": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillHistoryDto" }, "xml": { "name": "BillHistoryDto", "wrapped": true }, "type": "array" }, "relatedHouseholdSummaries": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.RelatedClientSummaryDto" }, "xml": { "name": "RelatedClientSummaryDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "BillHouseholdSummaryDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.HouseholdSummaryValueDto": { "properties": { "value": { "type": "number", "format": "double" }, "excludedAssetValue": { "type": "number", "format": "double" }, "billableValue": { "readOnly": true, "type": "number", "format": "double" } }, "xml": { "name": "HouseholdSummaryValueDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillScheduleSummaryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "feeSchedule": { "type": "string" }, "clientId": { "type": "integer", "format": "int32" } }, "xml": { "name": "BillScheduleSummaryDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillPayoutScheduleSummaryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "payoutSchedule": { "type": "string" }, "clientId": { "type": "integer", "format": "int32" } }, "xml": { "name": "BillPayoutScheduleSummaryDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillFrequencySummaryDto": { "properties": { "frequency": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" } }, "xml": { "name": "BillFrequencySummaryDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillPayMethodSummaryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "payInstruction": { "type": "string" }, "clientId": { "type": "integer", "format": "int32" } }, "xml": { "name": "BillPayMethodSummaryDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.HouseholdAccountSummaryDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "accountType": { "type": "string" }, "billingStartDate": { "type": "string", "format": "date-time" }, "feeSchedule": { "type": "string" }, "payoutSchedule": { "type": "string" }, "payMethod": { "type": "string" }, "frequency": { "type": "string", "enum": [ "Undefined", "Monthly", "Quarterly", "Triannual", "Semiannually", "Annually", "AtMaturity" ] }, "balanceDue": { "type": "number", "format": "double" }, "creditRemaining": { "type": "number", "format": "double" }, "repId": { "type": "integer", "format": "int32" }, "repName": { "type": "string" }, "paidByAccount": { "readOnly": true, "type": "string" }, "percentPaidByAccount": { "readOnly": true, "type": "string" }, "valuationMethod": { "type": "string", "enum": [ "PeriodEndingValue", "AvgDailyBalance", "AvgMonthlyBalance" ] }, "isActive": { "type": "boolean" } }, "xml": { "name": "HouseholdAccountSummaryDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.PaidByAccountSummaryDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "paidByAccountId": { "type": "integer", "format": "int32" }, "percent": { "type": "number", "format": "double" }, "fundName": { "type": "string" } }, "xml": { "name": "PaidByAccountSummaryDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillHistoryDto": { "properties": { "billId": { "type": "integer", "format": "int32" }, "householdId": { "type": "integer", "format": "int32" }, "billInstanceId": { "type": "integer", "format": "int32" }, "marketValueAtGeneration": { "type": "number", "format": "double" }, "asOfDate": { "type": "string", "format": "date-time" }, "billAmount": { "type": "number", "format": "double" }, "balanceDue": { "type": "number", "format": "double" }, "creditsToBill": { "type": "number", "format": "double" }, "billPeriod": { "readOnly": true, "type": "string" } }, "xml": { "name": "BillHistoryDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.RelatedClientSummaryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "clientName": { "type": "string" }, "currentValue": { "type": "number", "format": "double" }, "excludedValue": { "type": "number", "format": "double" }, "billableValue": { "readOnly": true, "type": "number", "format": "double" } }, "xml": { "name": "RelatedClientSummaryDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.IndirectScriptDto": { "properties": { "receivableId": { "type": "integer", "format": "int32" }, "message": { "type": "string" } }, "xml": { "name": "IndirectScriptDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillingEngineStatusDto": { "description": "Bill-generator execution status for a bill instance (from Billing API Gateway).", "properties": { "billInstanceId": { "type": "integer", "format": "int32" }, "executionName": { "type": "string" }, "status": { "description": "RUNNING, SUCCEEDED, FAILED, TIMED_OUT, or ABORTED.", "type": "string" }, "error": { "type": "string" }, "cause": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "stopDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "BillingEngineStatusDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.CreateBillFeeFilesDto": { "properties": { "billInstances": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "custodianSelectOption": { "type": "string" }, "ffSelectOption": { "type": "string" }, "custodians": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "fundFamilies": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "CreateBillFeeFilesDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.InvoiceDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "clientName": { "type": "string" }, "billType": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "name": { "readOnly": true, "type": "string" } }, "xml": { "name": "InvoiceDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.SimpleInvoiceDto": { "properties": { "isMockBill": { "type": "boolean" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "SimpleInvoiceDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.ManagementFeesNotPostedDto": { "properties": { "transactionID": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "accountID": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "transactionDate": { "type": "string", "format": "date-time" }, "transactionAmount": { "type": "number", "format": "double" }, "transactionDescription": { "type": "string" }, "isActive": { "type": "boolean" }, "outstandingReceivable": { "type": "boolean" }, "transCreatedDate": { "type": "string", "format": "date-time" }, "transCreatedBy": { "type": "string" }, "clientID": { "type": "integer", "format": "int32" } }, "xml": { "name": "ManagementFeesNotPostedDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.MasterPayoutScheduleDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "isPoints": { "type": "boolean" }, "description": { "type": "string" }, "isDefault": { "type": "boolean" }, "editDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "createDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" } }, "xml": { "name": "MasterPayoutScheduleDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.MasterPayoutScheduleFullDto": { "properties": { "details": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.MasterPayoutScheduleDetailDto" }, "xml": { "name": "MasterPayoutScheduleDetailDto", "wrapped": true }, "type": "array" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "isPoints": { "type": "boolean" }, "description": { "type": "string" }, "isDefault": { "type": "boolean" }, "editDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "createDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" } }, "xml": { "name": "MasterPayoutScheduleFullDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.MasterPayoutScheduleDetailDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "billEntityId": { "type": "integer", "format": "int32" }, "billEntityDescription": { "type": "string" }, "billScheduleId": { "type": "integer", "format": "int32" }, "billScheduleName": { "type": "string" }, "isRemainder": { "type": "boolean" }, "createDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" } }, "xml": { "name": "MasterPayoutScheduleDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.SimpleMasterPayoutScheduleDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "SimpleMasterPayoutScheduleDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.MasterPayoutScheduleHistoryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "isPoints": { "type": "boolean" }, "description": { "type": "string" }, "isDefault": { "type": "boolean" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" } }, "xml": { "name": "MasterPayoutScheduleHistoryDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.MasterPayoutScheduleDetailHistoryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "billEntityId": { "type": "integer", "format": "int32" }, "billEntityDescription": { "type": "string" }, "billScheduleId": { "type": "integer", "format": "int32" }, "billScheduleName": { "type": "string" }, "isRemainder": { "type": "boolean" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" } }, "xml": { "name": "MasterPayoutScheduleDetailHistoryDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.PayableSummaryDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "clientName": { "type": "string" }, "accountNumber": { "type": "string" }, "payMethod": { "type": "string" }, "totalMarketValue": { "type": "number", "format": "double" }, "totalInitialAmount": { "type": "number", "format": "double" }, "totalRecievedAdjustments": { "type": "number", "format": "double" }, "totalRecievedBalanceDue": { "type": "number", "format": "double" }, "daysInCycle": { "type": "integer", "format": "int32" }, "riaInitialAmount": { "type": "number", "format": "double" }, "riaAdjustments": { "type": "number", "format": "double" }, "repInitialAmount": { "type": "number", "format": "double" }, "repAdjustments": { "type": "number", "format": "double" }, "clsInitialAmount": { "type": "number", "format": "double" }, "clsAdjustments": { "type": "number", "format": "double" }, "bdInitialAmount": { "type": "number", "format": "double" }, "bdAdjustments": { "type": "number", "format": "double" }, "asiInitialAmount": { "type": "number", "format": "double" }, "asiAdjustments": { "type": "number", "format": "double" }, "rep2InitialAmount": { "type": "number", "format": "double" }, "rep2Adjustments": { "type": "number", "format": "double" }, "rep3InitialAmount": { "type": "number", "format": "double" }, "rep3Adjustments": { "type": "number", "format": "double" }, "subAdvisorInitialAmount": { "type": "number", "format": "double" }, "subAdvisorAdjustments": { "type": "number", "format": "double" }, "secondSubAdvisorInitialAmount": { "type": "number", "format": "double" }, "secondSubAdvisorAdjustments": { "type": "number", "format": "double" }, "thirdPartyInitialAmount": { "type": "number", "format": "double" }, "thirdPartyAdjustments": { "type": "number", "format": "double" }, "custodianInitialAmount": { "type": "number", "format": "double" }, "custodianAdjustments": { "type": "number", "format": "double" }, "managerInitialAmount": { "type": "number", "format": "double" }, "managerAdjustments": { "type": "number", "format": "double" }, "manager2InitialAmount": { "type": "number", "format": "double" }, "manager2Adjustments": { "type": "number", "format": "double" }, "wholesalerInitialAmount": { "type": "number", "format": "double" }, "wholesalerAdjustments": { "type": "number", "format": "double" }, "wholesaler2InitialAmount": { "type": "number", "format": "double" }, "wholesaler2Adjustments": { "type": "number", "format": "double" }, "osjInitialAmount": { "type": "number", "format": "double" }, "osjAdjustments": { "type": "number", "format": "double" }, "mgaInitialAmount": { "type": "number", "format": "double" }, "mgaAdjustments": { "type": "number", "format": "double" }, "representativeId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "outsideId": { "type": "string" }, "representativeName": { "type": "string" }, "registrationName": { "type": "string" }, "masterPayoutSchedule": { "type": "string" }, "representativeLastName": { "type": "string" }, "managementStyle": { "type": "string" }, "subAdvisorName": { "type": "string" }, "registrationLastName": { "type": "string" }, "representativeNumber": { "type": "string" }, "feeSchedule": { "type": "string" }, "planNameDue": { "type": "string" }, "brokerDealer": { "type": "string" }, "wholesalerName": { "type": "string" }, "custodianName": { "type": "string" }, "businessLine": { "type": "string" } }, "xml": { "name": "PayableSummaryDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.SimplePayeeDto": { "properties": { "personalId": { "type": "integer", "format": "int32" }, "personalLastName": { "type": "string" }, "personalFirstName": { "type": "string" }, "oldAutoId": { "type": "integer", "format": "int32" }, "oldPayeeCode": { "type": "string" }, "isActive": { "type": "boolean" }, "isUserAdded": { "type": "boolean" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "SimplePayeeDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.PayeeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "personalId": { "type": "integer", "format": "int32" }, "first": { "type": "string" }, "last": { "type": "string" }, "ssN_TaxID": { "type": "string" }, "oldAutoId": { "type": "integer", "format": "int32" }, "oldPayeeCode": { "type": "string" }, "isActive": { "type": "boolean" }, "isUserAdded": { "type": "boolean" }, "email": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "salutation": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "address3": { "type": "string" }, "zip": { "type": "string" }, "fax": { "type": "string" }, "faxExt": { "type": "string" }, "mobilePhone": { "type": "string" }, "businessPhone": { "type": "string" }, "businessPhoneExt": { "type": "string" }, "otherPhone": { "type": "string" }, "otherPhoneExt": { "type": "string" }, "company": { "type": "string" }, "jobTitle": { "type": "string" }, "webAddress": { "type": "string" } }, "xml": { "name": "PayeeDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.UpdateSsnDto": { "properties": { "ssn": { "type": "string" }, "reason": { "type": "string" } }, "xml": { "name": "UpdateSsnDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.BlobBaseDto": { "properties": { "createdDate": { "type": "string", "format": "date-time" }, "id": { "type": "integer", "format": "int32" }, "openWith": { "type": "string" }, "fileName": { "type": "string" }, "blobDesc": { "type": "string" }, "blobText": { "type": "string" }, "category": { "type": "string" }, "isZip": { "type": "boolean" } }, "xml": { "name": "BlobBaseDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.SimplePayMethodDto": { "properties": { "description": { "type": "string" }, "isVisible": { "type": "boolean" }, "includeInBusinessMetrics": { "type": "boolean" }, "isDownloading": { "type": "boolean" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "SimplePayMethodDto" }, "type": "object" }, "Hangfire.Console.Monitoring.LineDto": { "properties": { "type": { "readOnly": true, "type": "string", "enum": [ "Any", "Text", "ProgressBar" ] }, "timestamp": { "readOnly": true, "type": "string", "format": "date-time" }, "color": { "readOnly": true, "type": "string" } }, "xml": { "name": "LineDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillPayoutDashboardPaymentDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "payeeId": { "type": "integer", "format": "int32" }, "payee": { "type": "string" }, "asOfDate": { "type": "string", "format": "date-time" }, "paymentAmount": { "type": "number", "format": "double" }, "adjustmentAmount": { "type": "number", "format": "double" }, "uncollectedAmount": { "type": "number", "format": "double" }, "totalPaymentAmount": { "readOnly": true, "type": "number", "format": "double" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "note": { "type": "string" }, "toPay": { "type": "boolean" }, "blobId": { "type": "integer", "format": "int32" }, "hangFireId": { "type": "string" } }, "xml": { "name": "BillPayoutDashboardPaymentDto" }, "type": "object" }, "OAS.DataModel.Billing.BillPayoutDashboardPaymentListDto": { "properties": { "payeeId": { "type": "integer", "format": "int32" }, "paymentAmount": { "type": "number", "format": "double" }, "adjustmentAmount": { "type": "number", "format": "double" }, "uncollectedAmount": { "type": "number", "format": "double" }, "payee": { "type": "string" }, "totalPaymentAmount": { "type": "number", "format": "double" }, "toPay": { "type": "boolean" }, "asOfDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "BillPayoutDashboardPaymentListDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.PayoutDashboardDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "isActive": { "type": "boolean" }, "clientName": { "type": "string" }, "repName": { "type": "string" }, "fundName": { "type": "string" }, "calculatedDate": { "type": "string", "format": "date-time" }, "totalFeeAmount": { "type": "number", "format": "double" }, "changeAmount": { "type": "number", "format": "double" }, "payeeName": { "type": "string" }, "billedMarketValue": { "type": "number", "format": "double" }, "feeSchedule": { "type": "string" }, "payoutSchedule": { "type": "string" }, "adjustmentTypeId": { "type": "integer", "format": "int32" }, "adjustmentType": { "type": "string" }, "expenseType": { "type": "string", "enum": [ "None", "Credit", "Expense" ] }, "repStatus": { "type": "string", "enum": [ "ActiveNoIssues", "HoldForCompliance", "ActiveNoNewClients", "InActive", "Pending", "Limited", "Prospect", "Rejected" ] }, "repNumber": { "type": "string" }, "bdName": { "type": "string" }, "notes": { "type": "string" }, "receivableNotes": { "type": "string" }, "paidDate": { "type": "string", "format": "date-time" }, "entity": { "type": "string" }, "billId": { "type": "integer", "format": "int32" }, "payableId": { "type": "integer", "format": "int32" }, "paymentId": { "type": "integer", "format": "int32" }, "dateRange": { "type": "string" }, "clientLastName": { "type": "string" }, "billAccountItemId": { "type": "integer", "format": "int32" }, "billEntityId": { "type": "integer", "format": "int32" } }, "xml": { "name": "PayoutDashboardDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.PayoutDashboardActivityChartDto": { "properties": { "calculatedDate": { "type": "string", "format": "date-time" }, "payoutStatus": { "type": "string", "enum": [ "PendingApproval", "CurrentlyApproved", "CreditAndExpenses", "OutsideAccounts", "Paid" ] }, "amount": { "type": "number", "format": "double" } }, "xml": { "name": "PayoutDashboardActivityChartDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.AdvisoryFeeReportBlobDto": { "properties": { "entityName": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "id": { "type": "integer", "format": "int32" }, "openWith": { "type": "string" }, "fileName": { "type": "string" }, "blobDesc": { "type": "string" }, "blobText": { "type": "string" }, "category": { "type": "string" }, "isZip": { "type": "boolean" } }, "xml": { "name": "AdvisoryFeeReportBlobDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.ManualReportFileUploadDto": { "required": [ "entity", "entityId", "ownerName", "file", "fileExtension" ], "properties": { "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "ownerName": { "type": "string" }, "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" }, "fileExtension": { "type": "string", "pattern": "^(PDF|Excel)$", "enum": [ "PDF", "Excel" ] } }, "xml": { "name": "ManualReportFileUploadDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.FileImportDto": { "properties": { "pkBlob": { "type": "integer", "format": "int32" }, "fkParent": { "type": "integer", "format": "int32" }, "fileName": { "type": "string" }, "blobDesc": { "type": "string" }, "blobText": { "type": "string" }, "emailsSent": { "type": "integer", "format": "int32" }, "invalidEmail": { "type": "integer", "format": "int32" }, "message": { "type": "string" } }, "xml": { "name": "FileImportDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.PostedPaymentDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "billInstanceId": { "type": "integer", "format": "int32" }, "billId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "active": { "type": "boolean" }, "accountNumber": { "type": "string" }, "accountName": { "type": "string" }, "previousBalance": { "type": "number", "format": "double" }, "currentBalance": { "type": "number", "format": "double" }, "changeAmt": { "type": "number", "format": "double" }, "adjustmentType": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "dateOccured": { "type": "string", "format": "date-time" }, "batchNumber": { "type": "string" }, "originalDateOccured": { "type": "string", "format": "date-time" }, "billPaymentId": { "type": "integer", "format": "int32" }, "originalAmount": { "type": "number", "format": "double" } }, "xml": { "name": "PostedPaymentDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.UndoPostedPaymentRequestDto": { "properties": { "billPaymentId": { "type": "integer", "format": "int32" }, "ids": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, "xml": { "name": "UndoPostedPaymentRequestDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.PostedPaymentReportDTO": { "properties": { "batchNumber": { "type": "string" }, "postedDate": { "type": "string", "format": "date-time" }, "accountNumber": { "type": "string" }, "active": { "type": "boolean" }, "paymentCreatedDate": { "type": "string", "format": "date-time" }, "paymentCreatedBy": { "type": "string" }, "amount": { "type": "number", "format": "double" }, "clientName": { "type": "string" } }, "xml": { "name": "PostedPaymentReportDTO" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillPaymentDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "billPayMethod": { "type": "integer", "format": "int32" }, "paymentNumber": { "type": "string" }, "batchNumber": { "type": "string" }, "checkAmt": { "type": "number", "format": "double" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "postedDate": { "type": "string", "format": "date-time" }, "transOrigin": { "type": "string" }, "balance": { "type": "number", "format": "double" }, "oldReceivableID": { "type": "integer", "format": "int32" }, "timestamp": { "type": "string", "format": "byte" } }, "xml": { "name": "BillPaymentDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.PostPaymentBatchDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "batchNumber": { "type": "string" }, "amount": { "type": "number", "format": "double" }, "processStatus": { "type": "string", "enum": [ "Errored", "Queued", "Processing", "Complete" ] }, "completedCount": { "type": "integer", "format": "int32" }, "recordCount": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "batchType": { "type": "string", "enum": [ "PostPayments", "WriteOffs" ] }, "processStatusNote": { "type": "string" } }, "xml": { "name": "PostPaymentBatchDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillingFileUploadDto": { "properties": { "columnName": { "type": "string", "enum": [ "HouseholdId", "AccountId", "AccountNumber" ] }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile", "description": "the imported file" } }, "xml": { "name": "BillingFileUploadDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.PostPaymentsByFileDto": { "properties": { "missingSearchValues": { "type": "string" }, "postPayments": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.PostPaymentsDto" }, "xml": { "name": "PostPaymentsDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "PostPaymentsByFileDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillProductDto": { "properties": { "feeExcluded": { "type": "boolean" }, "includeByDefault": { "type": "boolean" }, "editedDate": { "type": "string", "format": "date-time" }, "editedby": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "feeBillExclusionMode": { "type": "integer", "format": "int32" }, "excludedBillEntityIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "id": { "type": "integer", "format": "int32" } }, "xml": { "name": "BillProductDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.ReceiveableSummaryDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "registrationId": { "type": "integer", "format": "int32" }, "fundFamily": { "type": "string" }, "productName": { "type": "string" }, "moneyMarketBalance": { "type": "number", "format": "double" }, "balanceDue": { "type": "number", "format": "double" }, "difference": { "type": "number", "format": "double" }, "payMethod": { "type": "string" }, "clientId": { "type": "integer", "format": "int32" }, "clientLastName": { "type": "string" }, "clientName": { "type": "string" }, "accountType": { "type": "string" }, "accountNumber": { "type": "string" }, "managementStyle": { "type": "string" }, "accountIsActive": { "type": "boolean" }, "representativeName": { "type": "string" }, "feeReqSrc": { "type": "string", "enum": [ "Invalid", "HighValueFund", "CashAccount", "ProRata" ] }, "instanceType": { "type": "string" } }, "xml": { "name": "ReceiveableSummaryDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.ReferralPaymentDto": { "properties": { "payeeFiratName": { "type": "string" }, "payeeLastName": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "batchName": { "type": "string" }, "custodian": { "type": "string" }, "accountName": { "type": "string" }, "accountNumber": { "type": "string" }, "payeeName": { "type": "string" }, "paymentAmount": { "type": "number", "format": "double" }, "feeAmount": { "type": "number", "format": "double" }, "transactionDate": { "type": "string", "format": "date-time" }, "tierYear": { "type": "integer", "format": "int32" }, "batchDateRangeStart": { "type": "string", "format": "date-time" }, "batchDateRangeEnd": { "type": "string", "format": "date-time" }, "batchId": { "type": "integer", "format": "int32" }, "accountReferralId": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "payeeEmail": { "type": "string" }, "payeePhoneNumber": { "type": "string" }, "batchBillPeriodStart": { "type": "string", "format": "date-time" }, "payeeId": { "type": "integer", "format": "int32" } }, "xml": { "name": "ReferralPaymentDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.ReferralPaymentBatchDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "batchName": { "type": "string" }, "dateRangeStart": { "type": "string", "format": "date-time" }, "dateRangeEnd": { "type": "string", "format": "date-time" }, "billPeriodStartDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "ReferralPaymentBatchDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.ReferralPaymentBatchFullDto": { "properties": { "referralPayments": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.ReferralPaymentFullDto" }, "xml": { "name": "ReferralPaymentFullDto", "wrapped": true }, "type": "array" }, "id": { "type": "integer", "format": "int32" }, "batchName": { "type": "string" }, "dateRangeStart": { "type": "string", "format": "date-time" }, "dateRangeEnd": { "type": "string", "format": "date-time" }, "billPeriodStartDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "ReferralPaymentBatchFullDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.ReferralPaymentFullDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "payeeFiratName": { "type": "string" }, "payeeLastName": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "batchName": { "type": "string" }, "custodian": { "type": "string" }, "accountName": { "type": "string" }, "accountNumber": { "type": "string" }, "payeeName": { "type": "string" }, "paymentAmount": { "type": "number", "format": "double" }, "feeAmount": { "type": "number", "format": "double" }, "transactionDate": { "type": "string", "format": "date-time" }, "tierYear": { "type": "integer", "format": "int32" }, "batchDateRangeStart": { "type": "string", "format": "date-time" }, "batchDateRangeEnd": { "type": "string", "format": "date-time" }, "batchId": { "type": "integer", "format": "int32" }, "accountReferralId": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "payeeEmail": { "type": "string" }, "payeePhoneNumber": { "type": "string" }, "batchBillPeriodStart": { "type": "string", "format": "date-time" }, "payeeId": { "type": "integer", "format": "int32" } }, "xml": { "name": "ReferralPaymentFullDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.ReferralPayoutDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "payoutName": { "type": "string" }, "payoutType": { "type": "string", "enum": [ "Perpetual", "Tiers", "OneTime" ] }, "amountType": { "type": "string", "enum": [ "Percent", "Dollars", "Shares" ] }, "payoutFrequency": { "type": "string", "enum": [ "Quarterly", "Annually" ] }, "amounts": { "type": "string" }, "accountReferralCount": { "type": "integer", "format": "int32" }, "accountReferrals": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.AccountReferralDto" }, "xml": { "name": "AccountReferralDto", "wrapped": true }, "type": "array" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "ReferralPayoutDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.AccountReferralDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "billEntityId": { "type": "integer", "format": "int32" }, "payee": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "completeDate": { "type": "string", "format": "date-time" }, "accountName": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "referralPayoutId": { "type": "integer", "format": "int32" } }, "xml": { "name": "AccountReferralDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.RelatedBillingClientDto": { "properties": { "firstClientId": { "type": "integer", "format": "int32" }, "firstClientName": { "type": "string" }, "firstClientFirstName": { "type": "string" }, "firstClientLastName": { "type": "string" }, "firstClientIsActive": { "type": "boolean" }, "firstClientValue": { "type": "number", "format": "double" }, "firstClientRepresentative": { "type": "string" }, "firstClientRepresentativeNumber": { "type": "string" }, "firstClientBillStatusType": { "type": "string", "enum": [ "ReadyToBill", "Hold", "PendingReview" ] }, "secondClientId": { "type": "integer", "format": "int32" }, "secondClientName": { "type": "string" }, "secondClientFirstName": { "type": "string" }, "secondClientLastName": { "type": "string" }, "secondClientIsActive": { "type": "boolean" }, "secondClientValue": { "type": "number", "format": "double" }, "secondClientRepresentative": { "type": "string" }, "secondClientRepresentativeNumber": { "type": "string" }, "secondClientBillStatusType": { "type": "string", "enum": [ "ReadyToBill", "Hold", "PendingReview" ] } }, "xml": { "name": "RelatedBillingClientDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.RevenuePayoutDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "totalFeeAmount": { "type": "number", "format": "double" }, "totalMarketValue": { "type": "number", "format": "double" }, "payoutSchedule": { "type": "string" }, "revenuePayoutBasedOn": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "isForecast": { "type": "boolean" }, "isBasis": { "type": "boolean" } }, "xml": { "name": "RevenuePayoutDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.RevenuePayoutDetailDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "revenuePayoutId": { "type": "integer", "format": "int32" }, "tier": { "type": "string" }, "feeAmount": { "type": "number", "format": "double" }, "riaPayout": { "type": "number", "format": "double" }, "riaAmount": { "type": "number", "format": "double" }, "advisorPayout": { "type": "number", "format": "double" }, "advisorAmount": { "type": "number", "format": "double" } }, "xml": { "name": "RevenuePayoutDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.RevenuePayoutPaymentDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "revenuePayoutId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "totalFeeRemaining": { "type": "number", "format": "double" }, "collectedRIAAmount": { "type": "number", "format": "double" }, "unCollectedRIAAmount": { "type": "number", "format": "double" }, "collectedAdvisorAmount": { "type": "number", "format": "double" }, "unCollectedAdvisorAmount": { "type": "number", "format": "double" }, "adjustmentAmount": { "type": "number", "format": "double" }, "note": { "type": "string" }, "reportId": { "type": "integer", "format": "int32" } }, "xml": { "name": "RevenuePayoutPaymentDto" }, "type": "object" }, "OAS.WebApi.DTO.SimpleEntityCheckedDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "isChecked": { "type": "boolean" } }, "xml": { "name": "SimpleEntityCheckedDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.IndirectManagementFeeAdjustmentDto": { "properties": { "clientId": { "type": "integer", "format": "int32" }, "clientName": { "type": "string" }, "billId": { "type": "integer", "format": "int32" }, "receivableId": { "type": "integer", "format": "int32" }, "payingFeeAccountId": { "type": "integer", "format": "int32" }, "payingFeeAccountActive": { "type": "boolean" }, "paidAccountId": { "type": "integer", "format": "int32" }, "paidAccountActive": { "type": "boolean" }, "processingMessage": { "type": "string" } }, "xml": { "name": "IndirectManagementFeeAdjustmentDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillScheduleCalculateDto": { "properties": { "billScheduleId": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "details": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillScheduleCalculateTeirDto" }, "xml": { "name": "BillScheduleCalculateTeirDto", "wrapped": true }, "type": "array" }, "totalBilledAmount": { "readOnly": true, "type": "number", "format": "double" }, "totalFeeAmount": { "readOnly": true, "type": "number", "format": "double" }, "totalFeePercent": { "readOnly": true, "type": "number", "format": "double" } }, "xml": { "name": "BillScheduleCalculateDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillScheduleCalculateTeirDto": { "properties": { "billScheduleDetailId": { "type": "integer", "format": "int32" }, "minimumAmount": { "type": "number", "format": "double" }, "maximumAmount": { "type": "number", "format": "double" }, "billedAmount": { "type": "number", "format": "double" }, "feeAmount": { "readOnly": true, "type": "number", "format": "double" }, "feePercent": { "readOnly": true, "type": "number", "format": "double" } }, "xml": { "name": "BillScheduleCalculateTeirDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillScheduleDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string" }, "schedule": { "type": "string", "enum": [ "Undefined", "Fee", "Payout", "BDOverride", "Remainder", "PerformanceFee", "PerformancePayout" ] }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "type": { "type": "string" }, "basis": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "minFeeAcctValueThreshold": { "type": "number", "format": "double" }, "minimumFee": { "type": "number", "format": "double" }, "howBilled": { "type": "integer", "format": "int32" }, "billEntityId": { "type": "integer", "format": "int32" }, "billEntityName": { "type": "string" }, "billEntityDescription": { "type": "string" }, "showInFeeCalculator": { "type": "boolean" }, "isActive": { "type": "boolean" }, "isPayoutCreditOffset": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" } }, "xml": { "name": "BillScheduleDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillScheduleFullDto": { "properties": { "scheduleCode": { "type": "string" }, "linearBreakpointMaximums": { "type": "boolean" }, "aggregateByHousehold": { "type": "boolean" }, "details": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillScheduleDetailDto" }, "xml": { "name": "BillScheduleDetailDto", "wrapped": true }, "type": "array" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string" }, "schedule": { "type": "string", "enum": [ "Undefined", "Fee", "Payout", "BDOverride", "Remainder", "PerformanceFee", "PerformancePayout" ] }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "type": { "type": "string" }, "basis": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "minFeeAcctValueThreshold": { "type": "number", "format": "double" }, "minimumFee": { "type": "number", "format": "double" }, "howBilled": { "type": "integer", "format": "int32" }, "billEntityId": { "type": "integer", "format": "int32" }, "billEntityName": { "type": "string" }, "billEntityDescription": { "type": "string" }, "showInFeeCalculator": { "type": "boolean" }, "isActive": { "type": "boolean" }, "isPayoutCreditOffset": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" } }, "xml": { "name": "BillScheduleFullDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillScheduleDetailDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "minimumAmount": { "type": "number", "format": "double" }, "maximumAmount": { "type": "number", "format": "double" }, "rate": { "type": "number", "format": "double" }, "points": { "type": "number", "format": "double" }, "flatFee": { "type": "number", "format": "double" }, "reducedRate": { "type": "number", "format": "double" }, "reducedRateMinimumAmount": { "type": "number", "format": "double" } }, "xml": { "name": "BillScheduleDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillScheduleHistoryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string" }, "schedule": { "type": "string", "enum": [ "Undefined", "Fee", "Payout", "BDOverride", "Remainder", "PerformanceFee", "PerformancePayout" ] }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "type": { "type": "string" }, "basis": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "minFeeAcctValueThreshold": { "type": "number", "format": "double" }, "minimumFee": { "type": "number", "format": "double" }, "howBilled": { "type": "string" }, "scheduleCode": { "type": "string" }, "billEntityId": { "type": "integer", "format": "int32" }, "billEntityDescription": { "type": "string" }, "showInFeeCalculator": { "type": "boolean" }, "isActive": { "type": "boolean" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" } }, "xml": { "name": "BillScheduleHistoryDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillScheduleDetailHistoryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "billScheduleId": { "type": "integer", "format": "int32" }, "minimumAmount": { "type": "number", "format": "double" }, "maximumAmount": { "type": "number", "format": "double" }, "rate": { "type": "number", "format": "double" }, "points": { "type": "number", "format": "double" }, "flatFee": { "type": "number", "format": "double" }, "reducedRate": { "type": "number", "format": "double" }, "reducedRateMinimumAmount": { "type": "number", "format": "double" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "changeType": { "type": "string" } }, "xml": { "name": "BillScheduleDetailHistoryDto" }, "type": "object" }, "OAS.DataModel.Billing.SimpleSchedule": { "properties": { "schedule": { "type": "string", "enum": [ "Undefined", "Fee", "Payout", "BDOverride", "Remainder", "PerformanceFee", "PerformancePayout" ] }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "SimpleSchedule" }, "type": "object" }, "OAS.WebApi.DTO.Billing.ClsBillScheduleTierByPlatformDto": { "required": [ "subAdvisorId", "platformId", "details", "repMax" ], "properties": { "id": { "type": "integer", "format": "int32" }, "subAdvisorId": { "type": "integer", "format": "int32" }, "platformId": { "type": "integer", "format": "int32" }, "details": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.ClsBillingWizardDetailDto" }, "xml": { "name": "ClsBillingWizardDetailDto", "wrapped": true }, "type": "array" }, "repMax": { "type": "integer", "format": "int32" } }, "xml": { "name": "ClsBillScheduleTierByPlatformDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.ClsBillingWizardDetailDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "cMinAmount": { "type": "number", "format": "double", "maximum": 7.9228162514264338E+28, "minimum": 0.0 }, "cMaxAmount": { "type": "number", "format": "double", "maximum": 7.9228162514264338E+28, "minimum": 0.0 }, "cls": { "type": "number", "format": "double", "maximum": 7.9228162514264338E+28, "minimum": 0.0 }, "rep": { "type": "number", "format": "double", "maximum": 2147483647, "minimum": 0 }, "total": { "type": "integer", "format": "int32", "maximum": 2147483647, "minimum": 0 } }, "xml": { "name": "ClsBillingWizardDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillAssignedSchedulesDto": { "properties": { "pageIndex": { "type": "integer", "format": "int32" }, "rowCount": { "type": "integer", "format": "int32" }, "searchType": { "type": "string" }, "searchFor": { "type": "string" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" } }, "xml": { "name": "BillAssignedSchedulesDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.AssignedSchedulesDto": { "properties": { "totalResults": { "type": "integer", "format": "int32" }, "schedules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.AssignedScheduleDto" }, "xml": { "name": "AssignedScheduleDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "AssignedSchedulesDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.AssignedScheduleDto": { "properties": { "billAccountId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "billFeeScheduleId": { "type": "integer", "format": "int32" }, "schedule": { "type": "string" }, "entityId": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "registrationCode": { "type": "string" }, "accountNumber": { "type": "string" }, "custodianName": { "type": "string" }, "payInstruction": { "type": "string" }, "frequencyDescription": { "type": "string" }, "billingStyleDescription": { "type": "string" }, "creditRemaining": { "type": "number", "format": "double" }, "lastPaymentAmount": { "type": "number", "format": "double" }, "lastAppliedCredit": { "type": "number", "format": "double" }, "lastPaymentDate": { "type": "string", "format": "date-time" }, "balanceDue": { "type": "number", "format": "double" }, "billPeriod": { "type": "string" } }, "xml": { "name": "AssignedScheduleDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.ClsBillingWizardDto": { "required": [ "payoutName", "feeName", "minimumFee", "accountId", "managementStyleId", "details" ], "properties": { "payoutName": { "type": "string" }, "feeName": { "type": "string" }, "minimumFee": { "type": "number", "format": "double", "maximum": 2147483647, "minimum": 0 }, "accountId": { "type": "integer", "format": "int32", "maximum": 2147483647, "minimum": 1 }, "managementStyleId": { "type": "integer", "format": "int32", "maximum": 2147483647, "minimum": 1 }, "subAdvisorId": { "type": "integer", "format": "int32" }, "details": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.ClsBillingWizardDetailDto" }, "xml": { "name": "ClsBillingWizardDetailDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ClsBillingWizardDto" }, "type": "object" }, "OAS.Integrations.Eclipse.Model.EclipseCashFundingResponse": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string" }, "createdOn": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedOn": { "type": "string", "format": "date-time" }, "id": { "type": "integer", "format": "int32" }, "isDeleted": { "type": "integer", "format": "int32" }, "isExpired": { "type": "boolean" }, "toleranceValue": { "type": "integer", "format": "int32" }, "cashAmount": { "type": "number", "format": "double" }, "cashAmountTypeId": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "expirationTypeId": { "type": "integer", "format": "int32" }, "expirationValue": { "type": "string" }, "minCashAmount": { "type": "number", "format": "double" } }, "xml": { "name": "EclipseCashFundingResponse" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillTransactionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "brokerDealerName": { "type": "string" }, "representativeName": { "type": "string" }, "representativeNumber": { "type": "string" }, "productName": { "type": "string" }, "transactionDate": { "type": "string", "format": "date-time" }, "transactionTime": { "type": "string", "format": "date-time" }, "transactionAmount": { "type": "number", "format": "double" }, "isFeeExcluded": { "type": "boolean" }, "isCashFlow": { "type": "boolean" }, "isNMReady": { "type": "boolean" }, "isBilled": { "type": "boolean" }, "billedDate": { "type": "string", "format": "date-time" }, "isAdvanceBilled": { "type": "boolean" }, "transactionDescription": { "type": "string" }, "managementStyle": { "type": "string" }, "fundFamily": { "type": "string" }, "cycleMonth": { "type": "integer", "format": "int32" }, "billStyle": { "type": "string", "enum": [ "Advance", "Arrears" ] }, "valuationMethod": { "type": "string", "enum": [ "PeriodEndingValue", "AvgDailyBalance", "AvgMonthlyBalance" ] }, "clientId": { "type": "integer", "format": "int32" }, "feeSchedule": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "billStartDate": { "type": "string", "format": "date-time" }, "notes": { "type": "string" }, "businessLine": { "type": "string" }, "billFrequency": { "type": "string", "enum": [ "Undefined", "Monthly", "Quarterly", "Triannual", "Semiannually", "Annually", "AtMaturity" ] }, "outsideId": { "type": "string" }, "accountCreatedDate": { "type": "string", "format": "date-time" }, "subAdvisor": { "type": "string" }, "productId": { "type": "integer", "format": "int32" }, "ticker": { "type": "string" }, "performanceFeeBreak": { "type": "boolean" }, "householdName": { "type": "string" } }, "xml": { "name": "BillTransactionDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.TransactionTypeDto": { "properties": { "financialType": { "type": "string", "enum": [ "None", "Contribution", "Distribution", "Exchange", "DivReinvest", "MgmntFees", "DivCash", "MiscFees", "Journal", "Merges" ] }, "description": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "TransactionTypeDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.AutomateCashflowSettingDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "isEnabled": { "type": "boolean" }, "minimumThreshold": { "type": "number", "format": "double" }, "selectAll": { "type": "boolean" }, "groupByDay": { "type": "boolean" }, "transactionTypes": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.AutomateCashflowTransactionType" }, "xml": { "name": "AutomateCashflowTransactionType", "wrapped": true }, "type": "array" } }, "xml": { "name": "AutomateCashflowSettingDto" }, "type": "object" }, "OAS.DataModel.Billing.AutomateCashflowTransactionType": { "properties": { "id": { "type": "integer", "format": "int32" }, "automateCashflowSettingId": { "type": "integer", "format": "int32" }, "transactionId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string" }, "financialType": { "type": "string", "enum": [ "None", "Contribution", "Distribution", "Exchange", "DivReinvest", "MgmntFees", "DivCash", "MiscFees", "Journal", "Merges" ] }, "automateCashflowSetting": { "$ref": "#/definitions/OAS.DataModel.Billing.AutomateCashflowSetting" } }, "xml": { "name": "AutomateCashflowTransactionType" }, "type": "object" }, "OAS.DataModel.Billing.AutomateCashflowSetting": { "properties": { "id": { "type": "integer", "format": "int32" }, "isEnabled": { "type": "boolean" }, "minimumThreshold": { "type": "number", "format": "double" }, "selectAll": { "type": "boolean" }, "groupByDay": { "type": "boolean" }, "transactionTypes": { "items": { "$ref": "#/definitions/OAS.DataModel.Billing.AutomateCashflowTransactionType" }, "xml": { "name": "AutomateCashflowTransactionType", "wrapped": true }, "type": "array" } }, "xml": { "name": "AutomateCashflowSetting" }, "type": "object" }, "OAS.WebApi.Code.Projection.ProjectionManipulatorOfOAS.WebApi.DTO.Billing.BillTransactionDto": { "properties": { "type": { "readOnly": true, "type": "string" }, "hasImpact": { "readOnly": true, "type": "boolean" }, "top": { "readOnly": true, "type": "integer", "format": "int32" }, "skip": { "readOnly": true, "type": "integer", "format": "int32" }, "requestedProperties": { "description": "The properties the user specifically asked for", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" }, "requiredProperties": { "description": "The properties that are required to fulfill the requested properties", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProjectionManipulator`1" }, "type": "object" }, "OAS.DataModel.Trading.TransactionSleeveCashflow": { "required": [ "sleeveTransactionId", "custodialTransactionId", "transDate", "transTypeId", "tradeStatus" ], "properties": { "sleeveTransactionId": { "type": "integer", "format": "int32" }, "custodialTransactionId": { "type": "integer", "format": "int32" }, "transDate": { "type": "string", "format": "date-time" }, "transTypeId": { "type": "integer", "format": "int32" }, "tradeStatus": { "type": "integer", "format": "int32" } }, "xml": { "name": "TransactionSleeveCashflow" }, "type": "object" }, "OAS.DataModel.Trading.FeeExcludedAsset": { "required": [ "transactionId", "feeExcludedTransactionId" ], "properties": { "transactionId": { "type": "integer", "format": "int32" }, "feeExcludedTransactionId": { "type": "integer", "format": "int32" }, "transDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "FeeExcludedAsset" }, "type": "object" }, "OAS.WebApi.DTO.ValidateImport.ValidateFileImportDto": { "description": "import file DTO for validating imports", "properties": { "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile", "description": "the imported file" } }, "xml": { "name": "ValidateFileImportDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RelatedHouseholdValidationDto": { "properties": { "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" }, "warningMessage": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "globalId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "isDataSharingEntity": { "type": "boolean" }, "billing": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientBillingDto" }, "recurringAdjustments": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BillRecurrentAdjustmentDto" }, "xml": { "name": "BillRecurrentAdjustmentDto", "wrapped": true }, "type": "array" }, "feePayingAccounts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BillFeePayingAccountDto" }, "xml": { "name": "BillFeePayingAccountDto", "wrapped": true }, "type": "array" }, "tieredFeeAccounts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.TieredFeeAccountDto" }, "xml": { "name": "TieredFeeAccountDto", "wrapped": true }, "type": "array" }, "householdBills": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.HouseholdBillDto" }, "xml": { "name": "HouseholdBillDto", "wrapped": true }, "type": "array" }, "financialPlanningFee": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillFinancialPlanningFeeDto" }, "portfolio": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientPortfolioDto" }, "householdMembers": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.HouseholdMemberDto" }, "xml": { "name": "HouseholdMemberDto", "wrapped": true }, "type": "array" }, "notes": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.NoteDto" }, "xml": { "name": "NoteDto", "wrapped": true }, "type": "array" }, "documents": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DocumentDto" }, "xml": { "name": "DocumentDto", "wrapped": true }, "type": "array" }, "additionalAccounts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AdditionalAccountDto" }, "xml": { "name": "AdditionalAccountDto", "wrapped": true }, "type": "array" }, "suitability": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientSuitabilityDto" }, "userDefinedFields": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" }, "targetAllocations": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TargetAllocationDto" }, "xml": { "name": "TargetAllocationDto", "wrapped": true }, "type": "array" }, "creditCard": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientCreditCardSimpleDto" }, "assetExclusions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientAssetExclusionDto" }, "xml": { "name": "ClientAssetExclusionDto", "wrapped": true }, "type": "array" }, "portfolioGroups": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientPortfolioGroupDto" }, "xml": { "name": "ClientPortfolioGroupDto", "wrapped": true }, "type": "array" }, "appLinks": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientAppLinkDto" }, "xml": { "name": "ClientAppLinkDto", "wrapped": true }, "type": "array" }, "additionalRepresentatives": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AdditionalRepresentativeDto" }, "xml": { "name": "AdditionalRepresentativeDto", "wrapped": true }, "type": "array" }, "clientRepAdditional": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientRepAdditionalDto" } }, "xml": { "name": "RelatedHouseholdValidationDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ClientBillingDto": { "properties": { "billClientId": { "type": "integer", "format": "int32" }, "statusType": { "type": "string", "enum": [ "ReadyToBill", "Hold", "PendingReview" ] }, "masterPayoutScheduleId": { "type": "integer", "format": "int32" }, "feeScheduleID": { "type": "integer", "format": "int32" }, "relatedClients": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BillRelatedClientDto" }, "xml": { "name": "BillRelatedClientDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ClientBillingDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.BillRecurrentAdjustmentDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "annualAmount": { "type": "number", "format": "double" }, "type": { "type": "integer", "format": "int32" }, "schedule": { "type": "integer", "format": "int32" }, "adjustmentType": { "type": "integer", "format": "int32" }, "responsibleEntity": { "type": "integer", "format": "int32" }, "endDate": { "type": "string", "format": "date-time" }, "startDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "BillRecurrentAdjustmentDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.BillFeePayingAccountDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "registration": { "type": "string" }, "accountType": { "type": "string" }, "managementStyle": { "type": "string" }, "custodian": { "type": "string" }, "accountNumber": { "type": "string" }, "accountValue": { "type": "number", "format": "double" }, "active": { "type": "boolean" }, "payPercent": { "type": "number", "format": "double" } }, "xml": { "name": "BillFeePayingAccountDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.TieredFeeAccountDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "priority": { "type": "integer", "format": "int32" }, "accountName": { "type": "string" }, "accountNumber": { "type": "string" }, "nameandNumber": { "readOnly": true, "type": "string" }, "active": { "type": "boolean" } }, "xml": { "name": "TieredFeeAccountDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.HouseholdBillDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "billInstanceId": { "type": "integer", "format": "int32" }, "calcDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "asofDate": { "type": "string", "format": "date-time" }, "billedMarket": { "type": "number", "format": "double" }, "initialAmount": { "type": "number", "format": "double" }, "adjustments": { "type": "number", "format": "double" }, "balanceDue": { "type": "number", "format": "double" }, "dateRange": { "readOnly": true, "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "isValid": { "type": "boolean" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "numOfDay": { "readOnly": true, "type": "number", "format": "double" } }, "xml": { "name": "HouseholdBillDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillFinancialPlanningFeeDto": { "properties": { "payMethodId": { "type": "integer", "format": "int32" }, "feeScheduleId": { "type": "integer", "format": "int32" }, "masterPayoutScheduleId": { "type": "integer", "format": "int32" }, "billStyle": { "type": "string", "enum": [ "Advance", "Arrears" ] }, "billFrequency": { "type": "string", "enum": [ "Undefined", "Monthly", "Quarterly", "Triannual", "Semiannually", "Annually", "AtMaturity" ] }, "startDate": { "type": "string", "format": "date-time" }, "cycleMonth": { "type": "integer", "format": "int32" }, "paidByAccountNumber": { "type": "integer", "format": "int32" }, "planningFeeAmount": { "type": "number", "format": "double" } }, "xml": { "name": "BillFinancialPlanningFeeDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ClientPortfolioDto": { "properties": { "startDate": { "type": "string", "format": "date-time" }, "isActive": { "type": "boolean" }, "representativeId": { "type": "integer", "format": "int32" }, "categoryId": { "type": "integer", "format": "int32" }, "statementDeliveryMethodId": { "type": "integer", "format": "int32" }, "videoStatementDeliveryMethod": { "type": "string", "enum": [ "Unassigned", "NoVideoStatement", "WebsiteOnly", "Email" ] }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "isUsResident": { "type": "boolean" }, "email": { "type": "string" }, "name": { "type": "string" }, "salutation": { "type": "string" }, "lastStatementSentTo": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "address3": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string" }, "homePhone": { "type": "string" }, "homePhoneExt": { "type": "string" }, "fax": { "type": "string" }, "faxExt": { "type": "string" }, "pager": { "type": "string" }, "pagerExt": { "type": "string" }, "mobilePhone": { "type": "string" }, "businessPhone": { "type": "string" }, "businessPhoneExt": { "type": "string" }, "otherPhone": { "type": "string" }, "otherPhoneExt": { "type": "string" }, "workPhone": { "type": "string" }, "workPhoneExt": { "type": "string" }, "reportName": { "type": "string" }, "company": { "type": "string" }, "jobTitle": { "type": "string" }, "ssN_TaxID": { "type": "string" }, "gender": { "type": "string" }, "prefix": { "type": "string" }, "suffix": { "type": "string" }, "advClientCategoryId": { "type": "integer", "format": "int32" }, "dob": { "type": "string", "format": "date-time" }, "webAddress": { "type": "string" }, "importKey": { "type": "string" }, "lastStatementSent": { "type": "string", "format": "date-time" }, "isQualifiedInvestor": { "type": "boolean" } }, "xml": { "name": "ClientPortfolioDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.HouseholdMemberDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "globalId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "salutation": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "type": "string" }, "homePhone": { "type": "string" }, "homePhoneExt": { "type": "string" }, "fax": { "type": "string" }, "faxExt": { "type": "string" }, "pager": { "type": "string" }, "pagerExt": { "type": "string" }, "mobilePhone": { "type": "string" }, "businessPhone": { "type": "string" }, "businessPhoneExt": { "type": "string" }, "otherPhone": { "type": "string" }, "otherPhoneExt": { "type": "string" }, "email": { "type": "string" }, "ssN_TaxID": { "type": "string" }, "gender": { "type": "string" }, "dob": { "type": "string", "format": "date-time" }, "webAddress": { "type": "string" }, "additionalAddresses": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.HouseholdMemberAdditionalAddressDto" }, "xml": { "name": "HouseholdMemberAdditionalAddressDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "HouseholdMemberDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.NoteDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "text": { "type": "string" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "category": { "type": "string" }, "isWebVisible": { "type": "boolean" }, "isSystemGenerated": { "type": "boolean" } }, "xml": { "name": "NoteDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.DocumentDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "category": { "type": "string" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "systemGenerated": { "type": "boolean" } }, "xml": { "name": "DocumentDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AdditionalAccountDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "registration": { "type": "string" }, "accountNumber": { "type": "string" }, "type": { "type": "integer", "format": "int32" }, "typeName": { "type": "string" }, "fundFamily": { "type": "integer", "format": "int32" }, "fundFamilyName": { "type": "string" }, "custodian": { "type": "integer", "format": "int32" }, "custodianName": { "type": "string" }, "managementStyle": { "type": "integer", "format": "int32" }, "managementStyleName": { "type": "string" }, "model": { "type": "integer", "format": "int32" }, "modelName": { "type": "string" }, "weight": { "type": "number", "format": "double" } }, "xml": { "name": "AdditionalAccountDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ClientSuitabilityDto": { "properties": { "returnObjective": { "type": "string" }, "investmentObjective": { "type": "string" }, "timeHorizon": { "type": "string" }, "stockPercent": { "type": "string" }, "riskTolerance": { "description": "Returns the Client RiskTolerance if there is one, otherwise returns Registration level risk tolerance", "type": "integer", "format": "int32" } }, "xml": { "name": "ClientSuitabilityDto" }, "type": "object" }, "OAS.WebApi.DTO.Settings.EntityOptionDto": { "properties": { "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "childParameter": { "type": "string" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "entityName": { "type": "string" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "category": { "type": "string" }, "type": { "type": "string", "enum": [ "MultiLineEditor", "DropDownEditor", "DropDownList", "CheckBox", "Currency", "Date", "DateTime", "Integer", "String", "Double", "Time", "Long", "CustomObject", "Email" ] }, "maxLength": { "type": "integer", "format": "int32" }, "code": { "type": "string" }, "sequence": { "type": "integer", "format": "int32" }, "options": { "type": "object" }, "input": { "type": "string" }, "securityCode": { "type": "string" }, "canEdit": { "type": "boolean" } }, "xml": { "name": "EntityOptionDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.TargetAllocationDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "weight": { "type": "number", "format": "double" }, "minimumRange": { "type": "number", "format": "double" }, "maximumRange": { "type": "number", "format": "double" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "TargetAllocationDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ClientCreditCardSimpleDto": { "properties": { "ccNum": { "type": "string" }, "ccType": { "type": "string" }, "ccToken": { "type": "string" }, "ccIsValid": { "type": "boolean" } }, "xml": { "name": "ClientCreditCardSimpleDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ClientAssetExclusionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "exclusionType": { "type": "integer", "format": "int32" }, "exclusionValue": { "type": "integer", "format": "int32" }, "isExcluded": { "type": "boolean" }, "securityClassificationMethodId": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "ClientAssetExclusionDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ClientPortfolioGroupDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "portfolioType": { "type": "string", "enum": [ "Composite", "Reporting", "Trading" ] }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "eclipsePortfolioId": { "type": "integer", "format": "int32" }, "accounts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AdditionalAccountDto" }, "xml": { "name": "AdditionalAccountDto", "wrapped": true }, "type": "array" }, "registrationIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "repId": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "modelAggId": { "type": "integer", "format": "int32" }, "platformId": { "type": "integer", "format": "int32" }, "planId": { "type": "integer", "format": "int32" }, "fundFamilyId": { "type": "integer", "format": "int32" }, "stockRange": { "type": "integer", "format": "int32" }, "riskTolerance": { "type": "integer", "format": "int32" }, "riskBudgetRange": { "type": "integer", "format": "int32" } }, "xml": { "name": "ClientPortfolioGroupDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ClientAppLinkDto": { "properties": { "appLinkId": { "type": "integer", "format": "int32" }, "externalIntId": { "type": "integer", "format": "int32" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedBy": { "type": "string" } }, "xml": { "name": "ClientAppLinkDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AdditionalRepresentativeDto": { "properties": { "repId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "repTitleId": { "type": "integer", "format": "int32" }, "simpleRep": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "repTitle": { "type": "string" }, "canDelete": { "type": "boolean" }, "numberOfHouseholds": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "AdditionalRepresentativeDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ClientRepAdditionalDto": { "properties": { "appendOnly": { "type": "boolean" }, "details": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientRepAdditionalDetailDto" }, "xml": { "name": "ClientRepAdditionalDetailDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ClientRepAdditionalDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.BillRelatedClientDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "billClientId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "isActive": { "type": "boolean" } }, "xml": { "name": "BillRelatedClientDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.HouseholdMemberAdditionalAddressDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "address3": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "email": { "type": "string" }, "company": { "type": "string" }, "jobTitle": { "type": "string" }, "webAddress": { "type": "string" }, "sendPeriodicStatements": { "type": "boolean" } }, "xml": { "name": "HouseholdMemberAdditionalAddressDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ClientRepAdditionalDetailDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "representativeId": { "type": "integer", "format": "int32" }, "simpleRep": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleRepresentative" }, "representativeTitleId": { "type": "integer", "format": "int32" }, "payoutRate": { "type": "number", "format": "double" }, "notes": { "type": "string" }, "isPrimary": { "type": "boolean" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "isActive": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" } }, "xml": { "name": "ClientRepAdditionalDetailDto" }, "type": "object" }, "OAS.DataModel.Portfolio.SimpleRepresentative": { "properties": { "isActive": { "type": "boolean" }, "number": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "SimpleRepresentative" }, "type": "object" }, "OAS.WebApi.DTO.Billing.FeeHierarchyValidationDto": { "properties": { "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" }, "warningMessage": { "type": "string" }, "level": { "description": "these are normally nested details in the feeHierarchyDto object", "type": "string", "enum": [ "BrokerDealer", "RIA", "Representative", "Plan401k", "Platform", "Client", "Registration", "SubAdvisor", "AggregateModel", "Account", "Global" ] }, "billEntityId": { "type": "integer", "format": "int32" }, "billScheduleId": { "type": "integer", "format": "int32" }, "status": { "type": "boolean" }, "name": { "description": "Name of the fee hierarchy", "type": "string" }, "entityId": { "description": "Entity ID", "type": "integer", "format": "int32" }, "entity": { "description": "Entity type", "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "custodianId": { "description": "Custodian ID", "type": "integer", "format": "int32" }, "billProductGroupId": { "description": "Bill Product Group ID", "type": "integer", "format": "int32" }, "feeHierarchyDetails": { "description": "List of fee hierarchies for the entity/custodian combination", "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FeeHierarchyDetail" }, "xml": { "name": "FeeHierarchyDetail", "wrapped": true }, "type": "array" } }, "xml": { "name": "FeeHierarchyValidationDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AccountVerboseValidationDto": { "properties": { "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "number": { "type": "string" }, "isDataSharingEntity": { "type": "boolean" }, "isAstroEnabled": { "type": "boolean" }, "billing": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountBillingDto" }, "portfolio": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountPortfolioDto" }, "modelingInfo": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountModelingInfoDto" }, "notes": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.NoteDto" }, "xml": { "name": "NoteDto", "wrapped": true }, "type": "array" }, "documents": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DocumentDto" }, "xml": { "name": "DocumentDto", "wrapped": true }, "type": "array" }, "compliance": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ComplianceDto" }, "systematics": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SystematicDto" }, "xml": { "name": "SystematicDto", "wrapped": true }, "type": "array" }, "accountManagers": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountManagerDto" }, "xml": { "name": "AccountManagerDto", "wrapped": true }, "type": "array" }, "recurringAdjustments": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BillRecurrentAdjustmentDto" }, "xml": { "name": "BillRecurrentAdjustmentDto", "wrapped": true }, "type": "array" }, "generalAccounts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.GeneralAccountDto" }, "xml": { "name": "GeneralAccountDto", "wrapped": true }, "type": "array" }, "referralSchedules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.AccountReferralDto" }, "xml": { "name": "AccountReferralDto", "wrapped": true }, "type": "array" }, "billAccountSchedules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BillAccountScheduleDto" }, "xml": { "name": "BillAccountScheduleDto", "wrapped": true }, "type": "array" }, "userDefinedFields": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" }, "targetAllocations": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TargetAllocationDto" }, "xml": { "name": "TargetAllocationDto", "wrapped": true }, "type": "array" }, "productEquivalents": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductEquivalentDto" }, "xml": { "name": "ProductEquivalentDto", "wrapped": true }, "type": "array" }, "sma": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountSmaDto" }, "bondTrade": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.AccountBondTradeDto" }, "compositeExclusions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.CompositeAccountExcludeDto" }, "xml": { "name": "CompositeAccountExcludeDto", "wrapped": true }, "type": "array" }, "futureCashflows": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountFutureCashflowDto" }, "xml": { "name": "AccountFutureCashflowDto", "wrapped": true }, "type": "array" }, "growthRates": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountGrowthRateDto" }, "xml": { "name": "AccountGrowthRateDto", "wrapped": true }, "type": "array" }, "goals": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountGoalDto" }, "xml": { "name": "AccountGoalDto", "wrapped": true }, "type": "array" }, "suitability": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountSuitabilityDto" }, "permissibleAggregateModels": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.SimpleAggregateModel" }, "xml": { "name": "SimpleAggregateModel", "wrapped": true }, "type": "array" }, "astroTaxSchedules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.AstroAccountTaxSchedulesDto" }, "xml": { "name": "AstroAccountTaxSchedulesDto", "wrapped": true }, "type": "array" }, "astroAccount": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.AstroAccountDto" }, "taxRates": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountTaxRateDto" }, "xml": { "name": "AccountTaxRateDto", "wrapped": true }, "type": "array" }, "additionalClients": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientAdditionalAccountDto" }, "xml": { "name": "ClientAdditionalAccountDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "AccountVerboseValidationDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AccountBillingDto": { "properties": { "billAccountId": { "type": "integer", "format": "int32" }, "accountType": { "type": "string" }, "fundName": { "type": "string" }, "feeSchedule": { "type": "string" }, "masterPayoutSchedule": { "type": "string" }, "payMethod": { "type": "string" }, "billFrequency": { "type": "string", "enum": [ "Undefined", "Monthly", "Quarterly", "Triannual", "Semiannually", "Annually", "AtMaturity" ] }, "billStyle": { "type": "string", "enum": [ "Advance", "Arrears" ] }, "acceptsList": { "type": "boolean" }, "valuationMethod": { "type": "string", "enum": [ "PeriodEndingValue", "AvgDailyBalance", "AvgMonthlyBalance" ] }, "fundFamilyId": { "type": "integer", "format": "int32" }, "managementStyleId": { "type": "integer", "format": "int32" }, "subAdvisorId": { "type": "integer", "format": "int32" }, "feeScheduleId": { "type": "integer", "format": "int32" }, "masterPayoutScheduleId": { "type": "integer", "format": "int32" }, "payMethodId": { "type": "integer", "format": "int32" }, "billStartDate": { "type": "string", "format": "date-time" }, "bankName": { "type": "string" }, "abaNumber": { "type": "string" }, "bankAccountNumber": { "type": "string" }, "nameOnAccount": { "type": "string" }, "custodialAccountNumber": { "type": "string" }, "isPerformanceBilled": { "type": "boolean" }, "lastPerfBillDate": { "type": "string", "format": "date-time" }, "expirationDate": { "type": "string" }, "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "addressLine3": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "includeInAggregate": { "type": "boolean" }, "nonManagedAccountNumber": { "type": "string" }, "nonManagedAccountName": { "type": "string" }, "nonManagedHouseholdName": { "type": "string" }, "cycleMonth": { "type": "integer", "format": "int32" }, "performanceMasterPayoutSchedule": { "type": "string" }, "performanceFeeSchedule": { "type": "string" }, "performanceMasterPayoutScheduleId": { "type": "integer", "format": "int32" }, "performanceFeeScheduleId": { "type": "integer", "format": "int32" }, "cardType": { "type": "string" }, "nameOnCard": { "type": "string" }, "billAccountStatus": { "type": "string", "enum": [ "Ready", "NotReady", "ReportingOnly", "FinancialPlanningFeeOnly" ] }, "tieredFeePriority": { "type": "integer", "format": "int32" }, "paysForAccounts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillPaysForAccountDto" }, "xml": { "name": "BillPaysForAccountDto", "wrapped": true }, "type": "array" }, "payedByAccounts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillPaysForAccountDto" }, "xml": { "name": "BillPaysForAccountDto", "wrapped": true }, "type": "array" }, "payeeList": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillAccountEntityPayeeDto" }, "xml": { "name": "BillAccountEntityPayeeDto", "wrapped": true }, "type": "array" }, "feeHierarchyItems": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.FeeHierarchyAccountDto" }, "xml": { "name": "FeeHierarchyAccountDto", "wrapped": true }, "type": "array" }, "creditCardNumber": { "type": "string" }, "accountHistoryBillingId": { "type": "integer", "format": "int32" }, "byAllAccountId": { "type": "integer", "format": "int32" }, "quovoAccountId": { "type": "integer", "format": "int32" }, "plaidAccountId": { "type": "string" }, "akoyaAccountId": { "type": "string" }, "useFeeHierarchy": { "type": "boolean" } }, "xml": { "name": "AccountBillingDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AccountPortfolioDto": { "properties": { "clientId": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "managementStyle": { "type": "string" }, "fundFamily": { "type": "string" }, "accountStartValue": { "type": "number", "format": "double" }, "accountStartDate": { "type": "string", "format": "date-time" }, "isManaged": { "type": "boolean" }, "isActive": { "type": "boolean" }, "isSweepAccount": { "type": "boolean" }, "isSleeveAccount": { "type": "boolean" }, "isSleeveCustodialAccount": { "type": "boolean" }, "importKey": { "type": "string" }, "outsideId": { "type": "string" }, "managementStyleId": { "type": "integer", "format": "int32" }, "fundFamilyId": { "type": "integer", "format": "int32" }, "accountHistoryId": { "type": "integer", "format": "int32" }, "modelName": { "type": "string" }, "accountType": { "type": "string" }, "custodian": { "type": "string" }, "custodianId": { "type": "integer", "format": "int32" }, "shareClass": { "type": "string" }, "shareClassId": { "type": "integer", "format": "int32" }, "subAdvisor": { "type": "string" }, "subAdvisorId": { "type": "integer", "format": "int32" }, "downloadSource": { "type": "string" }, "downloadSourceId": { "type": "integer", "format": "int32" }, "provider": { "type": "string" }, "plan": { "type": "integer", "format": "int32" }, "businessLine": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "accountStatusId": { "type": "integer", "format": "int32" }, "accountStatusDescription": { "type": "string" }, "isPositionOnlyRecon": { "type": "boolean" }, "eclipseFirmId": { "type": "integer", "format": "int32" }, "isUnfunded": { "type": "boolean" }, "isBundled": { "type": "boolean" }, "isExcludedFromFirmAssets": { "type": "boolean" }, "isDefaultFundFamily": { "type": "boolean" }, "custodialRepCode": { "type": "string" }, "isOps": { "type": "boolean" }, "lastPositionDate": { "type": "string", "format": "date-time" }, "inBalance": { "type": "boolean" }, "lastReconciledEffectiveDate": { "type": "string", "format": "date-time" }, "custodianCommonIdList": { "type": "string" }, "nickname": { "type": "string" } }, "xml": { "name": "AccountPortfolioDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AccountModelingInfoDto": { "properties": { "modelGroupNumber": { "type": "string" }, "isOriginalSMCAccount": { "type": "boolean" }, "isTradingBlocked": { "type": "boolean" }, "isRegistrationDoNotTrade": { "type": "boolean" }, "tradingInstructions": { "type": "string" }, "downloadSource": { "type": "integer", "format": "int32" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "isRebalance": { "type": "boolean" }, "isOutsideModel": { "type": "boolean" }, "minimumCashBalance": { "type": "number", "format": "double" }, "minimumCashBalanceType": { "type": "string", "enum": [ "Dollars", "Percent" ] }, "replenishMinimumCash": { "type": "boolean" }, "fundList": { "type": "string" }, "autoRebalanceFrequency": { "type": "string", "enum": [ "None", "Monthly", "Quarterly", "Semiannual", "Annual" ] }, "autoRebalanceMonth": { "type": "integer", "format": "int32" }, "autoRebalanceDay": { "type": "integer", "format": "int32" }, "dollarModelId": { "type": "integer", "format": "int32" }, "dollarModelAmount": { "type": "number", "format": "double" }, "expireMinCash": { "type": "number", "format": "double" }, "expireMinCashType": { "type": "string", "enum": [ "Dollars", "Percent" ] }, "expireMinCashDate": { "type": "string", "format": "date-time" }, "aggregateModel": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelAggDto" }, "isSleeveAccount": { "type": "boolean" }, "customAllocations": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.CustomAllocationsDto" } }, "xml": { "name": "AccountModelingInfoDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ComplianceDto": { "properties": { "sloas": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountSloaDto" }, "xml": { "name": "AccountSloaDto", "wrapped": true }, "type": "array" }, "advCustodyTypeId": { "type": "integer", "format": "int32" }, "is13FReportable": { "type": "boolean" }, "isAdvReportable": { "type": "boolean" }, "isAuaReportable": { "type": "boolean" }, "isDiscretionary": { "type": "boolean" }, "isWrapManaged": { "type": "boolean" }, "isWrapSponsored": { "type": "boolean" } }, "xml": { "name": "ComplianceDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SystematicDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "isDoubleCheck": { "type": "boolean" }, "type": { "type": "integer", "format": "int32" }, "doubleCheckBy": { "type": "string" }, "doubleCheckDate": { "type": "string", "format": "date-time" }, "swpAmount": { "type": "number", "format": "double" }, "isProrated": { "type": "boolean" }, "isCashFundingIgnored": { "type": "boolean" }, "frequency": { "type": "string", "enum": [ "Monthly", "Quarterly", "Semiannually", "Annually" ] }, "cycleMonth": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "inActiveDate": { "type": "string", "format": "date-time" }, "transactionDay": { "type": "integer", "format": "int32" }, "custodialSWPDate": { "type": "integer", "format": "int32" }, "taxesWithheld": { "type": "number", "format": "double" }, "stateTax": { "type": "number", "format": "double" }, "distributionCode": { "type": "integer", "format": "int32" }, "notes": { "type": "string" }, "source": { "type": "integer", "format": "int32" }, "dataEntryMethod": { "type": "integer", "format": "int32" }, "howTransfered": { "type": "integer", "format": "int32" }, "bankName": { "type": "string" }, "bankAddress": { "type": "string" }, "abaNumber": { "type": "string" }, "bankAccountNumber": { "type": "string" }, "lifeType": { "type": "integer", "format": "int32" }, "beneficiaryName": { "type": "string" }, "beneficiaryDoB": { "type": "string", "format": "date-time" }, "beneficiarySSN": { "type": "string" }, "reason": { "type": "string" }, "isSpouse": { "type": "boolean" }, "isTaxWithType": { "type": "string", "enum": [ "Undefined", "Dollar", "Percent", "Unknown", "None" ] }, "isRecalc": { "type": "boolean" }, "isAutoRmd": { "type": "boolean" }, "nextDate": { "type": "string", "format": "date-time" }, "importKey": { "type": "string" }, "custodialSystematicId": { "type": "string" } }, "xml": { "name": "SystematicDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AccountManagerDto": { "properties": { "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "entityName": { "type": "string" } }, "xml": { "name": "AccountManagerDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.GeneralAccountDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "parentId": { "type": "integer", "format": "int32" }, "dateOccured": { "type": "string", "format": "date-time" }, "adjustmentType": { "type": "integer", "format": "int32" }, "amount": { "type": "number", "format": "double" }, "billEntity": { "type": "integer", "format": "int32" }, "isDebit": { "type": "boolean" }, "notes": { "type": "string" }, "hasBillAdjustments": { "type": "boolean" }, "isBillAdjustment": { "type": "boolean" } }, "xml": { "name": "GeneralAccountDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.BillAccountScheduleDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "billSchedule": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "assignmentType": { "type": "string", "enum": [ "Undefined", "ProductCategory", "ProductClass", "RiskCategory", "AssetCategory", "Ticker", "SecurityClassification" ] }, "category": { "type": "string" }, "productClass": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "riskCategory": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "productCategory": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "product": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "securityClass": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillAccountScheduleSecurityClassSimpleDto" } }, "xml": { "name": "BillAccountScheduleDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ProductEquivalentDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "productModelId": { "type": "integer", "format": "int32" }, "productModelName": { "type": "string" }, "productModelTicker": { "type": "string" }, "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "productTicker": { "type": "string" }, "sortOrder": { "type": "integer", "format": "int32" } }, "xml": { "name": "ProductEquivalentDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AccountSmaDto": { "properties": { "isSma": { "type": "boolean" }, "eclipseSMA": { "type": "string", "enum": [ "False", "True", "FollowOrion" ] }, "smaAssetId": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "AccountSmaDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.AccountBondTradeDto": { "properties": { "accountBondTradeId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "excludeUntilDate": { "type": "string", "format": "date-time" }, "excludeUntilNotes": { "type": "string" }, "shortTermBondPercent": { "type": "number", "format": "double" }, "intermediateTermBondPercent": { "type": "number", "format": "double" }, "equityPercent": { "type": "number", "format": "double" }, "bondPercent": { "type": "number", "format": "double" }, "cashPercent": { "type": "number", "format": "double" }, "excludeBondsFromRebalance": { "type": "boolean" }, "excludeEquitiesFromRebalance": { "type": "boolean" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "AccountBondTradeDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.CompositeAccountExcludeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "reason": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" } }, "xml": { "name": "CompositeAccountExcludeDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AccountFutureCashflowDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "frequency": { "type": "string", "enum": [ "Weekly", "Monthly", "Quarterly", "SemiAnnually", "Annually" ] }, "daysIntoPeriod": { "type": "integer", "format": "int32" }, "amount": { "type": "number", "format": "double" } }, "xml": { "name": "AccountFutureCashflowDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AccountGrowthRateDto": { "properties": { "asOfDate": { "type": "string", "format": "date-time" }, "annualGrowthRate": { "type": "number", "format": "double" } }, "xml": { "name": "AccountGrowthRateDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AccountGoalDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "amount": { "type": "number", "format": "double" } }, "xml": { "name": "AccountGoalDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AccountSuitabilityDto": { "properties": { "riskScore": { "type": "number", "format": "double" } }, "xml": { "name": "AccountSuitabilityDto" }, "type": "object" }, "OAS.DataModel.Trading.SimpleAggregateModel": { "properties": { "isActive": { "type": "boolean" }, "managementStlyeId": { "type": "integer", "format": "int32" }, "managementStyleName": { "type": "string" }, "minimumInvestmentAmount": { "type": "number", "format": "double" }, "hasSMAModel": { "type": "boolean" }, "containsCommunityModel": { "type": "boolean" }, "communityModelId": { "type": "integer", "format": "int64" }, "subAdvisorId": { "type": "integer", "format": "int32" }, "subAdvisorName": { "type": "string" }, "riskScore": { "type": "number", "format": "double" }, "excludeRebalanceSleeve": { "type": "boolean" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "SimpleAggregateModel" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Astro.AstroAccountTaxSchedulesDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "year": { "type": "integer", "format": "int32" }, "annualCapGain": { "type": "number", "format": "double" }, "q1Percent": { "type": "number", "format": "double" }, "q2Percent": { "type": "number", "format": "double" }, "q3Percent": { "type": "number", "format": "double" }, "q4Percent": { "type": "number", "format": "double" } }, "xml": { "name": "AstroAccountTaxSchedulesDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Astro.AstroAccountDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "astroTemplate": { "type": "string" }, "maxRealizedGain": { "type": "number", "format": "double" }, "fedShortTaxRate": { "type": "number", "format": "double" }, "fedLongTaxRate": { "type": "number", "format": "double" }, "shortTermTaxRate": { "type": "number", "format": "double" }, "longTermTaxRate": { "type": "number", "format": "double" }, "ticketCharge": { "type": "number", "format": "double" }, "maxTrackingError": { "type": "number", "format": "double" }, "minTrackingError": { "type": "number", "format": "double" }, "assets": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.AstroAssetDto" }, "xml": { "name": "AstroAssetDto", "wrapped": true }, "type": "array" }, "sectors": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.SectorDto" }, "xml": { "name": "SectorDto", "wrapped": true }, "type": "array" }, "sleeves": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.AstroSleeveDto" }, "xml": { "name": "AstroSleeveDto", "wrapped": true }, "type": "array" }, "esgRestriction": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.EsgCategoryRestrictionDto" }, "xml": { "name": "EsgCategoryRestrictionDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "AstroAccountDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AccountTaxRateDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "shortTermTaxRate": { "type": "number", "format": "double" }, "longTermTaxRate": { "type": "number", "format": "double" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "AccountTaxRateDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ClientAdditionalAccountDto": { "properties": { "weight": { "type": "number", "format": "double" }, "isActive": { "type": "boolean" }, "custodian": { "type": "string" }, "custodianCode": { "type": "string" }, "managementStyle": { "type": "string" }, "currentValue": { "type": "number", "format": "double" }, "fundFamily": { "type": "string" }, "accountStartValue": { "type": "number", "format": "double" }, "createdDate": { "type": "string", "format": "date-time" }, "isManaged": { "type": "boolean" }, "isSweepAccount": { "type": "boolean" }, "isSleeveAccount": { "type": "boolean" }, "sleeveType": { "type": "string", "enum": [ "Normal sleeve", "Custodial account", "Contribution sleeve", "Distribution sleeve", "Unmanaged sleeve" ] }, "isAdvReportable": { "type": "boolean" }, "is13FReportable": { "type": "boolean" }, "isAuaReportable": { "type": "boolean" }, "advCustodyTypeId": { "type": "integer", "format": "int32" }, "custodialRepCode": { "type": "string" }, "brokerDealer": { "type": "string" }, "importKey": { "type": "string" }, "outsideId": { "type": "string" }, "secondaryAccountNumber": { "type": "string" }, "managementStyleId": { "type": "integer", "format": "int32" }, "fundFamilyId": { "type": "integer", "format": "int32" }, "accountHistoryId": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "shareClass": { "type": "string" }, "shareClassId": { "type": "integer", "format": "int32" }, "subAdvisorId": { "type": "integer", "format": "int32" }, "provider": { "type": "string" }, "plan": { "type": "integer", "format": "int32" }, "planName": { "type": "string" }, "modelGroupNumber": { "type": "string" }, "isOriginalSMCAccount": { "type": "boolean" }, "isTradingBlocked": { "type": "boolean" }, "tradingInstructions": { "type": "string" }, "downloadSource": { "type": "string" }, "businessLine": { "type": "string" }, "createdBy": { "type": "string" }, "accountStartDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "accountStatusId": { "type": "integer", "format": "int32" }, "accountStatus": { "type": "string" }, "accountStatusDescription": { "type": "string" }, "feeScheduleId": { "type": "integer", "format": "int32" }, "feeSchedule": { "type": "string" }, "masterPayoutScheduleId": { "type": "integer", "format": "int32" }, "masterPayoutSchedule": { "type": "string" }, "billFrequency": { "type": "string", "enum": [ "Undefined", "Monthly", "Quarterly", "Triannual", "Semiannually", "Annually", "AtMaturity" ] }, "representative": { "type": "string" }, "representativeNumber": { "type": "string" }, "representativeId": { "type": "integer", "format": "int32" }, "household": { "type": "string" }, "cancelDate": { "type": "string", "format": "date-time" }, "riskBudget": { "type": "integer", "format": "int32" }, "modelAggId": { "type": "integer", "format": "int32" }, "billPayMethod": { "type": "string" }, "acceptsList": { "type": "boolean" }, "billStartDate": { "type": "string", "format": "date-time" }, "missingInfoFromView": { "type": "string" }, "sweepAssetId": { "type": "integer", "format": "int32" }, "includeInAggregate": { "type": "boolean" }, "isDiscretionary": { "type": "boolean" }, "cashBalance": { "type": "number", "format": "double" }, "sleeveStrategy": { "type": "string" }, "isQualified": { "type": "boolean" }, "riskScore": { "type": "number", "format": "double" }, "isWrapManaged": { "type": "boolean" }, "isWrapSponsored": { "type": "boolean" }, "lastName": { "type": "string" }, "nickname": { "type": "string" }, "isPositionOnlyRecon": { "type": "boolean" }, "eclipseFirmId": { "type": "integer", "format": "int32" }, "isUnfunded": { "type": "boolean" }, "isBundled": { "type": "boolean" }, "isExcludedFromFirmAssets": { "type": "boolean" }, "annuityIncomeValue": { "type": "number", "format": "double" }, "currentRiskScore": { "type": "integer", "format": "int32" }, "targetRiskScore": { "type": "integer", "format": "int32" }, "riskScoreAsOfDate": { "type": "string", "format": "date-time" }, "riskScoreProvider": { "description": "The source of {OAS.WebApi.DTO.Portfolio.AccountDto.TargetRiskScore}{OAS.WebApi.DTO.Portfolio.AccountDto.CurrentRiskScore} and {OAS.WebApi.DTO.Portfolio.AccountDto.RiskScoreAsOfDate}", "type": "string" }, "riskTol": { "type": "integer", "format": "int32" }, "tieredFeePriority": { "type": "integer", "format": "int32" }, "additionalColumns": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Interface.AdditionalColumnDefinition" }, "xml": { "name": "AdditionalColumnDefinition", "wrapped": true }, "type": "array" }, "isOps": { "type": "boolean" }, "lastPositionDate": { "type": "string", "format": "date-time" }, "inBalance": { "type": "boolean" }, "lastReconciledEffectiveDate": { "type": "string", "format": "date-time" }, "clientGlobalId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "registrationGlobalId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "number": { "type": "string" }, "modelName": { "type": "string" }, "subAdvisor": { "type": "string" }, "accountType": { "type": "string" }, "isDataSharingEntity": { "type": "boolean" } }, "xml": { "name": "ClientAdditionalAccountDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillPaysForAccountDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "percent": { "type": "number", "format": "double" }, "accountNumber": { "type": "string" }, "accountSummary": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "BillPaysForAccountDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillAccountEntityPayeeDto": { "properties": { "billEntityId": { "type": "integer", "format": "int32" }, "payeeId": { "type": "integer", "format": "int32" }, "payout": { "type": "string" }, "readOnly": { "type": "boolean" } }, "xml": { "name": "BillAccountEntityPayeeDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.FeeHierarchyAccountDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "billEntity": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillEntityDto" }, "billEntityId": { "type": "integer", "format": "int32" }, "payoutId": { "type": "integer", "format": "int32" }, "payoutName": { "type": "string" }, "entityName": { "type": "string" }, "level": { "type": "string", "enum": [ "BrokerDealer", "RIA", "Representative", "Plan401k", "Platform", "Client", "Registration", "SubAdvisor", "AggregateModel", "Account", "Global" ] }, "status": { "type": "boolean" }, "id": { "type": "integer", "format": "int32" }, "productType": { "type": "integer", "format": "int32" }, "billProductGroupId": { "type": "integer", "format": "int32" }, "sleeveType": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "isNewOverride": { "type": "boolean" }, "billEntityCollectFromId": { "type": "integer", "format": "int32" } }, "xml": { "name": "FeeHierarchyAccountDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.ModelAggDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "isSystemMaintained": { "type": "boolean" }, "accountNumberSuffix": { "type": "string" }, "keepAlways": { "type": "boolean" }, "accountCount": { "type": "integer", "format": "int32" }, "value": { "type": "number", "format": "double" }, "sortOrder": { "type": "integer", "format": "int32" }, "color": { "type": "string" }, "eclipseFirmId": { "type": "integer", "format": "int32" }, "eclipseFirmIds_csv": { "type": "string" }, "modelTags": { "readOnly": true, "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "eclipseModelId": { "type": "integer", "format": "int32" }, "minimumInvestmentAmount": { "type": "number", "format": "double" }, "billFeeSchedule": { "type": "integer", "format": "int32" }, "payoutSchedule": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "entityId": { "type": "integer", "format": "int32" }, "entityEnum": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "include": { "type": "boolean" }, "owned": { "type": "boolean" }, "canMaintain": { "type": "boolean" }, "modelAggTypeId": { "type": "integer", "format": "int32" }, "modelAggType": { "type": "string" }, "riskScore": { "type": "number", "format": "double" }, "proposalEnabled": { "type": "boolean" }, "advisoryWorldModel": { "type": "boolean" }, "hasManagerFactSheet": { "type": "boolean" }, "subAdvisorId": { "type": "integer", "format": "int32" }, "subAdvisorName": { "type": "string" }, "containsCommunityModel": { "type": "boolean" }, "communityModelId": { "type": "integer", "format": "int64" }, "modelAssetType": { "type": "string" }, "modelRiskCategory": { "type": "string" }, "modelAssetClass": { "type": "string" }, "modelStrategyType": { "type": "string" }, "taxManaged": { "type": "boolean" }, "isSociallyResponsible": { "type": "boolean" }, "morningstarId": { "type": "string" }, "isAstroEnabled": { "type": "boolean" }, "syncToAstro": { "type": "boolean" }, "details": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelAggDetailDto" }, "xml": { "name": "ModelAggDetailDto", "wrapped": true }, "type": "array" }, "hasSMAModel": { "type": "boolean" }, "strategistId": { "type": "integer", "format": "int32" }, "worstReturn": { "type": "number", "format": "double" }, "averageReturn": { "type": "number", "format": "double" }, "bestReturn": { "type": "number", "format": "double" }, "associatedModelAggId": { "type": "integer", "format": "int32" }, "astroTemplate": { "type": "string" }, "portfolioOverview": { "type": "string" }, "portfolioManagementTeam": { "type": "string" }, "excludeRebalanceSleeve": { "description": "If true, then sleeved accounts assigned to this model agg will be excluded from portfolio level rebalances.\r\nThis field is intentionally not mapped in the API POST/PUT save, it is only meant to be synced from Eclipse.", "type": "boolean" }, "excludeFromComposites": { "type": "boolean" }, "eclipseModelType": { "type": "string", "enum": [ "Normal", "Unmanaged", "SelfDirected", "SMA", "Optimizer" ] }, "investmentObjectiveId": { "type": "integer", "format": "int32" }, "researchedStatus": { "type": "string" } }, "xml": { "name": "ModelAggDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.CustomAllocationsDto": { "properties": { "allocation": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.CustomAllocationsDetailDto" }, "newMoney": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.CustomAllocationsDetailDto" } }, "xml": { "name": "CustomAllocationsDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AccountSloaDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "sloaDate": { "type": "string", "format": "date-time" }, "thirdParty": { "type": "string" }, "isAffiliated": { "type": "boolean" }, "distributionType": { "type": "string", "enum": [ "Wire", "Journal", "EFT", "Check", "Other" ] }, "isActive": { "type": "boolean" }, "notes": { "type": "string" } }, "xml": { "name": "AccountSloaDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillAccountScheduleSecurityClassSimpleDto": { "properties": { "securityClassId": { "type": "integer", "format": "int32" }, "securityClassName": { "type": "string" }, "securityClassificationMethodId": { "type": "integer", "format": "int32" }, "securityClassificationMethodName": { "type": "string" } }, "xml": { "name": "BillAccountScheduleSecurityClassSimpleDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Astro.AstroAssetDto": { "properties": { "assetId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "source": { "type": "string" }, "restrictionType": { "type": "string", "enum": [ "None", "DoNotBuy", "DoNotSell", "DoNotTrade", "SellAllShares", "BringWeightTo", "Percent" ] }, "isCustodialCash": { "type": "boolean" }, "minPercentWeight": { "type": "number", "format": "double" }, "maxPercentWeight": { "type": "number", "format": "double" }, "ticker": { "type": "string" }, "shares": { "type": "number", "format": "double" }, "allocation": { "type": "number", "format": "double" } }, "xml": { "name": "AstroAssetDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Astro.SectorDto": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "penalty": { "type": "string" }, "minimumValue": { "type": "number", "format": "double" }, "maximumValue": { "type": "number", "format": "double" }, "industries": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.IndustryDto" }, "xml": { "name": "IndustryDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "SectorDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Astro.AstroSleeveDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "number": { "type": "string" }, "useCustodialRestrictions": { "type": "boolean" }, "restrictionStatus": { "type": "string", "enum": [ "None", "Exists", "Same" ] } }, "xml": { "name": "AstroSleeveDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Astro.EsgCategoryRestrictionDto": { "properties": { "esgCategoryId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "isExcluded": { "type": "boolean" } }, "xml": { "name": "EsgCategoryRestrictionDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.ModelAggDetailDto": { "properties": { "modelId": { "type": "integer", "format": "int32" }, "modelName": { "type": "string" }, "weightPercent": { "type": "number", "format": "double" }, "managementStyle": { "type": "string" }, "managementStyleId": { "type": "integer", "format": "int32" }, "isSMA": { "type": "boolean" }, "assetClassId": { "type": "integer", "format": "int32" }, "riskCategoryId": { "type": "integer", "format": "int32" } }, "xml": { "name": "ModelAggDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.CustomAllocationsDetailDto": { "properties": { "modelAggId": { "type": "integer", "format": "int32" }, "items": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelItemFullDto" }, "xml": { "name": "ModelItemFullDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "CustomAllocationsDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Astro.IndustryDto": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "penalty": { "type": "number", "format": "double" }, "minimumValue": { "type": "number", "format": "double" }, "maximumValue": { "type": "number", "format": "double" }, "sectorId": { "type": "string" } }, "xml": { "name": "IndustryDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.ModelItemFullDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "productClass": { "type": "string" }, "ticker": { "type": "string" }, "targetPercent": { "type": "number", "format": "double" }, "itemTol": { "type": "integer", "format": "int32" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "itemTolUpper": { "type": "number", "format": "double" }, "itemTolLower": { "type": "number", "format": "double" }, "oub": { "type": "number", "format": "double" }, "modelAggId": { "type": "integer", "format": "int32" }, "productRiskScore": { "type": "integer", "format": "int32" } }, "xml": { "name": "ModelItemFullDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.PartialExclusionValidationDto": { "properties": { "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" }, "warningMessage": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "lastName": { "type": "string" }, "fundFamily": { "type": "string" }, "accountNumber": { "type": "string" }, "productName": { "type": "string" }, "value": { "type": "number", "format": "double" }, "isFeeExcluded": { "type": "boolean" }, "isPayingFee": { "type": "boolean" }, "active": { "type": "boolean" }, "ticker": { "type": "string" }, "assetClass": { "type": "string" }, "excludeAmount": { "type": "number", "format": "double" }, "excludeAmountType": { "type": "string", "enum": [ "Percent", "Dollars", "Shares" ] }, "excludePercentOf": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "billAssetId": { "type": "integer", "format": "int32" }, "excludeEndDate": { "type": "string", "format": "date-time" }, "excludeStartDate": { "type": "string", "format": "date-time" }, "businessLine": { "type": "string" }, "representativeName": { "type": "string" }, "representativeNumber": { "type": "string" }, "cycleMonth": { "type": "integer", "format": "int32" }, "fundFamilyId": { "type": "integer", "format": "int32" }, "excludeFromMargin": { "type": "boolean" }, "feeBillExclusionMode": { "type": "string", "enum": [ "No", "YesAll", "SelectBillEntities" ] }, "excludedBillEntities": { "type": "string" }, "productId": { "type": "integer", "format": "int32" } }, "xml": { "name": "PartialExclusionValidationDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.PayForAccountValidationDto": { "properties": { "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" }, "warningMessage": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "number": { "type": "string" }, "isDataSharingEntity": { "type": "boolean" }, "isAstroEnabled": { "type": "boolean" }, "billing": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountBillingDto" }, "portfolio": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountPortfolioDto" }, "modelingInfo": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountModelingInfoDto" }, "notes": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.NoteDto" }, "xml": { "name": "NoteDto", "wrapped": true }, "type": "array" }, "documents": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DocumentDto" }, "xml": { "name": "DocumentDto", "wrapped": true }, "type": "array" }, "compliance": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ComplianceDto" }, "systematics": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SystematicDto" }, "xml": { "name": "SystematicDto", "wrapped": true }, "type": "array" }, "accountManagers": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountManagerDto" }, "xml": { "name": "AccountManagerDto", "wrapped": true }, "type": "array" }, "recurringAdjustments": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BillRecurrentAdjustmentDto" }, "xml": { "name": "BillRecurrentAdjustmentDto", "wrapped": true }, "type": "array" }, "generalAccounts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.GeneralAccountDto" }, "xml": { "name": "GeneralAccountDto", "wrapped": true }, "type": "array" }, "referralSchedules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.AccountReferralDto" }, "xml": { "name": "AccountReferralDto", "wrapped": true }, "type": "array" }, "billAccountSchedules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BillAccountScheduleDto" }, "xml": { "name": "BillAccountScheduleDto", "wrapped": true }, "type": "array" }, "userDefinedFields": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" }, "targetAllocations": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TargetAllocationDto" }, "xml": { "name": "TargetAllocationDto", "wrapped": true }, "type": "array" }, "productEquivalents": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductEquivalentDto" }, "xml": { "name": "ProductEquivalentDto", "wrapped": true }, "type": "array" }, "sma": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountSmaDto" }, "bondTrade": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.AccountBondTradeDto" }, "compositeExclusions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.CompositeAccountExcludeDto" }, "xml": { "name": "CompositeAccountExcludeDto", "wrapped": true }, "type": "array" }, "futureCashflows": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountFutureCashflowDto" }, "xml": { "name": "AccountFutureCashflowDto", "wrapped": true }, "type": "array" }, "growthRates": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountGrowthRateDto" }, "xml": { "name": "AccountGrowthRateDto", "wrapped": true }, "type": "array" }, "goals": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountGoalDto" }, "xml": { "name": "AccountGoalDto", "wrapped": true }, "type": "array" }, "suitability": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountSuitabilityDto" }, "permissibleAggregateModels": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.SimpleAggregateModel" }, "xml": { "name": "SimpleAggregateModel", "wrapped": true }, "type": "array" }, "astroTaxSchedules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.AstroAccountTaxSchedulesDto" }, "xml": { "name": "AstroAccountTaxSchedulesDto", "wrapped": true }, "type": "array" }, "astroAccount": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.AstroAccountDto" }, "taxRates": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountTaxRateDto" }, "xml": { "name": "AccountTaxRateDto", "wrapped": true }, "type": "array" }, "additionalClients": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientAdditionalAccountDto" }, "xml": { "name": "ClientAdditionalAccountDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "PayForAccountValidationDto" }, "type": "object" }, "OAS.WebApi.DTO.Blogging.BlogDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "title": { "type": "string" }, "caption": { "type": "string" }, "body": { "type": "string" }, "publishDate": { "type": "string", "format": "date-time" }, "expiredDate": { "type": "string", "format": "date-time" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] } }, "xml": { "name": "BlogDto" }, "type": "object" }, "OAS.WebApi.DTO.Blogging.EmailListDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "subject": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "attachmentCount": { "type": "integer", "format": "int32" } }, "xml": { "name": "EmailListDto" }, "type": "object" }, "OAS.WebApi.DTO.Blogging.EmailDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "subject": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "sender": { "type": "string" }, "recipient": { "type": "string" }, "messageText": { "type": "string" }, "attachments": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.EmailAttachmentDto" }, "xml": { "name": "EmailAttachmentDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "EmailDto" }, "type": "object" }, "OAS.WebApi.DTO.Blogging.EmailAttachmentDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "blobDesc": { "type": "string" }, "canDownload": { "type": "boolean" } }, "xml": { "name": "EmailAttachmentDto" }, "type": "object" }, "OAS.WebApi.DTO.Blogging.RecipientDto": { "properties": { "userId": { "type": "integer", "format": "int32" }, "userDetailId": { "type": "integer", "format": "int32" }, "loginUserId": { "type": "string" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "isUserDefault": { "type": "boolean" }, "userFirstName": { "type": "string" }, "userLastName": { "type": "string" }, "email": { "type": "string" }, "profileFirstName": { "type": "string" }, "profileLastName": { "type": "string" }, "profileName": { "type": "string" } }, "xml": { "name": "RecipientDto" }, "type": "object" }, "OAS.WebApi.DTO.Blogging.NewEmailDto": { "properties": { "recipients": { "type": "string" }, "subject": { "type": "string" }, "messageText": { "type": "string" }, "notificationMessage": { "type": "string" }, "files": { "items": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" }, "xml": { "name": "HttpFile", "wrapped": true }, "type": "array" } }, "xml": { "name": "NewEmailDto" }, "type": "object" }, "OAS.WebApi.DTO.Blogging.NewsFeedCompilationDto": { "properties": { "compilation": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.NewsfeedViewDto" }, "xml": { "name": "NewsfeedViewDto", "wrapped": true }, "type": "array" }, "previousPublishDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "NewsFeedCompilationDto" }, "type": "object" }, "OAS.WebApi.DTO.Blogging.NewsfeedViewDto": { "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "feedStatus": { "type": "string", "enum": [ "Inactive", "Active", "Draft", "Scheduled", "Published", "EBN", "Statement" ] }, "feedType": { "type": "string", "enum": [ "Post", "Rss", "Notification", "Statement", "Webinar", "AdvisorMaterial" ] }, "caption": { "type": "string" }, "contentText": { "type": "string" }, "url": { "type": "string" }, "publishDate": { "type": "string", "format": "date-time" }, "fileName": { "type": "string" } }, "xml": { "name": "NewsfeedViewDto" }, "type": "object" }, "OAS.WebApi.DTO.Blogging.NewsFeedTypeCountDto": { "properties": { "isEnabled": { "readOnly": true, "type": "boolean" }, "posts": { "type": "integer", "format": "int32" }, "rssFeeds": { "type": "integer", "format": "int32" }, "clientStatements": { "type": "integer", "format": "int32" }, "notifications": { "type": "integer", "format": "int32" } }, "xml": { "name": "NewsFeedTypeCountDto" }, "type": "object" }, "OAS.WebApi.DTO.Blogging.NewsfeedDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "title": { "type": "string" }, "feedStatus": { "type": "string", "enum": [ "Inactive", "Active", "Draft", "Scheduled", "Published", "EBN", "Statement" ] }, "feedType": { "type": "string", "enum": [ "Post", "Rss", "Notification", "Statement", "Webinar", "AdvisorMaterial" ] }, "audienceType": { "type": "string", "enum": [ "Clients", "Reps" ] }, "audience": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.NewsfeedAudienceDto" }, "content": { "$ref": "#/definitions/OAS.WebApi.DTO.Blogging.NewsfeedContentDto" }, "publishDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "categoryId": { "type": "integer", "format": "int32" }, "subCategoryId": { "type": "integer", "format": "int32" }, "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" } }, "xml": { "name": "NewsfeedDto" }, "type": "object" }, "OAS.WebApi.DTO.Blogging.NewsfeedAudienceDto": { "properties": { "includeAllClients": { "type": "boolean" }, "clients": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleClient" }, "xml": { "name": "SimpleClient", "wrapped": true }, "type": "array" }, "isInclusive": { "type": "boolean" }, "brokerDealerIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "audienceFacing": { "type": "string" } }, "xml": { "name": "NewsfeedAudienceDto" }, "type": "object" }, "OAS.WebApi.DTO.Blogging.NewsfeedContentDto": { "properties": { "caption": { "type": "string" }, "contentText": { "type": "string" }, "url": { "type": "string" }, "blobId": { "type": "integer", "format": "int32" }, "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" }, "fileName": { "type": "string" } }, "xml": { "name": "NewsfeedContentDto" }, "type": "object" }, "OAS.DataModel.Portfolio.SimpleClient": { "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "entityName": { "type": "string" }, "isActive": { "type": "boolean" }, "repCode": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "SimpleClient" }, "type": "object" }, "OAS.WebApi.DTO.Blogging.NewsfeedPostGridDto": { "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "feedStatus": { "type": "string", "enum": [ "Inactive", "Active", "Draft", "Scheduled", "Published", "EBN", "Statement" ] }, "audienceSummary": { "type": "string" }, "publishDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" } }, "xml": { "name": "NewsfeedPostGridDto" }, "type": "object" }, "OAS.WebApi.DTO.Blogging.NewsfeedRssGridDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "title": { "type": "string" }, "url": { "type": "string" }, "createdBy": { "type": "string" } }, "xml": { "name": "NewsfeedRssGridDto" }, "type": "object" }, "OAS.WebApi.DTO.Blogging.NewsfeedAdvisorMaterialDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "title": { "type": "string" }, "caption": { "type": "string" }, "url": { "type": "string" }, "feedStatus": { "type": "string", "enum": [ "Inactive", "Active", "Draft", "Scheduled", "Published", "EBN", "Statement" ] }, "audienceType": { "type": "string", "enum": [ "Clients", "Reps" ] }, "audienceFacing": { "type": "string" }, "publishDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "categoryId": { "type": "integer", "format": "int32" }, "feedTypeId": { "type": "integer", "format": "int32" }, "subCategoryId": { "type": "integer", "format": "int32" }, "isInclusive": { "type": "boolean" }, "blobId": { "type": "integer", "format": "int32" }, "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" }, "fileName": { "type": "string" }, "brokerDealerIds": { "type": "string" }, "contextText": { "type": "string" } }, "xml": { "name": "NewsfeedAdvisorMaterialDto" }, "type": "object" }, "OAS.DataModel.Portfolio.AdvisorBlob": { "required": [ "id", "isZip", "uniqueID" ], "properties": { "id": { "type": "integer", "format": "int32" }, "openWith": { "type": "string", "maxLength": 200, "minLength": 0 }, "fileName": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "rowVersion": { "type": "string", "format": "byte" }, "blobDesc": { "type": "string", "maxLength": 200, "minLength": 0 }, "blobText": { "type": "string" }, "isZip": { "type": "boolean" }, "fileNETidmId": { "type": "string", "maxLength": 9, "minLength": 0 }, "filePath": { "type": "string", "maxLength": 500, "minLength": 0 }, "eFileLocation": { "type": "string", "enum": [ "Undefined", "Database", "FileServer", "AmazonS3", "HttpGet", "RedtailIms", "Communities" ] }, "rootPath": { "type": "string", "maxLength": 100, "minLength": 0 }, "uniqueID": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "AdvisorBlob" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.ReportPdfArchiveDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "enabled": { "type": "boolean" }, "lastCompletedDate": { "type": "string", "format": "date-time" }, "lastErrorMessage": { "type": "string" }, "name": { "type": "string" }, "repIdFilter": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "termsAgreedBy": { "type": "string" }, "termsAgreedDate": { "type": "string", "format": "date-time" }, "type": { "type": "string", "enum": [ "Custom", "LPL", "SAI" ] }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "password": { "type": "string", "maxLength": 30, "minLength": 0 }, "uploadTargetId": { "type": "integer", "format": "int32" }, "url": { "type": "string", "maxLength": 255, "minLength": 0 }, "username": { "type": "string", "maxLength": 30, "minLength": 0 }, "pgpUserID": { "type": "string", "maxLength": 50, "minLength": 0 } }, "xml": { "name": "ReportPdfArchiveDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Custom.CustomReportFullDto": { "properties": { "runTo": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RunReport.RunToDto" }, "databaseIdList": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "prompts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportPromptDto" }, "xml": { "name": "CustomReportPromptDto", "wrapped": true }, "type": "array" }, "importTypeId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "scheduleIsActive": { "type": "boolean" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "activeScheduleCount": { "type": "integer", "format": "int32" }, "isCustom": { "type": "boolean" }, "isFavorite": { "type": "boolean" }, "scheduleId": { "type": "integer", "format": "int32" }, "isLandscape": { "type": "boolean" }, "reportClass": { "type": "string" }, "isInternal": { "type": "boolean" }, "guid": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "promptClass": { "type": "string" }, "reportType": { "type": "string", "enum": [ "Query", "CustomImport", "Scrub" ] }, "userOwnerId": { "type": "integer", "format": "int32" }, "queryType": { "readOnly": true, "type": "string", "enum": [ "None", "Custom", "Excel", "All" ] }, "title": { "readOnly": true, "type": "string" }, "isNoteEnabled": { "type": "boolean" }, "isReadOnly": { "type": "boolean" }, "isQuerySmith": { "type": "boolean" }, "category": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "xml": { "name": "CustomReportFullDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.RunReport.RunToDto": { "properties": { "reportFormat": { "type": "string", "enum": [ "Xml", "Null", "Csv", "Image", "PDF", "Html", "Html40", "Html32", "Mhtml", "Excel", "ExcelX", "HtmlOwc", "Json", "CustomImport" ] }, "storageType": { "type": "string" }, "provider": { "type": "string" }, "folderPath": { "type": "string" }, "combinationMethod": { "type": "string", "enum": [ "None", "Aggregate", "Zip", "Merge", "MergeSimplex", "MergeDuplex", "TarGzip" ] }, "userIdList": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "archiveReport": { "type": "boolean" }, "uploadTargetId": { "type": "integer", "format": "int32" }, "source": { "type": "string", "enum": [ "OnDemandUI", "OnDemandAPI", "QueryTester", "Scheduled", "AuditRequestOnDemand", "AuditTestOnDemand", "AuditTestSchedule", "SubscriptionNotification", "ReportBatchSyncDynamicGroupEntities", "ReconCompleteNotification", "DashboardDataAuditProcess", "DashboardDataAuditProcessCountOnly" ] } }, "xml": { "name": "RunToDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Custom.CustomReportPromptDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "code": { "type": "string" }, "prompt": { "type": "string" }, "promptDescription": { "type": "string" }, "promptType": { "type": "string", "enum": [ "None", "Text", "Numeric", "Date", "Dynamic Group" ] }, "defaultValue": { "type": "string" }, "isPromptUser": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" } }, "xml": { "name": "CustomReportPromptDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.AuditRequestItemAttachmentDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "fileName": { "type": "string" }, "blobId_Attachment": { "type": "integer", "format": "int32" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" } }, "xml": { "name": "AuditRequestItemAttachmentDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.AuditRequestItemDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "auditRequestId": { "type": "integer", "format": "int32" }, "category": { "type": "string" }, "type": { "type": "string" }, "description": { "type": "string" }, "customRptId": { "type": "integer", "format": "int32" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "attachments": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditRequestItemAttachmentDto" }, "xml": { "name": "AuditRequestItemAttachmentDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "AuditRequestItemDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.AuditRequestDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "blobId_RequestLetter": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "completedDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "items": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditRequestItemDto" }, "xml": { "name": "AuditRequestItemDto", "wrapped": true }, "type": "array" }, "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" }, "clientName": { "type": "string" }, "alClientId": { "type": "integer", "format": "int32" } }, "xml": { "name": "AuditRequestDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.AuditDefaultRequestCategoryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "displaySequence": { "type": "integer", "format": "int32" }, "items": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditDefaultRequestItemDto" }, "xml": { "name": "AuditDefaultRequestItemDto", "wrapped": true }, "type": "array" }, "alClient": { "type": "integer", "format": "int32" }, "dbName": { "type": "string" } }, "xml": { "name": "AuditDefaultRequestCategoryDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.AuditDefaultRequestItemDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "categoryId": { "type": "integer", "format": "int32" }, "categoryName": { "type": "string" }, "type": { "type": "string" }, "description": { "type": "string" }, "alClientId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "customRptId": { "type": "integer", "format": "int32" }, "displaySequence": { "type": "integer", "format": "int32" }, "dbName": { "type": "string" } }, "xml": { "name": "AuditDefaultRequestItemDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.ComplianceFilterDto": { "properties": { "label": { "type": "string" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "selected": { "items": { "type": "object" }, "type": "array" }, "selectedIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "hideSection": { "type": "boolean" }, "exclude": { "type": "boolean" } }, "xml": { "name": "ComplianceFilterDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.AuditTestResultDto": { "properties": { "categoryDescription": { "type": "string" }, "description": { "type": "string" }, "runDate": { "type": "string", "format": "date-time" }, "comment": { "type": "string" }, "totalRows": { "type": "integer", "format": "int32" }, "completedRows": { "type": "integer", "format": "int32" }, "recordsToReview": { "readOnly": true, "type": "integer", "format": "int32" }, "percentageComplete": { "readOnly": true, "type": "integer", "format": "int32" }, "isCompleted": { "type": "boolean" }, "frequency": { "type": "string", "enum": [ "Daily", "Weekly", "Monthly", "Once" ] }, "sampleSize": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "scheduleTestError": { "type": "string" }, "completedBy": { "type": "string" }, "completedDate": { "type": "string", "format": "date-time" }, "id": { "type": "integer", "format": "int32" }, "recordId": { "type": "integer", "format": "int32" }, "dbName": { "type": "string" }, "testScheduleId": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string" }, "alClientId": { "type": "integer", "format": "int32" }, "comments": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditTestResultCommentDto" }, "xml": { "name": "AuditTestResultCommentDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "AuditTestResultDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.AuditTestResultCommentDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "auditTestResultId": { "type": "integer", "format": "int32" }, "comment": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "AuditTestResultCommentDto" }, "type": "object" }, "OAS.WebApi.Domains.Compliance.AuditTestController.CompletedListDto": { "properties": { "comment": { "type": "string" }, "ids": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "alClientId": { "type": "integer", "format": "int32" } }, "xml": { "name": "CompletedListDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.AuditTestScheduleDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "description": { "type": "string" }, "category": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditTestCategoryDto" }, "comment": { "type": "string" }, "customReportId": { "type": "integer", "format": "int32" }, "customReportTitle": { "type": "string" }, "sampleSize": { "type": "integer", "format": "int32" }, "parameters": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportPromptArrayWithErrorDataDto" }, "frequency": { "type": "string", "enum": [ "Daily", "Weekly", "Monthly", "Once" ] }, "frequencyInfo": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportScheduleFrequencyDto" }, "exclusionInfo": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditTestExclusionDto" }, "timeOfDay": { "type": "string", "format": "date-time" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "lastRunDate": { "type": "string", "format": "date-time" }, "nextRunDate": { "type": "string", "format": "date-time" }, "isActive": { "type": "boolean" }, "categoryDescription": { "readOnly": true, "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "user": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "isDefault": { "type": "boolean" }, "templateId": { "type": "integer", "format": "int32" }, "repId": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "clientName": { "type": "string" } }, "xml": { "name": "AuditTestScheduleDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.AuditTestCategoryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "alClientId": { "type": "integer", "format": "int32" }, "templateCount": { "type": "integer", "format": "int32" }, "scheduleCount": { "type": "integer", "format": "int32" }, "resultCount": { "type": "integer", "format": "int32" }, "inactive": { "type": "boolean" } }, "xml": { "name": "AuditTestCategoryDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Custom.CustomReportPromptArrayWithErrorDataDto": { "properties": { "prompts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportPromptFullDto" }, "xml": { "name": "CustomReportPromptFullDto", "wrapped": true }, "type": "array" }, "isValid": { "type": "boolean" }, "errorMessage": { "type": "string" }, "databaseIdList": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "fileFormat": { "type": "string", "enum": [ "Csv", "Xls", "Xlsx", "Psv" ] }, "fileName": { "type": "string" }, "displayName": { "type": "string" }, "dynamicDateFormat": { "type": "string" } }, "xml": { "name": "CustomReportPromptArrayWithErrorDataDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Custom.CustomReportScheduleFrequencyDto": { "properties": { "interval": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.Frequency.CustomReportScheduleFrequencyIntervalDto" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "timeOfDay": { "type": "string", "format": "date-time" }, "isValid": { "type": "boolean" }, "errorMessage": { "type": "string" } }, "xml": { "name": "CustomReportScheduleFrequencyDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.AuditTestExclusionDto": { "properties": { "type": { "type": "string", "enum": [ "None", "Households", "Registrations", "Accounts", "Transactions", "Assest" ] }, "rangeType": { "type": "string", "enum": [ "Always", "Days", "Weeks", "Months", "Years" ] }, "rangeNumber": { "type": "integer", "format": "int32" } }, "xml": { "name": "AuditTestExclusionDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Custom.CustomReportPromptFullDto": { "properties": { "customReportId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "code": { "type": "string" }, "prompt": { "type": "string" }, "promptDescription": { "type": "string" }, "promptType": { "type": "string", "enum": [ "None", "Text", "Numeric", "Date", "Dynamic Group" ] }, "defaultValue": { "type": "string" }, "isPromptUser": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" } }, "xml": { "name": "CustomReportPromptFullDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Custom.Frequency.CustomReportScheduleFrequencyIntervalDto": { "properties": {}, "xml": { "name": "CustomReportScheduleFrequencyIntervalDto" }, "type": "object" }, "OAS.DataModel.Compliance.AuditTestResultCommentHistory": { "properties": { "comment": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "AuditTestResultCommentHistory" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.AuditTestExceptionResultRowDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "auditTestResultId": { "type": "integer", "format": "int32" }, "queryDescription": { "type": "string" }, "comment": { "type": "string" }, "queryRunDate": { "type": "string", "format": "date-time" }, "hasAttachment": { "type": "boolean" }, "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" }, "lastReviewedBy": { "type": "string" }, "lastReviewedDate": { "type": "string", "format": "date-time" }, "reviewed": { "type": "boolean" }, "exception": { "type": "boolean" }, "dbName": { "type": "string" }, "businessLine": { "type": "string" }, "brokerDealer": { "type": "string" }, "representative": { "type": "string" }, "ria": { "type": "string" }, "managementStyle": { "type": "string" }, "model": { "type": "string" }, "subAdvisor": { "type": "string" }, "custodian": { "type": "string" }, "registrationType": { "type": "string" }, "clientCategory": { "type": "string" }, "recordId": { "type": "integer", "format": "int32" }, "databaseId": { "type": "integer", "format": "int32" } }, "xml": { "name": "AuditTestExceptionResultRowDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.AuditTestResultRowDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "auditTestResultId": { "type": "integer", "format": "int32" }, "comment": { "type": "string" }, "blob_AttachmentId": { "type": "integer", "format": "int32" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" }, "lastReviewedBy": { "type": "string" }, "lastReviewedDate": { "type": "string", "format": "date-time" }, "reviewed": { "type": "boolean" }, "exception": { "type": "boolean" }, "client": { "type": "string" }, "registration": { "type": "string" }, "account": { "type": "string" }, "transaction": { "type": "string" }, "businessLine": { "type": "string" }, "brokerDealer": { "type": "string" }, "model": { "type": "string" }, "subAdvisor": { "type": "string" }, "custodian": { "type": "string" }, "accountType": { "type": "string" }, "registrationType": { "type": "string" }, "clientType": { "type": "string" }, "managementStyle": { "type": "string" } }, "xml": { "name": "AuditTestResultRowDto" }, "type": "object" }, "OAS.DataModel.Compliance.AuditTestResultRow": { "required": [ "id", "auditedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "auditTestResultId": { "type": "integer", "format": "int32" }, "comment": { "type": "string", "maxLength": 1000, "minLength": 0 }, "clientId": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "transactionId": { "type": "integer", "format": "int32" }, "assetId": { "type": "integer", "format": "int32" }, "jsonQueryResults": { "type": "string" }, "blob_AttachmentId": { "type": "integer", "format": "int32" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "lastReviewedBy": { "type": "string" }, "lastReviewedDate": { "type": "string", "format": "date-time" }, "reviewed": { "type": "boolean" }, "isException": { "type": "boolean" }, "attachment": { "$ref": "#/definitions/OAS.DataModel.Compliance.AuditTestResultRowAttachmentBlob" }, "client": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Client" }, "registration": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Registration" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" } }, "xml": { "name": "AuditTestResultRow" }, "type": "object" }, "OAS.DataModel.Compliance.AuditTestResultRowAttachmentBlob": { "required": [ "id", "isZip", "uniqueID" ], "properties": { "auditTestResultRowId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "openWith": { "type": "string", "maxLength": 200, "minLength": 0 }, "fileName": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "rowVersion": { "type": "string", "format": "byte" }, "blobDesc": { "type": "string", "maxLength": 200, "minLength": 0 }, "blobText": { "type": "string" }, "isZip": { "type": "boolean" }, "fileNETidmId": { "type": "string", "maxLength": 9, "minLength": 0 }, "filePath": { "type": "string", "maxLength": 500, "minLength": 0 }, "eFileLocation": { "type": "string", "enum": [ "Undefined", "Database", "FileServer", "AmazonS3", "HttpGet", "RedtailIms", "Communities" ] }, "rootPath": { "type": "string", "maxLength": 100, "minLength": 0 }, "uniqueID": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "AuditTestResultRowAttachmentBlob" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.AuditTestTemplateDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "category": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditTestCategoryDto" }, "comment": { "type": "string" }, "alClientId": { "type": "integer", "format": "int32" }, "clientName": { "type": "string" }, "customReportId": { "type": "integer", "format": "int32" }, "parameters": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportPromptArrayWithErrorDataDto" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "exclusionInfo": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AuditTestExclusionDto" }, "frequency": { "type": "string", "enum": [ "Daily", "Weekly", "Monthly", "Once" ] }, "frequencyInfo": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportScheduleFrequencyDto" }, "isAlert": { "type": "boolean" }, "thisDatabaseOnly": { "type": "boolean" }, "customReportTitle": { "type": "string" }, "customReportDescription": { "type": "string" }, "customReportEntity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "canEdit": { "type": "boolean" }, "categoryDescription": { "readOnly": true, "type": "string" }, "isDefault": { "type": "boolean" }, "canActivate": { "type": "boolean" } }, "xml": { "name": "AuditTestTemplateDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformUserForBccDto": { "properties": { "userId": { "type": "integer", "format": "int32" }, "userDtlId": { "type": "integer", "format": "int32" }, "informUserId": { "type": "integer", "format": "int32" }, "accessPersonId": { "type": "integer", "format": "int32" }, "loginUserId": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "isActiveUser": { "type": "boolean" }, "isActiveAccessPerson": { "type": "boolean" } }, "xml": { "name": "InformUserForBccDto" }, "type": "object" }, "OAS.WebApi.DTO.Security.UserInfoDetailsDto": { "properties": { "profiles": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.ProfileDto" }, "xml": { "name": "ProfileDto", "wrapped": true }, "type": "array" }, "password": { "type": "string" }, "isSecureExchangeRecipient": { "type": "boolean" }, "partnerAppId": { "type": "integer", "format": "int32" }, "twoFactor": { "type": "boolean" }, "errorMessage": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "userId": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "isActive": { "type": "boolean" }, "activeDate": { "type": "string", "format": "date-time" }, "inactiveDate": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time" }, "lastPasswordChange": { "type": "string", "format": "date-time" }, "isReset": { "type": "boolean" }, "mobilePhone": { "type": "string" }, "businessPhone": { "type": "string" }, "businessPhoneExtension": { "type": "string" }, "company": { "type": "string" }, "jobTitle": { "type": "string" }, "entityName": { "type": "string" }, "contactType": { "type": "string", "enum": [ "NotApproved", "Approved", "MainContact", "NoLongerWithFirm" ] }, "createdDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "UserInfoDetailsDto" }, "type": "object" }, "OAS.WebApi.DTO.Security.ProfileDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "loginEntityId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "advisorName": { "type": "string" }, "entityName": { "type": "string" }, "roleId": { "type": "integer", "format": "int32" }, "isUserDefault": { "type": "boolean" }, "alClientId": { "type": "integer", "format": "int32" }, "roleName": { "type": "string" }, "isInCurrentDb": { "type": "boolean" } }, "xml": { "name": "ProfileDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformAccountForBccDto": { "properties": { "informBrokerageAccountId": { "type": "integer", "format": "int32" }, "accessPersonId": { "type": "integer", "format": "int32" }, "informUserId": { "type": "integer", "format": "int32" }, "vendorAccountCode": { "type": "string" }, "accountNumber": { "type": "string" }, "institutionName": { "type": "string" }, "recordSource": { "type": "string", "enum": [ "Unknown", "Quovo", "Retirement", "OrionConnect", "Plaid", "ByAll" ] }, "isActive": { "type": "boolean" } }, "xml": { "name": "InformAccountForBccDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformTransactionForBccDto": { "properties": { "transactionId": { "type": "integer", "format": "int32" }, "accessPersonId": { "type": "integer", "format": "int32" }, "informBrokerageAccountId": { "type": "integer", "format": "int32" }, "price": { "type": "number", "format": "double" }, "quantity": { "type": "number", "format": "double" }, "transactionAmount": { "type": "number", "format": "double" }, "transDate": { "type": "string", "format": "date-time" }, "productName": { "type": "string" }, "sourceCusip": { "type": "string" }, "sourceTicker": { "type": "string" }, "transTypeId": { "type": "integer", "format": "int32" }, "transactionTypeName": { "type": "string" }, "accountNumber": { "type": "string" } }, "xml": { "name": "InformTransactionForBccDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformHoldingForBccDto": { "properties": { "transactionId": { "type": "integer", "format": "int32" }, "accessPersonId": { "type": "integer", "format": "int32" }, "informBrokerageAccountId": { "type": "integer", "format": "int32" }, "price": { "type": "number", "format": "double" }, "quantity": { "type": "number", "format": "double" }, "holdingAmount": { "type": "number", "format": "double" }, "asOfDate": { "type": "string", "format": "date-time" }, "productId": { "type": "integer", "format": "int32" }, "productType": { "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, "sourceProductType": { "type": "string" }, "productName": { "type": "string" }, "cusip": { "type": "string" }, "ticker": { "type": "string" } }, "xml": { "name": "InformHoldingForBccDto" }, "type": "object" }, "OAS.DataModel.Compliance.GetRepresentativesModel": { "properties": { "funds": { "items": { "$ref": "#/definitions/OAS.DataModel.Compliance.GetRepresentativesModel.FundModel" }, "xml": { "name": "FundModel", "wrapped": true }, "type": "array" } }, "xml": { "name": "GetRepresentativesModel" }, "type": "object" }, "OAS.DataModel.Compliance.GetRepresentativesModel.FundModel": { "properties": { "alertId": { "type": "integer", "format": "int32" }, "ticker": { "type": "string" }, "custodian": { "type": "string" } }, "xml": { "name": "FundModel" }, "type": "object" }, "OAS.DataModel.Compliance.NotifyConsultantsModel": { "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "company": { "type": "string" }, "consultantIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "comment": { "type": "string" } }, "xml": { "name": "NotifyConsultantsModel" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.CompassDashboardWidgetDto": { "properties": { "value": { "type": "integer", "format": "int64" } }, "xml": { "name": "CompassDashboardWidgetDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.CompassDashboardTestsDto": { "properties": { "dailyAlerts": { "type": "integer", "format": "int32" }, "value": { "type": "integer", "format": "int64" } }, "xml": { "name": "CompassDashboardTestsDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.CompassDashboardVerifyDto": { "properties": { "lastRunDate": { "type": "string", "format": "date-time" }, "value": { "type": "integer", "format": "int64" } }, "xml": { "name": "CompassDashboardVerifyDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.CompassDashboardInformDto": { "properties": { "exceptions": { "type": "integer", "format": "int32" }, "value": { "type": "integer", "format": "int64" } }, "xml": { "name": "CompassDashboardInformDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.Disclose13FDto": { "properties": { "equityValue": { "type": "number", "format": "double" }, "productListUpdate": { "type": "string", "format": "date-time" } }, "xml": { "name": "Disclose13FDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.Disclose13FSummaryReportDto": { "properties": { "tableMarketValue": { "type": "number", "format": "double" }, "tableEntryTotal": { "type": "integer", "format": "int32" } }, "xml": { "name": "Disclose13FSummaryReportDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.DiscloseAdvAumDto": { "properties": { "aum": { "type": "number", "format": "double" }, "smaAum": { "type": "number", "format": "double" }, "accounts": { "type": "integer", "format": "int32" }, "registrations": { "type": "integer", "format": "int32" }, "clients": { "type": "integer", "format": "int32" } }, "xml": { "name": "DiscloseAdvAumDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.DiscloseAdvSloaDto": { "properties": { "aum": { "type": "number", "format": "double" }, "totalActiveSloas": { "type": "integer", "format": "int32" }, "numberOfHouseholds": { "type": "integer", "format": "int32" }, "numberOfAccounts": { "type": "integer", "format": "int32" } }, "xml": { "name": "DiscloseAdvSloaDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.DiscloseAdvCustodyDto": { "properties": { "custodyTypeId": { "type": "integer", "format": "int32" }, "label": { "type": "string" }, "totalAccounts": { "type": "integer", "format": "int32" }, "households": { "type": "integer", "format": "int32" }, "custodyDollars": { "type": "number", "format": "double" } }, "xml": { "name": "DiscloseAdvCustodyDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.DiscloseAuaAumDto": { "properties": { "aum": { "type": "number", "format": "double" }, "accounts": { "type": "integer", "format": "int32" }, "registrations": { "type": "integer", "format": "int32" }, "clients": { "type": "integer", "format": "int32" } }, "xml": { "name": "DiscloseAuaAumDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.DiscloseAuaProductDto": { "properties": { "products": { "type": "integer", "format": "int32" }, "assets": { "type": "integer", "format": "int32" } }, "xml": { "name": "DiscloseAuaProductDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.DisclosDashboardEntityDto": { "properties": { "label": { "type": "string" }, "aum": { "type": "number", "format": "double" }, "count": { "type": "integer", "format": "int32" }, "percentage": { "type": "number", "format": "double" } }, "xml": { "name": "DisclosDashboardEntityDto" }, "type": "object" }, "OAS.DataProcess.DTO.Compliance.ADVConsolidatedDetailDto": { "properties": { "databaseId": { "type": "integer", "format": "int32" }, "database": { "type": "string" }, "asOfDate": { "type": "string", "format": "date-time" }, "pkClient": { "type": "integer", "format": "int32" }, "clientName": { "type": "string" }, "pkRegistration": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "pkAccount": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "isSleeveAccount": { "type": "boolean" }, "sma": { "type": "boolean" }, "fkRep": { "type": "integer", "format": "int32" }, "representative": { "type": "string" }, "fkPlatform": { "type": "integer", "format": "int32" }, "managementStyle": { "type": "string" }, "fkRia": { "type": "integer", "format": "int32" }, "ria": { "type": "string" }, "fkCustodian": { "type": "integer", "format": "int32" }, "custodian": { "type": "string" }, "fkClientCat": { "type": "integer", "format": "int32" }, "clientCategory": { "type": "string" }, "fkRegistrationType": { "type": "integer", "format": "int32" }, "registrationType": { "type": "string" }, "fkBrokerDealer": { "type": "integer", "format": "int32" }, "brokerDealer": { "type": "string" }, "fkSubAdvisor": { "type": "integer", "format": "int32" }, "subAdvisor": { "type": "string" }, "fkBusinessLine": { "type": "integer", "format": "int32" }, "businessLine": { "type": "string" }, "fkAdvCustodyType": { "type": "integer", "format": "int32" }, "custodyTypeName": { "type": "string" }, "fkModelAgg": { "type": "integer", "format": "int32" }, "aggregationName": { "type": "string" }, "discretionary": { "type": "string" }, "accountStatus": { "type": "string" }, "isAdvReportable": { "type": "boolean" }, "isWrapManaged": { "type": "boolean" }, "isWrapSponsored": { "type": "boolean" }, "aum": { "type": "number", "format": "double" }, "smA_AUM": { "type": "number", "format": "double" }, "accruedInterest": { "type": "number", "format": "double" }, "advClientCategory": { "type": "string" }, "generatedAt": { "type": "string", "format": "date-time" } }, "xml": { "name": "ADVConsolidatedDetailDto" }, "type": "object" }, "OAS.WebApi.Domains.Compliance.DiscloseController.AdvDetailUpdateDto": { "properties": { "alClientId": { "type": "integer", "format": "int32" }, "ids": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "field": { "type": "string" }, "value": { "type": "string" }, "asOfDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "AdvDetailUpdateDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.AdvAssetCategoryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string" } }, "xml": { "name": "AdvAssetCategoryDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.AdvClientCategoryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string" } }, "xml": { "name": "AdvClientCategoryDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.ValidateTemplateImportRowDto": { "properties": { "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" }, "warningMessage": { "type": "string" }, "questionNumber": { "type": "integer", "format": "int32" }, "questionText": { "type": "string" }, "questionType": { "type": "string", "enum": [ "Text", "Radio", "AccountList", "UploadDocument", "Date", "Currency", "MultiCheckbox" ] }, "policyId": { "type": "integer", "format": "int32" }, "affirmationId": { "type": "integer", "format": "int32" }, "showTransactionHistory": { "type": "boolean" }, "transactionStartDate": { "type": "string", "format": "date-time" }, "transactionEndDate": { "type": "string", "format": "date-time" }, "showActiveAccounts": { "type": "boolean" }, "option1": { "type": "string" }, "option2": { "type": "string" }, "option3": { "type": "string" }, "option1_Child_QuestionText": { "type": "string" }, "option1_Child_QuestionType": { "type": "string", "enum": [ "Text", "Radio", "AccountList", "UploadDocument", "Date", "Currency", "MultiCheckbox" ] }, "option1_Child_Option1": { "type": "string" }, "option1_Child_Option2": { "type": "string" }, "option1_Child_Option3": { "type": "string" }, "option2_Child_QuestionText": { "type": "string" }, "option2_Child_QuestionType": { "type": "string", "enum": [ "Text", "Radio", "AccountList", "UploadDocument", "Date", "Currency", "MultiCheckbox" ] }, "option2_Child_Option1": { "type": "string" }, "option2_Child_Option2": { "type": "string" }, "option2_Child_Option3": { "type": "string" }, "option3_Child_QuestionText": { "type": "string" }, "option3_Child_QuestionType": { "type": "string", "enum": [ "Text", "Radio", "AccountList", "UploadDocument", "Date", "Currency", "MultiCheckbox" ] }, "option3_Child_Option1": { "type": "string" }, "option3_Child_Option2": { "type": "string" }, "option3_Child_Option3": { "type": "string" } }, "xml": { "name": "ValidateTemplateImportRowDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformTemplateImportRowDto": { "properties": { "questionNumber": { "type": "integer", "format": "int32" }, "questionText": { "type": "string" }, "questionType": { "type": "string", "enum": [ "Text", "Radio", "AccountList", "UploadDocument", "Date", "Currency", "MultiCheckbox" ] }, "policyId": { "type": "integer", "format": "int32" }, "affirmationId": { "type": "integer", "format": "int32" }, "showTransactionHistory": { "type": "boolean" }, "transactionStartDate": { "type": "string", "format": "date-time" }, "transactionEndDate": { "type": "string", "format": "date-time" }, "showActiveAccounts": { "type": "boolean" }, "option1": { "type": "string" }, "option2": { "type": "string" }, "option3": { "type": "string" }, "option1_Child_QuestionText": { "type": "string" }, "option1_Child_QuestionType": { "type": "string", "enum": [ "Text", "Radio", "AccountList", "UploadDocument", "Date", "Currency", "MultiCheckbox" ] }, "option1_Child_Option1": { "type": "string" }, "option1_Child_Option2": { "type": "string" }, "option1_Child_Option3": { "type": "string" }, "option2_Child_QuestionText": { "type": "string" }, "option2_Child_QuestionType": { "type": "string", "enum": [ "Text", "Radio", "AccountList", "UploadDocument", "Date", "Currency", "MultiCheckbox" ] }, "option2_Child_Option1": { "type": "string" }, "option2_Child_Option2": { "type": "string" }, "option2_Child_Option3": { "type": "string" }, "option3_Child_QuestionText": { "type": "string" }, "option3_Child_QuestionType": { "type": "string", "enum": [ "Text", "Radio", "AccountList", "UploadDocument", "Date", "Currency", "MultiCheckbox" ] }, "option3_Child_Option1": { "type": "string" }, "option3_Child_Option2": { "type": "string" }, "option3_Child_Option3": { "type": "string" } }, "xml": { "name": "InformTemplateImportRowDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformTemplateDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "templateName": { "type": "string" }, "created": { "type": "integer", "format": "int32" }, "pending": { "type": "integer", "format": "int32" }, "completed": { "type": "integer", "format": "int32" }, "percentageCompleted": { "readOnly": true, "type": "integer", "format": "int32" }, "templateType": { "type": "string", "enum": [ "Task", "Questionnaire", "PreClearance", "BrokerageAccount", "TradeViolation", "AccessPerson", "AccessPersonNew", "AccessPersonInactive", "AccessPersonAll", "DuplicateAccessPerson", "TaskWithMultiple" ] }, "distributionDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time" }, "isLocked": { "type": "boolean" }, "questions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformTemplateQuestionDto" }, "xml": { "name": "InformTemplateQuestionDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "InformTemplateDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformTemplateQuestionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "informTemplateId": { "type": "integer", "format": "int32" }, "questionText": { "type": "string" }, "questionType": { "type": "string", "enum": [ "Text", "Radio", "AccountList", "UploadDocument", "Date", "Currency", "MultiCheckbox" ] }, "questionNumber": { "type": "integer", "format": "int32" }, "parentQuestionId": { "type": "integer", "format": "int32" }, "parentOptionId": { "type": "integer", "format": "int32" }, "showActiveAccounts": { "type": "boolean" }, "showTransactionHistory": { "type": "boolean" }, "transactionStartDate": { "type": "string", "format": "date-time" }, "transactionEndDate": { "type": "string", "format": "date-time" }, "affirmation": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformAffirmationDto" }, "policy": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformPolicyDto" }, "options": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformTemplateQuestionOptionDto" }, "xml": { "name": "InformTemplateQuestionOptionDto", "wrapped": true }, "type": "array" }, "parentOptionText": { "type": "string" }, "slickGridColumnHeader": { "readOnly": true, "type": "string" }, "slickGridColumnHeaderWithType": { "readOnly": true, "type": "string" } }, "xml": { "name": "InformTemplateQuestionDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformAffirmationDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "affirmation": { "type": "string" }, "informPolicyId": { "type": "integer", "format": "int32" }, "policyName": { "readOnly": true, "type": "string" }, "isActive": { "type": "boolean" }, "policy": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformPolicyDto" } }, "xml": { "name": "InformAffirmationDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformPolicyDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "policyName": { "type": "string" }, "libraryType": { "type": "string", "enum": [ "Policy", "Manual", "Form" ] }, "isActive": { "type": "boolean" }, "isVisible": { "type": "boolean" }, "auditedByDisplay": { "type": "string" }, "documents": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformPolicyDocumentDto" }, "xml": { "name": "InformPolicyDocumentDto", "wrapped": true }, "type": "array" }, "currentDocument": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformPolicyDocumentDto", "readOnly": true }, "currentFileName": { "readOnly": true, "type": "string" }, "currentEffectiveDate": { "readOnly": true, "type": "string", "format": "date-time" }, "newEffectiveDate": { "type": "string", "format": "date-time" }, "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" } }, "xml": { "name": "InformPolicyDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformTemplateQuestionOptionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "informTemplateQuestionId": { "type": "integer", "format": "int32" }, "optionSequence": { "type": "integer", "format": "int32" }, "optionText": { "type": "string" }, "childQuestion": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformTemplateQuestionDto" }, "childAnswer": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformDocumentAnswerDto" }, "multiAnswer": { "type": "boolean" } }, "xml": { "name": "InformTemplateQuestionOptionDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformPolicyDocumentDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "informPolicyId": { "type": "integer", "format": "int32" }, "blobId": { "type": "integer", "format": "int32" }, "fileName": { "type": "string" }, "effectiveDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "InformPolicyDocumentDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformDocumentAnswerDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "informTemplateQuestionId": { "type": "integer", "format": "int32" }, "parentTemplateQuestionId": { "type": "integer", "format": "int32" }, "parentOptionId": { "type": "integer", "format": "int32" }, "informDocumentId": { "type": "integer", "format": "int32" }, "answer": { "type": "string" }, "dateOnlyAnswer": { "readOnly": true, "type": "string" }, "multiCheckboxAnswers": { "readOnly": true, "type": "string" }, "questionText": { "type": "string" }, "questionType": { "type": "string", "enum": [ "Text", "Radio", "AccountList", "UploadDocument", "Date", "Currency", "MultiCheckbox" ] }, "questionNumber": { "type": "integer", "format": "int32" }, "showActiveAccounts": { "type": "boolean" }, "showTransactionHistory": { "type": "boolean" }, "transactionStartDate": { "type": "string", "format": "date-time" }, "transactionEndDate": { "type": "string", "format": "date-time" }, "show": { "type": "boolean" }, "questionOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformTemplateQuestionOptionDto" }, "xml": { "name": "InformTemplateQuestionOptionDto", "wrapped": true }, "type": "array" }, "attachments": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformDocumentAnswerAttachmentDto" }, "xml": { "name": "InformDocumentAnswerAttachmentDto", "wrapped": true }, "type": "array" }, "policyId": { "type": "integer", "format": "int32" }, "policyName": { "type": "string" } }, "xml": { "name": "InformDocumentAnswerDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformDocumentAnswerAttachmentDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "informDocumentAnswerId": { "type": "integer", "format": "int32" }, "blobId": { "type": "integer", "format": "int32" }, "comment": { "type": "string" }, "informBrokerageAccountId": { "type": "integer", "format": "int32" }, "fileName": { "type": "string" }, "auditedDateTime": { "type": "string", "format": "date-time" } }, "xml": { "name": "InformDocumentAnswerAttachmentDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.ValidateMonitoredProductImportRowDto": { "properties": { "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" }, "warningMessage": { "type": "string" }, "entityId": { "type": "integer", "format": "int32" }, "entityType": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "approveType": { "type": "string", "enum": [ "AutoApprove", "AutoDeny", "ManualReview" ] }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "ValidateMonitoredProductImportRowDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformMonitoredProductImportRowDto": { "properties": { "entityId": { "type": "integer", "format": "int32" }, "entityType": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "approveType": { "type": "string", "enum": [ "AutoApprove", "AutoDeny", "ManualReview" ] }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "InformMonitoredProductImportRowDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformMonitoredProductDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "entityType": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "entityName": { "readOnly": true, "type": "string" }, "approveType": { "type": "string", "enum": [ "AutoApprove", "AutoDeny", "ManualReview" ] }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "productName": { "type": "string" }, "ticker": { "type": "string" }, "cusip": { "type": "string" }, "productType": { "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, "assetClassDescription": { "type": "string" }, "assetCategory": { "type": "string" }, "assetProvider": { "type": "string" } }, "xml": { "name": "InformMonitoredProductDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformLicenseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "license": { "type": "string" }, "isActive": { "type": "boolean" }, "isDefault": { "type": "boolean" } }, "xml": { "name": "InformLicenseDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformLicenseSummaryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "license": { "type": "string" }, "employeeCount": { "type": "integer", "format": "int32" } }, "xml": { "name": "InformLicenseSummaryDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformLicenseAccessPersonDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "firstName": { "readOnly": true, "type": "string" }, "lastName": { "readOnly": true, "type": "string" }, "license": { "type": "string" }, "officeLocationName": { "type": "string" }, "jobTitle": { "readOnly": true, "type": "string" }, "homeAddress1": { "type": "string" }, "homeAddress2": { "type": "string" }, "homeCity": { "type": "string" }, "homeState": { "type": "string" }, "homeZip": { "type": "string" }, "licenseId": { "type": "integer", "format": "int32" }, "accessPersonId": { "type": "integer", "format": "int32" }, "personalId": { "type": "integer", "format": "int32" }, "deletedUser": { "readOnly": true, "type": "boolean" }, "personal": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformPersonalDto" } }, "xml": { "name": "InformLicenseAccessPersonDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformPersonalDto": { "properties": { "deletedUser": { "type": "boolean" }, "deletedDate": { "type": "string", "format": "date-time" }, "salutation": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "name": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "address3": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "homePhone": { "type": "string" }, "homePhoneExt": { "type": "string" }, "fax": { "type": "string" }, "faxExt": { "type": "string" }, "pager": { "type": "string" }, "pagerExt": { "type": "string" }, "mobilePhone": { "type": "string" }, "businessPhone": { "type": "string" }, "businessPhoneExt": { "type": "string" }, "otherPhone": { "type": "string" }, "otherPhoneExt": { "type": "string" }, "email": { "type": "string" }, "reportName": { "type": "string" }, "company": { "type": "string" }, "jobTitle": { "type": "string" }, "ssN_TaxID": { "type": "string" }, "gender": { "type": "string" }, "webAddress": { "type": "string" }, "dob": { "type": "string" }, "birthDate": { "readOnly": true, "type": "string", "format": "date-time" }, "id": { "type": "integer", "format": "int32" } }, "xml": { "name": "InformPersonalDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformOfficeLocationDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "personalId": { "type": "integer", "format": "int32" }, "lastName": { "type": "string" }, "name": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "address3": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "businessPhone": { "type": "string" }, "businessPhoneExt": { "type": "string" }, "isActive": { "type": "boolean" }, "employeeCount": { "type": "integer", "format": "int32" } }, "xml": { "name": "InformOfficeLocationDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformOfficeEmployeeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "firstName": { "readOnly": true, "type": "string" }, "lastName": { "readOnly": true, "type": "string" }, "email": { "readOnly": true, "type": "string" }, "businessPhone": { "readOnly": true, "type": "string" }, "mobilePhone": { "readOnly": true, "type": "string" }, "userRole": { "type": "string" }, "officeLocationName": { "type": "string" }, "department": { "type": "string" }, "jobTitle": { "readOnly": true, "type": "string" }, "officeLocationId": { "type": "integer", "format": "int32" }, "personal": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformPersonalDto" } }, "xml": { "name": "InformOfficeEmployeeDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformBrokerageAccountDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "lastName": { "readOnly": true, "type": "string" }, "firstName": { "readOnly": true, "type": "string" }, "fullName": { "readOnly": true, "type": "string" }, "institutionName": { "type": "string" }, "accountName": { "type": "string" }, "nickName": { "type": "string" }, "accountValue": { "type": "number", "format": "double" }, "valueAsOfDate": { "type": "string", "format": "date-time" }, "managedAccount": { "type": "boolean" }, "statementFrequency": { "type": "string", "enum": [ "Quarterly", "Monthly", "Other" ] }, "comment": { "type": "string" }, "accessPersonId": { "type": "integer", "format": "int32" }, "recordSource": { "type": "string", "enum": [ "Unknown", "Quovo", "Retirement", "OrionConnect", "Plaid", "ByAll" ] }, "currentStatus": { "readOnly": true, "type": "string", "enum": [ "New", "NotSubmitted", "Submitted", "Approved", "Denied", "AutoApprove", "AutoDeny", "ClosePending", "Closed", "Active", "FollowUp", "Canceled", "BrokenConnection" ] }, "statusDate": { "readOnly": true, "type": "string", "format": "date-time" }, "userDetailId": { "type": "integer", "format": "int32" }, "files": { "items": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" }, "xml": { "name": "HttpFile", "wrapped": true }, "type": "array" }, "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" }, "attachments": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformDocumentAnswerAttachmentDto" }, "xml": { "name": "InformDocumentAnswerAttachmentDto", "wrapped": true }, "type": "array" }, "documentId": { "type": "integer", "format": "int32" }, "accessPerson": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformAccessPersonDto" }, "statusHistory": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformStatusDto" }, "xml": { "name": "InformStatusDto", "wrapped": true }, "type": "array" }, "hasStaleHoldings": { "type": "boolean" }, "isActive": { "type": "boolean" }, "sourceAccountCode": { "type": "string" }, "sourceAccountId": { "type": "string" }, "informConnectionId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "isElectraOption": { "type": "boolean" }, "isAccountNumberValidated": { "type": "boolean" }, "connection": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformConnectionDto" }, "holdings": { "items": { "$ref": "#/definitions/OAS.DataModel.Compliance.InformHolding" }, "xml": { "name": "InformHolding", "wrapped": true }, "type": "array" } }, "xml": { "name": "InformBrokerageAccountDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformAccessPersonDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "userDetailId": { "type": "integer", "format": "int32" }, "personalId": { "type": "integer", "format": "int32" }, "firstName": { "readOnly": true, "type": "string" }, "lastName": { "readOnly": true, "type": "string" }, "fullName": { "readOnly": true, "type": "string" }, "jobTitle": { "readOnly": true, "type": "string" }, "email": { "readOnly": true, "type": "string" }, "businessPhone": { "readOnly": true, "type": "string" }, "mobilePhone": { "readOnly": true, "type": "string" }, "birthDate": { "readOnly": true, "type": "string", "format": "date-time" }, "deletedUser": { "readOnly": true, "type": "boolean" }, "deletedDate": { "readOnly": true, "type": "string", "format": "date-time" }, "userRole": { "type": "string" }, "loginEntityId": { "type": "string", "enum": [ "BrokerDealer", "Wholesaler", "Representative", "Client", "RIA", "Administrator", "SubAdvisor", "ThirdPartyAdministrator", "Custodian", "PlanSponsor", "ThirdParty", "ServiceAccount", "Participant", "RepAccountManager", "Payee", "RIATable", "Cotenant" ] }, "isActive": { "type": "boolean" }, "employmentDate": { "type": "string", "format": "date-time" }, "terminationDate": { "type": "string", "format": "date-time" }, "crd": { "type": "integer", "format": "int32" }, "u4": { "type": "boolean" }, "iar": { "type": "boolean" }, "homeAddress1": { "type": "string" }, "homeAddress2": { "type": "string" }, "homeCity": { "type": "string" }, "homeState": { "type": "string" }, "homeZip": { "type": "string" }, "userProfileCreated": { "type": "string", "format": "date-time" }, "notes": { "type": "string" }, "isEmployeeViewable": { "type": "boolean" }, "personal": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformPersonalDto" }, "licenses": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.AccessPersonLicenseDto" }, "xml": { "name": "AccessPersonLicenseDto", "wrapped": true }, "type": "array" }, "officeLocationName": { "type": "string" }, "officeLocationId": { "type": "integer", "format": "int32" }, "departmentName": { "type": "string" }, "informDepartmentId": { "type": "integer", "format": "int32" }, "quovoUserId": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "userProfileIsDefault": { "type": "boolean" }, "loginUserId": { "type": "string" }, "entityId": { "type": "integer", "format": "int32" } }, "xml": { "name": "InformAccessPersonDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformStatusDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "documentId": { "type": "integer", "format": "int32" }, "brokerageAccountId": { "type": "integer", "format": "int32" }, "preClearanceId": { "type": "integer", "format": "int32" }, "status": { "type": "string", "enum": [ "New", "NotSubmitted", "Submitted", "Approved", "Denied", "AutoApprove", "AutoDeny", "ClosePending", "Closed", "Active", "FollowUp", "Canceled", "BrokenConnection" ] }, "comment": { "type": "string" }, "showComment": { "type": "boolean" }, "sentEmailId": { "type": "integer", "format": "int32" }, "tradeViolationId": { "type": "integer", "format": "int32" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "accessPersonId": { "type": "integer", "format": "int32" }, "email": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.SentEmailDto" } }, "xml": { "name": "InformStatusDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformConnectionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "institutionName": { "type": "string" }, "connectionStatus": { "type": "string" }, "connectionStatusDescription": { "type": "string" }, "lastName": { "readOnly": true, "type": "string" }, "firstName": { "readOnly": true, "type": "string" }, "fullName": { "readOnly": true, "type": "string" }, "connectionTotalValue": { "type": "number", "format": "double" }, "created": { "type": "string", "format": "date-time" }, "isActive": { "type": "boolean" }, "lastGoodSync": { "type": "string", "format": "date-time" }, "lastSync": { "type": "string", "format": "date-time" }, "isAccessPersonActive": { "readOnly": true, "type": "boolean" }, "sourceConnectionId": { "type": "string" }, "sourceUserId": { "type": "integer", "format": "int64" }, "informUserId": { "type": "integer", "format": "int32" }, "requiresAttention": { "readOnly": true, "type": "integer", "format": "int32" }, "autoUpdates": { "type": "boolean" }, "configInstructions": { "type": "string" }, "userName": { "type": "string" }, "brokerageAccounts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformBrokerageAccountDto" }, "xml": { "name": "InformBrokerageAccountDto", "wrapped": true }, "type": "array" }, "accessPerson": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformAccessPersonDto" }, "status": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformConnectionStatusDto" }, "informUser": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformUserDto" }, "toBeDeleted": { "type": "boolean" }, "sourceCreatedDate": { "type": "string", "format": "date-time" }, "institutionId": { "type": "string" }, "downloadFormatId": { "type": "integer", "format": "int32" }, "downloadFormatName": { "type": "string" } }, "xml": { "name": "InformConnectionDto" }, "type": "object" }, "OAS.DataModel.Compliance.InformHolding": { "required": [ "id", "informBrokerageAccountId", "price", "quantity", "holdingAmount" ], "properties": { "id": { "type": "integer", "format": "int32" }, "informBrokerageAccountId": { "type": "integer", "format": "int32" }, "sourceHoldingId": { "type": "string" }, "ticker": { "type": "string", "maxLength": 50, "minLength": 0 }, "cusip": { "type": "string", "maxLength": 50, "minLength": 0 }, "symbolName": { "type": "string", "maxLength": 255, "minLength": 0 }, "sourceProductType": { "type": "string", "maxLength": 100, "minLength": 0 }, "productId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "price": { "type": "number", "format": "double" }, "quantity": { "type": "number", "format": "double" }, "holdingAmount": { "type": "number", "format": "double" }, "accessPersonId": { "type": "integer", "format": "int32" }, "sourceAccountId": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "accessPerson": { "$ref": "#/definitions/OAS.DataModel.Compliance.AccessPerson" }, "brokerageAccount": { "$ref": "#/definitions/OAS.DataModel.Compliance.InformBrokerageAccount" }, "product": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductLocal" } }, "xml": { "name": "InformHolding" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.AccessPersonLicenseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "accessPersonId": { "type": "integer", "format": "int32" }, "informLicenseId": { "type": "integer", "format": "int32" }, "licenseDescription": { "type": "string" } }, "xml": { "name": "AccessPersonLicenseDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.SentEmailDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "userIdSender": { "type": "integer", "format": "int32" }, "userIdRecipient": { "type": "integer", "format": "int32" }, "sentDate": { "type": "string", "format": "date-time" }, "email": { "$ref": "#/definitions/OAT.Utilities.Email.EmailVerbose" }, "_email": { "type": "string" }, "parentId": { "type": "integer", "format": "int32" }, "accessPersonId": { "type": "integer", "format": "int32" } }, "xml": { "name": "SentEmailDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformConnectionStatusDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "connectionStatus": { "type": "string" }, "connectionDescription": { "type": "string" }, "requiresUserAction": { "type": "integer", "format": "int32" } }, "xml": { "name": "InformConnectionStatusDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformUserDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "downloadSourceId": { "type": "integer", "format": "int32" }, "sourceUserID": { "type": "integer", "format": "int64" }, "userDtlId": { "type": "integer", "format": "int32" }, "accessPersonId": { "type": "integer", "format": "int32" }, "accessPerson": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformAccessPersonDto" }, "downloadFormatId": { "type": "integer", "format": "int32" }, "downloadFormatName": { "type": "string" }, "connections": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformConnectionDto" }, "xml": { "name": "InformConnectionDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "InformUserDto" }, "type": "object" }, "OAS.DataModel.Compliance.AccessPerson": { "required": [ "id", "userDetailId", "personalId", "loginEntityId", "isActive", "u4", "iar" ], "properties": { "id": { "type": "integer", "format": "int32" }, "userDetailId": { "type": "integer", "format": "int32" }, "personalId": { "type": "integer", "format": "int32" }, "loginEntityId": { "type": "string", "enum": [ "BrokerDealer", "Wholesaler", "Representative", "Client", "RIA", "Administrator", "SubAdvisor", "ThirdPartyAdministrator", "Custodian", "PlanSponsor", "ThirdParty", "ServiceAccount", "Participant", "RepAccountManager", "Payee", "RIATable", "Cotenant" ] }, "isActive": { "type": "boolean" }, "employmentDate": { "type": "string", "format": "date-time" }, "terminationDate": { "type": "string", "format": "date-time" }, "crd": { "type": "integer", "format": "int32" }, "u4": { "type": "boolean" }, "iar": { "type": "boolean" }, "homeAddress1": { "type": "string", "maxLength": 255, "minLength": 0 }, "homeAddress2": { "type": "string", "maxLength": 255, "minLength": 0 }, "homeCity": { "type": "string", "maxLength": 30, "minLength": 0 }, "homeState": { "type": "string", "maxLength": 2, "minLength": 0 }, "homeZip": { "type": "string", "maxLength": 10, "minLength": 0 }, "officeLocationId": { "type": "integer", "format": "int32" }, "notes": { "type": "string", "maxLength": 512, "minLength": 0 }, "informDepartmentId": { "type": "integer", "format": "int32" }, "isEmployeeViewable": { "type": "boolean" }, "officeLocation": { "$ref": "#/definitions/OAS.DataModel.Compliance.InformOfficeLocation" }, "licenses": { "items": { "$ref": "#/definitions/OAS.DataModel.Compliance.AccessPersonLicense" }, "xml": { "name": "AccessPersonLicense", "wrapped": true }, "type": "array" }, "department": { "$ref": "#/definitions/OAS.DataModel.Compliance.InformDepartment" } }, "xml": { "name": "AccessPerson" }, "type": "object" }, "OAS.DataModel.Compliance.InformBrokerageAccount": { "required": [ "id", "managedAccount", "statementFrequency" ], "properties": { "id": { "type": "integer", "format": "int32" }, "managedAccount": { "type": "boolean" }, "statementFrequency": { "type": "string", "enum": [ "Quarterly", "Monthly", "Other" ] }, "comment": { "type": "string", "maxLength": 1000, "minLength": 0 }, "documentId": { "type": "integer", "format": "int32" }, "nickName": { "type": "string", "maxLength": 100, "minLength": 0 }, "sourceNickName": { "type": "string" }, "accessPersonId": { "type": "integer", "format": "int32" }, "recordSource": { "type": "string", "enum": [ "Unknown", "Quovo", "Retirement", "OrionConnect", "Plaid", "ByAll" ] }, "institutionName": { "type": "string", "maxLength": 128, "minLength": 0 }, "accountName": { "type": "string", "maxLength": 50, "minLength": 0 }, "isActive": { "type": "boolean" }, "sourceAccountCode": { "type": "string" }, "sourceAccountId": { "type": "string" }, "informConnectionId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string", "maxLength": 50, "minLength": 0 }, "isElectraOption": { "type": "boolean" }, "isAccountNumberValidated": { "type": "boolean" }, "connection": { "$ref": "#/definitions/OAS.DataModel.Compliance.InformConnection" }, "holdings": { "items": { "$ref": "#/definitions/OAS.DataModel.Compliance.InformHolding" }, "xml": { "name": "InformHolding", "wrapped": true }, "type": "array" }, "documentAnswerAttachments": { "items": { "$ref": "#/definitions/OAS.DataModel.Compliance.InformDocumentAnswerAttachment" }, "xml": { "name": "InformDocumentAnswerAttachment", "wrapped": true }, "type": "array" }, "statusHistory": { "items": { "$ref": "#/definitions/OAS.DataModel.Compliance.InformStatus" }, "xml": { "name": "InformStatus", "wrapped": true }, "type": "array" }, "accessPerson": { "$ref": "#/definitions/OAS.DataModel.Compliance.AccessPerson" } }, "xml": { "name": "InformBrokerageAccount" }, "type": "object" }, "OAT.Utilities.Email.EmailVerbose": { "properties": { "from": { "type": "string" }, "to": { "type": "string" }, "subject": { "type": "string" }, "body": { "type": "string" }, "isHtml": { "type": "boolean" }, "cc": { "type": "string" }, "bcc": { "type": "string" }, "host": { "type": "string" }, "useEmailFilter": { "type": "boolean" }, "attachment": { "$ref": "#/definitions/System.Net.Mail.Attachment" }, "alternateViews": { "items": { "$ref": "#/definitions/System.Net.Mail.AlternateView" }, "xml": { "name": "AlternateView", "wrapped": true }, "type": "array" } }, "xml": { "name": "EmailVerbose" }, "type": "object" }, "OAS.DataModel.Compliance.InformOfficeLocation": { "required": [ "id", "personalId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "personalId": { "type": "integer", "format": "int32" }, "personal": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Personal" } }, "xml": { "name": "InformOfficeLocation" }, "type": "object" }, "OAS.DataModel.Compliance.AccessPersonLicense": { "required": [ "id", "accessPersonId", "informLicenseId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "accessPersonId": { "type": "integer", "format": "int32" }, "informLicenseId": { "type": "integer", "format": "int32" }, "detail": { "$ref": "#/definitions/OAS.DataModel.Compliance.InformLicense" }, "person": { "$ref": "#/definitions/OAS.DataModel.Compliance.AccessPerson" } }, "xml": { "name": "AccessPersonLicense" }, "type": "object" }, "OAS.DataModel.Compliance.InformDepartment": { "required": [ "id", "department", "isActive", "isDefault" ], "properties": { "id": { "type": "integer", "format": "int32" }, "department": { "type": "string", "maxLength": 100, "minLength": 0 }, "isActive": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "InformDepartment" }, "type": "object" }, "OAS.DataModel.Compliance.InformConnection": { "required": [ "id", "informUserId", "isActive" ], "properties": { "id": { "type": "integer", "format": "int32" }, "informUserId": { "type": "integer", "format": "int32" }, "connectionStatus": { "type": "string", "maxLength": 255, "minLength": 0 }, "isActive": { "type": "boolean" }, "sourceCreatedDate": { "type": "string", "format": "date-time" }, "institutionName": { "type": "string", "maxLength": 255, "minLength": 0 }, "lastGoodSync": { "type": "string", "format": "date-time" }, "lastSync": { "type": "string", "format": "date-time" }, "brokerageAccounts": { "items": { "$ref": "#/definitions/OAS.DataModel.Compliance.InformBrokerageAccount" }, "xml": { "name": "InformBrokerageAccount", "wrapped": true }, "type": "array" }, "informUser": { "$ref": "#/definitions/OAS.DataModel.Compliance.InformUser" }, "sourceConnectionId": { "type": "string" }, "institutionId": { "type": "string" }, "sourceUserId": { "type": "integer", "format": "int64" } }, "xml": { "name": "InformConnection" }, "type": "object" }, "OAS.DataModel.Compliance.InformDocumentAnswerAttachment": { "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int32" }, "informDocumentAnswerId": { "type": "integer", "format": "int32" }, "blobId": { "type": "integer", "format": "int32" }, "comment": { "type": "string", "maxLength": 2000, "minLength": 0 }, "informBrokerageAccountId": { "type": "integer", "format": "int32" }, "auditedDate": { "type": "string", "format": "date-time" }, "blob": { "$ref": "#/definitions/OAS.EntityFramework.Configuration.Advisor.Compliance.InformAttachmentBlob" } }, "xml": { "name": "InformDocumentAnswerAttachment" }, "type": "object" }, "OAS.DataModel.Compliance.InformStatus": { "required": [ "id", "status", "showComment", "createdDate", "createdBy" ], "properties": { "id": { "type": "integer", "format": "int32" }, "documentId": { "type": "integer", "format": "int32" }, "brokerageAccountId": { "type": "integer", "format": "int32" }, "preClearanceId": { "type": "integer", "format": "int32" }, "sentEmailId": { "type": "integer", "format": "int32" }, "tradeViolationId": { "type": "integer", "format": "int32" }, "status": { "type": "string", "enum": [ "New", "NotSubmitted", "Submitted", "Approved", "Denied", "AutoApprove", "AutoDeny", "ClosePending", "Closed", "Active", "FollowUp", "Canceled", "BrokenConnection" ] }, "comment": { "type": "string", "maxLength": 2000, "minLength": 0 }, "showComment": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "email": { "$ref": "#/definitions/OAS.DataModel.Compliance.SentEmail" }, "accessPersonId": { "type": "integer", "format": "int32" } }, "xml": { "name": "InformStatus" }, "type": "object" }, "System.Net.Mail.Attachment": { "properties": { "name": { "type": "string" }, "nameEncoding": { "$ref": "#/definitions/System.Text.Encoding" }, "contentDisposition": { "$ref": "#/definitions/System.Net.Mime.ContentDisposition", "readOnly": true }, "contentStream": { "$ref": "#/definitions/System.IO.Stream", "readOnly": true }, "contentId": { "type": "string" }, "contentType": { "$ref": "#/definitions/System.Net.Mime.ContentType" }, "transferEncoding": { "type": "string", "enum": [ "QuotedPrintable", "Base64", "SevenBit", "EightBit", "Unknown" ] } }, "xml": { "name": "Attachment" }, "type": "object" }, "System.Net.Mail.AlternateView": { "properties": { "linkedResources": { "items": { "$ref": "#/definitions/System.Net.Mail.LinkedResource" }, "readOnly": true, "xml": { "name": "LinkedResource", "wrapped": true }, "type": "array" }, "baseUri": { "type": "string" }, "contentStream": { "$ref": "#/definitions/System.IO.Stream", "readOnly": true }, "contentId": { "type": "string" }, "contentType": { "$ref": "#/definitions/System.Net.Mime.ContentType" }, "transferEncoding": { "type": "string", "enum": [ "QuotedPrintable", "Base64", "SevenBit", "EightBit", "Unknown" ] } }, "xml": { "name": "AlternateView" }, "type": "object" }, "OAS.DataModel.Compliance.InformLicense": { "required": [ "id", "license", "isActive", "isDefault" ], "properties": { "id": { "type": "integer", "format": "int32" }, "license": { "type": "string", "maxLength": 100, "minLength": 4 }, "isActive": { "type": "boolean" }, "isDefault": { "type": "boolean" } }, "xml": { "name": "InformLicense" }, "type": "object" }, "OAS.DataModel.Compliance.InformUser": { "required": [ "id", "sourceUserID", "userDtlId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "downloadSourceId": { "type": "integer", "format": "int32" }, "sourceUserID": { "type": "integer", "format": "int64" }, "userDtlId": { "type": "integer", "format": "int32" }, "accessPersonId": { "type": "integer", "format": "int32" }, "accessPerson": { "$ref": "#/definitions/OAS.DataModel.Compliance.AccessPerson" }, "connections": { "items": { "$ref": "#/definitions/OAS.DataModel.Compliance.InformConnection" }, "xml": { "name": "InformConnection", "wrapped": true }, "type": "array" }, "downloadSource": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadSource" }, "informUserDetailPersonal": { "$ref": "#/definitions/OAS.DataModel.Compliance.InformUserDetailPersonal" } }, "xml": { "name": "InformUser" }, "type": "object" }, "OAS.EntityFramework.Configuration.Advisor.Compliance.InformAttachmentBlob": { "required": [ "id", "createdDate", "createdBy", "editedBy", "editedDate", "isZip", "isDeleted" ], "properties": { "informDocumentAnswerId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "openWith": { "type": "string", "maxLength": 200, "minLength": 0 }, "fileName": { "type": "string", "maxLength": 150, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedBy": { "type": "string", "maxLength": 150, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "blobDesc": { "type": "string", "maxLength": 200, "minLength": 0 }, "blobType": { "type": "string", "maxLength": 20, "minLength": 0 }, "isZip": { "type": "boolean" }, "isDeleted": { "type": "boolean" }, "blobDataIsNull": { "type": "boolean" }, "accessPersonId": { "type": "integer", "format": "int32" } }, "xml": { "name": "InformAttachmentBlob" }, "type": "object" }, "OAS.DataModel.Compliance.SentEmail": { "required": [ "id", "userIdSender", "userIdRecipient", "sentDate", "emailJson", "accessPersonId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "userIdSender": { "type": "integer", "format": "int32" }, "userIdRecipient": { "type": "integer", "format": "int32" }, "sentDate": { "type": "string", "format": "date-time" }, "emailJson": { "type": "string", "maxLength": 4000, "minLength": 0 }, "accessPersonId": { "type": "integer", "format": "int32" } }, "xml": { "name": "SentEmail" }, "type": "object" }, "System.Text.Encoding": { "properties": { "bodyName": { "readOnly": true, "type": "string" }, "encodingName": { "readOnly": true, "type": "string" }, "headerName": { "readOnly": true, "type": "string" }, "webName": { "readOnly": true, "type": "string" }, "windowsCodePage": { "readOnly": true, "type": "integer", "format": "int32" }, "isBrowserDisplay": { "readOnly": true, "type": "boolean" }, "isBrowserSave": { "readOnly": true, "type": "boolean" }, "isMailNewsDisplay": { "readOnly": true, "type": "boolean" }, "isMailNewsSave": { "readOnly": true, "type": "boolean" }, "isSingleByte": { "readOnly": true, "type": "boolean" }, "encoderFallback": { "$ref": "#/definitions/System.Text.EncoderFallback" }, "decoderFallback": { "$ref": "#/definitions/System.Text.DecoderFallback" }, "isReadOnly": { "readOnly": true, "type": "boolean" }, "codePage": { "readOnly": true, "type": "integer", "format": "int32" } }, "xml": { "name": "Encoding" }, "type": "object" }, "System.Net.Mime.ContentDisposition": { "properties": { "dispositionType": { "type": "string" }, "parameters": { "items": { "type": "object" }, "readOnly": true, "type": "array" }, "fileName": { "type": "string" }, "creationDate": { "type": "string", "format": "date-time" }, "modificationDate": { "type": "string", "format": "date-time" }, "inline": { "type": "boolean" }, "readDate": { "type": "string", "format": "date-time" }, "size": { "type": "integer", "format": "int64" } }, "xml": { "name": "ContentDisposition" }, "type": "object" }, "System.IO.Stream": { "properties": { "canRead": { "readOnly": true, "type": "boolean" }, "canSeek": { "readOnly": true, "type": "boolean" }, "canTimeout": { "readOnly": true, "type": "boolean" }, "canWrite": { "readOnly": true, "type": "boolean" }, "length": { "readOnly": true, "type": "integer", "format": "int64" }, "position": { "type": "integer", "format": "int64" }, "readTimeout": { "type": "integer", "format": "int32" }, "writeTimeout": { "type": "integer", "format": "int32" } }, "xml": { "name": "Stream" }, "type": "object" }, "System.Net.Mime.ContentType": { "properties": { "boundary": { "type": "string" }, "charSet": { "type": "string" }, "mediaType": { "type": "string" }, "name": { "type": "string" }, "parameters": { "items": { "type": "object" }, "readOnly": true, "type": "array" } }, "xml": { "name": "ContentType" }, "type": "object" }, "System.Net.Mail.LinkedResource": { "properties": { "contentLink": { "type": "string" }, "contentStream": { "$ref": "#/definitions/System.IO.Stream", "readOnly": true }, "contentId": { "type": "string" }, "contentType": { "$ref": "#/definitions/System.Net.Mime.ContentType" }, "transferEncoding": { "type": "string", "enum": [ "QuotedPrintable", "Base64", "SevenBit", "EightBit", "Unknown" ] } }, "xml": { "name": "LinkedResource" }, "type": "object" }, "OAS.DataModel.Compliance.InformUserDetailPersonal": { "required": [ "accessPersonId", "userDtlId" ], "properties": { "accessPersonId": { "type": "integer", "format": "int32" }, "userDtlId": { "type": "integer", "format": "int32" }, "isActiveAccessPerson": { "type": "boolean" }, "userId": { "type": "integer", "format": "int32" }, "loginEntityId": { "type": "integer", "format": "int32" }, "userKey": { "type": "integer", "format": "int32" }, "isDeletedUserDtl": { "type": "boolean" }, "personalId": { "type": "integer", "format": "int32" }, "entityEnum": { "type": "integer", "format": "int32" }, "loginUserId": { "type": "string", "maxLength": 200, "minLength": 0 }, "isActiveUser": { "type": "boolean" }, "firstName": { "type": "string", "maxLength": 30, "minLength": 0 }, "lastName": { "type": "string", "maxLength": 255, "minLength": 0 }, "entityName": { "type": "string", "maxLength": 255, "minLength": 0 }, "addressLine1": { "type": "string", "maxLength": 255, "minLength": 0 }, "addressLine2": { "type": "string", "maxLength": 255, "minLength": 0 }, "addressLine3": { "type": "string", "maxLength": 255, "minLength": 0 }, "city": { "type": "string", "maxLength": 30, "minLength": 0 }, "state": { "type": "string", "maxLength": 2, "minLength": 0 }, "zip": { "type": "string", "maxLength": 10, "minLength": 0 }, "homePhone": { "type": "string" }, "phHomeExt": { "type": "string" }, "businessPhone": { "type": "string" }, "businessPhoneExtension": { "type": "string" }, "mobilePhone": { "type": "string" }, "phFax": { "type": "string" }, "phFaxExt": { "type": "string" }, "email": { "type": "string" }, "prefix": { "type": "string" }, "suffix": { "type": "string" }, "entityType": { "type": "integer", "format": "int32" }, "isActivePersonal": { "type": "boolean" }, "jobTitle": { "type": "string" }, "company": { "type": "string" }, "dob": { "type": "string" }, "isDeletedPersonal": { "type": "boolean" }, "deletedDate": { "type": "string", "format": "date-time" }, "informUser": { "$ref": "#/definitions/OAS.DataModel.Compliance.InformUser" } }, "xml": { "name": "InformUserDetailPersonal" }, "type": "object" }, "System.Text.EncoderFallback": { "properties": { "maxCharCount": { "readOnly": true, "type": "integer", "format": "int32" } }, "xml": { "name": "EncoderFallback" }, "type": "object" }, "System.Text.DecoderFallback": { "properties": { "maxCharCount": { "readOnly": true, "type": "integer", "format": "int32" } }, "xml": { "name": "DecoderFallback" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformPreClearanceDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "fullName": { "readOnly": true, "type": "string" }, "lastName": { "readOnly": true, "type": "string" }, "firstName": { "readOnly": true, "type": "string" }, "description": { "readOnly": true, "type": "string" }, "created": { "readOnly": true, "type": "string", "format": "date-time" }, "tradeDate": { "type": "string", "format": "date-time" }, "tradeValue": { "type": "number", "format": "double" }, "tradeStatus": { "readOnly": true, "type": "string", "enum": [ "Executed", "Expired", "PendingExecution" ] }, "status": { "readOnly": true, "type": "string", "enum": [ "New", "NotSubmitted", "Submitted", "Approved", "Denied", "AutoApprove", "AutoDeny", "ClosePending", "Closed", "Active", "FollowUp", "Canceled", "BrokenConnection" ] }, "statusDate": { "readOnly": true, "type": "string", "format": "date-time" }, "statusComment": { "readOnly": true, "type": "string" }, "symbol": { "readOnly": true, "type": "string" }, "comment": { "type": "string" }, "quantity": { "type": "number", "format": "double" }, "isIPO": { "type": "boolean" }, "userDetailId": { "type": "integer", "format": "int32" }, "accessPersonId": { "type": "integer", "format": "int32" }, "brokerageAccountId": { "type": "integer", "format": "int32" }, "isOption": { "type": "boolean" }, "optionExpirationDate": { "type": "string", "format": "date-time" }, "strikePrice": { "type": "number", "format": "double" }, "accessPerson": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformAccessPersonDto" }, "statusHistory": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformStatusDto" }, "xml": { "name": "InformStatusDto", "wrapped": true }, "type": "array" }, "product": { "$ref": "#/definitions/OAS.DataModel.Search.SearchProduct" }, "accountTitle": { "type": "string" }, "lastUpdated": { "readOnly": true, "type": "string", "format": "date-time" }, "lastUpdatedBy": { "readOnly": true, "type": "string" }, "matchPreClearanceDescription": { "readOnly": true, "type": "string" }, "informTransactionId": { "type": "integer", "format": "int32" }, "transTypeDescription": { "type": "string" }, "transTypeId": { "type": "integer", "format": "int32" }, "transSubTypeId": { "type": "integer", "format": "int32" }, "informTransaction": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformTransactionDto" }, "brokerageAccount": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformBrokerageAccountDto" }, "transType": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TransactionTypeDto" }, "transSubType": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TransactionSubTypeDto" }, "nickName": { "type": "string" } }, "xml": { "name": "InformPreClearanceDto" }, "type": "object" }, "OAS.DataModel.Search.SearchProduct": { "properties": { "productId": { "type": "integer", "format": "int32" }, "ticker": { "type": "string" }, "productName": { "type": "string" }, "productType": { "type": "integer", "format": "int32" } }, "xml": { "name": "SearchProduct" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformTransactionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "downloadSourceId": { "type": "integer", "format": "int32" }, "informBrokerageAccountId": { "type": "integer", "format": "int32" }, "informHoldingId": { "type": "integer", "format": "int32" }, "sourceTransactionID": { "type": "string" }, "transDate": { "type": "string", "format": "date-time" }, "price": { "type": "number", "format": "double" }, "quantity": { "type": "number", "format": "double" }, "feeAmount": { "type": "number", "format": "double" }, "transactionAmount": { "type": "number", "format": "double" }, "productId": { "type": "integer", "format": "int32" }, "sourceTicker": { "type": "string" }, "sourceCusip": { "type": "string" }, "symbolName": { "type": "string" }, "transTypeId": { "type": "integer", "format": "int32" }, "transTypeDescription": { "type": "string" }, "sourceTransType": { "type": "string" }, "transSubTypeId": { "type": "integer", "format": "int32" }, "transSubTypeDescription": { "type": "string" }, "sourceTransSubType": { "type": "string" }, "memo": { "type": "string" }, "additionalMemo": { "type": "string" }, "sourceRecordID": { "type": "integer", "format": "int64" }, "accessPersonId": { "type": "integer", "format": "int32" }, "informReconciliationId": { "type": "integer", "format": "int64" }, "jobID": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "reconStatus": { "type": "integer", "format": "int32" }, "sourceAccountId": { "type": "string" }, "account": { "readOnly": true, "type": "string" }, "accountName": { "type": "string" }, "accountNickName": { "type": "string" }, "institutionName": { "type": "string" }, "ticker": { "type": "string" }, "cusip": { "type": "string" }, "productName": { "type": "string" }, "productType": { "type": "string" }, "transactionDetails": { "readOnly": true, "type": "string" }, "accessPerson": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformAccessPersonDto" }, "brokerageAccount": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformBrokerageAccountDto" }, "transactionType": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TransactionTypeDto" }, "transactionSubType": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TransactionSubTypeDto" }, "preClearanceId": { "type": "integer", "format": "int32" } }, "xml": { "name": "InformTransactionDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.TransactionSubTypeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string" }, "transTypeCommonId": { "type": "integer", "format": "int32" } }, "xml": { "name": "TransactionSubTypeDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.DocumentAlert": { "properties": { "templateName": { "type": "string" }, "templateId": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" }, "templateType": { "type": "string", "enum": [ "Task", "Questionnaire", "PreClearance", "BrokerageAccount", "TradeViolation", "AccessPerson", "AccessPersonNew", "AccessPersonInactive", "AccessPersonAll", "DuplicateAccessPerson", "TaskWithMultiple" ] } }, "xml": { "name": "DocumentAlert" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformRulesEngineDto": { "properties": { "rules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformRuleDto" }, "xml": { "name": "InformRuleDto", "wrapped": true }, "type": "array" }, "monitoredProducts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformMonitoredProductDto" }, "xml": { "name": "InformMonitoredProductDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "InformRulesEngineDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformRuleDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "informRuleType": { "type": "string", "enum": [ "PreClearance", "DeMinimis", "IPO", "FrontRunning", "SecuritiesViolation", "ShortSale", "RoundTrip30" ] }, "recordType": { "type": "string", "enum": [ "PreClearance", "PostTrade", "PreAndPostTrade" ] }, "isActive": { "type": "boolean" }, "deMinimisRule": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformDeMinimisRuleDto" }, "preclearanceRules": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformPreClearanceRuleDto" }, "frontRunningRule": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformFrontRunningRuleDto" }, "shortSaleProducts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformShortSaleProductDto" }, "xml": { "name": "InformShortSaleProductDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "InformRuleDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformDeMinimisRuleDto": { "properties": { "unitPriceMax": { "type": "integer", "format": "int32" }, "shareQuantity": { "type": "integer", "format": "int32" }, "shareDays": { "type": "integer", "format": "int32" }, "tradeDollars": { "type": "integer", "format": "int32" }, "tradeDays": { "type": "integer", "format": "int32" } }, "xml": { "name": "InformDeMinimisRuleDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformPreClearanceRuleDto": { "properties": { "isAutoApprove": { "type": "boolean" } }, "xml": { "name": "InformPreClearanceRuleDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformFrontRunningRuleDto": { "properties": { "daysBefore": { "type": "integer", "format": "int32" }, "daysAfter": { "type": "integer", "format": "int32" } }, "xml": { "name": "InformFrontRunningRuleDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformShortSaleProductDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "ticker": { "type": "string" }, "isActive": { "type": "boolean" } }, "xml": { "name": "InformShortSaleProductDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformMonitoredProductAuditDto": { "properties": { "changeType": { "type": "string" }, "informMonitoredProductId": { "type": "integer", "format": "int32" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "monitoredProduct": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformMonitoredProductDto" }, "id": { "type": "integer", "format": "int32" }, "entityType": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "entityName": { "readOnly": true, "type": "string" }, "approveType": { "type": "string", "enum": [ "AutoApprove", "AutoDeny", "ManualReview" ] }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "productName": { "type": "string" }, "ticker": { "type": "string" }, "cusip": { "type": "string" }, "productType": { "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, "assetClassDescription": { "type": "string" }, "assetCategory": { "type": "string" }, "assetProvider": { "type": "string" } }, "xml": { "name": "InformMonitoredProductAuditDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformTradeViolationAlertDto": { "properties": { "countSecuritiesViolations": { "type": "integer", "format": "int32" }, "countFrontRunning": { "type": "integer", "format": "int32" }, "countPreClearance": { "type": "integer", "format": "int32" }, "count30RoundTrip": { "type": "integer", "format": "int32" } }, "xml": { "name": "InformTradeViolationAlertDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformTradeViolationDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "lastName": { "readOnly": true, "type": "string" }, "firstName": { "readOnly": true, "type": "string" }, "fullName": { "readOnly": true, "type": "string" }, "created": { "readOnly": true, "type": "string", "format": "date-time" }, "tradeDate": { "type": "string", "format": "date-time" }, "account": { "type": "string" }, "institutionName": { "type": "string" }, "transactionDetails": { "readOnly": true, "type": "string" }, "isPreClearance": { "type": "boolean" }, "isSecuritiesViolation": { "type": "boolean" }, "isFrontRunning": { "type": "boolean" }, "isRoundTrip30": { "type": "boolean" }, "violationDetails": { "type": "string" }, "status": { "readOnly": true, "type": "string", "enum": [ "New", "NotSubmitted", "Submitted", "Approved", "Denied", "AutoApprove", "AutoDeny", "ClosePending", "Closed", "Active", "FollowUp", "Canceled", "BrokenConnection" ] }, "statusDate": { "readOnly": true, "type": "string", "format": "date-time" }, "outcome": { "type": "string", "enum": [ "None", "VerbalWarning", "WrittenWarning", "LossOfPrivileges", "Termination", "FalsePositive", "Other" ] }, "statusComment": { "readOnly": true, "type": "string" }, "informTransactionId": { "type": "integer", "format": "int32" }, "userDetailId": { "type": "integer", "format": "int32" }, "accessPersonId": { "type": "integer", "format": "int32" }, "statusHistory": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformStatusDto" }, "xml": { "name": "InformStatusDto", "wrapped": true }, "type": "array" }, "accessPerson": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformAccessPersonDto" }, "_linkedTransactions": { "type": "string" }, "linkedTransactions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformLinkedTransactionDto" }, "xml": { "name": "InformLinkedTransactionDto", "wrapped": true }, "type": "array" }, "informTransaction": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformTransactionDto" } }, "xml": { "name": "InformTradeViolationDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformLinkedTransactionDto": { "properties": { "alClientId": { "type": "integer", "format": "int32" }, "transactionId": { "type": "integer", "format": "int32" }, "tradeDate": { "type": "string", "format": "date-time" }, "symbol": { "type": "string" }, "description": { "type": "string" }, "action": { "type": "string" }, "quantity": { "type": "number", "format": "double" }, "pricePerUnit": { "type": "number", "format": "double" }, "value": { "type": "number", "format": "double" }, "dbClientName": { "type": "string" }, "clientName": { "type": "string" }, "eclipseOrderId": { "type": "integer", "format": "int32" }, "representativeId": { "type": "integer", "format": "int32" }, "recordSource": { "type": "string", "enum": [ "Unknown", "Quovo", "Retirement", "OrionConnect", "Plaid", "ByAll" ] } }, "xml": { "name": "InformLinkedTransactionDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformTradeViolationMassUpdateDto": { "properties": { "tradeViolationIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "outcome": { "type": "string", "enum": [ "None", "VerbalWarning", "WrittenWarning", "LossOfPrivileges", "Termination", "FalsePositive", "Other" ] }, "comment": { "type": "string" } }, "xml": { "name": "InformTradeViolationMassUpdateDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformTemplateQuestionnaireGridDto": { "properties": { "distributed": { "readOnly": true, "type": "string", "format": "date-time" }, "due": { "readOnly": true, "type": "string", "format": "date-time" }, "followUpItems": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "templateName": { "type": "string" }, "created": { "type": "integer", "format": "int32" }, "pending": { "type": "integer", "format": "int32" }, "completed": { "type": "integer", "format": "int32" }, "percentageCompleted": { "readOnly": true, "type": "integer", "format": "int32" }, "templateType": { "type": "string", "enum": [ "Task", "Questionnaire", "PreClearance", "BrokerageAccount", "TradeViolation", "AccessPerson", "AccessPersonNew", "AccessPersonInactive", "AccessPersonAll", "DuplicateAccessPerson", "TaskWithMultiple" ] }, "distributionDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time" }, "isLocked": { "type": "boolean" }, "questions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformTemplateQuestionDto" }, "xml": { "name": "InformTemplateQuestionDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "InformTemplateQuestionnaireGridDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformTemplateTaskGridDto": { "properties": { "isActive": { "type": "boolean" }, "id": { "type": "integer", "format": "int32" }, "templateName": { "type": "string" }, "created": { "type": "integer", "format": "int32" }, "pending": { "type": "integer", "format": "int32" }, "completed": { "type": "integer", "format": "int32" }, "percentageCompleted": { "readOnly": true, "type": "integer", "format": "int32" }, "templateType": { "type": "string", "enum": [ "Task", "Questionnaire", "PreClearance", "BrokerageAccount", "TradeViolation", "AccessPerson", "AccessPersonNew", "AccessPersonInactive", "AccessPersonAll", "DuplicateAccessPerson", "TaskWithMultiple" ] }, "distributionDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time" }, "isLocked": { "type": "boolean" }, "questions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformTemplateQuestionDto" }, "xml": { "name": "InformTemplateQuestionDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "InformTemplateTaskGridDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformHoldingDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "fullName": { "type": "string" }, "lastName": { "type": "string" }, "firstName": { "type": "string" }, "informBrokerageAccountId": { "type": "integer", "format": "int32" }, "sourceHoldingID": { "type": "string" }, "productId": { "type": "integer", "format": "int32" }, "account": { "readOnly": true, "type": "string" }, "accountName": { "type": "string" }, "accountNickName": { "type": "string" }, "ticker": { "type": "string" }, "cusip": { "type": "string" }, "productName": { "type": "string" }, "quantity": { "type": "number", "format": "double" }, "price": { "type": "number", "format": "double" }, "holdingAmount": { "type": "number", "format": "double" }, "productType": { "type": "string" }, "accessPersonId": { "type": "integer", "format": "int32" }, "institutionName": { "type": "string" }, "sourceAccountId": { "type": "string" }, "accessPerson": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformAccessPersonDto" }, "brokerageAccount": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformBrokerageAccountDto" } }, "xml": { "name": "InformHoldingDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformAccessPersonAlertDto": { "properties": { "templateName": { "type": "string" }, "count": { "type": "integer", "format": "int32" }, "templateType": { "type": "string", "enum": [ "Task", "Questionnaire", "PreClearance", "BrokerageAccount", "TradeViolation", "AccessPerson", "AccessPersonNew", "AccessPersonInactive", "AccessPersonAll", "DuplicateAccessPerson", "TaskWithMultiple" ] } }, "xml": { "name": "InformAccessPersonAlertDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformTradeHistoryDto": { "properties": { "rowId": { "type": "integer", "format": "int64" }, "quovoTransactionId": { "type": "integer", "format": "int64" }, "informTransactionId": { "type": "integer", "format": "int32" }, "preClearanceId": { "type": "integer", "format": "int32" }, "quovoAccountId": { "type": "integer", "format": "int32" }, "brokerageAccountId": { "type": "integer", "format": "int32" }, "tradeViolationId": { "type": "integer", "format": "int32" }, "userDetailId": { "type": "integer", "format": "int32" }, "accessPersonId": { "type": "integer", "format": "int32" }, "lastName": { "readOnly": true, "type": "string" }, "firstName": { "readOnly": true, "type": "string" }, "fullName": { "readOnly": true, "type": "string" }, "account": { "readOnly": true, "type": "string" }, "accountName": { "type": "string" }, "accountNickName": { "type": "string" }, "tradeDate": { "readOnly": true, "type": "string", "format": "date-time" }, "transactionType": { "type": "string" }, "symbol": { "type": "string" }, "cusip": { "type": "string" }, "symbolDescription": { "type": "string" }, "quantity": { "type": "number", "format": "double" }, "price": { "type": "number", "format": "double" }, "totalValue": { "type": "number", "format": "double" }, "status": { "type": "string", "enum": [ "New", "NotSubmitted", "Submitted", "Approved", "Denied", "AutoApprove", "AutoDeny", "ClosePending", "Closed", "Active", "FollowUp", "Canceled", "BrokenConnection" ] }, "tradeStatus": { "readOnly": true, "type": "string", "enum": [ "Executed", "Expired", "PendingExecution" ] }, "institutionName": { "type": "string" }, "isSecuritiesViolation": { "readOnly": true, "type": "boolean" }, "isFrontRunning": { "readOnly": true, "type": "boolean" }, "isPreClearance": { "readOnly": true, "type": "boolean" }, "isRoundTrip30": { "readOnly": true, "type": "boolean" }, "outcome": { "readOnly": true, "type": "string", "enum": [ "None", "VerbalWarning", "WrittenWarning", "LossOfPrivileges", "Termination", "FalsePositive", "Other" ] }, "isHistorical": { "type": "boolean" }, "statusHistory": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformStatusDto" }, "xml": { "name": "InformStatusDto", "wrapped": true }, "type": "array" }, "tradeViolation": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformTradeViolationDto" }, "productId": { "type": "integer", "format": "int32" }, "accessPerson": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformAccessPersonDto" }, "product": { "$ref": "#/definitions/OAS.DataModel.Search.SearchProduct" } }, "xml": { "name": "InformTradeHistoryDto" }, "type": "object" }, "OAS.DataProcess.Compliance.ByAllConsolidateSSOResponse": { "properties": { "errorMessage": { "type": "string" }, "errorCode": { "type": "integer", "format": "int32" }, "sSOResponse": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.SSOResponse" }, "addUserResponse": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.AddUserResponse" } }, "xml": { "name": "ByAllConsolidateSSOResponse" }, "type": "object" }, "OAT.Integrations.ByAllAccounts.SSOResponse": { "properties": { "version": { "type": "string" }, "loginResponse": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.LoginResponse" }, "sessionAuthResponse": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.SessionAuthResponse" } }, "xml": { "name": "SSOResponse" }, "type": "object" }, "OAT.Integrations.ByAllAccounts.AddUserResponse": { "properties": { "version": { "type": "string" }, "loginResponse": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.LoginResponse" }, "body": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.AddUserResponseBody" } }, "xml": { "name": "AddUserResponse" }, "type": "object" }, "OAT.Integrations.ByAllAccounts.LoginResponse": { "properties": { "status": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.Status" } }, "xml": { "name": "LoginResponse" }, "type": "object" }, "OAT.Integrations.ByAllAccounts.SessionAuthResponse": { "properties": { "status": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.Status" }, "applicationUrl": { "type": "string" }, "sessionId": { "type": "string" }, "csrfToken": { "type": "string" } }, "xml": { "name": "SessionAuthResponse" }, "type": "object" }, "OAT.Integrations.ByAllAccounts.AddUserResponseBody": { "properties": { "status": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.Status" }, "id": { "type": "string" }, "fpId": { "type": "string" } }, "xml": { "name": "AddUserResponseBody" }, "type": "object" }, "OAT.Integrations.ByAllAccounts.Status": { "properties": { "errorCode": { "type": "integer", "format": "int32" }, "errorMessage": { "type": "string" } }, "xml": { "name": "Status" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformDocumentAnswerAttachmentFilesDto": { "properties": { "files": { "items": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" }, "xml": { "name": "HttpFile", "wrapped": true }, "type": "array" }, "attachments": { "type": "string" } }, "xml": { "name": "InformDocumentAnswerAttachmentFilesDto" }, "type": "object" }, "OAS.DataModel.Compliance.InformComment": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "comment": { "type": "string" } }, "xml": { "name": "InformComment" }, "type": "object" }, "OAS.DataModel.Compliance.AggregatorMessage": { "properties": { "recordSource": { "type": "string", "enum": [ "Unknown", "Quovo", "Retirement", "OrionConnect", "Plaid", "ByAll" ] }, "sourceCall": { "type": "string" }, "errorCode": { "type": "integer", "format": "int32" }, "errorMessage": { "type": "string" }, "informIdLevel": { "type": "string", "enum": [ "User", "Connection", "Account" ] }, "informId": { "type": "integer", "format": "int32" }, "sourceId": { "type": "string" } }, "xml": { "name": "AggregatorMessage" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformConnectionAlertDto": { "properties": { "quovoConnectionId": { "type": "integer", "format": "int32" }, "institutionName": { "type": "string" }, "connectionStatus": { "type": "string" }, "count": { "type": "integer", "format": "int32" } }, "xml": { "name": "InformConnectionAlertDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformConnectionSourceDto": { "properties": { "downloadFormatName": { "type": "string" }, "downloadFormatId": { "type": "integer", "format": "int32" }, "downloadSourceId": { "type": "integer", "format": "int32" } }, "xml": { "name": "InformConnectionSourceDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.ConnectionsToDeleteDto": { "properties": { "ids": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "comment": { "type": "string" } }, "xml": { "name": "ConnectionsToDeleteDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformAffirmationResponseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "affirmationId": { "type": "integer", "format": "int32" }, "affirmation": { "type": "string" }, "response": { "type": "string" }, "fullName": { "readOnly": true, "type": "string" }, "lastName": { "readOnly": true, "type": "string" }, "firstName": { "readOnly": true, "type": "string" }, "responseDate": { "type": "string", "format": "date-time" }, "questionnaireName": { "type": "string" }, "questionnaireStatus": { "type": "string", "enum": [ "New", "NotSubmitted", "Submitted", "Approved", "Denied", "AutoApprove", "AutoDeny", "ClosePending", "Closed", "Active", "FollowUp", "Canceled", "BrokenConnection" ] }, "questionnaireId": { "type": "integer", "format": "int32" }, "questionText": { "type": "string" }, "accessPersonId": { "type": "integer", "format": "int32" }, "policy": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformPolicyDto" }, "accessPerson": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformAccessPersonDto" } }, "xml": { "name": "InformAffirmationResponseDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ProductClassDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string" }, "category": { "type": "string" }, "categoryAbbreviation": { "type": "string" }, "subCategory": { "type": "string" }, "isDefault": { "type": "boolean" }, "riskScore": { "type": "number", "format": "double" }, "color": { "type": "string" }, "classLevel": { "type": "integer", "format": "int32" }, "sortOrder1": { "type": "integer", "format": "int32" }, "sortOrder2": { "type": "integer", "format": "int32" }, "productCategoryId": { "type": "integer", "format": "int32" }, "externalId": { "type": "string" }, "importKey": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "productDescriptionProviderId": { "type": "integer", "format": "int32" }, "productDescriptionProviderName": { "type": "string" }, "rebalancePriority": { "type": "integer", "format": "int32" }, "rebalanceSellPriority": { "type": "integer", "format": "int32" }, "symbol": { "type": "string" }, "value": { "type": "number", "format": "double" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "ProductClassDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.Inform.InformDepartmentDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "department": { "type": "string" }, "isActive": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "count": { "type": "integer", "format": "int32" } }, "xml": { "name": "InformDepartmentDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformDocumentDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "informTemplateId": { "type": "integer", "format": "int32" }, "userDetailId": { "type": "integer", "format": "int32" }, "accessPersonId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "lastName": { "readOnly": true, "type": "string" }, "firstName": { "readOnly": true, "type": "string" }, "fullName": { "readOnly": true, "type": "string" }, "dueDate": { "type": "string", "format": "date-time" }, "created": { "readOnly": true, "type": "string", "format": "date-time" }, "followUpItems": { "readOnly": true, "type": "integer", "format": "int32" }, "documentStatus": { "readOnly": true, "type": "string", "enum": [ "New", "NotSubmitted", "Submitted", "Approved", "Denied", "AutoApprove", "AutoDeny", "ClosePending", "Closed", "Active", "FollowUp", "Canceled", "BrokenConnection" ] }, "statusDate": { "readOnly": true, "type": "string", "format": "date-time" }, "submittedDate": { "readOnly": true, "type": "string", "format": "date-time" }, "statusComment": { "readOnly": true, "type": "string" }, "brokerageAccountId": { "type": "integer", "format": "int32" }, "preClearanceId": { "type": "integer", "format": "int32" }, "answers": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformDocumentAnswerDto" }, "xml": { "name": "InformDocumentAnswerDto", "wrapped": true }, "type": "array" }, "accessPerson": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformAccessPersonDto" }, "statusHistory": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformStatusDto" }, "xml": { "name": "InformStatusDto", "wrapped": true }, "type": "array" }, "templateType": { "type": "string", "enum": [ "Task", "Questionnaire", "PreClearance", "BrokerageAccount", "TradeViolation", "AccessPerson", "AccessPersonNew", "AccessPersonInactive", "AccessPersonAll", "DuplicateAccessPerson", "TaskWithMultiple" ] }, "lastUpdatedBy": { "readOnly": true, "type": "string" }, "lastUpdated": { "readOnly": true, "type": "string", "format": "date-time" } }, "xml": { "name": "InformDocumentDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.DocumentStatusDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "comment": { "type": "string" }, "status": { "type": "string", "enum": [ "New", "NotSubmitted", "Submitted", "Approved", "Denied", "AutoApprove", "AutoDeny", "ClosePending", "Closed", "Active", "FollowUp", "Canceled", "BrokenConnection" ] } }, "xml": { "name": "DocumentStatusDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformHistoricalDocumentDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "accessPersonId": { "type": "integer", "format": "int32" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "uploadedBy": { "type": "string" }, "uploadedDate": { "type": "string", "format": "date-time" }, "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" }, "informBlobId": { "type": "integer", "format": "int32" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "InformHistoricalDocumentDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformHistoricalDocumentSimpleDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "informBlobId": { "type": "integer", "format": "int32" } }, "xml": { "name": "InformHistoricalDocumentSimpleDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.Inform.InformEmailTemplateDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "templateName": { "type": "string" }, "emailSubject": { "type": "string" }, "emailBody": { "type": "string" }, "useCustomTemplate": { "type": "boolean" }, "customSubject": { "type": "string" }, "customBody": { "type": "string" } }, "xml": { "name": "InformEmailTemplateDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.Inform.InformTestEmailDto": { "properties": { "emailTemplate": { "type": "string" }, "emailAddressTo": { "type": "string" }, "useCustomTemplate": { "type": "boolean" } }, "xml": { "name": "InformTestEmailDto" }, "type": "object" }, "OAT.Utilities.Email.EmailResult": { "properties": { "success": { "type": "boolean" }, "emailException": { "type": "object" } }, "xml": { "name": "EmailResult" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.DashboardRiskTileDto": { "properties": { "title": { "type": "string" }, "regCount": { "type": "integer", "format": "int32" }, "url": { "type": "string" }, "infoData": { "type": "string" }, "countLabel": { "type": "string" }, "entitySessionId": { "type": "integer", "format": "int32" } }, "xml": { "name": "DashboardRiskTileDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.RiskAlertSettingDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "alert": { "type": "string" }, "isActive": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" }, "sectionNumber": { "type": "integer", "format": "int32" }, "cacheMinutes": { "type": "integer", "format": "int32" }, "riskSettingType": { "type": "string", "enum": [ "AccountAlert", "OutOfTolerance", "TileSetting" ] }, "riskAlertOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.RiskAlertOptionDto" }, "xml": { "name": "RiskAlertOptionDto", "wrapped": true }, "type": "array" }, "auditedByDisplay": { "type": "string" }, "brokerDealerId": { "type": "integer", "format": "int32" }, "riaId": { "type": "integer", "format": "int32" } }, "xml": { "name": "RiskAlertSettingDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.RiskAlertOptionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "riskAlertSettingId": { "type": "integer", "format": "int32" }, "parameterNumber": { "type": "integer", "format": "int32" }, "label": { "type": "string" }, "defaultValue": { "type": "integer", "format": "int32" }, "rangeLow": { "type": "integer", "format": "int32" }, "rangeHigh": { "type": "integer", "format": "int32" }, "currentValue": { "type": "integer", "format": "int32" }, "fieldType": { "type": "integer", "format": "int32" }, "sortOrder": { "type": "integer", "format": "int32" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "RiskAlertOptionDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.RiskAccountAlertDashboardDto": { "properties": { "alertLabel": { "type": "string" }, "alertCount": { "type": "integer", "format": "int32" }, "entitySessionId": { "type": "integer", "format": "int32" } }, "xml": { "name": "RiskAccountAlertDashboardDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.RiskToleranceDto": { "properties": { "investmentObjectiveId": { "type": "integer", "format": "int32" }, "investmentObjectiveName": { "type": "string" }, "riskRangeLow": { "type": "integer", "format": "int32" }, "riskRangeHigh": { "type": "integer", "format": "int32" }, "driftRangeLow": { "type": "integer", "format": "int32" }, "driftRangeHigh": { "type": "integer", "format": "int32" }, "registrationCount": { "type": "integer", "format": "int32" }, "entitySessionId": { "type": "integer", "format": "int32" } }, "xml": { "name": "RiskToleranceDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.NonRegisteredStatesDto": { "properties": { "repId": { "type": "integer", "format": "int32" }, "repName": { "type": "string" }, "repDetails": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.NonRegisteredStatesRepDetailsDto" }, "xml": { "name": "NonRegisteredStatesRepDetailsDto", "wrapped": true }, "type": "array" }, "totalClients": { "type": "integer", "format": "int32" } }, "xml": { "name": "NonRegisteredStatesDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.NonRegisteredStatesRepDetailsDto": { "properties": { "state": { "type": "string" }, "clientCount": { "type": "integer", "format": "int32" } }, "xml": { "name": "NonRegisteredStatesRepDetailsDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.ABConfirmCompareDifferenceDto": { "properties": { "id": { "type": "string" }, "recordType": { "type": "string", "enum": [ "Name", "Position", "Transaction", "Price", "Dividend", "Product", "NotImported", "Header", "Security", "CorpAction", "TranDetail", "Generic", "CostBasis", "Beneficiary", "StoredPerformance", "Systematic", "RMD", "Banking" ] }, "downloadFileKeyId": { "type": "integer", "format": "int32" }, "downloadRecordKeyId": { "type": "integer", "format": "int32" }, "downloadSourceId": { "type": "integer", "format": "int32" }, "downloadFileLastId": { "type": "integer", "format": "int32" }, "downloadFileNextId": { "type": "integer", "format": "int32" }, "downloadRecordLastId": { "type": "integer", "format": "int32" }, "downloadRecordNextId": { "type": "integer", "format": "int32" }, "checksumDifferenceType": { "type": "string", "enum": [ "Unknown", "RecordAndCustomInfoDoesNotMatch", "RecordInfoDoesNotMatch", "CustomInfoDoesNotMatch", "RecordExistsInLastFileOnly", "RecordExistsInNextFileOnly" ] }, "signOffDate": { "type": "string", "format": "date-time" }, "signOffBy": { "type": "string" }, "detectedDate": { "type": "string", "format": "date-time" }, "signOffNotes": { "type": "string" }, "isSignedOff": { "readOnly": true, "type": "boolean" } }, "xml": { "name": "ABConfirmCompareDifferenceDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.AccountMerge.AccountMergeBatchDetailUpdateDto": { "properties": { "sourceAccountId": { "type": "integer", "format": "int32" }, "accountMergeStatus": { "type": "string", "enum": [ "Pending", "Processing", "Complete", "Error", "Cancelled" ] }, "isRetry": { "type": "boolean" }, "isPriority": { "type": "boolean" } }, "xml": { "name": "AccountMergeBatchDetailUpdateDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.AccountRestore.RestoreAccountDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" } }, "xml": { "name": "RestoreAccountDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.AccountRestore.AccountRestoreSimpleDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "name": { "type": "string" }, "accountType": { "type": "string" }, "fundFamily": { "type": "string" }, "currentValue": { "type": "number", "format": "double" }, "downloadSource": { "type": "string" }, "effectiveDate": { "type": "string", "format": "date-time" }, "isCancelled": { "type": "boolean" }, "restoreData": { "type": "boolean" }, "lastPositionDate": { "type": "string", "format": "date-time" }, "inBalance": { "type": "boolean" }, "validationMessage": { "type": "string" }, "validationMessageType": { "type": "integer", "format": "int32" }, "accountRestoreId": { "type": "integer", "format": "int32" } }, "xml": { "name": "AccountRestoreSimpleDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.AccountRestore.AccountRestoreSummaryDto": { "properties": { "batchId": { "type": "integer", "format": "int32" }, "restoreStatus": { "type": "string" }, "numberOfAccounts": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "AccountRestoreSummaryDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.AccountRestore.AccountRestoreBatchStatusDetailDto": { "properties": { "batchId": { "type": "integer", "format": "int32" }, "batchStatus": { "type": "string", "enum": [ "New", "CreateNameFile", "CreateTransactionPosition", "ApplyTransactionPosition", "CleanupPositions", "Notify", "Complete", "Error", "UndoCancelledAccounts" ] }, "accountNumber": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "accountStatus": { "type": "string", "enum": [ "Pending", "Processing", "Complete", "Error" ] }, "startDate": { "type": "string", "format": "date-time" }, "wasPlugged": { "type": "boolean" }, "statusMessage": { "type": "string" }, "statusMessageHtml": { "type": "string" }, "registrationId": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "householdId": { "type": "integer", "format": "int32" }, "householdName": { "type": "string" }, "isCancelled": { "type": "boolean" }, "restoreData": { "type": "boolean" }, "accountInBalance": { "type": "boolean" } }, "xml": { "name": "AccountRestoreBatchStatusDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Alternative.EquityActivityTypeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "transactionSubTypeId": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "impactsCommitmentDefault": { "type": "boolean" }, "impactsCapitalBalanceDefault": { "type": "boolean" }, "capitalBalanceImpact": { "type": "integer", "format": "int32" }, "hasCashOffset": { "type": "boolean" } }, "xml": { "name": "EquityActivityTypeDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Alternative.ExpectedReturnDto": { "properties": { "productId": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "high": { "type": "number", "format": "double" }, "low": { "type": "number", "format": "double" }, "comment": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "ExpectedReturnDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Alternative.AssetVerboseValidationDto": { "properties": { "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" }, "warningMessage": { "type": "string" }, "recordKey": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "isDataSharingEntity": { "type": "boolean" }, "portfolio": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetPortfolioDto" }, "billing": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetBillingDto" }, "stepUps": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.StepUpDto" }, "xml": { "name": "StepUpDto", "wrapped": true }, "type": "array" }, "bifurcates": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BifurcateDto" }, "xml": { "name": "BifurcateDto", "wrapped": true }, "type": "array" }, "costBasisHistories": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasisHistoryDto" }, "xml": { "name": "CostBasisHistoryDto", "wrapped": true }, "type": "array" }, "costBasisLots": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.UnrealizedAssetCostDto" }, "xml": { "name": "UnrealizedAssetCostDto", "wrapped": true }, "type": "array" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" }, "userDefinedFields": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" }, "userDefinedTimeFields": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionTimeDto" }, "xml": { "name": "EntityOptionTimeDto", "wrapped": true }, "type": "array" }, "assetValuations": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.AssetValuationDto" }, "xml": { "name": "AssetValuationDto", "wrapped": true }, "type": "array" }, "commitments": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.CommitmentLedgerDto" }, "xml": { "name": "CommitmentLedgerDto", "wrapped": true }, "type": "array" }, "alternativeSchedules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.AlternativeScheduleDto" }, "xml": { "name": "AlternativeScheduleDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "AssetVerboseValidationDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AssetPortfolioDto": { "properties": { "name": { "type": "string" }, "accountNumber": { "type": "string" }, "accountCode": { "type": "string" }, "currentShares": { "type": "number", "format": "double" }, "currentValue": { "type": "number", "format": "double" }, "ticker": { "type": "string" }, "isManaged": { "type": "boolean" }, "secondaryAccountNumber": { "type": "string" }, "cusip": { "type": "string" }, "productId": { "type": "integer", "format": "int32" }, "assetClass": { "type": "string" }, "isCustodialCash": { "type": "boolean" }, "assetLevelStrategyId": { "type": "integer", "format": "int32" }, "status": { "type": "string", "enum": [ "Undefined", "NormalDownloading", "ManuallyManaged", "Alternative" ] }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "accountId": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "personalName": { "type": "string" }, "clientId": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "downloadSymbol": { "type": "integer", "format": "int32" }, "isStrategyOverride": { "type": "boolean" }, "isAdvisorOnly": { "type": "boolean" }, "isAdvReportable": { "type": "boolean" }, "is13FReportable": { "type": "boolean" }, "accountStatusId": { "type": "integer", "format": "int32" }, "dailyChangeTolerance": { "type": "number", "format": "double" }, "isOrionVision": { "type": "boolean" }, "custodianCommonIdList": { "type": "string" } }, "xml": { "name": "AssetPortfolioDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AssetBillingDto": { "properties": { "billAssetId": { "type": "integer", "format": "int32" }, "isFeeExcluded": { "type": "boolean" }, "isPayingFee": { "type": "boolean" }, "excludeAmount": { "type": "number", "format": "double" }, "excludeAmountType": { "type": "string", "enum": [ "Percent", "Dollars", "Shares" ] }, "excludePercentOf": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "excludeEndDate": { "type": "string", "format": "date-time" }, "excludeStartDate": { "type": "string", "format": "date-time" }, "excludeBillProduct": { "type": "boolean" }, "isFeeExcludedAsset": { "type": "boolean" }, "isFeeExcludedProduct": { "type": "boolean" }, "isFeeExcludedHouseholdAsset": { "type": "boolean" }, "excludeFromMargin": { "type": "boolean" }, "feeBillExclusionMode": { "type": "integer", "format": "int32" }, "excludedBillEntityIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, "xml": { "name": "AssetBillingDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.StepUpDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "percent": { "type": "number", "format": "double" }, "date": { "type": "string", "format": "date-time" }, "unitPrice": { "type": "number", "format": "double" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "StepUpDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.BifurcateDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "method": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "BifurcateDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.CostBasisHistoryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "acquiredDate": { "type": "string", "format": "date-time" }, "sellDate": { "type": "string", "format": "date-time" }, "holdingPeriodDate": { "type": "string", "format": "date-time" }, "costAmount": { "type": "number", "format": "double" }, "numberOfUnits": { "type": "number", "format": "double" }, "method": { "type": "string" }, "proceedAmount": { "type": "number", "format": "double" }, "importedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "CostBasisHistoryDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.UnrealizedAssetCostDto": { "properties": { "asOfDate": { "type": "string", "format": "date-time" }, "longTermCost": { "type": "number", "format": "double" }, "shortTermCost": { "type": "number", "format": "double" }, "longTermUnits": { "type": "number", "format": "double" }, "shortTermUnits": { "type": "number", "format": "double" }, "acquiredDate": { "type": "string", "format": "date-time" }, "amortizationAmt": { "type": "number", "format": "double" }, "costPerShare": { "type": "number", "format": "double" } }, "xml": { "name": "UnrealizedAssetCostDto" }, "type": "object" }, "OAS.WebApi.DTO.Settings.EntityOptionTimeDto": { "properties": { "mostRecent": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionTimeValueDto", "readOnly": true }, "values": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionTimeValueDto" }, "xml": { "name": "EntityOptionTimeValueDto", "wrapped": true }, "type": "array" }, "childParameter": { "type": "string" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "entityName": { "type": "string" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "category": { "type": "string" }, "type": { "type": "string", "enum": [ "MultiLineEditor", "DropDownEditor", "DropDownList", "CheckBox", "Currency", "Date", "DateTime", "Integer", "String", "Double", "Time", "Long", "CustomObject", "Email" ] }, "maxLength": { "type": "integer", "format": "int32" }, "code": { "type": "string" }, "sequence": { "type": "integer", "format": "int32" }, "options": { "type": "object" }, "input": { "type": "string" }, "securityCode": { "type": "string" }, "canEdit": { "type": "boolean" } }, "xml": { "name": "EntityOptionTimeDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Alternative.AssetValuationDto": { "properties": { "assetId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "asOfDate": { "type": "string", "format": "date-time" }, "unitBalance": { "type": "number", "format": "double" }, "isEstimated": { "type": "boolean" }, "valuationStatus": { "type": "string", "enum": [ "Complete", "Pending" ] }, "notes": { "type": "string" }, "productValuationId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "name": { "type": "string" }, "accountNumber": { "type": "string" }, "ticker": { "type": "string" }, "isManaged": { "type": "boolean" }, "assetClass": { "type": "string" }, "productCategory": { "type": "string" }, "productCategoryAbbreviation": { "type": "string" }, "isCustodialCash": { "type": "boolean" }, "secondaryAccountNumber": { "type": "string" }, "cusip": { "type": "string" }, "assetLevelStrategyId": { "type": "integer", "format": "int32" }, "assetLevelStrategy": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "isStrategyOverride": { "type": "boolean" }, "assetCreatedBy": { "type": "string" }, "assetCreatedDate": { "type": "string", "format": "date-time" }, "assetEditedBy": { "type": "string" }, "assetEditedDate": { "type": "string", "format": "date-time" }, "registrationId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "downloadSymbol": { "type": "integer", "format": "int32" }, "accountType": { "type": "string" }, "fundFamily": { "type": "string" }, "custodian": { "type": "string" }, "registrationName": { "type": "string" }, "managementStyle": { "type": "string" }, "productType": { "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, "productSubType": { "type": "string" }, "isGlobalExcluded": { "type": "boolean" }, "isFeeExcluded": { "type": "boolean" }, "excludeAmountType": { "type": "string", "enum": [ "Percent", "Dollars", "Shares" ] }, "excludeAmount": { "type": "number", "format": "double" }, "excludePercentOf": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "excludeFromMargin": { "type": "boolean" }, "isRebalance": { "type": "boolean" }, "isAdvisorOnly": { "type": "boolean" }, "isAdvReportable": { "type": "boolean" }, "is13FReportable": { "type": "boolean" }, "mscsFundAccountNumber": { "type": "string" }, "lastReconDate": { "type": "string", "format": "date-time" }, "isOrionVision": { "type": "boolean" } }, "xml": { "name": "AssetValuationDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Alternative.CommitmentLedgerDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "assetId": { "type": "integer", "format": "int32" }, "ledgerType": { "type": "string", "enum": [ "CommittedCapital", "UnFundedAdjustment", "ContributedCapital", "Distribution" ] }, "asOfDate": { "type": "string", "format": "date-time" }, "amount": { "type": "number", "format": "double" }, "notes": { "type": "string" }, "tradeStatus": { "type": "string", "enum": [ "Complete", "Pending", "Rejected", "Reversed", "Inactive", "PendingCorpAction", "FutureAip" ] }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "CommitmentLedgerDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Alternative.AlternativeScheduleDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "assetId": { "type": "integer", "format": "int32" }, "scheduleType": { "type": "string", "enum": [ "CapitalCommitment", "Distribution" ] }, "scheduleDate": { "type": "string", "format": "date-time" }, "amount": { "type": "number", "format": "double" }, "amountType": { "type": "string", "enum": [ "Dollars", "Percent" ] } }, "xml": { "name": "AlternativeScheduleDto" }, "type": "object" }, "OAS.WebApi.DTO.Settings.EntityOptionTimeValueDto": { "properties": { "userDefineTimeDataId": { "type": "integer", "format": "int32" }, "effectiveDate": { "type": "string", "format": "date-time" }, "value": { "type": "string" } }, "xml": { "name": "EntityOptionTimeValueDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Alternative.ProductValuationDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "ticker": { "type": "string" }, "productName": { "type": "string" }, "valuationDate": { "type": "string", "format": "date-time" }, "changePercent": { "type": "number", "format": "double" }, "isEstimated": { "type": "boolean" }, "notes": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "ProductValuationDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Alternative.ValuationPreviewDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "assetId": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "productName": { "type": "string" }, "asOfDate": { "type": "string", "format": "date-time" }, "asOfValue": { "type": "number", "format": "double" }, "valuation": { "type": "number", "format": "double" }, "netChange": { "type": "number", "format": "double" }, "valuationPercent": { "type": "number", "format": "double" } }, "xml": { "name": "ValuationPreviewDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Alternative.AssetValuationValidationDto": { "properties": { "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" }, "warningMessage": { "type": "string" }, "recordKey": { "type": "string" }, "assetId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "valuationAmount": { "type": "number", "format": "double" }, "isEstimated": { "type": "boolean" }, "valuationStatus": { "type": "string", "enum": [ "Complete", "Pending" ] }, "notes": { "type": "string" } }, "xml": { "name": "AssetValuationValidationDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Alternative.AssetValuationKeyDto": { "properties": { "assetId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "AssetValuationKeyDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Alternative.ValuationStatusDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string" } }, "xml": { "name": "ValuationStatusDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Alternative.EquityFundingTypeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string" } }, "xml": { "name": "EquityFundingTypeDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Alternative.TransactionAlternativeValidationDto": { "properties": { "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" }, "warningMessage": { "type": "string" }, "recordKey": { "type": "string" }, "impactsCommitment": { "type": "boolean" }, "impactsCapitalBalance": { "type": "boolean" }, "originalCost": { "type": "number", "format": "double" }, "originalCostDate": { "type": "string", "format": "date-time" }, "equityFundingType": { "type": "string" }, "equityFundingTypeId": { "type": "integer", "format": "int32" }, "equityActivityType": { "type": "string" }, "equityActivityTypeId": { "type": "integer", "format": "int32" }, "costBasis": { "type": "number", "format": "double" }, "productTransactionId": { "type": "integer", "format": "int32" }, "cashDate": { "type": "string", "format": "date-time" }, "id": { "type": "integer", "format": "int32" }, "transDate": { "type": "string", "format": "date-time" }, "transactionDescription": { "type": "string" }, "productName": { "type": "string" }, "ticker": { "type": "string" }, "transAmount": { "type": "number", "format": "double" }, "noUnits": { "type": "number", "format": "double" }, "navPrice": { "type": "number", "format": "double" }, "accountNumber": { "type": "string" }, "status": { "type": "string", "enum": [ "Complete", "Pending", "Rejected", "Reversed", "Inactive", "PendingCorpAction", "FutureAip" ] }, "fileTranCode": { "type": "string" }, "type": { "type": "string" }, "transTime": { "type": "string", "format": "date-time" }, "assetId": { "type": "integer", "format": "int32" }, "assetStatusId": { "type": "integer", "format": "int32" }, "cusip": { "type": "string" }, "notes": { "type": "string" }, "transTypeId": { "type": "integer", "format": "int32" }, "transactionSubTypeId": { "type": "integer", "format": "int32" }, "transactionSubTypeName": { "type": "string" }, "transactionSubTypeDescription": { "type": "string" }, "contributionCodeId": { "type": "integer", "format": "int32" }, "contributionCodeName": { "type": "string" }, "distributionCodeId": { "type": "integer", "format": "int32" }, "distributionCodeName": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "accountStatusId": { "type": "integer", "format": "int32" }, "managementStyle": { "type": "string" }, "payee": { "type": "integer", "format": "int32" }, "advisorNotes": { "type": "string" }, "state": { "type": "string" }, "settleDate": { "type": "string", "format": "date-time" }, "tradeReferenceNumber": { "type": "string" }, "transactionLinkCode": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "registrationId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "typeCode": { "type": "string" }, "brokerCode": { "type": "string" }, "accountType": { "type": "string" }, "fundFamily": { "type": "string" }, "custodian": { "type": "string" }, "count": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "unitBalance": { "type": "number", "format": "double" }, "productId": { "type": "integer", "format": "int32" }, "performanceFeeBreak": { "type": "boolean" }, "financialType": { "type": "string", "enum": [ "None", "Contribution", "Distribution", "Exchange", "DivReinvest", "MgmntFees", "DivCash", "MiscFees", "Journal", "Merges" ] } }, "xml": { "name": "TransactionAlternativeValidationDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Alternative.InvestmentPlatformAssetHistoryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "recordDate": { "type": "string", "format": "date-time" }, "productName": { "type": "string" }, "transTypeName": { "type": "string" }, "transAmount": { "type": "number", "format": "double" }, "assetBalance": { "type": "number", "format": "double" }, "notes": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "isEstimated": { "type": "boolean" }, "impactsCommitment": { "type": "boolean" }, "auditedByDisplay": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "InvestmentPlatformAssetHistoryDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Alternative.ProductTransactionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "ticker": { "type": "string" }, "productName": { "type": "string" }, "transactionDate": { "type": "string", "format": "date-time" }, "transactionType": { "type": "string" }, "percentOfCommitmentAmount": { "type": "number", "format": "double" }, "notes": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "transactionTypeId": { "type": "integer", "format": "int32" }, "alternativeEquityActivityTypeId": { "type": "integer", "format": "int32" }, "alternativeEquityFundingTypeId": { "type": "integer", "format": "int32" }, "impactsCommitment": { "type": "boolean" }, "impactsCapitalBalance": { "type": "boolean" } }, "xml": { "name": "ProductTransactionDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Alternative.TransactionPreviewDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "assetId": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "productName": { "type": "string" }, "transactionDate": { "type": "string", "format": "date-time" }, "activityTransactionType": { "type": "string" }, "transactionAmount": { "type": "number", "format": "double" }, "commitmentAmount": { "type": "number", "format": "double" }, "commitmentPercent": { "type": "number", "format": "double" } }, "xml": { "name": "TransactionPreviewDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.CorpAction.CorpActionProcessingTypeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "notes": { "type": "string" } }, "xml": { "name": "CorpActionProcessingTypeDto" }, "type": "object" }, "OAS.DataModel.Confirm.CorpAction.CorpActionProcessingType": { "required": [ "id", "name" ], "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "notes": { "type": "string", "maxLength": 255, "minLength": 0 } }, "xml": { "name": "CorpActionProcessingType" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.CorpAction.CorpActionTransactionV2Dto": { "properties": { "id": { "readOnly": true, "type": "string" }, "dbName": { "type": "string" }, "transactionId": { "type": "integer", "format": "int32" }, "corpActionId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "processingType": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "assetId": { "type": "integer", "format": "int32" }, "transDate": { "type": "string", "format": "date-time" }, "transType": { "type": "string" }, "amount": { "type": "number", "format": "double" }, "units": { "type": "number", "format": "double" }, "price": { "type": "number", "format": "double" }, "tradeStatus": { "type": "string", "enum": [ "Complete", "Pending", "Rejected", "Reversed", "Inactive", "PendingCorpAction", "FutureAip" ] }, "custodian": { "type": "string" }, "transSubType": { "type": "string" }, "isProcessing": { "type": "boolean" }, "processingId": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "transTypeId": { "type": "integer", "format": "int32" }, "transSubTypeId": { "type": "integer", "format": "int32" }, "notes": { "type": "string" }, "accountNumber": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "isCil": { "type": "boolean" }, "custodianId": { "type": "integer", "format": "int32" } }, "xml": { "name": "CorpActionTransactionV2Dto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.CorpAction.CorpActionTaskQueueSkippedDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "corpActionProcessingId": { "type": "integer", "format": "int32" }, "corpActionTaskQueueStartId": { "type": "integer", "format": "int32" }, "corpActionTaskQueueEndId": { "type": "integer", "format": "int32" }, "comment": { "type": "string" } }, "xml": { "name": "CorpActionTaskQueueSkippedDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.CorpAction.CorporateActionProcessingDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "corpActionId": { "type": "integer", "format": "int32" }, "corpActionName": { "type": "string" }, "corpActionProcessingTypeId": { "type": "integer", "format": "int32" }, "corpActionProcessingTypeName": { "type": "string" }, "processStatus": { "type": "string", "enum": [ "New", "Approved", "CreatePendings", "Processing", "InProcess", "Complete", "Cancelled", "RecalculateUnits", "NotProcessed", "MoveCostBasis" ] }, "mergeOutRatio": { "type": "number", "format": "double" }, "roundingType": { "type": "string", "enum": [ "Normal", "Up", "Down", "Nearest", "NoRounding" ] }, "expectedClose": { "type": "string", "format": "date-time" }, "isHeld": { "type": "boolean" }, "isVerified": { "type": "boolean" }, "isBeginningOfDay": { "type": "boolean" }, "navPrice": { "type": "number", "format": "double" }, "newProductName": { "type": "string" }, "newCusip": { "type": "string" }, "newTicker": { "type": "string" } }, "xml": { "name": "CorporateActionProcessingDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.CorpAction.CorporateActionProcessingDetailDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "corpActionId": { "type": "integer", "format": "int32" }, "corpActionProcessingTypeId": { "type": "integer", "format": "int32" }, "corpActionProcessingTypeName": { "type": "string" }, "processStatus": { "type": "string", "enum": [ "New", "Approved", "CreatePendings", "Processing", "InProcess", "Complete", "Cancelled", "RecalculateUnits", "NotProcessed", "MoveCostBasis" ] }, "mergeOutRatio": { "type": "number", "format": "double" }, "roundingType": { "type": "string", "enum": [ "Normal", "Up", "Down", "Nearest", "NoRounding" ] }, "expectedClose": { "type": "string", "format": "date-time" }, "isHeld": { "type": "boolean" }, "isVerified": { "type": "boolean" }, "isBeginningOfDay": { "type": "boolean" }, "navPrice": { "type": "number", "format": "double" }, "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "entryDate": { "type": "string", "format": "date-time" }, "remarks": { "type": "string" }, "notifyType": { "type": "string" }, "notifyTypeUpdate": { "type": "string" }, "recordStatus": { "type": "string" }, "numOptions": { "type": "integer", "format": "int32" }, "securityType": { "type": "string" }, "effectiveDate": { "type": "string", "format": "date-time" }, "cusip": { "type": "string" }, "oldCusip": { "type": "string" }, "ticker": { "type": "string" }, "name": { "type": "string" }, "oldName": { "type": "string" }, "expireDate": { "type": "string", "format": "date-time" }, "cash": { "type": "number", "format": "double" }, "cashCode": { "type": "string" }, "stateCode": { "type": "string" }, "tenderAgent": { "type": "string" }, "infoAgent": { "type": "string" }, "maturityDate": { "type": "string", "format": "date-time" }, "rate1": { "type": "number", "format": "double" }, "rateCode": { "type": "string" }, "rate2": { "type": "number", "format": "double" }, "voluntaryMandatory": { "type": "string" }, "dtc": { "type": "string" }, "prorationRate": { "type": "string" }, "prorationDate": { "type": "string", "format": "date-time" }, "note": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "textNo": { "type": "integer", "format": "int32" }, "dealNo": { "type": "integer", "format": "int32" }, "costBasisFactor": { "type": "number", "format": "double" }, "textNoUpdate": { "type": "integer", "format": "int32" }, "fairMarketValue": { "type": "number", "format": "double" }, "fairMarketValueOut": { "type": "number", "format": "double" }, "newProductName": { "type": "string" }, "newCusip": { "type": "string" }, "newTicker": { "type": "string" } }, "xml": { "name": "CorporateActionProcessingDetailDto" }, "type": "object" }, "OAS.DataModel.Confirm.CorpAction.CorpActionProcessing": { "required": [ "id", "corpActionId", "corpActionProcessingTypeId", "processStatus", "roundingType", "isHeld", "isVerified" ], "properties": { "id": { "type": "integer", "format": "int32" }, "corpActionId": { "type": "integer", "format": "int32" }, "corpActionProcessingTypeId": { "type": "integer", "format": "int32" }, "processStatus": { "type": "string", "enum": [ "New", "Approved", "CreatePendings", "Processing", "InProcess", "Complete", "Cancelled", "RecalculateUnits", "NotProcessed", "MoveCostBasis" ] }, "mergeOutRatio": { "type": "number", "format": "double", "maximum": 1.0, "minimum": 0.0 }, "roundingType": { "type": "string", "enum": [ "Normal", "Up", "Down", "Nearest", "NoRounding" ] }, "expectedClose": { "type": "string", "format": "date-time" }, "isHeld": { "type": "boolean" }, "isVerified": { "type": "boolean" }, "isBeginningOfDay": { "type": "boolean" }, "navPrice": { "type": "number", "format": "double" }, "newProductName": { "type": "string" }, "newCusip": { "type": "string" }, "newTicker": { "type": "string" }, "processingType": { "$ref": "#/definitions/OAS.DataModel.Confirm.CorpAction.CorpActionProcessingType" }, "corporateAction": { "$ref": "#/definitions/OAS.DataModel.Portfolio.CorporateAction" }, "corpActionTaskQueues": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.CorpAction.CorpActionTaskQueue" }, "xml": { "name": "CorpActionTaskQueue", "wrapped": true }, "type": "array" } }, "xml": { "name": "CorpActionProcessing" }, "type": "object" }, "OAS.DataModel.Portfolio.CorporateAction": { "required": [ "id", "createdBy", "createdDate", "editedBy", "editedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "entryDate": { "type": "string", "format": "date-time" }, "remarks": { "type": "string", "maxLength": 50, "minLength": 0 }, "notifyType": { "type": "string", "maxLength": 1, "minLength": 0 }, "notifyTypeUpdate": { "type": "string", "maxLength": 1, "minLength": 0 }, "recordStatus": { "type": "string", "maxLength": 1, "minLength": 0 }, "numOptions": { "type": "integer", "format": "int32", "maximum": 2147483647, "minimum": 0 }, "securityType": { "type": "string", "maxLength": 1, "minLength": 0 }, "effectiveDate": { "type": "string", "format": "date-time" }, "cusip": { "type": "string" }, "oldCusip": { "type": "string" }, "ticker": { "type": "string" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "oldName": { "type": "string", "maxLength": 50, "minLength": 0 }, "expireDate": { "type": "string", "format": "date-time" }, "cash": { "type": "number", "format": "double" }, "cashCode": { "type": "string", "maxLength": 1, "minLength": 0 }, "stateCode": { "type": "string", "maxLength": 2, "minLength": 0 }, "tenderAgent": { "type": "string", "maxLength": 4, "minLength": 0 }, "infoAgent": { "type": "string", "maxLength": 4, "minLength": 0 }, "maturityDate": { "type": "string", "format": "date-time" }, "rate1": { "type": "number", "format": "double" }, "rateCode": { "type": "string", "maxLength": 1, "minLength": 0 }, "rate2": { "type": "number", "format": "double" }, "voluntaryMandatory": { "type": "string", "maxLength": 1, "minLength": 0 }, "dtc": { "type": "string", "maxLength": 1, "minLength": 0 }, "prorationRate": { "type": "string", "maxLength": 20, "minLength": 0 }, "prorationDate": { "type": "string", "format": "date-time" }, "note": { "type": "string", "maxLength": 3000, "minLength": 0 }, "createdBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "textNo": { "type": "integer", "format": "int32" }, "dealNo": { "type": "integer", "format": "int32" }, "costBasisFactor": { "type": "number", "format": "double" }, "textNoUpdate": { "type": "integer", "format": "int32" }, "fairMarketValue": { "type": "number", "format": "double" }, "moreInfoUrl": { "type": "string", "maxLength": 2000, "minLength": 0 }, "product": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductGlobal" }, "processes": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.CorpAction.CorpActionProcessing" }, "xml": { "name": "CorpActionProcessing", "wrapped": true }, "type": "array" } }, "xml": { "name": "CorporateAction" }, "type": "object" }, "OAS.DataModel.Confirm.CorpAction.CorpActionTaskQueue": { "required": [ "id", "corpActionProcessingId", "corpActionTaskTypeId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "corpActionProcessingId": { "type": "integer", "format": "int32" }, "corpActionTaskTypeId": { "type": "integer", "format": "int32" }, "processing": { "$ref": "#/definitions/OAS.DataModel.Confirm.CorpAction.CorpActionProcessing" }, "taskType": { "$ref": "#/definitions/OAS.DataModel.Confirm.CorpAction.CorpActionTaskType" } }, "xml": { "name": "CorpActionTaskQueue" }, "type": "object" }, "OAS.DataModel.Portfolio.ProductGlobal": { "required": [ "createdDate", "estimatedDividendFrequency", "id", "ticker", "isActive", "shareClassId", "defaultPrice", "tradesPerDay", "repurchaseBlockDays", "is144A", "isDerivative", "includeByDefault", "allowIncomeOverride", "excludeFromCB" ], "properties": { "createdDate": { "type": "string", "format": "date-time" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "oldRecID": { "type": "string", "maxLength": 10, "minLength": 0 }, "oldLRecID": { "type": "string", "maxLength": 10, "minLength": 0 }, "productSubTypeId": { "type": "integer", "format": "int32" }, "estimatedDividendFrequency": { "type": "number", "format": "double" }, "id": { "type": "integer", "format": "int32" }, "fundFamilyId": { "type": "integer", "format": "int32" }, "ticker": { "type": "string", "maxLength": 50, "minLength": 0 }, "cusip": { "type": "string", "maxLength": 50, "minLength": 0 }, "isin": { "type": "string", "maxLength": 50, "minLength": 0 }, "isActive": { "type": "boolean" }, "productName": { "type": "string", "maxLength": 150, "minLength": 0 }, "rowVersion": { "type": "string", "format": "byte" }, "importDate": { "type": "string", "format": "date-time" }, "shareClassId": { "type": "integer", "format": "int32" }, "apcCode": { "type": "string", "maxLength": 20, "minLength": 0 }, "micropalCode": { "type": "string", "maxLength": 20, "minLength": 0 }, "defaultPrice": { "type": "number", "format": "double" }, "convSchSells": { "type": "boolean" }, "productType": { "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, "fundNumber": { "type": "string", "maxLength": 20, "minLength": 0 }, "isUsePriceTime": { "type": "boolean" }, "tradeCutoffTime": { "type": "string", "format": "date-time" }, "estimateReportTime": { "type": "string", "format": "date-time" }, "estimateInterval": { "type": "integer", "format": "int32" }, "shortTermTradeFeeDays": { "type": "integer", "format": "int32" }, "shortTermTradeFeePercent": { "type": "number", "format": "double" }, "tradesPerDay": { "type": "integer", "format": "int32" }, "repurchaseBlockDays": { "type": "integer", "format": "int32" }, "is144A": { "type": "boolean" }, "productParentId": { "type": "integer", "format": "int32" }, "priceStatus": { "type": "string", "enum": [ "Normal", "Default", "Manual", "ReceivedMoreThan1Day", "InfrequentPricing", "SecurityIsWorthless", "IndeterminableValue", "NotActiveProduct" ] }, "subHoldingId": { "type": "integer", "format": "int32" }, "strikePrice": { "type": "number", "format": "double" }, "expirationDate": { "type": "string", "format": "date-time" }, "optionLotSize": { "type": "integer", "format": "int32" }, "isDerivative": { "type": "boolean" }, "includeByDefault": { "type": "boolean" }, "allowIncomeOverride": { "type": "boolean" }, "isDividendSuspended": { "type": "boolean" }, "excludeFromCB": { "type": "boolean" }, "isMLP": { "type": "boolean" }, "isIntervalFund": { "type": "boolean" }, "inceptionDate": { "type": "string", "format": "date-time" }, "shortTermDiscountObligation": { "type": "boolean" }, "subType": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductSubType" }, "fundFamily": { "$ref": "#/definitions/OAS.DataModel.Portfolio.FundFamilyGlobal" }, "shareClass": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ShareClass" }, "subHolding": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SubHolding" }, "bondRates": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.BondRate" }, "xml": { "name": "BondRate", "wrapped": true }, "type": "array" }, "downloadSymbols": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.DownloadSymbol" }, "xml": { "name": "DownloadSymbol", "wrapped": true }, "type": "array" }, "fundFamilyProducts": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.FundFamilyProduct" }, "xml": { "name": "FundFamilyProduct", "wrapped": true }, "type": "array" }, "parentProduct": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductGlobal" }, "childProducts": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductGlobal" }, "xml": { "name": "ProductGlobal", "wrapped": true }, "type": "array" }, "preferredRates": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.PreferredRate" }, "xml": { "name": "PreferredRate", "wrapped": true }, "type": "array" }, "currentPrices": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.PriceCurrent" }, "xml": { "name": "PriceCurrent", "wrapped": true }, "type": "array" }, "descriptionProviderDetail": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductDescriptionProviderFlat" }, "productUsages": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductUsage" }, "xml": { "name": "ProductUsage", "wrapped": true }, "type": "array" }, "alClients": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductALClient" }, "xml": { "name": "ProductALClient", "wrapped": true }, "type": "array" }, "gicsMapping": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductGICSMapping" }, "productRiskScores": { "items": { "$ref": "#/definitions/OAS.DataModel.Integration.FinMason.ProductRiskScore" }, "xml": { "name": "ProductRiskScore", "wrapped": true }, "type": "array" }, "currentProductRiskScore": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductRiskScoreCurrent" }, "xml": { "name": "ProductRiskScoreCurrent", "wrapped": true }, "type": "array" }, "info": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductGlobalAdditionalInfo" }, "portfolioAnalyses": { "items": { "$ref": "#/definitions/OAS.DataModel.Performance.PortfolioAnalysis" }, "xml": { "name": "PortfolioAnalysis", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProductGlobal" }, "type": "object" }, "OAS.DataModel.Confirm.CorpAction.CorpActionTaskType": { "required": [ "id", "statusChangeOnly" ], "properties": { "id": { "type": "integer", "format": "int32" }, "taskDescription": { "type": "string", "maxLength": 50, "minLength": 0 }, "statusChangeOnly": { "type": "boolean" } }, "xml": { "name": "CorpActionTaskType" }, "type": "object" }, "OAS.DataModel.Portfolio.FundFamilyGlobal": { "required": [ "id", "personalId", "isAnnuity", "isCanBeDownLoad", "isActive" ], "properties": { "id": { "type": "integer", "format": "int32" }, "personalId": { "type": "integer", "format": "int32" }, "isAnnuity": { "type": "boolean" }, "isCanBeDownLoad": { "type": "boolean" }, "oldGroup": { "type": "string", "maxLength": 5, "minLength": 0 }, "oldFFId": { "type": "integer", "format": "int32" }, "persContactId": { "type": "integer", "format": "int32" }, "persOverNTId": { "type": "integer", "format": "int32" }, "speedDial": { "type": "string", "maxLength": 10, "minLength": 0 }, "tradeInstr": { "type": "string", "maxLength": 255, "minLength": 0 }, "isActive": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 20, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 20, "minLength": 0 }, "timestamp": { "type": "string", "format": "byte" }, "vendor": { "type": "string", "maxLength": 50, "minLength": 0 }, "status": { "type": "string", "maxLength": 50, "minLength": 0 }, "restrictionNotes": { "type": "string", "maxLength": 500, "minLength": 0 }, "reregistrationNotes": { "type": "string", "maxLength": 500, "minLength": 0 }, "cstOperationHours": { "type": "string", "maxLength": 20, "minLength": 0 }, "isPhoneTrade": { "type": "boolean" }, "isFaxTrade": { "type": "boolean" }, "isUploadTrade": { "type": "boolean" }, "isConfirmPhone": { "type": "boolean" }, "isConfirmInternet": { "type": "boolean" }, "isConfirmFundServ": { "type": "boolean" }, "isConfirmAps": { "type": "boolean" }, "isConfirmOther": { "type": "boolean" }, "confirmNotes": { "type": "string", "maxLength": 500, "minLength": 0 }, "downloadMethod": { "type": "string", "maxLength": 10, "minLength": 0 }, "downloadNotes": { "type": "string", "maxLength": 500, "minLength": 0 }, "custFundServe": { "type": "string", "maxLength": 20, "minLength": 0 }, "directFundServe": { "type": "string", "maxLength": 20, "minLength": 0 }, "trader": { "type": "string", "maxLength": 20, "minLength": 0 }, "unitBalanceScale": { "type": "integer", "format": "int32" }, "priceScale": { "type": "integer", "format": "int32" }, "isAcctNumUnique": { "type": "boolean" }, "isNetworkingEligible": { "type": "boolean" }, "isShareClassSensitive": { "type": "boolean" }, "sungardBrokerId": { "type": "integer", "format": "int32" }, "personal": { "$ref": "#/definitions/OAS.DataModel.Portfolio.PersonalGlobal" } }, "xml": { "name": "FundFamilyGlobal" }, "type": "object" }, "OAS.DataModel.Portfolio.SubHolding": { "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "maxLength": 150, "minLength": 0 }, "subHoldingDates": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SubHoldingDate" }, "xml": { "name": "SubHoldingDate", "wrapped": true }, "type": "array" } }, "xml": { "name": "SubHolding" }, "type": "object" }, "OAS.DataModel.Portfolio.FundFamilyProduct": { "required": [ "id", "productId", "fundFamilyId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "fundFamilyId": { "type": "integer", "format": "int32" }, "product": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductGlobal" }, "fundFamily": { "$ref": "#/definitions/OAS.DataModel.Portfolio.FundFamilyGlobal" } }, "xml": { "name": "FundFamilyProduct" }, "type": "object" }, "OAS.DataModel.Portfolio.PreferredRate": { "required": [ "id", "productId", "isFixedRate", "isConvertible", "isVotingRights", "isCallable", "isCumulative", "isParticipating", "isInDefault", "createdBy", "createdDate", "editedBy", "editedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "dividendRate": { "type": "number", "format": "double" }, "frequency": { "type": "integer", "format": "int32" }, "parValue": { "type": "number", "format": "double" }, "isFixedRate": { "type": "boolean" }, "isConvertible": { "type": "boolean" }, "isVotingRights": { "type": "boolean" }, "isCallable": { "type": "boolean" }, "isCumulative": { "type": "boolean" }, "isParticipating": { "type": "boolean" }, "isInDefault": { "type": "boolean" }, "createdBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 40, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "PreferredRate" }, "type": "object" }, "OAS.DataModel.Portfolio.ProductUsage": { "required": [ "alClientId", "productId" ], "properties": { "alClientId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "assetCount": { "type": "integer", "format": "int32" }, "units": { "type": "integer", "format": "int32" }, "overridden": { "type": "boolean" }, "editedDate": { "type": "string", "format": "date-time" }, "riskScoreSource": { "type": "string", "enum": [ "Unscored", "FinMason" ] } }, "xml": { "name": "ProductUsage" }, "type": "object" }, "OAS.DataModel.Portfolio.ProductALClient": { "required": [ "productId", "alClientId" ], "properties": { "productId": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" } }, "xml": { "name": "ProductALClient" }, "type": "object" }, "OAS.DataModel.Portfolio.ProductGICSMapping": { "required": [ "id", "sectorCode", "sectorDescription", "industryGroupCode", "industryGroupDescription", "industryCode", "industryDescription", "subIndustryCode", "subIndustryDescription" ], "properties": { "id": { "type": "integer", "format": "int32" }, "sectorCode": { "type": "integer", "format": "int32" }, "sectorDescription": { "type": "string", "maxLength": 60, "minLength": 0 }, "industryGroupCode": { "type": "integer", "format": "int32" }, "industryGroupDescription": { "type": "string", "maxLength": 60, "minLength": 0 }, "industryCode": { "type": "integer", "format": "int32" }, "industryDescription": { "type": "string", "maxLength": 60, "minLength": 0 }, "subIndustryCode": { "type": "integer", "format": "int32" }, "subIndustryDescription": { "type": "string", "maxLength": 60, "minLength": 0 } }, "xml": { "name": "ProductGICSMapping" }, "type": "object" }, "OAS.DataModel.Integration.FinMason.ProductRiskScore": { "required": [ "productId", "asOfDate", "riskScore" ], "properties": { "productId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "riskScore": { "type": "integer", "format": "int32" }, "product": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductGlobal" }, "extension": { "$ref": "#/definitions/OAS.DataModel.Integration.FinMason.ProductRiskScoreExt" } }, "xml": { "name": "ProductRiskScore" }, "type": "object" }, "OAS.DataModel.Portfolio.ProductRiskScoreCurrent": { "properties": { "productPk": { "type": "integer", "format": "int32" }, "riskScore": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "riskScoreMethod": { "type": "string" } }, "xml": { "name": "ProductRiskScoreCurrent" }, "type": "object" }, "OAS.DataModel.Portfolio.ProductGlobalAdditionalInfo": { "required": [ "productId" ], "properties": { "productId": { "type": "integer", "format": "int32" }, "currentOrionPrice": { "type": "number", "format": "double" }, "currentOrionPriceDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "ProductGlobalAdditionalInfo" }, "type": "object" }, "OAS.DataModel.Performance.PortfolioAnalysis": { "required": [ "id", "productId", "productIndex", "alClientId", "whenCalculated" ], "properties": { "id": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "productIndex": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "whenCalculated": { "type": "string", "format": "date-time" }, "standardDeviation": { "type": "number", "format": "double" }, "beta": { "type": "number", "format": "double" }, "alpha": { "type": "number", "format": "double" }, "rSquared": { "type": "number", "format": "double" }, "drawdown": { "type": "number", "format": "double" }, "performance": { "type": "number", "format": "double" }, "sharpe": { "type": "number", "format": "double" }, "sortino": { "type": "number", "format": "double" }, "treynor": { "type": "number", "format": "double" }, "downsideCaptureRatio": { "type": "number", "format": "double" }, "errorMessage": { "type": "string" } }, "xml": { "name": "PortfolioAnalysis" }, "type": "object" }, "OAS.DataModel.Portfolio.PersonalGlobal": { "required": [ "id", "lastName", "entityName", "entity", "isUSResident" ], "properties": { "id": { "type": "integer", "format": "int32" }, "firstName": { "type": "string", "maxLength": 30, "minLength": 0 }, "lastName": { "type": "string", "maxLength": 255, "minLength": 0 }, "entityName": { "type": "string", "maxLength": 255, "minLength": 0 }, "address": { "$ref": "#/definitions/OAS.DataModel.ComplexTypes.Address" }, "homePhone": { "$ref": "#/definitions/OAS.DataModel.ComplexTypes.FullPhoneNumber" }, "businessPhone": { "$ref": "#/definitions/OAS.DataModel.ComplexTypes.FullPhoneNumber" }, "mobilePhone": { "$ref": "#/definitions/OAS.DataModel.ComplexTypes.PhoneNumber" }, "fax": { "$ref": "#/definitions/OAS.DataModel.ComplexTypes.FullPhoneNumber" }, "otherPhone": { "$ref": "#/definitions/OAS.DataModel.ComplexTypes.FullPhoneNumber" }, "pager": { "$ref": "#/definitions/OAS.DataModel.ComplexTypes.FullPhoneNumber" }, "email": { "type": "string", "maxLength": 200, "minLength": 0 }, "webAddress": { "type": "string", "maxLength": 255, "minLength": 0 }, "salutation": { "type": "string", "maxLength": 50, "minLength": 0 }, "ssN_TaxID": { "type": "string", "maxLength": 15, "minLength": 0 }, "deceasedSSN_TaxID": { "type": "string", "maxLength": 15, "minLength": 0 }, "dob": { "type": "string", "maxLength": 20, "minLength": 0 }, "birthDate": { "readOnly": true, "type": "string", "format": "date-time" }, "isSmoker": { "type": "boolean" }, "gender": { "type": "string", "maxLength": 1, "minLength": 0 }, "marital": { "type": "string", "maxLength": 50, "minLength": 0 }, "prefix": { "type": "string", "maxLength": 50, "minLength": 0 }, "suffix": { "type": "string", "maxLength": 50, "minLength": 0 }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "audit": { "$ref": "#/definitions/OAT.DataModel.ComplexTypes.BasicAuditNullNull" }, "personalDesc": { "type": "string", "maxLength": 50, "minLength": 0 }, "isActive": { "type": "boolean" }, "jobTitle": { "type": "string", "maxLength": 200, "minLength": 0 }, "isBlockedPersonOverride": { "type": "boolean" }, "isUSCitizen": { "type": "boolean" }, "company": { "type": "string", "maxLength": 255, "minLength": 0 }, "twitterUsername": { "type": "string", "maxLength": 50, "minLength": 0 }, "facebookUrl": { "type": "string", "maxLength": 8000, "minLength": 0 }, "blobPhotoId": { "type": "integer", "format": "int32" }, "reportName": { "type": "string", "maxLength": 255, "minLength": 0 }, "isUSResident": { "type": "boolean" }, "country": { "type": "string", "maxLength": 150, "minLength": 0 }, "isMobileVerified": { "type": "boolean" } }, "xml": { "name": "PersonalGlobal" }, "type": "object" }, "OAS.DataModel.Portfolio.SubHoldingDate": { "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int32" }, "subHoldingId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "subHoldingAllocs": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SubHoldingAlloc" }, "xml": { "name": "SubHoldingAlloc", "wrapped": true }, "type": "array" } }, "xml": { "name": "SubHoldingDate" }, "type": "object" }, "OAS.DataModel.Integration.FinMason.ProductRiskScoreExt": { "required": [ "productId", "asOfDate", "riskScore" ], "properties": { "productId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "riskScore": { "type": "integer", "format": "int32" }, "productStdDev1Yr": { "type": "number", "format": "double" }, "productStdDev3Yr": { "type": "number", "format": "double" }, "productStdDev5Yr": { "type": "number", "format": "double" }, "productStdDev10Yr": { "type": "number", "format": "double" }, "covarianceProductBench1Yr": { "type": "number", "format": "double" }, "covarianceProductBench3Yr": { "type": "number", "format": "double" }, "covarianceProductBench5Yr": { "type": "number", "format": "double" }, "covarianceProductBench10Yr": { "type": "number", "format": "double" }, "relativeRisk1Yr": { "type": "number", "format": "double" }, "relativeRisk3Yr": { "type": "number", "format": "double" }, "relativeRisk5Yr": { "type": "number", "format": "double" }, "relativeRisk10Yr": { "type": "number", "format": "double" }, "beta1Yr": { "type": "number", "format": "double" }, "beta3Yr": { "type": "number", "format": "double" }, "beta5Yr": { "type": "number", "format": "double" }, "beta10Yr": { "type": "number", "format": "double" }, "benchmarkStdDev1Yr": { "type": "number", "format": "double" }, "benchmarkStdDev3Yr": { "type": "number", "format": "double" }, "benchmarkStdDev5Yr": { "type": "number", "format": "double" }, "benchmarkStdDev10Yr": { "type": "number", "format": "double" }, "clusterCorrelation1Yr": { "type": "number", "format": "double" }, "clusterCorrelation3Yr": { "type": "number", "format": "double" }, "clusterCorrelation5Yr": { "type": "number", "format": "double" }, "clusterCorrelation10Yr": { "type": "number", "format": "double" } }, "xml": { "name": "ProductRiskScoreExt" }, "type": "object" }, "OAS.DataModel.Portfolio.SubHoldingAlloc": { "required": [ "id", "subHoldingDateId", "productId", "allocationPercent", "units" ], "properties": { "id": { "type": "integer", "format": "int32" }, "subHoldingDateId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "allocationPercent": { "type": "number", "format": "double" }, "units": { "type": "number", "format": "double" }, "product": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ProductGlobal" } }, "xml": { "name": "SubHoldingAlloc" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.CorpAction.CorpActionProcessingStatusDto": { "properties": { "id": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "corporateActionId": { "type": "integer", "format": "int32" }, "corporateActionProcessingId": { "type": "integer", "format": "int32" }, "databaseName": { "type": "string" }, "serverName": { "type": "string" }, "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "ticker": { "type": "string" }, "processingType": { "type": "string" }, "effectiveDate": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "New", "Approved", "CreatePendings", "Processing", "InProcess", "Complete", "Cancelled", "RecalculateUnits", "NotProcessed", "MoveCostBasis" ] }, "corporateActionTaskType": { "type": "string" }, "corporateActionTaskQueueStatus": { "type": "string", "enum": [ "Unknown", "Pending", "Skipped", "Complete" ] }, "corporateActionTaskQueueId": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "corporateActionStatus": { "type": "string" }, "mergeOutRatio": { "type": "number", "format": "double" }, "roundingType": { "type": "string", "enum": [ "Normal", "Up", "Down", "Nearest", "NoRounding" ] }, "expectedClose": { "type": "string", "format": "date-time" }, "isHeld": { "type": "boolean" }, "isVerified": { "type": "boolean" }, "isBeginingOfDate": { "type": "boolean" }, "navPrice": { "type": "number", "format": "double" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedBy": { "type": "string" }, "skippedTask": { "type": "boolean" }, "remarks": { "type": "string" }, "recordStatus": { "type": "string" }, "entryDate": { "type": "string", "format": "date-time" }, "recordDate": { "type": "string", "format": "date-time" }, "rate1": { "type": "number", "format": "double" }, "rate2": { "type": "number", "format": "double" }, "cash": { "type": "number", "format": "double" }, "payDate": { "type": "string", "format": "date-time" }, "note": { "type": "string" }, "productType": { "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] } }, "xml": { "name": "CorpActionProcessingStatusDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.CorpAction.CorpActionProcessingStatusCountsDto": { "properties": { "complete": { "type": "integer", "format": "int32" }, "pending": { "type": "integer", "format": "int32" }, "skipped": { "type": "integer", "format": "int32" } }, "xml": { "name": "CorpActionProcessingStatusCountsDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.CorpAction.CorpActionProcessingTaskDto": { "properties": { "corpActionProcessingId": { "type": "integer", "format": "int32" }, "corpActionProcessingTaskType": { "type": "string", "enum": [ "ApproveCorpAction", "DisregardCorpAction", "CreateTransactions", "SetBackToNew", "UpdateDate", "UpdatePriceAmounts", "Cancel", "RecalculateTransactions", "RemoveUncoveredPendings", "CopyProcessingRecord", "BodConversion", "NameChange", "CusipChange" ] }, "effectiveDate": { "type": "string", "format": "date-time" }, "navPrice": { "type": "number", "format": "double" } }, "xml": { "name": "CorpActionProcessingTaskDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.CustomImportFileDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "customImportId": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "newCount": { "type": "integer", "format": "int32" }, "updateCount": { "type": "integer", "format": "int32" }, "errorCount": { "type": "integer", "format": "int32" }, "importStatus": { "type": "string", "enum": [ "None", "Uploaded", "Verifing", "Verified", "Applying", "Applied" ] } }, "xml": { "name": "CustomImportFileDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.CustomImportDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "importName": { "type": "string" }, "importDesc": { "type": "string" } }, "xml": { "name": "CustomImportDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DatabaseBackupFileRestoreHistoryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "pkDatabaseBackupFileRestoreHistory": { "type": "integer", "format": "int32" }, "directory": { "type": "string" }, "fileName": { "type": "string" }, "databaseName": { "type": "string" }, "relatedDatabaseName": { "type": "string" }, "startExecutionTime": { "type": "string", "format": "date-time" }, "endExecutionTime": { "type": "string", "format": "date-time" }, "totalExecutionTimeInMinutes": { "type": "integer", "format": "int32" }, "restoreMessage": { "type": "string" }, "databaseBackupFileRestoreStatus": { "type": "string", "enum": [ "Queued", "Restoring", "Error", "Restored" ] }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdByDisplay": { "type": "string" } }, "xml": { "name": "DatabaseBackupFileRestoreHistoryDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DataQueryEntityExcludeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "database": { "type": "string" }, "dataQueryName": { "type": "string" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "parentId": { "type": "integer", "format": "int32" }, "expirationDate": { "type": "string", "format": "date-time" }, "notes": { "type": "string" }, "alClientId": { "type": "integer", "format": "int32" }, "customRptId": { "type": "integer", "format": "int32" } }, "xml": { "name": "DataQueryEntityExcludeDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadFileCreateTransDto": { "properties": { "confirmOverviewId": { "type": "integer", "format": "int32" }, "downloadSourceId": { "type": "integer", "format": "int32" }, "downloadFileId": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" } }, "xml": { "name": "DownloadFileCreateTransDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.SleeveColumnDataDto": { "properties": { "columnName": { "type": "string" }, "columnSize": { "type": "integer", "format": "int32" }, "columnCodeName": { "type": "string" }, "columnEnabled": { "type": "boolean" } }, "xml": { "name": "SleeveColumnDataDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadFileDetailDto": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "id": { "type": "integer", "format": "int32" }, "downloadFileId": { "type": "integer", "format": "int32" }, "downloadSourceId": { "type": "integer", "format": "int32" }, "downloadDescription": { "type": "string" }, "status": { "type": "string", "enum": [ "NotConfirmed", "Confirmed", "Excluded", "AggregationOnly" ] }, "createdDate": { "type": "string", "format": "date-time" }, "fileDate": { "type": "string", "format": "date-time" }, "link": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFileDetailLinkDto" }, "memoDescription": { "type": "string" }, "memoCount": { "type": "integer", "format": "int32" }, "memoSeverity": { "type": "integer", "format": "int32" }, "memos": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadMemoDto" }, "xml": { "name": "DownloadMemoDto", "wrapped": true }, "type": "array" }, "downloadFormatId": { "type": "integer", "format": "int32" }, "databaseId": { "type": "integer", "format": "int32" }, "databaseName": { "type": "string" }, "memoDescriptionList": { "items": { "type": "string" }, "type": "array" }, "suggestion": { "type": "string" }, "suggestionAuditedBy": { "type": "string" } }, "xml": { "name": "DownloadFileDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadFileDetailLinkDto": { "properties": { "representativeId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "assetId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "transactionId": { "type": "integer", "format": "int32" }, "personalId": { "type": "integer", "format": "int32" }, "receivableId": { "type": "integer", "format": "int32" }, "dividendId": { "type": "integer", "format": "int32" } }, "xml": { "name": "DownloadFileDetailLinkDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadMemoDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "memoCode": { "type": "integer", "format": "int32" }, "description": { "type": "string" } }, "xml": { "name": "DownloadMemoDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.RateAgentNextBestActionRequestDto": { "required": [ "accuracy", "records" ], "properties": { "accuracy": { "description": "One of: Is Accurate, Not Accurate, Partially Accurate.", "type": "string" }, "notes": { "description": "Required when accuracy is Not Accurate or Partially Accurate.", "type": "string" }, "records": { "description": "Download rows to rate; each entry includes {OAS.WebApi.DTO.Confirm.RateAgentNextBestActionRecordRequestDto.DownloadFileId} and detail {OAS.WebApi.DTO.Confirm.RateAgentNextBestActionRecordRequestDto.Id}.", "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.RateAgentNextBestActionRecordRequestDto" }, "xml": { "name": "RateAgentNextBestActionRecordRequestDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "RateAgentNextBestActionRequestDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.RateAgentNextBestActionRecordRequestDto": { "description": "One download detail row to rate, identified by file and record id (JSON: downloadFileId, id).", "properties": { "downloadFileId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" } }, "xml": { "name": "RateAgentNextBestActionRecordRequestDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadFileDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "downloadSource": { "type": "string" }, "fileName": { "type": "string" }, "fileDate": { "type": "string", "format": "date-time" }, "recordType": { "type": "string", "enum": [ "Name", "Position", "Transaction", "Price", "Dividend", "Product", "NotImported", "Header", "Security", "CorpAction", "TranDetail", "Generic", "CostBasis", "Beneficiary", "StoredPerformance", "Systematic", "RMD", "Banking" ] }, "totalRecords": { "type": "integer", "format": "int32" }, "totalRecordsImported": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "dateConfirmed": { "type": "string", "format": "date-time" }, "notConfirmed": { "type": "integer", "format": "int32" }, "confirmed": { "type": "integer", "format": "int32" }, "excluded": { "type": "integer", "format": "int32" }, "costBasisType": { "type": "string", "enum": [ "None", "Unrealized", "Realized", "Both" ] }, "batchProcessingId": { "type": "integer", "format": "int32" } }, "xml": { "name": "DownloadFileDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadFilesOptionsDto": { "properties": { "downloadFileIds": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFileKeyValue" }, "xml": { "name": "DownloadFileKeyValue", "wrapped": true }, "type": "array" } }, "xml": { "name": "DownloadFilesOptionsDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadFileKeyValue": { "properties": { "alClientId": { "type": "integer", "format": "int32" }, "fileId": { "type": "integer", "format": "int32" } }, "xml": { "name": "DownloadFileKeyValue" }, "type": "object" }, "OAS.DataModel.Confirm.ConfirmExclusionReason": { "properties": { "id": { "type": "integer", "format": "int32" }, "reason": { "type": "string" } }, "xml": { "name": "ConfirmExclusionReason" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadFileImportFileDto": { "properties": { "downloadSourceId": { "type": "integer", "format": "int32" }, "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" }, "autoApply": { "type": "string", "enum": [ "None", "VerifyPrice", "ApplyPrice", "VerifyName", "ApplyName", "VerifyTran", "ApplyTran", "VerifyPos", "ApplyPos", "VerifyCorpAction", "ApplyCorpAction", "VerifySecurity", "ApplySecurity", "VerifyDiv", "ApplyDiv", "VerifyTranDetail", "ApplyTranDetail", "VerifyGeneric", "ApplyGeneric", "VerifyCostBasis", "ApplyCostBasis", "VerifyBeneficiary", "ApplyBeneficiary", "VerifyBanking", "ApplyBanking", "VerifyRMD", "ApplyRMD", "VerifySystematic", "ApplySystematic", "VerifyStoredPerformance", "ApplyStoredPerformance", "VerifyAndApplyAll" ] } }, "xml": { "name": "DownloadFileImportFileDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadFileImportMultiFileDto": { "properties": { "downloadSourceId": { "description": "The Download Source ID", "type": "integer", "format": "int32" }, "files": { "description": "The HttpFiles", "items": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" }, "xml": { "name": "HttpFile", "wrapped": true }, "type": "array" }, "autoApply": { "description": "Enum Representing if to apply/verify", "type": "string", "enum": [ "None", "VerifyPrice", "ApplyPrice", "VerifyName", "ApplyName", "VerifyTran", "ApplyTran", "VerifyPos", "ApplyPos", "VerifyCorpAction", "ApplyCorpAction", "VerifySecurity", "ApplySecurity", "VerifyDiv", "ApplyDiv", "VerifyTranDetail", "ApplyTranDetail", "VerifyGeneric", "ApplyGeneric", "VerifyCostBasis", "ApplyCostBasis", "VerifyBeneficiary", "ApplyBeneficiary", "VerifyBanking", "ApplyBanking", "VerifyRMD", "ApplyRMD", "VerifySystematic", "ApplySystematic", "VerifyStoredPerformance", "ApplyStoredPerformance", "VerifyAndApplyAll" ] }, "fromUrl": { "description": "Bool flag indicating whether it is from a url", "type": "boolean" } }, "xml": { "name": "DownloadFileImportMultiFileDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadFileImportMultiFileReturnDto": { "description": "Download File Import Multiple File Return DTO", "properties": { "filename": { "description": "The file name being imported", "type": "string" }, "batchProcessingId": { "description": "Batch Processing Id for the import", "type": "integer", "format": "int32" }, "errorMessage": { "description": "Any error message from trying to start the import", "type": "string" } }, "xml": { "name": "DownloadFileImportMultiFileReturnDto" }, "type": "object" }, "OAS.Remote.Confirmation.VerifyApplyFileRequest": { "properties": { "downloadFileId": { "type": "integer", "format": "int32" }, "apply": { "type": "boolean" }, "triggerAgenticRecon": { "type": "boolean" }, "currentAttempt": { "type": "integer", "format": "int32" } }, "xml": { "name": "VerifyApplyFileRequest" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadFileImportFilesMultiDownloadSourceDto": { "properties": { "downloadSourceIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "autoApply": { "type": "string", "enum": [ "None", "VerifyPrice", "ApplyPrice", "VerifyName", "ApplyName", "VerifyTran", "ApplyTran", "VerifyPos", "ApplyPos", "VerifyCorpAction", "ApplyCorpAction", "VerifySecurity", "ApplySecurity", "VerifyDiv", "ApplyDiv", "VerifyTranDetail", "ApplyTranDetail", "VerifyGeneric", "ApplyGeneric", "VerifyCostBasis", "ApplyCostBasis", "VerifyBeneficiary", "ApplyBeneficiary", "VerifyBanking", "ApplyBanking", "VerifyRMD", "ApplyRMD", "VerifySystematic", "ApplySystematic", "VerifyStoredPerformance", "ApplyStoredPerformance", "VerifyAndApplyAll" ] }, "encoding": { "type": "string" } }, "xml": { "name": "DownloadFileImportFilesMultiDownloadSourceDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.BatchProcessingDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "correlationId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "alClientName": { "type": "string" }, "status": { "type": "string", "enum": [ "New", "Processing", "Failed", "PartiallyComplete", "Complete", "Canceled" ] }, "message": { "readOnly": true, "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedDate": { "type": "string", "format": "date-time" }, "elapsed": { "readOnly": true, "type": "string" }, "parentId": { "type": "integer", "format": "int32" }, "isDone": { "type": "boolean" }, "totalItems": { "type": "integer", "format": "int32" }, "itemsCompleted": { "type": "integer", "format": "int32" }, "processingType": { "type": "string", "enum": [ "Undefined", "Trading", "PendingTransactions", "CheckForWashTrades", "CustomImport", "CostBasis", "Composites", "TradeExecution", "ConvertToSleeves", "Confirmation", "DataQueries", "Notifications", "Export", "Maintenance", "ConfirmationUndo" ] }, "errorCount": { "readOnly": true, "type": "integer", "format": "int32" }, "warningCount": { "type": "integer", "format": "int32" }, "details": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.BatchProcessingErrorDto" }, "xml": { "name": "BatchProcessingErrorDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "BatchProcessingDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.BatchProcessingErrorDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "batchId": { "type": "integer", "format": "int32" }, "errorMessage": { "type": "string" }, "details": { "type": "string" }, "severityCode": { "type": "integer", "format": "int32" }, "severity": { "type": "string", "enum": [ "Error", "Warning", "Information" ] }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "BatchProcessingErrorDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.GridCountDto": { "properties": { "name": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "object" }, "count": { "type": "integer", "format": "int32" } }, "xml": { "name": "GridCountDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadSubFormatSchedulerDefaultDto": { "properties": { "downloadFormatId": { "type": "integer", "format": "int32" }, "downloadFormatSubTypeId": { "type": "integer", "format": "int32" }, "isAltSchedule": { "type": "boolean" }, "notificationGroup": { "type": "integer", "format": "int32" }, "notifyOnSuccess": { "type": "boolean" }, "active": { "type": "boolean" }, "priorityJob": { "type": "boolean" }, "interval": { "type": "string", "enum": [ "Minute", "Hour", "Day", "Week", "Month", "Quarter", "Year" ] }, "frequency": { "type": "integer", "format": "int32" }, "offset": { "type": "integer", "format": "int32" }, "offsetInterval": { "type": "string", "enum": [ "Minute", "Hour", "Day", "Week", "Month", "Quarter", "Year" ] }, "startTime": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" }, "runDays": { "type": "string", "enum": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday", "Everyday", "Weekdays", "Weekends", "TuesdayToSaturday" ] }, "businessDayOfMonth": { "type": "string" }, "schedulerTypeName": { "type": "string" }, "filePath": { "type": "string" }, "folderPath": { "type": "string" }, "searchPattern": { "type": "string" }, "searchOption": { "type": "string", "enum": [ "TopDirectoryOnly", "AllDirectories" ] }, "importFiles": { "type": "boolean" }, "applyPriceAndSecurity": { "type": "boolean" }, "applyName": { "type": "boolean" }, "applyPosition": { "type": "boolean" }, "applyTransaction": { "type": "boolean" }, "applyDividend": { "type": "boolean" }, "applyCorpAction": { "type": "boolean" }, "applyTranDetail": { "type": "boolean" }, "applyGeneric": { "type": "boolean" }, "applyCostBasis": { "type": "boolean" }, "applyBeneficiary": { "type": "boolean" }, "applySystematic": { "type": "boolean" }, "applyRMD": { "type": "boolean" }, "applyBanking": { "type": "boolean" }, "useThreading": { "type": "boolean" }, "numberOfThreads": { "type": "integer", "format": "int32" }, "sizeOfBatch": { "type": "integer", "format": "int32" }, "useAlternateFilePattern": { "type": "boolean" }, "expectedNumberOfFiles": { "type": "integer", "format": "int32" }, "parentJobID": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "isCostBasis": { "type": "boolean" }, "addToFetchJobScheduleID": { "type": "string" } }, "xml": { "name": "DownloadSubFormatSchedulerDefaultDto" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadSubFormatSchedulerDefaultKey": { "properties": { "downloadFormatId": { "type": "integer", "format": "int32" }, "downloadFormatSubTypeId": { "type": "integer", "format": "int32" }, "isCostBasis": { "type": "boolean" } }, "xml": { "name": "DownloadSubFormatSchedulerDefaultKey" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadFormatVerboseDto": { "description": "The Download Format Verbose DTO", "properties": { "id": { "description": "Download Format ID", "type": "integer", "format": "int32" }, "downloadFormat": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFormatDto", "description": "Download Format Properties" }, "downloadFormatNoteMapping": { "description": "The Download Format Mappings for the download format", "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFormatNoteMappingDto" }, "xml": { "name": "DownloadFormatNoteMappingDto", "wrapped": true }, "type": "array" }, "downloadFormatLocalSecurityMappings": { "description": "The Download Format Local Security Mappings for the format", "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFormatLocalSecurityMappingDto" }, "xml": { "name": "DownloadFormatLocalSecurityMappingDto", "wrapped": true }, "type": "array" }, "downloadFormatUniqueSymbolMappings": { "description": "The Download Format Unique Symbol Mappings for the format", "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFormatUniqueSymbolMappingDto" }, "xml": { "name": "DownloadFormatUniqueSymbolMappingDto", "wrapped": true }, "type": "array" }, "downloadFormatTransactionNoteMappings": { "description": "The Download Format Transaction Note Mappings for the format", "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFormatTransactionNoteSymbolMappingDto" }, "xml": { "name": "DownloadFormatTransactionNoteSymbolMappingDto", "wrapped": true }, "type": "array" }, "downloadFormatSubTypes": { "description": "The Download Format Subtypes for the format", "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFormatSubTypeDto" }, "xml": { "name": "DownloadFormatSubTypeDto", "wrapped": true }, "type": "array" }, "downloadFormatOffsetCashMappings": { "description": "The Download Format Offset Cash Mappings for the format", "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadFormatOffsetCashMappingDto" }, "xml": { "name": "DownloadFormatOffsetCashMappingDto", "wrapped": true }, "type": "array" }, "processCostBasisTypeEnabled": { "description": "When true, cost basis type is stored per format subtype and extended dropdown values are available (OC-16422).", "type": "boolean" } }, "xml": { "name": "DownloadFormatVerboseDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadFormatDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "formatName": { "type": "string" }, "costBasisType": { "type": "string", "enum": [ "None", "Unrealized", "Realized", "Both" ] }, "formatInformation": { "type": "string" }, "isNonFileFormat": { "type": "boolean" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "downloadFormatConfigJSON": { "type": "string" } }, "xml": { "name": "DownloadFormatDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadFormatNoteMappingDto": { "description": "A Download Format Note Mapping DTO", "properties": { "id": { "description": "Gets or sets the ID", "type": "integer", "format": "int32" }, "fileTranCode": { "description": "Gets or sets the File Tran Code", "type": "string" }, "searchFor": { "description": "Gets or sets the Search For", "type": "string" }, "translateTo": { "description": "Gets or sets the Translate To", "type": "string" }, "auditedDate": { "description": "Gets or sets the Audited Date (used in Audited Date String)", "type": "string", "format": "date-time" }, "auditedByDisplay": { "description": "Gets or sets the AuditedByDisplay", "type": "string" }, "downloadFormatId": { "description": "Gets or sets the download format id", "type": "integer", "format": "int32" }, "downloadFormatSubtypeId": { "description": "Gets or sets the download format subtype id", "type": "integer", "format": "int32" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 } }, "xml": { "name": "DownloadFormatNoteMappingDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadFormatLocalSecurityMappingDto": { "description": "A Download Format Local Security Mapping DTO", "properties": { "downloadSymbol": { "description": "Gets or sets The Download Symbol", "type": "string" }, "localMapping": { "description": "Gets or sets the Local Mapping", "type": "string" }, "auditedDateString": { "description": "Gets the Audited Date String", "readOnly": true, "type": "string" }, "auditedDate": { "description": "Gets or sets the Audited Date (used in Audited Date String)", "type": "string", "format": "date-time" }, "auditedByDisplay": { "description": "Gets or sets the AuditedByDisplay", "type": "string" }, "downloadFormatId": { "description": "Gets or sets the download format id", "type": "integer", "format": "int32" }, "downloadFormatSubtypeId": { "description": "Gets or sets the download format subtype id", "type": "integer", "format": "int32" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 } }, "xml": { "name": "DownloadFormatLocalSecurityMappingDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadFormatUniqueSymbolMappingDto": { "description": "Download Format Unique Symbol Mapping DTO", "properties": { "uniqueSymbol": { "description": "Gets or sets the Unique Symbol", "type": "string" }, "auditedDateString": { "description": "Gets the Audited Date String", "readOnly": true, "type": "string" }, "auditedDate": { "description": "Gets or sets the Audited Date (used in Audited Date String)", "type": "string", "format": "date-time" }, "auditedByDisplay": { "description": "Gets or sets the AuditedByDisplay", "type": "string" }, "downloadFormatId": { "description": "Gets or sets the download format id", "type": "integer", "format": "int32" }, "downloadFormatSubtypeId": { "description": "Gets or sets the download format subtype id", "type": "integer", "format": "int32" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 } }, "xml": { "name": "DownloadFormatUniqueSymbolMappingDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadFormatTransactionNoteSymbolMappingDto": { "description": "A Download Format Transaction Note Symbol Mapping DTO", "properties": { "id": { "description": "The Primary Key for DownloadFormatTransactionNoteSymbolMapping", "type": "integer", "format": "int32" }, "downloadSymbol": { "description": "The Download Symbol to find", "type": "string" }, "newSymbol": { "description": "The new Symbol to replace with", "type": "string" }, "note": { "description": "A note field for user notes", "type": "string" }, "auditedDateString": { "description": "Gets the Audited Date String", "readOnly": true, "type": "string" }, "auditedDate": { "description": "Gets or sets the Audited Date (used in Audited Date String)", "type": "string", "format": "date-time" }, "auditedByDisplay": { "description": "Gets or sets the AuditedByDisplay", "type": "string" }, "downloadFormatId": { "description": "Gets or sets the download format id", "type": "integer", "format": "int32" }, "downloadFormatSubtypeId": { "description": "Gets or sets the download format subtype id", "type": "integer", "format": "int32" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 } }, "xml": { "name": "DownloadFormatTransactionNoteSymbolMappingDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadFormatSubTypeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "downloadFormatId": { "type": "integer", "format": "int32" }, "downloadFormatConfigJSON": { "type": "string" }, "costBasisType": { "type": "string", "enum": [ "None", "Unrealized", "Realized", "Both" ] } }, "xml": { "name": "DownloadFormatSubTypeDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadFormatOffsetCashMappingDto": { "description": "A Download Format Offset Cash Mapping DTO", "properties": { "externalCode": { "description": "Gets or sets the External Code", "type": "string" }, "cashSymbol": { "description": "Gets or sets the Cash Symbol", "type": "string" }, "downloadFormatId": { "description": "Gets or sets the download format id", "type": "integer", "format": "int32" }, "downloadFormatSubtypeId": { "description": "Gets or sets the download format subtype id", "type": "integer", "format": "int32" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 } }, "xml": { "name": "DownloadFormatOffsetCashMappingDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadFormatMarkupDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "xml": { "type": "string" } }, "xml": { "name": "DownloadFormatMarkupDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadFormatRectypeDto": { "properties": { "recTypeBySectionName": { "additionalProperties": { "type": "string" }, "type": "object" } }, "xml": { "name": "DownloadFormatRectypeDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadFormatSourceDefaultDto": { "properties": { "downloadFormatId": { "type": "integer", "format": "int32" }, "downloadDescription": { "type": "string" }, "custodianCommonCode": { "type": "string" }, "serviceTeamReconId": { "type": "integer", "format": "int32" }, "serviceTeamMemberId": { "type": "integer", "format": "int32" }, "newAccounts": { "type": "string", "enum": [ "Default", "DoNotCreate", "Create", "AutoExclude" ] }, "reconTargetTime": { "type": "string", "format": "date-time" }, "note": { "type": "string" }, "transmitMethod": { "type": "string", "enum": [ "Empty", "None", "FTP", "DSTHTTP", "Network", "SFTP", "FTPS", "HTTPS", "S3" ] }, "url": { "type": "string" }, "filePattern": { "type": "string" }, "altFilePattern": { "type": "string" }, "patternMatchType": { "type": "string", "enum": [ "Included", "Excluded" ] }, "zipPassword": { "type": "string" }, "userId": { "type": "string" }, "password": { "type": "string" }, "transPercTolerance": { "type": "number", "format": "double" }, "transDaysTolerance": { "type": "integer", "format": "int32" }, "cashCusip": { "type": "string" }, "deleteSourceFile": { "type": "boolean" }, "registrationBaseNumber": { "type": "integer", "format": "int32" }, "positionOnlyReconcile": { "type": "string", "enum": [ "No", "Yes", "EnabledAccountsOnly", "AIP", "EnabledAccountsOnlyAIP", "EnabledAccountsOnlyHAA", "HAA" ] }, "dailyAccrualTolerance": { "type": "number", "format": "double" }, "useReversal": { "type": "boolean" }, "ignoreRepVerify": { "type": "boolean" }, "isAutoHouseholding": { "type": "boolean" }, "noOrionPriceCopy": { "type": "boolean" }, "newAccountCenterSuppression": { "type": "boolean" }, "isFixSmallBalance": { "type": "boolean" }, "isDividendTransactionCombination": { "type": "boolean" }, "alwaysCreateNewRegistration": { "type": "boolean" }, "namePercentMatch": { "type": "number", "format": "double" }, "positionPercentMatch": { "type": "number", "format": "double" }, "transactionPercentMatch": { "type": "number", "format": "double" }, "comparePositionValue": { "type": "boolean" }, "runAssetValueComparison": { "type": "boolean" }, "isSourceExclusionCB": { "type": "boolean" }, "isSourceExclusionTran": { "type": "boolean" }, "isUnVerifiedSells": { "type": "boolean" }, "allowPriceZero": { "type": "boolean" }, "allowAcctCodeMatch": { "type": "boolean" }, "allowAcctCodeMatchWOZero": { "type": "boolean" }, "allowSecondaryAcctCodeMatch": { "type": "boolean" }, "allowPriceImport": { "type": "boolean" }, "allowNameImport": { "type": "boolean" }, "allowPositionImport": { "type": "boolean" }, "allowTransactionImport": { "type": "boolean" }, "allowSecurityImport": { "type": "boolean" }, "allowCorpActionImport": { "type": "boolean" }, "allowDivImport": { "type": "boolean" }, "allowBeneficiaryImport": { "type": "boolean" }, "allowSystematicImport": { "type": "boolean" }, "allowRMDImport": { "type": "boolean" }, "allowBankingImport": { "type": "boolean" }, "allowTranDetailImport": { "type": "boolean" }, "allowGenericImport": { "type": "boolean" }, "allowCostBasisImport": { "type": "boolean" }, "isActive": { "type": "boolean" }, "downloadSourceOptionJSON": { "type": "string" }, "autoCreateStartingValues": { "type": "boolean" }, "archiveFiles": { "type": "boolean" }, "underReview": { "type": "boolean" }, "isOrionEnterpriseEnabled": { "type": "boolean" }, "allowDuplicateAssets": { "type": "boolean" }, "allowProperName": { "type": "boolean" }, "removeSettleDateTrades": { "type": "boolean" }, "principalAndIncome": { "type": "boolean" }, "createTransactionInPendingStatus": { "type": "boolean" }, "hasSftpKey": { "readOnly": true, "type": "boolean" }, "isSshEnabled": { "type": "boolean" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "downloadFormatSubTypeId": { "type": "integer", "format": "int32" }, "downloadFormatSubTypeName": { "type": "string" }, "schedules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadSubFormatSourceScheduleDefaultDto" }, "xml": { "name": "DownloadSubFormatSourceScheduleDefaultDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "DownloadFormatSourceDefaultDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadSubFormatSourceScheduleDefaultDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "downloadFormatId": { "type": "integer", "format": "int32" }, "downloadFormatSubTypeId": { "type": "integer", "format": "int32" }, "scheduledTime": { "type": "string" }, "scheduleConfiguration": { "type": "string" }, "active": { "type": "boolean" } }, "xml": { "name": "DownloadSubFormatSourceScheduleDefaultDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.SourceFileDto": { "properties": { "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" } }, "xml": { "name": "SourceFileDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadFormatVersionALClientDto": { "properties": { "databaseName": { "type": "string" }, "downloadFormatVersionId": { "type": "integer", "format": "int32" }, "auditedBy": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "alClientId": { "type": "integer", "format": "int32" }, "downloadFormatId": { "type": "integer", "format": "int32" } }, "xml": { "name": "DownloadFormatVersionALClientDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.LocalDownloadMapDto": { "required": [ "orionKey", "tableName", "externalCode" ], "properties": { "id": { "type": "integer", "format": "int32" }, "orionKey": { "type": "integer", "format": "int32", "maximum": 2147483647, "minimum": 1 }, "orionName": { "type": "string" }, "tableName": { "type": "string", "maxLength": 50, "minLength": 1 }, "externalCode": { "type": "string", "maxLength": 50, "minLength": 1 } }, "xml": { "name": "LocalDownloadMapDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadMapTableDto": { "properties": { "name": { "type": "string" } }, "xml": { "name": "DownloadMapTableDto" }, "type": "object" }, "OAS.WebApi.Domains.Confirm.DownloadMapALClientDto": { "properties": { "downloadSourceName": { "type": "string" }, "downloadSourceId": { "type": "integer", "format": "int32" }, "firmParseCode": { "type": "string" }, "clientName": { "type": "string" }, "alClientId": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedBy": { "type": "string" } }, "xml": { "name": "DownloadMapALClientDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadMapDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "tableName": { "type": "string" }, "downloadFormatId": { "type": "integer", "format": "int32" }, "downloadFormat": { "type": "string" }, "downloadFormatSubTypeId": { "type": "integer", "format": "int32" }, "downloadFormatSubType": { "type": "string" }, "externalCode": { "type": "string" }, "orionKey": { "type": "integer", "format": "int32" }, "orionKeyDescription": { "type": "string" }, "mappingLevel": { "type": "string" }, "downloadSourceId": { "type": "integer", "format": "int32" }, "downloadSource": { "type": "string" }, "isCommon": { "type": "boolean" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "DownloadMapDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadPositionRuleDto": { "properties": { "positionPostVerifyRules": { "type": "string" }, "positionPostVerifyUserDefinedID": { "type": "integer", "format": "int32" } }, "xml": { "name": "DownloadPositionRuleDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadProcessConfigurationDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "downloadProcessTypeId": { "type": "integer", "format": "int32" }, "runOrder": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "downloadProcessId": { "type": "integer", "format": "int32" }, "processName": { "type": "string" }, "includeType": { "type": "boolean" }, "configJSON": { "type": "string" }, "alClientIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "DownloadProcessConfigurationDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadProcessConfigurationAdHocDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "downloadProcessTypeId": { "type": "integer", "format": "int32" }, "runOrder": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "downloadProcessId": { "type": "integer", "format": "int32" }, "processName": { "type": "string" }, "configJSON": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "DownloadProcessConfigurationAdHocDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.AutoScrubAdHocBatchCreateDto": { "required": [ "batchName" ], "properties": { "batchName": { "type": "string", "maxLength": 255, "minLength": 1 }, "downloadProcessConfigurationListJson": { "type": "string" }, "repList": { "type": "string" }, "accountList": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "AutoScrubAdHocBatchCreateDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.AutoScrubAdHocBatchUpdateDto": { "properties": { "batchStatus": { "type": "string", "enum": [ "Pending", "AddingTransactionsToQueue", "Processing", "Complete", "Cancelled", "Error" ] } }, "xml": { "name": "AutoScrubAdHocBatchUpdateDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.ScrubAutomationRulesDTO": { "properties": { "scrubAutomationRules": { "type": "string" }, "scrubAutomationUserDefinedDataID": { "type": "integer", "format": "int32" } }, "xml": { "name": "ScrubAutomationRulesDTO" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadSourceNoteDto": { "properties": { "downloadSourceId": { "type": "integer", "format": "int32" }, "downloadSourceDescription": { "type": "string" }, "serviceTeam": { "type": "string" }, "analystAssigned": { "type": "string" }, "downloadFormat": { "type": "string" }, "downloadFormatId": { "type": "integer", "format": "int32" }, "analystNote": { "type": "string" }, "advisorNote": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "analystNoteEditedDate": { "type": "string", "format": "date-time" }, "analystNoteEditedBy": { "type": "string" }, "advisorNoteEditedDate": { "type": "string", "format": "date-time" }, "advisorNoteEditedBy": { "type": "string" }, "isDownloadSourceActive": { "type": "boolean" } }, "xml": { "name": "DownloadSourceNoteDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadSourceQueueLogMessageDto": { "properties": { "id": { "type": "string" }, "time": { "type": "string", "format": "date-time" }, "message": { "type": "string" } }, "xml": { "name": "DownloadSourceQueueLogMessageDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.DownloadSourceVerboseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "portfolio": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadSourceDto" }, "schedules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadSourceScheduleDto" }, "xml": { "name": "DownloadSourceScheduleDto", "wrapped": true }, "type": "array" }, "logs": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadSourceQueueLogDto" }, "xml": { "name": "DownloadSourceQueueLogDto", "wrapped": true }, "type": "array" }, "defaults": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadSourceDefaultDto" } }, "xml": { "name": "DownloadSourceVerboseDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadSourceDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "downloadDescription": { "type": "string" }, "downloadFormatId": { "type": "integer", "format": "int32" }, "downloadFormatSubTypeId": { "type": "integer", "format": "int32" }, "downloadFormat": { "type": "string" }, "downloadSourceParentId": { "type": "integer", "format": "int32" }, "custodianCommon": { "type": "string" }, "custodianCommonCode": { "type": "string" }, "custodianCommonId": { "type": "integer", "format": "int32" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "serviceTeamReconId": { "type": "integer", "format": "int32" }, "serviceTeamRecon": { "type": "string" }, "serviceTeamMemberId": { "type": "integer", "format": "int32" }, "transmitMethod": { "type": "string", "enum": [ "Empty", "None", "FTP", "DSTHTTP", "Network", "SFTP", "FTPS", "HTTPS", "S3" ] }, "note": { "type": "string" }, "registrationBaseNumber": { "type": "integer", "format": "int32" }, "url": { "type": "string" }, "userId": { "type": "string" }, "alClientId": { "type": "integer", "format": "int32" }, "clientName": { "type": "string" }, "filePattern": { "type": "string" }, "transPercTolerance": { "type": "number", "format": "double" }, "transDaysTolerance": { "type": "integer", "format": "int32" }, "deleteSourceFile": { "type": "boolean" }, "cashCusip": { "type": "string" }, "allowPriceImport": { "type": "boolean" }, "allowSecondaryAcctCodeMatch": { "type": "boolean" }, "allowAcctCodeMatch": { "type": "boolean" }, "allowNameImport": { "type": "boolean" }, "allowPositionImport": { "type": "boolean" }, "allowTransactionImport": { "type": "boolean" }, "allowSecurityImport": { "type": "boolean" }, "allowCorpActionImport": { "type": "boolean" }, "allowDivImport": { "type": "boolean" }, "allowBankingImport": { "type": "boolean" }, "allowDuplicateAssets": { "type": "boolean" }, "allowProperName": { "type": "boolean" }, "advReportable": { "type": "boolean" }, "thirteenFReportable": { "type": "boolean" }, "underReview": { "type": "boolean" }, "principalAndIncome": { "type": "boolean" }, "autoCreateStartingValues": { "type": "boolean" }, "removeSettleDateTrades": { "type": "boolean" }, "allowRMDImport": { "type": "boolean" }, "allowBeneficiaryImport": { "type": "boolean" }, "allowSystematicImport": { "type": "boolean" }, "patternMatchType": { "type": "string", "enum": [ "Included", "Excluded" ] }, "baseAcctLength": { "type": "integer", "format": "int32" }, "useReversal": { "type": "boolean" }, "allowTranDetailImport": { "type": "boolean" }, "allowGenericImport": { "type": "boolean" }, "allowCostBasisImport": { "type": "boolean" }, "isAutoHouseholding": { "type": "boolean" }, "isAcctCreation": { "type": "boolean" }, "isUnVerifiedSells": { "type": "boolean" }, "createTransactionInPendingStatus": { "type": "boolean" }, "ignoreRepVerify": { "type": "boolean" }, "doNotUseBulk": { "type": "boolean" }, "altFilePattern": { "type": "string" }, "allowPriceZero": { "type": "boolean" }, "reconTargetTime": { "type": "string", "format": "date-time" }, "comparePositionValue": { "type": "boolean" }, "newAccounts": { "type": "string", "enum": [ "Default", "DoNotCreate", "Create", "AutoExclude" ] }, "runAssetValueComparison": { "type": "boolean" }, "alwaysCreateNewRegistration": { "type": "boolean" }, "allowAcctCodeMatchWOZero": { "type": "boolean" }, "isSourceExclusionCB": { "type": "boolean" }, "isSourceExclusionTran": { "type": "boolean" }, "noOrionPriceCopy": { "type": "boolean" }, "namePercentMatch": { "type": "number", "format": "double" }, "positionPercentMatch": { "type": "number", "format": "double" }, "transactionPercentMatch": { "type": "number", "format": "double" }, "archiveFiles": { "type": "boolean" }, "positionOnlyReconcile": { "type": "string", "enum": [ "No", "Yes", "EnabledAccountsOnly", "AIP", "EnabledAccountsOnlyAIP", "EnabledAccountsOnlyHAA", "HAA" ] }, "dailyAccrualTolerance": { "type": "number", "format": "double" }, "isFixSmallBalance": { "type": "boolean" }, "isDividendTransactionCombination": { "type": "boolean" }, "newAccountCenterSuppression": { "type": "boolean" }, "isOrionEnterpriseEnabled": { "type": "boolean" }, "isSshEnabled": { "type": "boolean" }, "isCreateJobSchedule": { "type": "boolean" }, "nextScheduledRunDate": { "type": "string", "format": "date-time" }, "downloadSourceOptionJSON": { "type": "string" }, "hasSftpKey": { "readOnly": true, "type": "boolean" }, "password": { "type": "string" }, "zipPassword": { "type": "string" } }, "xml": { "name": "DownloadSourceDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadSourceScheduleDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "downloadSourceId": { "type": "integer", "format": "int32" }, "time": { "type": "string" }, "skipHolidays": { "type": "boolean" }, "scheduleConfiguration": { "type": "string" } }, "xml": { "name": "DownloadSourceScheduleDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadSourceQueueLogDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "downloadSourceId": { "type": "integer", "format": "int32" }, "messages": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.DownloadSourceQueueLogMessageDto" }, "xml": { "name": "DownloadSourceQueueLogMessageDto", "wrapped": true }, "type": "array" }, "jobId": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "DownloadSourceQueueLogDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadSourceDefaultDto": { "properties": { "representativeId": { "type": "integer", "format": "int32" }, "riaId": { "type": "integer", "format": "int32" }, "fundFamilyId": { "type": "integer", "format": "int32" }, "registrationTypeId": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "shareClassId": { "type": "integer", "format": "int32" }, "platformId": { "type": "integer", "format": "int32" }, "subAdvisorId": { "type": "integer", "format": "int32" }, "createSweepAccts": { "type": "boolean" }, "createTradeBlock": { "type": "boolean" }, "notes": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "isDiscretionary": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "modelAggId": { "type": "integer", "format": "int32" }, "businessLineId": { "type": "integer", "format": "int32" }, "isWrapManaged": { "type": "boolean" }, "isWrapSponsored": { "type": "boolean" }, "isAuaReportable": { "type": "boolean" } }, "xml": { "name": "DownloadSourceDefaultDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadTextModificationDto": { "required": [ "id", "downloadFormatId", "modificationType", "recordType", "runOrder" ], "properties": { "id": { "type": "integer", "format": "int32" }, "downloadFormatId": { "type": "integer", "format": "int32" }, "downloadFormatSubtypeId": { "type": "integer", "format": "int32" }, "modificationType": { "type": "string", "enum": [ "FindAndReplace", "Proper", "SmartProper", "Remove", "RemoveTextAfterText", "RemovingLeadingZeroes", "DateFormatting" ] }, "externalText": { "type": "string" }, "newText": { "type": "string" }, "recordType": { "type": "string", "enum": [ "Name", "Position", "Transaction", "Price", "Dividend", "Product", "NotImported", "Header", "Security", "CorpAction", "TranDetail", "Generic", "CostBasis", "Beneficiary", "StoredPerformance", "Systematic", "RMD", "Banking" ] }, "runOrder": { "type": "integer", "format": "int32" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "downloadFormatName": { "type": "string" }, "downloadFormatSubTypeName": { "type": "string" } }, "xml": { "name": "DownloadTextModificationDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Recon.DuplicateAccountMappingDto": { "properties": { "downloadSourceId": { "type": "integer", "format": "int32" }, "accountCode": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "auditedBy": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "DuplicateAccountMappingDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Recon.DuplicateAccountMappingUpsertRequestDto": { "properties": { "originalCopy": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Recon.DuplicateAccountMappingDto" }, "changedMapping": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Recon.DuplicateAccountMappingDto" } }, "xml": { "name": "DuplicateAccountMappingUpsertRequestDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadExcludeCommonDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "downloadFormatId": { "type": "integer", "format": "int32" }, "downloadFormat": { "type": "string" }, "cusip": { "type": "string" }, "ticker": { "type": "string" }, "recordTypeDisplay": { "readOnly": true, "type": "string", "enum": [ "Name", "Position", "Transaction", "Price", "Dividend", "Product", "NotImported", "Header", "Security", "CorpAction", "TranDetail", "Generic", "CostBasis", "Beneficiary", "StoredPerformance", "Systematic", "RMD", "Banking" ] }, "recordTypeKey": { "type": "integer", "format": "int32" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "excludeCommonCustodian": { "type": "boolean" } }, "xml": { "name": "DownloadExcludeCommonDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadExcludeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "downloadFormatId": { "type": "integer", "format": "int32" }, "downloadFormat": { "type": "string" }, "accountNumber": { "type": "string" }, "cusip": { "type": "string" }, "notes": { "type": "string" }, "advisorNotes": { "type": "string" }, "isPriceExclusion": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "downloadSourceId": { "type": "integer", "format": "int32" }, "downloadSource": { "type": "string" }, "fundFamilyName": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "nacSuppression": { "type": "boolean" } }, "xml": { "name": "DownloadExcludeDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.DownloadExcludeCurrentDto": { "properties": { "downloadNameId": { "type": "integer", "format": "int32" }, "formatName": { "type": "string" }, "fileDate": { "type": "string", "format": "date-time" }, "repNumber": { "type": "string" }, "lastName": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "downloadFormatId": { "type": "integer", "format": "int32" }, "downloadFormat": { "type": "string" }, "accountNumber": { "type": "string" }, "cusip": { "type": "string" }, "notes": { "type": "string" }, "advisorNotes": { "type": "string" }, "isPriceExclusion": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "downloadSourceId": { "type": "integer", "format": "int32" }, "downloadSource": { "type": "string" }, "fundFamilyName": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "nacSuppression": { "type": "boolean" } }, "xml": { "name": "DownloadExcludeCurrentDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.NoteListDtoOfSystem.Int32": { "properties": { "keyList": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "note": { "type": "string" } }, "xml": { "name": "NoteListDto`1" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Recon.ExclusionSyncDto": { "properties": { "statusIcon": { "readOnly": true, "type": "string" }, "id": { "type": "integer", "format": "int64" }, "ruleId": { "type": "integer", "format": "int32" }, "downloadExcludeId": { "type": "integer", "format": "int32" }, "syncSignOffId": { "type": "integer", "format": "int64" }, "lastAlertDate": { "type": "string", "format": "date-time" }, "syncBeginDate": { "type": "string", "format": "date-time" }, "syncEndDate": { "type": "string", "format": "date-time" }, "exclusionCreatedDate": { "type": "string", "format": "date-time" }, "formatName": { "type": "string" }, "serviceTeamName": { "type": "string" }, "clientName": { "type": "string" }, "analystLoginUserId": { "type": "string" }, "managerLoginUserId": { "type": "string" }, "syncSignOffDisplay": { "type": "string" }, "syncSignOffNote": { "type": "string" }, "managerSyncSignOffDisplay": { "type": "string" }, "managerSignOffNote": { "type": "string" }, "exclusionNote": { "type": "string" }, "accountCode": { "type": "string" }, "cusip": { "type": "string" }, "exclusionCreatedBy": { "type": "string" }, "exclusionEditedDate": { "type": "string", "format": "date-time" }, "exclusionEditedBy": { "type": "string" } }, "xml": { "name": "ExclusionSyncDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Recon.SyncSignOffsDto": { "properties": { "syncIds": { "items": { "type": "integer", "format": "int64" }, "type": "array" }, "syncType": { "type": "string", "enum": [ "Daily", "Weekly", "Exclusion", "Price" ] }, "managerSignOff": { "type": "boolean" }, "syncNote": { "type": "string" }, "priceNote": { "type": "string" } }, "xml": { "name": "SyncSignOffsDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.FileExportDto": { "properties": { "transmissionId": { "type": "integer", "format": "int32" }, "fileId": { "type": "integer", "format": "int32" }, "fileType": { "type": "string" }, "fileName": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "dateSent": { "type": "string", "format": "date-time" }, "status": { "type": "string" }, "blobFileId": { "type": "integer", "format": "int32" } }, "xml": { "name": "FileExportDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.ConfirmGroupDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "isPrivate": { "type": "boolean" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "userId": { "type": "integer", "format": "int32" }, "databases": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" }, "downloadFormats": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" }, "recordTypes": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" }, "scrubGroups": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" }, "dataQueries": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmGroupDataQueryDto" }, "xml": { "name": "ConfirmGroupDataQueryDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ConfirmGroupDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.ConfirmGroupDataQueryDto": { "properties": { "confirmGroupId": { "type": "integer", "format": "int32" }, "customReportId": { "type": "integer", "format": "int32" }, "dataQueryParams": { "type": "string" }, "dataQuery": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportFullDto" } }, "xml": { "name": "ConfirmGroupDataQueryDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.ConfirmOverviewDto": { "description": "", "properties": { "id": { "type": "integer", "format": "int32" }, "accountStatusIcon": { "readOnly": true, "type": "string" }, "databaseName": { "type": "string" }, "downloadFileId": { "type": "integer", "format": "int32" }, "formatName": { "type": "string" }, "recordTypeName": { "type": "string" }, "fileName": { "type": "string" }, "confirmedCount": { "type": "integer", "format": "int32" }, "notConfirmedCount": { "type": "integer", "format": "int32" }, "excludedCount": { "type": "integer", "format": "int32" }, "dataAggOnlyCount": { "type": "integer", "format": "int32" }, "unmappedTransTypeCount": { "type": "integer", "format": "int32" }, "status": { "type": "integer", "format": "int32" }, "isImportComplete": { "type": "boolean" }, "fileStatus": { "type": "string", "enum": [ "Created", "PendingImport", "StartingImport", "CreatingRecords", "RecordsCreated", "PostImportsStarted", "ImportFinished", "ImportFailed", "InitialVerifyStarted", "InitialVerifyFinished", "InitialVerifyFailed", "InitialApplyStarted", "InitialApplyFinished", "InitialApplyFailed", "ProcessingCompleted", "ProcessingFailed" ] }, "fileStatusInt": { "type": "integer", "format": "int32" }, "agentAnalysisStatus": { "type": "string", "enum": [ "NA", "NotStarted", "Running", "Complete" ] }, "noteCount": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "downloadSourceId": { "type": "integer", "format": "int32" }, "fileDate": { "type": "string", "format": "date-time" }, "fileCreated": { "type": "string", "format": "date-time" }, "fileCreatedBy": { "type": "string" }, "dateConfirmed": { "type": "string", "format": "date-time" }, "downloadSource": { "type": "string" }, "reconTargetTime": { "type": "string", "format": "date-time" }, "noteSummary": { "type": "string" }, "refreshStart": { "type": "string", "format": "date-time" }, "refreshEnd": { "type": "string", "format": "date-time" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "serviceTeamRecon": { "type": "string" }, "serviceTeamMember": { "type": "string" }, "signOffBy": { "type": "string" }, "signOffDate": { "type": "string", "format": "date-time" }, "signOffByUserId": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "costBasisType": { "type": "string", "enum": [ "None", "Unrealized", "Realized", "Both" ] }, "advisorNumber": { "type": "string" }, "batchProcessingId": { "type": "integer", "format": "int32" }, "isNonFileFormat": { "type": "boolean" }, "hasReconNotes": { "type": "boolean" } }, "xml": { "name": "ConfirmOverviewDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.HeldAwayCountDto": { "properties": { "performanceErrorCount": { "type": "integer", "format": "int32" }, "transactionErrorCount": { "type": "integer", "format": "int32" }, "accountCount": { "type": "integer", "format": "int32" } }, "xml": { "name": "HeldAwayCountDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.HeldAwayAccountDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "accountName": { "type": "string" }, "accountNumber": { "type": "string" }, "downloadSourceName": { "type": "string" }, "performanceErrorCount": { "type": "integer", "format": "int32" }, "transactionErrorCount": { "type": "integer", "format": "int32" }, "isManaged": { "type": "boolean" }, "clientId": { "type": "integer", "format": "int32" }, "representativeId": { "type": "integer", "format": "int32" }, "downloadFileId": { "type": "integer", "format": "int32" }, "secondaryAccountNumber": { "type": "string" }, "fileFundCode": { "type": "string" }, "note": { "type": "string" }, "fileDate": { "type": "string", "format": "date-time" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "representativeName": { "type": "string" }, "firstTransactionErrorDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "HeldAwayAccountDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.HeldAwayAssetDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "ticker": { "type": "string" }, "performanceError": { "type": "boolean" }, "transactionError": { "type": "boolean" }, "errorDate": { "type": "string", "format": "date-time" }, "excludedFromPositionOnly": { "type": "boolean" } }, "xml": { "name": "HeldAwayAssetDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.HeldAwayAllAssetValueDto": { "properties": { "assetId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "ticker": { "type": "string" }, "price": { "type": "number", "format": "double" }, "custodianUnits": { "type": "number", "format": "double" }, "orionUnits": { "type": "number", "format": "double" }, "units": { "type": "number", "format": "double" }, "amount": { "type": "number", "format": "double" }, "performanceError": { "type": "boolean" }, "transactionError": { "type": "boolean" }, "transactionDate": { "type": "string", "format": "date-time" }, "isCashAsset": { "type": "boolean" } }, "xml": { "name": "HeldAwayAllAssetValueDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.HeldAwayAssetValueWithErrorDto": { "properties": { "assetId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "performanceError": { "type": "boolean" }, "acceptable": { "type": "boolean" }, "asOfDate": { "readOnly": true, "type": "string", "format": "date-time" }, "startValue": { "type": "number", "format": "double" }, "performance": { "type": "number", "format": "double" }, "cashFlowAmount": { "type": "number", "format": "double" }, "price": { "type": "number", "format": "double" }, "ticker": { "type": "string" }, "note": { "type": "string" }, "message": { "type": "string" }, "value": { "type": "number", "format": "double" }, "productId": { "type": "integer", "format": "int32" }, "factor": { "type": "number", "format": "double" }, "valueChange": { "type": "number", "format": "double" }, "feeAmount": { "type": "number", "format": "double" }, "startAccruedInterst": { "type": "number", "format": "double" }, "accruedInterstChange": { "type": "number", "format": "double" }, "lastUpdate": { "type": "string", "format": "date-time" }, "asOf": { "type": "integer", "format": "int32" }, "transactionError": { "type": "boolean" } }, "xml": { "name": "HeldAwayAssetValueWithErrorDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.HeldAwayTransactionithErrorDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "transactionError": { "type": "boolean" }, "acceptable": { "type": "boolean" }, "asOfDate": { "type": "string", "format": "date-time" }, "transactionDescription": { "type": "string" }, "tradeStatus": { "type": "string", "enum": [ "Complete", "Pending", "Rejected", "Reversed", "Inactive", "PendingCorpAction", "FutureAip" ] }, "transactionAmount": { "type": "number", "format": "double" }, "units": { "type": "number", "format": "double" }, "price": { "type": "number", "format": "double" }, "orionUnits": { "type": "number", "format": "double" }, "custodianUnits": { "type": "number", "format": "double" }, "note": { "type": "string" }, "excludedFromPositionOnly": { "type": "boolean" }, "ticker": { "type": "string" }, "assetId": { "type": "integer", "format": "int32" }, "lastUpdate": { "type": "string", "format": "date-time" }, "message": { "type": "string" }, "performanceError": { "type": "boolean" } }, "xml": { "name": "HeldAwayTransactionithErrorDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.HeldAwayTransactionTypeWithOffsetDto": { "properties": { "description": { "type": "string" }, "offsetId": { "type": "integer", "format": "int32" }, "offsetName": { "type": "string" }, "offsetDescription": { "type": "string" }, "offsetMultiplier": { "type": "number", "format": "double" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "HeldAwayTransactionTypeWithOffsetDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.HeldAwayTransactionCreateDto": { "properties": { "assetId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "transactionDate": { "type": "string", "format": "date-time" }, "price": { "type": "number", "format": "double" }, "units": { "type": "number", "format": "double" }, "amount": { "type": "number", "format": "double" }, "transTypeId": { "type": "integer", "format": "int32" }, "note": { "type": "string" } }, "xml": { "name": "HeldAwayTransactionCreateDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.HeldAwayAssetConfirmErrorUpdateKeyDto": { "properties": { "assetId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "HeldAwayAssetConfirmErrorUpdateKeyDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.InterfaceReconciliationDto": { "properties": { "downloadSourceId": { "type": "integer", "format": "int32" }, "createdDate": { "type": "string", "format": "date-time" }, "downloadSourceName": { "type": "string" }, "transactionStatus": { "type": "string" }, "positionStatus": { "type": "string" }, "completeDate": { "type": "string", "format": "date-time" }, "transactionFileCount": { "type": "integer", "format": "int32" }, "transactionNotConfirmedCount": { "type": "integer", "format": "int32" }, "transactionConfirmedCount": { "type": "integer", "format": "int32" }, "transactionExcludedCount": { "type": "integer", "format": "int32" }, "transactionCount": { "type": "integer", "format": "int32" }, "positionFileCount": { "type": "integer", "format": "int32" }, "positionNotConfirmedCount": { "type": "integer", "format": "int32" }, "positionConfirmedCount": { "type": "integer", "format": "int32" }, "positionExcludedCount": { "type": "integer", "format": "int32" }, "positionCount": { "type": "integer", "format": "int32" }, "downloadFileNotesCount": { "type": "integer", "format": "int32" }, "downloadSourceNotesCount": { "type": "integer", "format": "int32" }, "nameFileCount": { "type": "integer", "format": "int32" }, "nameNotConfirmedCount": { "type": "integer", "format": "int32" }, "nameConfirmedCount": { "type": "integer", "format": "int32" }, "nameExcludedCount": { "type": "integer", "format": "int32" }, "nameStatus": { "type": "string" }, "nameCount": { "type": "integer", "format": "int32" }, "costBasisFileCount": { "type": "integer", "format": "int32" }, "costBasisNotConfirmedCount": { "type": "integer", "format": "int32" }, "costBasisConfirmedCount": { "type": "integer", "format": "int32" }, "costBasisExcludedCount": { "type": "integer", "format": "int32" }, "costBasisStatus": { "type": "string" }, "costBasisCount": { "type": "integer", "format": "int32" }, "notesCount": { "readOnly": true, "type": "integer", "format": "int32" }, "nameNumberConfirmed": { "readOnly": true, "type": "string" }, "transactionNumberConfirmed": { "readOnly": true, "type": "string" }, "positionNumberConfirmed": { "readOnly": true, "type": "string" } }, "xml": { "name": "InterfaceReconciliationDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.InterfaceReconciliationCountsDto": { "properties": { "unconfirmedAccounts": { "type": "integer", "format": "int32" }, "unconfirmedPositions": { "type": "integer", "format": "int32" }, "unconfirmedTransactions": { "type": "integer", "format": "int32" } }, "xml": { "name": "InterfaceReconciliationCountsDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.InterfaceReconciliationStatusDto": { "properties": { "isReconciled": { "type": "boolean" }, "reconcileTime": { "type": "string", "format": "date-time" }, "showInTom": { "type": "boolean" } }, "xml": { "name": "InterfaceReconciliationStatusDto" }, "type": "object" }, "OAS.WebApi.Domains.Confirm.InterfaceReconciliationsController.ReconNotificationDto": { "properties": { "emailToList": { "type": "string" }, "sendACR": { "type": "boolean" }, "sendEmail": { "type": "boolean" }, "emailBodyNoACR": { "type": "string" }, "emailBodyWithACR": { "type": "string" }, "sendChatter": { "type": "boolean" } }, "xml": { "name": "ReconNotificationDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Recon.InterfaceSyncDto": { "properties": { "statusIcon": { "readOnly": true, "type": "string" }, "id": { "type": "integer", "format": "int64" }, "syncBeginDate": { "type": "string", "format": "date-time" }, "syncEndDate": { "type": "string", "format": "date-time" }, "downloadRecordId": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "downloadFileType": { "type": "string" }, "downloadFileDate": { "type": "string", "format": "date-time" }, "clientName": { "type": "string" }, "serviceTeamName": { "type": "string" }, "analystLoginUserId": { "type": "string" }, "managerLoginUserId": { "type": "string" }, "downloadSourceName": { "type": "string" }, "downloadFileID": { "type": "integer", "format": "int32" }, "downloadRecordStatus": { "type": "string" }, "exclusionMessage": { "type": "string" }, "syncSignOffId": { "type": "integer", "format": "int64" }, "ruleId": { "type": "integer", "format": "int32" }, "lastAlertDate": { "type": "string", "format": "date-time" }, "auditedDate": { "type": "string", "format": "date-time" }, "syncSignOffDisplay": { "type": "string" }, "syncSignOffNote": { "type": "string" }, "managerSyncSignOffDisplay": { "type": "string" }, "managerSignOffNote": { "type": "string" }, "statusReason": { "type": "string" }, "cusip": { "type": "string" }, "ticker": { "type": "string" }, "accountCode": { "type": "string" }, "lineNumber": { "type": "integer", "format": "int32" }, "transactionType": { "type": "string" }, "householdName": { "type": "string" }, "productName": { "type": "string" }, "notesSummary": { "type": "string" } }, "xml": { "name": "InterfaceSyncDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Recon.InterfaceSyncsByFileDto": { "properties": { "downloadFileId": { "type": "integer", "format": "int32" }, "databaseName": { "type": "string" }, "alClientId": { "type": "integer", "format": "int32" }, "downloadFileType": { "type": "string" }, "downloadSourceName": { "type": "string" }, "notConfirmedCount": { "type": "integer", "format": "int32" }, "serviceTeamName": { "type": "string" }, "analystUserId": { "type": "string" }, "analystSignOffDate": { "type": "string", "format": "date-time" }, "analystSignOffNotes": { "type": "string" }, "managerUserId": { "type": "string" }, "managerSignOffNotes": { "type": "string" }, "managerSignOffDate": { "type": "string", "format": "date-time" }, "downloadFileDate": { "type": "string", "format": "date-time" }, "notesSummary": { "type": "string" }, "userAnalystId": { "type": "integer", "format": "int32" }, "userManagerId": { "type": "integer", "format": "int32" } }, "xml": { "name": "InterfaceSyncsByFileDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.MatrixCashActivityGemini.MatrixCashActivityGeminiInspectDto": { "properties": { "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" } }, "xml": { "name": "MatrixCashActivityGeminiInspectDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.MatrixCashActivityGemini.MatrixCashActivityGeminiInspectResultDto": { "properties": { "worksheetNames": { "items": { "type": "string" }, "type": "array" }, "suggestedWorksheet": { "type": "string" } }, "xml": { "name": "MatrixCashActivityGeminiInspectResultDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.MatrixCashActivityGemini.MatrixCashActivityGeminiValidateDto": { "properties": { "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" }, "fileType": { "type": "string", "enum": [ "Settlement", "Dividend" ] }, "tradeDate": { "type": "string", "format": "date-time" }, "worksheetNames": { "items": { "type": "string" }, "type": "array" } }, "xml": { "name": "MatrixCashActivityGeminiValidateDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.MatrixCashActivityGemini.MatrixCashActivityGeminiValidateResultDto": { "properties": { "isValid": { "type": "boolean" }, "columnErrors": { "items": { "type": "string" }, "type": "array" }, "missingAssetWarnings": { "items": { "type": "string" }, "type": "array" }, "rowCount": { "type": "integer", "format": "int32" } }, "xml": { "name": "MatrixCashActivityGeminiValidateResultDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.MatrixCashActivityGemini.MatrixCashActivityGeminiConvertDto": { "properties": { "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" }, "fileType": { "type": "string", "enum": [ "Settlement", "Dividend" ] }, "tradeDate": { "type": "string", "format": "date-time" }, "worksheetNames": { "items": { "type": "string" }, "type": "array" } }, "xml": { "name": "MatrixCashActivityGeminiConvertDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Recon.MissingPriceSyncDto": { "properties": { "statusIcon": { "readOnly": true, "type": "string" }, "id": { "type": "integer", "format": "int64" }, "syncBeginDate": { "type": "string", "format": "date-time" }, "syncEndDate": { "type": "string", "format": "date-time" }, "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "priceStatus": { "type": "string" }, "units": { "type": "integer", "format": "int32" }, "priceDate": { "type": "string", "format": "date-time" }, "navPrice": { "type": "number", "format": "double" }, "priceNotes": { "type": "string" }, "syncSignOffId": { "type": "integer", "format": "int64" }, "ruleId": { "type": "integer", "format": "int32" }, "lastAlertDate": { "type": "string", "format": "date-time" }, "clientName": { "type": "string" }, "serviceTeamName": { "type": "string" }, "analystLoginUserId": { "type": "string" }, "managerLoginUserId": { "type": "string" }, "syncSignOffDisplay": { "type": "string" }, "managerSyncSignOffDisplay": { "type": "string" }, "syncSignOffNote": { "type": "string" }, "managerSyncSignOffNote": { "type": "string" }, "cusip": { "type": "string" }, "ticker": { "type": "string" } }, "xml": { "name": "MissingPriceSyncDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Recon.MissingPriceSyncPriceNoteDto": { "properties": { "syncIds": { "items": { "type": "integer", "format": "int64" }, "type": "array" }, "priceNote": { "type": "string" } }, "xml": { "name": "MissingPriceSyncPriceNoteDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.ConfirmOverviewNoteDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "sourceType": { "type": "string", "enum": [ "MissingFile", "AccountNotInFile", "DownloadFile", "DownloadSource", "ScheduleJobs", "DataAudits", "ManualExclusions", "ExclusionTable", "FilesReceived" ] }, "alClientId": { "type": "integer", "format": "int32" }, "downloadSourceId": { "type": "integer", "format": "int32" }, "parentId": { "type": "integer", "format": "int32" }, "isAdvisorVisible": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "downloadSourceName": { "type": "string" }, "userId": { "type": "integer", "format": "int32" }, "note": { "type": "string" }, "associatedDescription": { "type": "string" }, "associatedRoute": { "type": "string" } }, "xml": { "name": "ConfirmOverviewNoteDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Dashboard.MissingFileConfirmOverviewDashboardDto": { "properties": { "expectedFileInformation": { "type": "string" }, "frequency": { "type": "integer", "format": "int32" }, "startDay": { "type": "integer", "format": "int32" }, "startTime": { "type": "string", "format": "date-time" }, "fileCount": { "type": "integer", "format": "int32" }, "serviceTeamRecon": { "type": "string" }, "serviceTeamMember": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "downloadSourceName": { "type": "string" }, "noteCount": { "type": "integer", "format": "int32" }, "notesSummary": { "type": "string" }, "reason": { "type": "string" }, "recordType": { "type": "string", "enum": [ "Name", "Position", "Transaction", "Price", "Dividend", "Product", "NotImported", "Header", "Security", "CorpAction", "TranDetail", "Generic", "CostBasis", "Beneficiary", "StoredPerformance", "Systematic", "RMD", "Banking" ] }, "resolvedDate": { "type": "string", "format": "date-time" }, "signOffBy": { "type": "string" }, "signOffDate": { "type": "string", "format": "date-time" }, "databaseName": { "type": "string" }, "signOffByUserId": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "downloadFormatId": { "type": "integer", "format": "int32" }, "downloadSourceId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "downloadFormatName": { "type": "string" } }, "xml": { "name": "MissingFileConfirmOverviewDashboardDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformReconciliationDto": { "properties": { "id": { "type": "integer", "format": "int64" }, "databaseName": { "type": "string" }, "downloadDate": { "type": "string", "format": "date-time" }, "confirmed": { "type": "integer", "format": "int32" }, "notConfirmed": { "type": "integer", "format": "int32" }, "excluded": { "type": "integer", "format": "int32" }, "signOffDate": { "type": "string", "format": "date-time" }, "signOffBy": { "type": "string" }, "alClientId": { "type": "integer", "format": "int32" }, "sourceAnalysis": { "type": "string" }, "downloadFormatName": { "type": "string" }, "downloadFormatId": { "type": "integer", "format": "int32" } }, "xml": { "name": "InformReconciliationDto" }, "type": "object" }, "OAS.WebApi.DTO.Compliance.InformReconciliationTransactionDto": { "properties": { "informTransactionId": { "type": "integer", "format": "int32" }, "informReconStatus": { "type": "string", "enum": [ "NotConfirmed", "Confirmed", "Excluded" ] }, "informPreClearanceId": { "type": "integer", "format": "int32" }, "preClearanceDescription": { "readOnly": true, "type": "string" }, "informBrokerageAccountID": { "type": "integer", "format": "int32" }, "userDetailId": { "type": "integer", "format": "int32" }, "accessPersonId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "ticker": { "type": "string" }, "cusip": { "type": "string" }, "sourceTicker": { "type": "string" }, "sourceCusip": { "type": "string" }, "sourceSymbolName": { "type": "string" }, "transactionDate": { "readOnly": true, "type": "string", "format": "date-time" }, "transactionDateTime": { "type": "string", "format": "date-time" }, "transactionValue": { "type": "number", "format": "double" }, "unitPrice": { "type": "number", "format": "double" }, "price": { "type": "number", "format": "double" }, "quantity": { "type": "number", "format": "double" }, "sourceTransType": { "type": "string" }, "sourceTransSubType": { "type": "string" }, "transTypeId": { "type": "integer", "format": "int32" }, "transactionTypeDescription": { "type": "string" }, "transactionSubType": { "type": "string" }, "transSubTypeId": { "type": "integer", "format": "int32" }, "transactionSubTypeDescription": { "type": "string" }, "assetClass": { "type": "string" }, "memo": { "type": "string" }, "additionalMemo": { "type": "string" }, "rulesEngineDate": { "type": "string", "format": "date-time" }, "preClearance": { "$ref": "#/definitions/OAS.WebApi.DTO.Compliance.InformPreClearanceDto" } }, "xml": { "name": "InformReconciliationTransactionDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.ConfirmOverviewSummaryDto": { "properties": { "name": { "type": "string" }, "value": { "readOnly": true, "type": "integer", "format": "int64" }, "children": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.ConfirmOverviewSummaryChildDto" }, "xml": { "name": "ConfirmOverviewSummaryChildDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ConfirmOverviewSummaryDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.ConfirmOverviewSummaryChildDto": { "properties": { "name": { "type": "string" }, "value": { "type": "integer", "format": "int64" } }, "xml": { "name": "ConfirmOverviewSummaryChildDto" }, "type": "object" }, "OAS.DataModel.Confirm.ConfirmGroup": { "required": [ "id", "userId", "isPrivate", "name" ], "properties": { "id": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "isPrivate": { "type": "boolean" }, "name": { "type": "string", "maxLength": 100, "minLength": 0 }, "audit": { "$ref": "#/definitions/OAT.DataModel.ComplexTypes.BasicAuditNotNullNotNull" }, "user": { "$ref": "#/definitions/OAS.DataModel.Security.User" }, "databases": { "items": { "$ref": "#/definitions/OAS.DataModel.Security.AlClient" }, "xml": { "name": "AlClient", "wrapped": true }, "type": "array" }, "recordTypes": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.ConfirmRecordType" }, "xml": { "name": "ConfirmRecordType", "wrapped": true }, "type": "array" }, "downloadFormats": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadFormat" }, "xml": { "name": "DownloadFormat", "wrapped": true }, "type": "array" }, "scrubGroups": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Scrubs.ScrubGroupName" }, "xml": { "name": "ScrubGroupName", "wrapped": true }, "type": "array" }, "dataQueries": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.ConfirmGroupDataQuery" }, "xml": { "name": "ConfirmGroupDataQuery", "wrapped": true }, "type": "array" } }, "xml": { "name": "ConfirmGroup" }, "type": "object" }, "OAS.DataModel.Security.User": { "required": [ "id", "activeDate", "isActive", "isVpnUser", "encryptionType", "passwordRequirement", "twoFactor", "isSecureExchangeRecipient" ], "properties": { "id": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "userName": { "type": "string", "maxLength": 100, "minLength": 0 }, "loginUserId": { "type": "string", "maxLength": 200, "minLength": 0 }, "password": { "type": "string", "maxLength": 200, "minLength": 0 }, "entityEnum": { "type": "integer", "format": "int32" }, "activeDate": { "type": "string", "format": "date-time" }, "inactiveDate": { "type": "string", "format": "date-time" }, "isActive": { "type": "boolean" }, "userKey": { "type": "integer", "format": "int32" }, "groupId": { "type": "integer", "format": "int32" }, "isReset": { "type": "boolean" }, "lastPasswordChange": { "type": "string", "format": "date-time" }, "securityQuestion": { "type": "string", "maxLength": 100, "minLength": 0 }, "securityAnswer": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdBy": { "type": "string", "maxLength": 150, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 150, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "isEncrypted": { "type": "boolean" }, "isActiveDirectory": { "type": "boolean" }, "userGuid": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "personalId": { "type": "integer", "format": "int32" }, "adUserId": { "type": "string", "maxLength": 50, "minLength": 0 }, "isVpnUser": { "type": "boolean" }, "domain": { "type": "string", "maxLength": 50, "minLength": 0 }, "encryptionType": { "type": "integer", "format": "int32" }, "salt": { "type": "string", "maxLength": 255, "minLength": 0 }, "passwordRequirement": { "type": "integer", "format": "int32" }, "twoFactor": { "type": "boolean" }, "isSecureExchangeRecipient": { "type": "boolean" }, "partnerAppId": { "type": "integer", "format": "int32" }, "contactType": { "type": "string", "enum": [ "NotApproved", "Approved", "MainContact", "NoLongerWithFirm" ] }, "details": { "items": { "$ref": "#/definitions/OAS.DataModel.Security.UserDetail" }, "xml": { "name": "UserDetail", "wrapped": true }, "type": "array" }, "personal": { "$ref": "#/definitions/OAS.DataModel.Portfolio.PersonalGlobal" }, "appLinkDetails": { "items": { "$ref": "#/definitions/OAS.DataModel.Integrations.AppLinkDetail" }, "xml": { "name": "AppLinkDetail", "wrapped": true }, "type": "array" }, "userForgotPasswords": { "items": { "$ref": "#/definitions/OAS.DataModel.Security.UserForgotPassword" }, "xml": { "name": "UserForgotPassword", "wrapped": true }, "type": "array" }, "userLogins": { "items": { "$ref": "#/definitions/OAS.DataModel.Security.UserLogin" }, "xml": { "name": "UserLogin", "wrapped": true }, "type": "array" }, "serviceTeamMembers": { "items": { "$ref": "#/definitions/OAS.DataModel.Security.ServiceTeamMember" }, "xml": { "name": "ServiceTeamMember", "wrapped": true }, "type": "array" }, "confirmGroups": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.ConfirmGroup" }, "xml": { "name": "ConfirmGroup", "wrapped": true }, "type": "array" }, "refreshTokens": { "items": { "$ref": "#/definitions/OAS.DataModel.Security.PartnerAppUser" }, "xml": { "name": "PartnerAppUser", "wrapped": true }, "type": "array" }, "fingerprints": { "items": { "$ref": "#/definitions/OAS.DataModel.Security.UserFingerprint" }, "xml": { "name": "UserFingerprint", "wrapped": true }, "type": "array" }, "privileges": { "items": { "$ref": "#/definitions/OAS.DataModel.Security.UserPrivilege" }, "xml": { "name": "UserPrivilege", "wrapped": true }, "type": "array" }, "ipRanges": { "items": { "$ref": "#/definitions/OAS.DataModel.Security.AlClientIpRange" }, "xml": { "name": "AlClientIpRange", "wrapped": true }, "type": "array" }, "lastLogin": { "$ref": "#/definitions/OAS.DataModel.Security.UserLastLogin" } }, "xml": { "name": "User" }, "type": "object" }, "OAS.DataModel.Security.AlClient": { "required": [ "id", "clientName", "activeDate", "isActive", "masterGroup", "guid" ], "properties": { "id": { "type": "integer", "format": "int32" }, "clientName": { "type": "string", "maxLength": 50, "minLength": 0 }, "databaseName": { "type": "string", "maxLength": 100, "minLength": 0 }, "serverName": { "type": "string", "maxLength": 30, "minLength": 0 }, "activeDate": { "type": "string", "format": "date-time" }, "inactiveDate": { "type": "string", "format": "date-time" }, "isActive": { "type": "boolean" }, "masterGroup": { "type": "string", "maxLength": 100, "minLength": 0 }, "isDemo": { "type": "boolean" }, "guid": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "serviceTeamId": { "type": "integer", "format": "int32" }, "chatRouteId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "lockDown": { "type": "string", "enum": [ "None", "Billing" ] }, "advisorNumber": { "type": "integer", "format": "int32" }, "accessGroup": { "type": "string", "enum": [ "TCS" ] }, "firmType": { "type": "string", "enum": [ "None", "Foundations", "Essentials", "Advantage", "OrionTradingOnly", "OrionRiskOnly", "OrionComplianceOnly", "OrionPlanningOnly", "OasLegacy" ] }, "isCloudStreamingEnabled": { "type": "boolean" }, "includeInRollup": { "type": "boolean" }, "extensions": { "items": { "$ref": "#/definitions/OAS.DataModel.Security.AlClientExtension" }, "xml": { "name": "AlClientExtension", "wrapped": true }, "type": "array" }, "serviceTeam": { "$ref": "#/definitions/OAS.DataModel.Security.ServiceTeam" }, "userDetails": { "items": { "$ref": "#/definitions/OAS.DataModel.Security.UserDetail" }, "xml": { "name": "UserDetail", "wrapped": true }, "type": "array" }, "server": { "$ref": "#/definitions/OAS.DataModel.Security.Server" }, "ipRanges": { "items": { "$ref": "#/definitions/OAS.DataModel.Security.AlClientIpRange" }, "xml": { "name": "AlClientIpRange", "wrapped": true }, "type": "array" }, "defaultReportTheme": { "$ref": "#/definitions/OAS.DataModel.Reporting.Envision.AlClientDefaultReportTheme" }, "defaultCoverPages": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Envision.AlClientDefaultCoverPage" }, "xml": { "name": "AlClientDefaultCoverPage", "wrapped": true }, "type": "array" }, "ops": { "$ref": "#/definitions/OAS.DataModel.Security.AlClientOps" } }, "xml": { "name": "AlClient" }, "type": "object" }, "OAS.DataModel.Confirm.ConfirmRecordType": { "required": [ "id", "description", "sortOrder" ], "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string", "maxLength": 50, "minLength": 0 }, "sortOrder": { "type": "integer", "format": "int32" } }, "xml": { "name": "ConfirmRecordType" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadFormat": { "required": [ "id", "formatName", "assemblyName", "costBasisType" ], "properties": { "id": { "type": "integer", "format": "int32" }, "formatName": { "type": "string", "maxLength": 50, "minLength": 0 }, "assemblyName": { "type": "string", "maxLength": 150, "minLength": 0 }, "xmlFileName": { "type": "string", "maxLength": 150, "minLength": 0 }, "xmlFile": { "type": "string" }, "pricePriority": { "type": "integer", "format": "int32" }, "costBasisType": { "type": "string", "enum": [ "None", "Unrealized", "Realized", "Both" ] }, "formatInformation": { "type": "string" }, "isNonFileFormat": { "type": "boolean" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "isForInform": { "type": "boolean" }, "downloadFormatConfigJSON": { "type": "string" }, "sourceDefaults": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadFormatSourceDefault" }, "xml": { "name": "DownloadFormatSourceDefault", "wrapped": true }, "type": "array" }, "downloadFormatNoteMapping": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadFormatNoteMapping" }, "xml": { "name": "DownloadFormatNoteMapping", "wrapped": true }, "type": "array" }, "downloadFormatSymbolMappings": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadFormatSymbolMapping" }, "xml": { "name": "DownloadFormatSymbolMapping", "wrapped": true }, "type": "array" }, "downloadFormatUniqueSymbolMappings": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadFormatUniqueSymbolMapping" }, "xml": { "name": "DownloadFormatUniqueSymbolMapping", "wrapped": true }, "type": "array" }, "downloadFormatTransactionSymbolMappings": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadFormatTransactionSymbolMapping" }, "xml": { "name": "DownloadFormatTransactionSymbolMapping", "wrapped": true }, "type": "array" }, "downloadFormatSubTypes": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadFormatSubType" }, "xml": { "name": "DownloadFormatSubType", "wrapped": true }, "type": "array" }, "downloadFormatOffsetCashMappings": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadFormatOffsetCashMapping" }, "xml": { "name": "DownloadFormatOffsetCashMapping", "wrapped": true }, "type": "array" } }, "xml": { "name": "DownloadFormat" }, "type": "object" }, "OAS.DataModel.Reporting.Scrubs.ScrubGroupName": { "required": [ "id", "groupName" ], "properties": { "id": { "type": "integer", "format": "int32" }, "groupName": { "type": "string", "maxLength": 50, "minLength": 0 }, "scrubs": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Scrub" }, "xml": { "name": "Scrub", "wrapped": true }, "type": "array" } }, "xml": { "name": "ScrubGroupName" }, "type": "object" }, "OAS.DataModel.Confirm.ConfirmGroupDataQuery": { "required": [ "confirmGroupId", "customReportId", "queryRank" ], "properties": { "confirmGroupId": { "type": "integer", "format": "int32" }, "customReportId": { "type": "integer", "format": "int32" }, "dataQueryParams": { "type": "string" }, "queryRank": { "type": "integer", "format": "int32" }, "confirmGroup": { "$ref": "#/definitions/OAS.DataModel.Confirm.ConfirmGroup" }, "customReport": { "$ref": "#/definitions/OAS.DataModel.Reporting.Custom.CustomReport" } }, "xml": { "name": "ConfirmGroupDataQuery" }, "type": "object" }, "OAS.DataModel.Security.UserDetail": { "required": [ "id", "userId", "alClientId", "loginEntityId", "isUserDefault", "createdBy", "createdDate", "editedBy", "editedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "roleId": { "type": "integer", "format": "int32" }, "loginEntityId": { "type": "string", "enum": [ "BrokerDealer", "Wholesaler", "Representative", "Client", "RIA", "Administrator", "SubAdvisor", "ThirdPartyAdministrator", "Custodian", "PlanSponsor", "ThirdParty", "ServiceAccount", "Participant", "RepAccountManager", "Payee", "RIATable", "Cotenant" ] }, "userKey": { "type": "integer", "format": "int32" }, "isUserDefault": { "type": "boolean" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "user": { "$ref": "#/definitions/OAS.DataModel.Security.User" }, "loginEntity": { "$ref": "#/definitions/OAS.DataModel.Security.LoginEntity" }, "alClient": { "$ref": "#/definitions/OAS.DataModel.Security.AlClient" }, "userDetailIntegration": { "items": { "$ref": "#/definitions/OAS.DataModel.Security.UserDetailIntegration" }, "xml": { "name": "UserDetailIntegration", "wrapped": true }, "type": "array" }, "accessibleBy": { "items": { "$ref": "#/definitions/OAS.DataModel.Security.UserDetailAccess" }, "xml": { "name": "UserDetailAccess", "wrapped": true }, "type": "array" }, "accessibleProfiles": { "items": { "$ref": "#/definitions/OAS.DataModel.Security.UserDetailAccess" }, "xml": { "name": "UserDetailAccess", "wrapped": true }, "type": "array" }, "role": { "$ref": "#/definitions/OAS.DataModel.Security.Role" }, "privileges": { "items": { "$ref": "#/definitions/OAS.DataModel.Security.UserPrivilege" }, "xml": { "name": "UserPrivilege", "wrapped": true }, "type": "array" } }, "xml": { "name": "UserDetail" }, "type": "object" }, "OAS.DataModel.Integrations.AppLinkDetail": { "required": [ "id", "appLinkId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "appLinkId": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "externalId": { "type": "string" }, "externalIdNonEncryptedBackUp": { "type": "string" }, "appLink": { "$ref": "#/definitions/OAS.DataModel.Integrations.AppLink" }, "userDetailId": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "level": { "type": "string", "enum": [ "System", "Firm", "User", "UserProfile", "Client", "Custodian", "Rep" ] }, "userDetail": { "$ref": "#/definitions/OAS.DataModel.Security.UserDetail" }, "alClient": { "$ref": "#/definitions/OAS.DataModel.Security.AlClient" }, "user": { "$ref": "#/definitions/OAS.DataModel.Security.User" }, "createdDate": { "type": "string", "format": "date-time" }, "createdByDisplay": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedByDisplay": { "type": "string" } }, "xml": { "name": "AppLinkDetail" }, "type": "object" }, "OAS.DataModel.Security.UserForgotPassword": { "required": [ "forgotPasswordId", "userId", "createdDate", "expirationDate" ], "properties": { "forgotPasswordId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "userId": { "type": "integer", "format": "int32" }, "createdDate": { "type": "string", "format": "date-time" }, "expirationDate": { "type": "string", "format": "date-time" }, "usedOnDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "UserForgotPassword" }, "type": "object" }, "OAS.DataModel.Security.UserLogin": { "required": [ "id", "userId", "loginDate", "failed", "failType" ], "properties": { "id": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "loginDate": { "type": "string", "format": "date-time" }, "failed": { "type": "boolean" }, "failType": { "type": "string", "enum": [ "Success", "IncorrectPassword", "LockedOut", "PasswordEpired", "InactiveUser", "TwoFactorChallenge" ] }, "clientIp": { "type": "string" }, "providedUserId": { "type": "string" }, "correlationId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "compromisedPwd": { "type": "boolean" }, "source": { "type": "string", "enum": [ "Engage", "OrionPlanning", "OrionConnect", "LegacyClientPortal", "LegacyMobileApp", "LegacyLoginPage", "ApiTester", "AuthService", "Element", "PartnerApp", "LoginActivityImportEndpoint", "LoginActivityEndpoint", "spimUserLoginAdd", "Unknown", "OrionPlanningWeb", "OrionPlanningMobile" ] } }, "xml": { "name": "UserLogin" }, "type": "object" }, "OAS.DataModel.Security.ServiceTeamMember": { "required": [ "id", "serviceTeamId", "userId", "isAnalyst", "isAccountManager" ], "properties": { "id": { "type": "integer", "format": "int32" }, "serviceTeamId": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "isAnalyst": { "type": "boolean" }, "isAccountManager": { "type": "boolean" }, "userManagerId": { "type": "integer", "format": "int32" }, "serviceTeam": { "$ref": "#/definitions/OAS.DataModel.Security.ServiceTeam" }, "user": { "$ref": "#/definitions/OAS.DataModel.Security.User" }, "userManager": { "$ref": "#/definitions/OAS.DataModel.Security.User" }, "alClients": { "items": { "$ref": "#/definitions/OAS.DataModel.Security.ServiceTeamMemberAlClient" }, "xml": { "name": "ServiceTeamMemberAlClient", "wrapped": true }, "type": "array" } }, "xml": { "name": "ServiceTeamMember" }, "type": "object" }, "OAS.DataModel.Security.PartnerAppUser": { "required": [ "partnerAppId", "userId", "refreshToken", "expirationDate", "isRevolked" ], "properties": { "partnerAppId": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "refreshToken": { "type": "string", "maxLength": 100, "minLength": 0 }, "expirationDate": { "type": "string", "format": "date-time" }, "isRevolked": { "type": "boolean" } }, "xml": { "name": "PartnerAppUser" }, "type": "object" }, "OAS.DataModel.Security.UserFingerprint": { "required": [ "id", "userId", "fingerprint", "expirationDate", "issuedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "fingerprint": { "type": "string", "maxLength": 255, "minLength": 0 }, "expirationDate": { "type": "string", "format": "date-time" }, "issuedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "UserFingerprint" }, "type": "object" }, "OAS.DataModel.Security.UserPrivilege": { "required": [ "userId", "alClientId", "userDetailId", "roleId", "grantedAccess", "privilegeId", "privilegeType", "entity" ], "properties": { "userId": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "userDetailId": { "type": "integer", "format": "int32" }, "roleId": { "type": "integer", "format": "int32" }, "grantedAccess": { "type": "string", "enum": [ "None", "Read", "Edit", "Delete" ] }, "privilegeId": { "type": "integer", "format": "int32" }, "privilegeCode": { "type": "string", "maxLength": 50, "minLength": 0 }, "privilegeType": { "type": "string", "enum": [ "Unknown", "Apps", "Records", "Actions", "Advanced", "Applinks", "FeatureFlags" ] }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "revokeOnLockdownType": { "type": "string", "enum": [ "None", "Billing" ] }, "lockDown": { "type": "string", "enum": [ "None", "Billing" ] } }, "xml": { "name": "UserPrivilege" }, "type": "object" }, "OAS.DataModel.Security.AlClientIpRange": { "required": [ "id", "alClientId", "loginEntityId", "startAddress", "endAddress", "isBlacklist" ], "properties": { "id": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "loginEntityId": { "type": "string", "enum": [ "BrokerDealer", "Wholesaler", "Representative", "Client", "RIA", "Administrator", "SubAdvisor", "ThirdPartyAdministrator", "Custodian", "PlanSponsor", "ThirdParty", "ServiceAccount", "Participant", "RepAccountManager", "Payee", "RIATable", "Cotenant" ] }, "description": { "type": "string", "maxLength": 255, "minLength": 0 }, "startAddress": { "type": "string", "maxLength": 15, "minLength": 0 }, "endAddress": { "type": "string", "maxLength": 15, "minLength": 0 }, "isBlacklist": { "type": "boolean" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "AlClientIpRange" }, "type": "object" }, "OAS.DataModel.Security.UserLastLogin": { "required": [ "userId" ], "properties": { "userId": { "type": "integer", "format": "int32" }, "lastLogin": { "type": "string", "format": "date-time" } }, "xml": { "name": "UserLastLogin" }, "type": "object" }, "OAS.DataModel.Security.AlClientExtension": { "required": [ "alClientId", "entity", "passwordExpiration", "acctDeactivated", "acctDeleted", "advisorPerformanceOrder" ], "properties": { "alClientId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "passwordExpiration": { "type": "integer", "format": "int32" }, "acctDeactivated": { "type": "integer", "format": "int32" }, "acctDeleted": { "type": "integer", "format": "int32" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "serviceTeamId": { "type": "integer", "format": "int32" }, "advisorPerformanceOrder": { "type": "integer", "format": "int32" }, "serviceTeamReconId": { "type": "integer", "format": "int32" } }, "xml": { "name": "AlClientExtension" }, "type": "object" }, "OAS.DataModel.Security.ServiceTeam": { "required": [ "id", "team" ], "properties": { "id": { "type": "integer", "format": "int32" }, "team": { "type": "string", "maxLength": 50, "minLength": 0 }, "emailAddress": { "type": "string", "maxLength": 200, "minLength": 0 }, "teamType": { "type": "string", "enum": [ "ServiceTeam", "ReconTeam", "ApplicationTeam", "AlternateApplicationTeam", "RemovedServiceTeam" ] }, "phone": { "type": "string", "maxLength": 25, "minLength": 0 }, "chatUrl": { "type": "string", "maxLength": 255, "minLength": 0 }, "chatSecurityCode": { "type": "string", "maxLength": 50, "minLength": 0 }, "chatRouteIntendedRecipient": { "type": "string" }, "members": { "items": { "$ref": "#/definitions/OAS.DataModel.Security.ServiceTeamMember" }, "xml": { "name": "ServiceTeamMember", "wrapped": true }, "type": "array" } }, "xml": { "name": "ServiceTeam" }, "type": "object" }, "OAS.DataModel.Security.Server": { "required": [ "serverName" ], "properties": { "serverName": { "type": "string", "maxLength": 30, "minLength": 0 }, "reportExecutionCount": { "type": "integer", "format": "int32" } }, "xml": { "name": "Server" }, "type": "object" }, "OAS.DataModel.Reporting.Envision.AlClientDefaultReportTheme": { "required": [ "alClientId", "reportId" ], "properties": { "alClientId": { "type": "integer", "format": "int32" }, "reportId": { "type": "integer", "format": "int32" }, "reportTheme": { "$ref": "#/definitions/OAS.DataModel.Reporting.Envision.ReportTheme" } }, "xml": { "name": "AlClientDefaultReportTheme" }, "type": "object" }, "OAS.DataModel.Reporting.Envision.AlClientDefaultCoverPage": { "required": [ "alClientId", "paperOrientation", "reportId" ], "properties": { "alClientId": { "type": "integer", "format": "int32" }, "paperOrientation": { "type": "string", "enum": [ "Portrait", "Landscape" ] }, "reportId": { "type": "integer", "format": "int32" }, "coverPage": { "$ref": "#/definitions/OAS.DataModel.Reporting.Envision.ReportCoverPage" } }, "xml": { "name": "AlClientDefaultCoverPage" }, "type": "object" }, "OAS.DataModel.Security.AlClientOps": { "required": [ "id", "isFullOps", "isBilling", "isTrading", "isStatements", "isComposites", "auditedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "isFullOps": { "type": "boolean" }, "isBilling": { "type": "boolean" }, "isTrading": { "type": "boolean" }, "isStatements": { "type": "boolean" }, "isComposites": { "type": "boolean" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "AlClientOps" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadFormatSourceDefault": { "required": [ "downloadFormatId", "downloadDescription", "transmitMethod", "newAccounts", "registrationBaseNumber", "positionOnlyReconcile", "isDividendTransactionCombination" ], "properties": { "downloadFormatId": { "type": "integer", "format": "int32" }, "downloadDescription": { "type": "string", "maxLength": 50, "minLength": 0 }, "custodianCommonCode": { "type": "string", "maxLength": 10, "minLength": 0 }, "transmitMethod": { "type": "string", "enum": [ "Empty", "None", "FTP", "DSTHTTP", "Network", "SFTP", "FTPS", "HTTPS", "S3" ] }, "url": { "type": "string", "maxLength": 255, "minLength": 0 }, "filePattern": { "type": "string", "maxLength": 1000, "minLength": 0 }, "patternMatchType": { "type": "string", "enum": [ "Included", "Excluded" ] }, "transPercTolerance": { "type": "number", "format": "double" }, "transDaysTolerance": { "type": "integer", "format": "int32" }, "cashCusip": { "type": "string" }, "deleteSourceFile": { "type": "boolean" }, "allowPriceImport": { "type": "boolean" }, "allowNameImport": { "type": "boolean" }, "allowPositionImport": { "type": "boolean" }, "allowTransactionImport": { "type": "boolean" }, "allowSecurityImport": { "type": "boolean" }, "allowCorpActionImport": { "type": "boolean" }, "allowDivImport": { "type": "boolean" }, "allowBeneficiaryImport": { "type": "boolean" }, "allowSystematicImport": { "type": "boolean" }, "allowRMDImport": { "type": "boolean" }, "allowBankingImport": { "type": "boolean" }, "allowTranDetailImport": { "type": "boolean" }, "allowGenericImport": { "type": "boolean" }, "allowCostBasisImport": { "type": "boolean" }, "note": { "type": "string", "maxLength": 1000, "minLength": 0 }, "altFilePattern": { "type": "string", "maxLength": 1000, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "allowSecondaryAcctCodeMatch": { "type": "boolean" }, "allowAcctCodeMatch": { "type": "boolean" }, "isActive": { "type": "boolean" }, "isAutoHouseholding": { "type": "boolean" }, "isAcctCreation": { "type": "boolean" }, "ignoreRepVerify": { "type": "boolean" }, "allowPriceZero": { "type": "boolean" }, "reconTargetTime": { "type": "string", "format": "date-time" }, "comparePositionValue": { "type": "boolean" }, "serviceTeamReconId": { "type": "integer", "format": "int32" }, "serviceTeamMemberId": { "type": "integer", "format": "int32" }, "runAssetValueComparison": { "type": "boolean" }, "useReversal": { "type": "boolean" }, "alwaysCreateNewRegistration": { "type": "boolean" }, "newAccounts": { "type": "string", "enum": [ "Default", "DoNotCreate", "Create", "AutoExclude" ] }, "isUnVerifiedSells": { "type": "boolean" }, "allowAcctCodeMatchWOZero": { "type": "boolean" }, "isSourceExclusionCB": { "type": "boolean" }, "isSourceExclusionTran": { "type": "boolean" }, "noOrionPriceCopy": { "type": "boolean" }, "namePercentMatch": { "type": "number", "format": "double" }, "positionPercentMatch": { "type": "number", "format": "double" }, "transactionPercentMatch": { "type": "number", "format": "double" }, "registrationBaseNumber": { "type": "integer", "format": "int32" }, "newAccountCenterSuppression": { "type": "boolean" }, "positionOnlyReconcile": { "type": "string", "enum": [ "No", "Yes", "EnabledAccountsOnly", "AIP", "EnabledAccountsOnlyAIP", "EnabledAccountsOnlyHAA", "HAA" ] }, "dailyAccrualTolerance": { "type": "number", "format": "double" }, "isFixSmallBalance": { "type": "boolean" }, "isDividendTransactionCombination": { "type": "boolean" }, "downloadSourceOptionJSON": { "type": "string" }, "autoCreateStartingValues": { "type": "boolean" }, "archiveFiles": { "type": "boolean" }, "sftpKey": { "type": "string", "format": "byte" }, "underReview": { "type": "boolean" }, "isOrionEnterpriseEnabled": { "type": "boolean" }, "allowDuplicateAssets": { "type": "boolean" }, "allowProperName": { "type": "boolean" }, "removeSettleDateTrades": { "type": "boolean" }, "principalAndIncome": { "type": "boolean" }, "createTransactionInPendingStatus": { "type": "boolean" }, "downloadFormatSubTypeId": { "type": "integer", "format": "int32" }, "transmitUserId_e": { "type": "string", "format": "byte" }, "transmitPassword_e": { "type": "string", "format": "byte" }, "zipPassword_e": { "type": "string", "format": "byte" }, "downloadSubFormatSourceScheduleDefaults": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.DownloadSubFormatSourceScheduleDefault" }, "xml": { "name": "DownloadSubFormatSourceScheduleDefault", "wrapped": true }, "type": "array" } }, "xml": { "name": "DownloadFormatSourceDefault" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadFormatNoteMapping": { "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int32" }, "downloadFormatId": { "type": "integer", "format": "int32" }, "downloadFormatSubtypeId": { "type": "integer", "format": "int32" }, "fileTranCode": { "type": "string", "maxLength": 50, "minLength": 0 }, "searchFor": { "type": "string", "maxLength": 50, "minLength": 0 }, "translateTo": { "type": "string", "maxLength": 50, "minLength": 0 }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 } }, "xml": { "name": "DownloadFormatNoteMapping" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadFormatSymbolMapping": { "properties": { "downloadFormatId": { "type": "integer", "format": "int32" }, "fileSymbol": { "type": "string", "maxLength": 50, "minLength": 0 }, "newSymbol": { "type": "string", "maxLength": 50, "minLength": 0 }, "downloadFormatSubtypeId": { "type": "integer", "format": "int32" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 } }, "xml": { "name": "DownloadFormatSymbolMapping" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadFormatUniqueSymbolMapping": { "properties": { "uniqueSymbol": { "type": "string" }, "downloadFormatId": { "type": "integer", "format": "int32" }, "downloadFormatSubtypeId": { "type": "integer", "format": "int32" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 } }, "xml": { "name": "DownloadFormatUniqueSymbolMapping" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadFormatTransactionSymbolMapping": { "properties": { "id": { "type": "integer", "format": "int32" }, "downloadFormatId": { "type": "integer", "format": "int32" }, "downloadFormatSubtypeId": { "type": "integer", "format": "int32" }, "downloadSymbol": { "type": "string", "maxLength": 50, "minLength": 0 }, "newSymbol": { "type": "string", "maxLength": 50, "minLength": 0 }, "note": { "type": "string", "maxLength": 1000, "minLength": 0 }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 } }, "xml": { "name": "DownloadFormatTransactionSymbolMapping" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadFormatSubType": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "downloadFormatId": { "type": "integer", "format": "int32" }, "downloadFormatConfigJSON": { "type": "string" }, "costBasisType": { "type": "string", "enum": [ "None", "Unrealized", "Realized", "Both" ] } }, "xml": { "name": "DownloadFormatSubType" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadFormatOffsetCashMapping": { "properties": { "downloadFormatId": { "type": "integer", "format": "int32" }, "downloadFormatSubtypeId": { "type": "integer", "format": "int32" }, "externalCode": { "type": "string", "maxLength": 50, "minLength": 0 }, "cashSymbol": { "type": "string", "maxLength": 50, "minLength": 0 }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 } }, "xml": { "name": "DownloadFormatOffsetCashMapping" }, "type": "object" }, "OAS.DataModel.Reporting.Scrub": { "required": [ "id", "customRptId", "resultOutput", "isUpdate", "entity", "databaseDefault", "userDefault" ], "properties": { "id": { "type": "integer", "format": "int32" }, "customRptId": { "type": "integer", "format": "int32" }, "resultOutput": { "type": "integer", "format": "int32" }, "customImportId": { "type": "integer", "format": "int32" }, "isUpdate": { "type": "boolean" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "databaseDefault": { "type": "integer", "format": "int32" }, "userDefault": { "type": "integer", "format": "int32" } }, "xml": { "name": "Scrub" }, "type": "object" }, "OAS.DataModel.Reporting.Custom.CustomReport": { "required": [ "id", "title", "reportDescription", "category", "sqlText", "isLandscape", "isInternal", "guid", "reportType", "isNoteEnabled", "isReadOnly", "isQuerySmith" ], "properties": { "id": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "title": { "type": "string", "maxLength": 100, "minLength": 0 }, "reportDescription": { "type": "string", "maxLength": 1000, "minLength": 0 }, "category": { "type": "string", "maxLength": 50, "minLength": 0 }, "sqlText": { "type": "string" }, "isLandscape": { "type": "boolean" }, "reportClass": { "type": "string", "maxLength": 50, "minLength": 0 }, "isInternal": { "type": "boolean" }, "guid": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "promptClass": { "type": "string", "maxLength": 20, "minLength": 0 }, "reportType": { "type": "string", "enum": [ "Query", "CustomImport", "Scrub" ] }, "userOwnerId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "isNoteEnabled": { "type": "boolean" }, "isReadOnly": { "type": "boolean" }, "isQuerySmith": { "type": "boolean" }, "prompts": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Custom.CustomReportPrompt" }, "xml": { "name": "CustomReportPrompt", "wrapped": true }, "type": "array" }, "schedules": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Custom.CustomReportSchedule" }, "xml": { "name": "CustomReportSchedule", "wrapped": true }, "type": "array" }, "alClients": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Custom.CustomReportAlClient" }, "xml": { "name": "CustomReportAlClient", "wrapped": true }, "type": "array" }, "confirmGroups": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.ConfirmGroupDataQuery" }, "xml": { "name": "ConfirmGroupDataQuery", "wrapped": true }, "type": "array" }, "notes": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Custom.CustomReportNote" }, "xml": { "name": "CustomReportNote", "wrapped": true }, "type": "array" }, "importTypes": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Custom.CustomReportImport" }, "xml": { "name": "CustomReportImport", "wrapped": true }, "type": "array" } }, "xml": { "name": "CustomReport" }, "type": "object" }, "OAS.DataModel.Security.LoginEntity": { "required": [ "id", "entity", "entityDesc", "createdBy", "createdDate", "editedBy", "editedDate", "isTableBased" ], "properties": { "id": { "type": "string", "enum": [ "BrokerDealer", "Wholesaler", "Representative", "Client", "RIA", "Administrator", "SubAdvisor", "ThirdPartyAdministrator", "Custodian", "PlanSponsor", "ThirdParty", "ServiceAccount", "Participant", "RepAccountManager", "Payee", "RIATable", "Cotenant" ] }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityDesc": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "isTableBased": { "type": "boolean" }, "extension": { "$ref": "#/definitions/OAS.DataModel.Security.LoginEntityParent" } }, "xml": { "name": "LoginEntity" }, "type": "object" }, "OAS.DataModel.Security.UserDetailAccess": { "required": [ "userDetailId", "accessibleUserDetailId", "alClientId" ], "properties": { "userDetailId": { "type": "integer", "format": "int32" }, "accessibleUserDetailId": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "userDetail": { "$ref": "#/definitions/OAS.DataModel.Security.UserDetail" } }, "xml": { "name": "UserDetailAccess" }, "type": "object" }, "OAS.DataModel.Security.Role": { "required": [ "id", "name", "loginEntityId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "maxLength": 255, "minLength": 0 }, "loginEntityId": { "type": "string", "enum": [ "BrokerDealer", "Wholesaler", "Representative", "Client", "RIA", "Administrator", "SubAdvisor", "ThirdPartyAdministrator", "Custodian", "PlanSponsor", "ThirdParty", "ServiceAccount", "Participant", "RepAccountManager", "Payee", "RIATable", "Cotenant" ] }, "tokenLife": { "type": "number", "format": "double" }, "defaultDashboardId": { "type": "integer", "format": "int32" }, "defaultPVDashboardId": { "type": "integer", "format": "int32" }, "privilegeRoles": { "items": { "$ref": "#/definitions/OAS.DataModel.Security.PrivilegeRole" }, "xml": { "name": "PrivilegeRole", "wrapped": true }, "type": "array" }, "loginEntity": { "$ref": "#/definitions/OAS.DataModel.Security.LoginEntity" }, "alClient": { "$ref": "#/definitions/OAS.DataModel.Security.AlClient" }, "profiles": { "items": { "$ref": "#/definitions/OAS.DataModel.Security.UserDetail" }, "xml": { "name": "UserDetail", "wrapped": true }, "type": "array" }, "sharedDashboards": { "items": { "$ref": "#/definitions/OAS.DataModel.Homepage.RoleSharedDashboard" }, "xml": { "name": "RoleSharedDashboard", "wrapped": true }, "type": "array" }, "defaultDashboard": { "$ref": "#/definitions/OAS.DataModel.Homepage.RoleSharedDashboard" }, "defaultPVDashboard": { "$ref": "#/definitions/OAS.DataModel.Homepage.RoleSharedDashboard" } }, "xml": { "name": "Role" }, "type": "object" }, "OAS.DataModel.Integrations.AppLink": { "required": [ "id", "appCode", "credentialLevel" ], "properties": { "id": { "type": "integer", "format": "int32" }, "appCode": { "type": "string", "maxLength": 30, "minLength": 0 }, "appDescription": { "type": "string", "maxLength": 100, "minLength": 0 }, "registrationLink": { "type": "string", "maxLength": 255, "minLength": 0 }, "loginLink": { "type": "string", "maxLength": 255, "minLength": 0 }, "loginCredentials": { "type": "string" }, "publicRSAKeyValueXml": { "type": "string", "maxLength": 500, "minLength": 0 }, "partnerAppId": { "type": "integer", "format": "int32" }, "credentialLevel": { "type": "integer", "format": "int32" }, "isAggregator": { "type": "boolean" }, "details": { "items": { "$ref": "#/definitions/OAS.DataModel.Integrations.AppLinkDetail" }, "xml": { "name": "AppLinkDetail", "wrapped": true }, "type": "array" } }, "xml": { "name": "AppLink" }, "type": "object" }, "OAS.DataModel.Security.ServiceTeamMemberAlClient": { "required": [ "serviceTeamMemberId", "alClientId" ], "properties": { "serviceTeamMemberId": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "alClient": { "$ref": "#/definitions/OAS.DataModel.Security.AlClient" }, "serviceTeamMember": { "$ref": "#/definitions/OAS.DataModel.Security.ServiceTeamMember" } }, "xml": { "name": "ServiceTeamMemberAlClient" }, "type": "object" }, "OAS.DataModel.Reporting.Envision.ReportTheme": { "required": [ "themeData", "id", "guid", "name", "description" ], "properties": { "themeData": { "type": "string", "format": "byte" }, "customData": { "type": "string", "format": "byte" }, "optionsData": { "type": "string", "format": "byte" }, "category": { "type": "string", "maxLength": 100, "minLength": 0 }, "defaults": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Envision.AlClientDefaultReportTheme" }, "xml": { "name": "AlClientDefaultReportTheme", "wrapped": true }, "type": "array" }, "id": { "type": "integer", "format": "int32" }, "auditedByDisplay": { "type": "string" }, "auditedBy": { "type": "string", "format": "byte" }, "auditedDate": { "type": "string", "format": "date-time" }, "guid": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 200, "minLength": 0 }, "description": { "type": "string" }, "isDeleted": { "type": "boolean" }, "rules": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Envision.ReportAccessRule" }, "xml": { "name": "ReportAccessRule", "wrapped": true }, "type": "array" }, "info": { "$ref": "#/definitions/OAS.DataModel.Reporting.Envision.ReportInfo" } }, "xml": { "name": "ReportTheme" }, "type": "object" }, "OAS.DataModel.Reporting.Envision.ReportCoverPage": { "required": [ "coverPageData", "additionalOptionsData", "id", "guid", "name", "description" ], "properties": { "coverPageData": { "type": "string", "format": "byte" }, "additionalOptionsData": { "type": "string", "format": "byte" }, "defaults": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Envision.AlClientDefaultCoverPage" }, "xml": { "name": "AlClientDefaultCoverPage", "wrapped": true }, "type": "array" }, "id": { "type": "integer", "format": "int32" }, "auditedByDisplay": { "type": "string" }, "auditedBy": { "type": "string", "format": "byte" }, "auditedDate": { "type": "string", "format": "date-time" }, "guid": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 200, "minLength": 0 }, "description": { "type": "string" }, "isDeleted": { "type": "boolean" }, "rules": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Envision.ReportAccessRule" }, "xml": { "name": "ReportAccessRule", "wrapped": true }, "type": "array" }, "info": { "$ref": "#/definitions/OAS.DataModel.Reporting.Envision.ReportInfo" } }, "xml": { "name": "ReportCoverPage" }, "type": "object" }, "OAS.DataModel.Confirm.DownloadSubFormatSourceScheduleDefault": { "required": [ "id", "downloadFormatId", "downloadFormatSubTypeId", "scheduledTime" ], "properties": { "id": { "type": "integer", "format": "int32" }, "downloadFormatId": { "type": "integer", "format": "int32" }, "downloadFormatSubTypeId": { "type": "integer", "format": "int32" }, "scheduledTime": { "type": "string" }, "scheduleConfiguration": { "type": "string" }, "active": { "type": "boolean" } }, "xml": { "name": "DownloadSubFormatSourceScheduleDefault" }, "type": "object" }, "OAS.DataModel.Reporting.Custom.CustomReportPrompt": { "required": [ "id", "customReportId", "code", "prompt", "promptType", "isPromptUser", "sortOrder" ], "properties": { "id": { "type": "integer", "format": "int32" }, "customReportId": { "type": "integer", "format": "int32" }, "code": { "type": "string", "maxLength": 25, "minLength": 0 }, "prompt": { "type": "string", "maxLength": 50, "minLength": 0 }, "promptDescription": { "type": "string", "maxLength": 255, "minLength": 0 }, "promptType": { "type": "string", "enum": [ "None", "Text", "Numeric", "Date", "Dynamic Group" ] }, "defaultValue": { "type": "string", "maxLength": 50, "minLength": 0 }, "isPromptUser": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" } }, "xml": { "name": "CustomReportPrompt" }, "type": "object" }, "OAS.DataModel.Reporting.Custom.CustomReportSchedule": { "required": [ "id", "customReportId", "frequency", "frequencyInfo", "timeOfDay", "startDate", "isActive", "createdBy", "createdDate", "editedBy", "editedDate", "userId", "entity" ], "properties": { "id": { "type": "integer", "format": "int32" }, "customReportId": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "parameters": { "type": "string" }, "frequency": { "type": "string", "enum": [ "Daily", "Weekly", "Monthly", "Once" ] }, "frequencyInfo": { "type": "string", "maxLength": 1000, "minLength": 0 }, "timeOfDay": { "type": "string", "format": "date-time" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "notes": { "type": "string", "maxLength": 1000, "minLength": 0 }, "isActive": { "type": "boolean" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "userId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "lastRunDate": { "type": "string", "format": "date-time" }, "nextRunDate": { "type": "string", "format": "date-time" }, "uploadTargetId": { "type": "integer", "format": "int32" }, "running": { "type": "boolean" }, "customReport": { "$ref": "#/definitions/OAS.DataModel.Reporting.Custom.CustomReport" }, "database": { "$ref": "#/definitions/OAS.DataModel.Security.AlClient" }, "user": { "$ref": "#/definitions/OAS.DataModel.Security.User" }, "results": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Custom.CustomReportScheduleResult" }, "xml": { "name": "CustomReportScheduleResult", "wrapped": true }, "type": "array" } }, "xml": { "name": "CustomReportSchedule" }, "type": "object" }, "OAS.DataModel.Reporting.Custom.CustomReportAlClient": { "required": [ "id", "customReportId", "alClientId", "reportDescription" ], "properties": { "id": { "type": "integer", "format": "int32" }, "customReportId": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "reportDescription": { "type": "string", "maxLength": 1000, "minLength": 0 } }, "xml": { "name": "CustomReportAlClient" }, "type": "object" }, "OAS.DataModel.Reporting.Custom.CustomReportNote": { "required": [ "id", "customReportId", "alClientId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "customReportId": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "note": { "type": "string" }, "auditedByDisplay": { "type": "string" }, "auditedBy": { "type": "string", "format": "byte" }, "auditedDate": { "type": "string", "format": "date-time" }, "rowData_c": { "type": "string", "format": "byte" }, "customReport": { "$ref": "#/definitions/OAS.DataModel.Reporting.Custom.CustomReport" }, "database": { "$ref": "#/definitions/OAS.DataModel.Security.AlClient" } }, "xml": { "name": "CustomReportNote" }, "type": "object" }, "OAS.DataModel.Reporting.Custom.CustomReportImport": { "required": [ "customReportId", "importTypeId", "isInternalOnly" ], "properties": { "customReportId": { "type": "integer", "format": "int32" }, "importTypeId": { "type": "integer", "format": "int32" }, "isInternalOnly": { "type": "boolean" } }, "xml": { "name": "CustomReportImport" }, "type": "object" }, "OAS.DataModel.Security.LoginEntityParent": { "required": [ "loginEntityId", "parentLoginEntityId" ], "properties": { "loginEntityId": { "type": "string", "enum": [ "BrokerDealer", "Wholesaler", "Representative", "Client", "RIA", "Administrator", "SubAdvisor", "ThirdPartyAdministrator", "Custodian", "PlanSponsor", "ThirdParty", "ServiceAccount", "Participant", "RepAccountManager", "Payee", "RIATable", "Cotenant" ] }, "parentLoginEntityId": { "type": "string", "enum": [ "BrokerDealer", "Wholesaler", "Representative", "Client", "RIA", "Administrator", "SubAdvisor", "ThirdPartyAdministrator", "Custodian", "PlanSponsor", "ThirdParty", "ServiceAccount", "Participant", "RepAccountManager", "Payee", "RIATable", "Cotenant" ] }, "parentLoginEntity": { "$ref": "#/definitions/OAS.DataModel.Security.LoginEntity" } }, "xml": { "name": "LoginEntityParent" }, "type": "object" }, "OAS.DataModel.Security.PrivilegeRole": { "required": [ "accessType", "privilegeId", "roleId" ], "properties": { "accessType": { "type": "string", "enum": [ "None", "Read", "Edit", "Delete" ] }, "privilege": { "$ref": "#/definitions/OAS.DataModel.Security.Privilege" }, "role": { "$ref": "#/definitions/OAS.DataModel.Security.Role" }, "privilegeId": { "type": "integer", "format": "int32" }, "roleId": { "type": "integer", "format": "int32" } }, "xml": { "name": "PrivilegeRole" }, "type": "object" }, "OAS.DataModel.Homepage.RoleSharedDashboard": { "properties": { "id": { "type": "integer", "format": "int32" }, "roleId": { "type": "integer", "format": "int32" }, "homepageDashboardId": { "type": "integer", "format": "int32" }, "role": { "$ref": "#/definitions/OAS.DataModel.Security.Role" }, "dashboard": { "$ref": "#/definitions/OAS.DataModel.Homepage.HomepageDashboard" } }, "xml": { "name": "RoleSharedDashboard" }, "type": "object" }, "OAS.DataModel.Reporting.Envision.ReportAccessRule": { "required": [ "reportId", "id" ], "properties": { "reportId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "auditedByDisplay": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "ReportAccessRule" }, "type": "object" }, "OAS.DataModel.Reporting.Envision.ReportInfo": { "properties": { "reportId": { "type": "integer", "format": "int32" }, "guid": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "byte" }, "createdByDisplay": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "deletedBy": { "type": "string", "format": "byte" }, "deletedByDisplay": { "type": "string" }, "deletedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "ReportInfo" }, "type": "object" }, "OAS.DataModel.Reporting.Custom.CustomReportScheduleResult": { "required": [ "id", "customReportScheduleId", "resultData", "createdBy", "createdDate", "editedBy", "editedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "customReportScheduleId": { "type": "integer", "format": "int32" }, "resultData": { "type": "string", "format": "byte" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "fileFormat": { "type": "string", "enum": [ "Csv", "Xls", "Xlsx", "Psv" ] }, "fileNameOnRun": { "type": "string" }, "schedule": { "$ref": "#/definitions/OAS.DataModel.Reporting.Custom.CustomReportSchedule" } }, "xml": { "name": "CustomReportScheduleResult" }, "type": "object" }, "OAS.DataModel.Security.Privilege": { "required": [ "id", "categoryId", "name", "code", "isIncludedByDefault", "revokeOnLockdownType", "dbLimitationAdminOverride", "firmTypes" ], "properties": { "id": { "type": "integer", "format": "int32" }, "categoryId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "maxLength": 255, "minLength": 0 }, "code": { "type": "string", "maxLength": 50, "minLength": 0 }, "description": { "type": "string", "maxLength": 255, "minLength": 0 }, "type": { "type": "string", "enum": [ "Unknown", "Apps", "Records", "Actions", "Advanced", "Applinks", "FeatureFlags" ] }, "accessType": { "type": "string", "enum": [ "None", "Read", "Edit", "Delete" ] }, "isIncludedByDefault": { "type": "boolean" }, "revokeOnLockdownType": { "type": "string", "enum": [ "None", "Billing" ] }, "dbLimitationAdminOverride": { "type": "boolean" }, "firmTypes": { "type": "string", "enum": [ "None", "Foundations", "Essentials", "Advantage", "OrionTradingOnly", "OrionRiskOnly", "OrionComplianceOnly", "OrionPlanningOnly", "OasLegacy" ] }, "allowedEntities": { "items": { "$ref": "#/definitions/OAS.DataModel.Security.PrivilegeAllowEntity" }, "xml": { "name": "PrivilegeAllowEntity", "wrapped": true }, "type": "array" }, "category": { "$ref": "#/definitions/OAS.DataModel.Security.PrivilegeCategory" }, "privilegeRoles": { "items": { "$ref": "#/definitions/OAS.DataModel.Security.PrivilegeRole" }, "xml": { "name": "PrivilegeRole", "wrapped": true }, "type": "array" }, "privilegeHistory": { "items": { "$ref": "#/definitions/OAS.DataModel.Security.PrivilegeHistory" }, "xml": { "name": "PrivilegeHistory", "wrapped": true }, "type": "array" }, "privilegeAlClients": { "items": { "$ref": "#/definitions/OAS.DataModel.Security.PrivilegeAlClient" }, "xml": { "name": "PrivilegeAlClient", "wrapped": true }, "type": "array" }, "firmTypeExceptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Security.PrivilegeFirmTypeException" }, "xml": { "name": "PrivilegeFirmTypeException", "wrapped": true }, "type": "array" }, "privilegeAllowEntityHistory": { "items": { "$ref": "#/definitions/OAS.DataModel.Security.PrivilegeAllowEntityHistory" }, "xml": { "name": "PrivilegeAllowEntityHistory", "wrapped": true }, "type": "array" } }, "xml": { "name": "Privilege" }, "type": "object" }, "OAS.DataModel.Homepage.HomepageDashboard": { "required": [ "name" ], "properties": { "id": { "type": "integer", "format": "int32" }, "firmId": { "readOnly": true, "type": "integer", "format": "int32" }, "isDefault": { "type": "boolean" }, "name": { "type": "string" }, "createdBy": { "readOnly": true, "type": "string" }, "createdDate": { "readOnly": true, "type": "string", "format": "date-time" }, "isGlobal": { "type": "boolean" }, "parentDashboardId": { "type": "integer", "format": "int32" }, "isPortfolioView": { "type": "boolean" }, "userId": { "type": "integer", "format": "int32" }, "cards": { "items": { "$ref": "#/definitions/OAS.DataModel.Homepage.AssignedDashboardCard" }, "xml": { "name": "AssignedDashboardCard", "wrapped": true }, "type": "array" }, "roles": { "items": { "$ref": "#/definitions/OAS.DataModel.Homepage.RoleSharedDashboard" }, "xml": { "name": "RoleSharedDashboard", "wrapped": true }, "type": "array" }, "dashboardType": { "type": "string", "enum": [ "Homepage", "View", "Tool" ] } }, "xml": { "name": "HomepageDashboard" }, "type": "object" }, "OAS.DataModel.Security.PrivilegeAllowEntity": { "required": [ "privilegeId", "loginEntityId", "accessType" ], "properties": { "privilegeId": { "type": "integer", "format": "int32" }, "loginEntityId": { "type": "string", "enum": [ "BrokerDealer", "Wholesaler", "Representative", "Client", "RIA", "Administrator", "SubAdvisor", "ThirdPartyAdministrator", "Custodian", "PlanSponsor", "ThirdParty", "ServiceAccount", "Participant", "RepAccountManager", "Payee", "RIATable", "Cotenant" ] }, "accessType": { "type": "string", "enum": [ "None", "Read", "Edit", "Delete" ] }, "privilege": { "$ref": "#/definitions/OAS.DataModel.Security.Privilege" }, "loginEntity": { "$ref": "#/definitions/OAS.DataModel.Security.LoginEntity" } }, "xml": { "name": "PrivilegeAllowEntity" }, "type": "object" }, "OAS.DataModel.Security.PrivilegeCategory": { "required": [ "id", "category" ], "properties": { "id": { "type": "integer", "format": "int32" }, "category": { "type": "string", "maxLength": 255, "minLength": 0 } }, "xml": { "name": "PrivilegeCategory" }, "type": "object" }, "OAS.DataModel.Security.PrivilegeHistory": { "required": [ "id", "privilegeId", "privilegeCategory", "name", "code", "type", "accessType", "changeType" ], "properties": { "id": { "type": "integer", "format": "int32" }, "privilegeId": { "type": "integer", "format": "int32" }, "privilegeCategory": { "type": "integer", "format": "int32" }, "name": { "type": "string", "maxLength": 255, "minLength": 0 }, "code": { "type": "string", "maxLength": 50, "minLength": 0 }, "description": { "type": "string", "maxLength": 255, "minLength": 0 }, "type": { "type": "integer", "format": "int32" }, "accessType": { "type": "string", "enum": [ "None", "Read", "Edit", "Delete" ] }, "auditedBy": { "type": "string", "format": "byte" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplayName": { "type": "string" }, "isIncludedByDefault": { "type": "boolean" }, "revokeOnLockdownType": { "type": "string", "enum": [ "None", "Billing" ] }, "dbLimitationAdminOverride": { "type": "boolean" }, "firmTypes": { "type": "string", "enum": [ "None", "Foundations", "Essentials", "Advantage", "OrionTradingOnly", "OrionRiskOnly", "OrionComplianceOnly", "OrionPlanningOnly", "OasLegacy" ] }, "changeType": { "type": "string", "maxLength": 1, "minLength": 0 }, "privilegeAllowEntityHistory": { "$ref": "#/definitions/OAS.DataModel.Security.PrivilegeAllowEntityHistory" } }, "xml": { "name": "PrivilegeHistory" }, "type": "object" }, "OAS.DataModel.Security.PrivilegeAlClient": { "required": [ "privilegeId", "alClientId" ], "properties": { "privilegeId": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" } }, "xml": { "name": "PrivilegeAlClient" }, "type": "object" }, "OAS.DataModel.Security.PrivilegeFirmTypeException": { "required": [ "privilegeId", "alClientId" ], "properties": { "privilegeId": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" } }, "xml": { "name": "PrivilegeFirmTypeException" }, "type": "object" }, "OAS.DataModel.Security.PrivilegeAllowEntityHistory": { "required": [ "id", "privilegeHistory", "loginEntityHistory", "accessType", "changeType" ], "properties": { "id": { "type": "integer", "format": "int32" }, "privilegeHistory": { "type": "integer", "format": "int32" }, "loginEntityHistory": { "type": "string", "enum": [ "BrokerDealer", "Wholesaler", "Representative", "Client", "RIA", "Administrator", "SubAdvisor", "ThirdPartyAdministrator", "Custodian", "PlanSponsor", "ThirdParty", "ServiceAccount", "Participant", "RepAccountManager", "Payee", "RIATable", "Cotenant" ] }, "accessType": { "type": "string", "enum": [ "None", "Read", "Edit", "Delete" ] }, "auditedBy": { "type": "string", "format": "byte" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplayName": { "type": "string" }, "changeType": { "type": "string", "maxLength": 1, "minLength": 0 } }, "xml": { "name": "PrivilegeAllowEntityHistory" }, "type": "object" }, "OAS.DataModel.Homepage.AssignedDashboardCard": { "properties": { "id": { "type": "integer", "format": "int32" }, "cardId": { "type": "integer", "format": "int32" }, "dashboardId": { "type": "integer", "format": "int32" }, "position": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "size": { "type": "integer", "format": "int32" }, "cardSettingCompressedJson": { "type": "string", "format": "byte" }, "card": { "$ref": "#/definitions/OAS.DataModel.Homepage.Card" } }, "xml": { "name": "AssignedDashboardCard" }, "type": "object" }, "OAS.DataModel.Homepage.Card": { "properties": { "id": { "type": "integer", "format": "int32" }, "firmId": { "readOnly": true, "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string" }, "size": { "type": "integer", "format": "int32" }, "category": { "type": "string" }, "createdBy": { "readOnly": true, "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "cardSettingCompressedJson": { "type": "string", "format": "byte" }, "isVisible": { "type": "boolean" }, "hideIfRestricted": { "type": "boolean" }, "components": { "items": { "$ref": "#/definitions/OAS.DataModel.Homepage.Component" }, "xml": { "name": "Component", "wrapped": true }, "type": "array" }, "icon": { "type": "string" }, "cardType": { "type": "string", "enum": [ "None", "Homepage", "View" ] } }, "xml": { "name": "Card" }, "type": "object" }, "OAS.DataModel.Homepage.Component": { "properties": { "id": { "type": "integer", "format": "int32" }, "parentComponentId": { "type": "integer", "format": "int32" }, "dataSourceId": { "type": "integer", "format": "int32" }, "title": { "type": "string" }, "type": { "type": "string", "enum": [ "Text", "Header", "Footer", "Table", "Chart", "BigNumber", "Hr", "Grid", "ComponentButtonList", "ActionSteps", "SchwabStatus", "RiskProfile", "ComponentIFrame", "Message", "Gauge", "ThreeDRiskProfile", "BeFi20", "MgpInsurancePolicy", "SimpleGroupingTable", "MgpPlanSummary", "ImageDisplay", "QueryStudioResultsGrid" ] }, "settingsCompressedJson": { "type": "string", "format": "byte" }, "sort": { "type": "integer", "format": "int32" }, "dataSource": { "$ref": "#/definitions/OAS.DataModel.Homepage.ComponentDataSource" } }, "xml": { "name": "Component" }, "type": "object" }, "OAS.DataModel.Homepage.ComponentDataSource": { "properties": { "id": { "readOnly": true, "type": "integer", "format": "int32" }, "firmId": { "type": "integer", "format": "int32" }, "text": { "type": "string" }, "description": { "type": "string" }, "privilegeId": { "type": "integer", "format": "int32" }, "connector": { "type": "string", "enum": [ "DB", "RestApi", "DirectRestApi", "Eclipse", "RB3", "AWSPOC" ] }, "type": { "type": "string", "enum": [ "External", "Internal" ] }, "configurationCompressedJson": { "type": "string", "format": "byte" }, "privilege": { "$ref": "#/definitions/OAS.DataModel.Security.Privilege" } }, "xml": { "name": "ComponentDataSource" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.ConfirmOverviewBatchProcessingPollingDto": { "properties": { "batchProcessingIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "correlationIds": { "items": { "type": "string" }, "type": "array" } }, "xml": { "name": "ConfirmOverviewBatchProcessingPollingDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.FixShares005Dto": { "properties": { "databaseRun": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "databaseNotRun": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, "xml": { "name": "FixShares005Dto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.FixSleeveSharesDto": { "properties": { "databaseRun": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "databaseNotRun": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, "xml": { "name": "FixSleeveSharesDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.OrionVisionConfirmDto": { "properties": { "id": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "status": { "readOnly": true, "type": "string" }, "alClientId": { "type": "integer", "format": "int32" }, "advisorNumber": { "type": "integer", "format": "int32" }, "databaseName": { "type": "string" }, "area": { "type": "string" }, "totalToReview": { "type": "integer", "format": "int32" }, "lastUpdated": { "type": "string", "format": "date-time" } }, "xml": { "name": "OrionVisionConfirmDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Dashboard.AccountNotInFileConfirmOverviewDashboardDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "fundFamily": { "type": "string" }, "custodian": { "type": "string" }, "registrationName": { "type": "string" }, "registrationLastName": { "type": "string" }, "clientName": { "type": "string" }, "clientLastName": { "type": "string" }, "representative": { "type": "string" }, "lastEffectiveDate": { "type": "string", "format": "date-time" }, "accountStatus": { "type": "string" }, "serviceTeamRecon": { "type": "string" }, "serviceTeamMember": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "downloadSourceName": { "type": "string" }, "noteCount": { "type": "integer", "format": "int32" }, "notesSummary": { "type": "string" }, "reason": { "type": "string" }, "recordType": { "type": "string", "enum": [ "Name", "Position", "Transaction", "Price", "Dividend", "Product", "NotImported", "Header", "Security", "CorpAction", "TranDetail", "Generic", "CostBasis", "Beneficiary", "StoredPerformance", "Systematic", "RMD", "Banking" ] }, "resolvedDate": { "type": "string", "format": "date-time" }, "signOffBy": { "type": "string" }, "signOffDate": { "type": "string", "format": "date-time" }, "databaseName": { "type": "string" }, "signOffByUserId": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "downloadFormatId": { "type": "integer", "format": "int32" }, "downloadSourceId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "downloadFormatName": { "type": "string" } }, "xml": { "name": "AccountNotInFileConfirmOverviewDashboardDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Dashboard.DataAuditsConfirmOverviewDashboardDto": { "properties": { "dataAuditName": { "type": "string" }, "dataAuditRecordCount": { "type": "integer", "format": "int32" }, "customReportId": { "type": "integer", "format": "int32" }, "downloadFileFormat": { "type": "string" }, "serviceTeamRecon": { "type": "string" }, "serviceTeamMember": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "downloadSourceName": { "type": "string" }, "noteCount": { "type": "integer", "format": "int32" }, "notesSummary": { "type": "string" }, "reason": { "type": "string" }, "recordType": { "type": "string", "enum": [ "Name", "Position", "Transaction", "Price", "Dividend", "Product", "NotImported", "Header", "Security", "CorpAction", "TranDetail", "Generic", "CostBasis", "Beneficiary", "StoredPerformance", "Systematic", "RMD", "Banking" ] }, "resolvedDate": { "type": "string", "format": "date-time" }, "signOffBy": { "type": "string" }, "signOffDate": { "type": "string", "format": "date-time" }, "databaseName": { "type": "string" }, "signOffByUserId": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "downloadFormatId": { "type": "integer", "format": "int32" }, "downloadSourceId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "downloadFormatName": { "type": "string" } }, "xml": { "name": "DataAuditsConfirmOverviewDashboardDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Dashboard.ScheduleJobsConfirmOverviewDashboardDto": { "properties": { "jobScheduleId": { "type": "integer", "format": "int32" }, "scheduleName": { "type": "string" }, "jobStatus": { "type": "string", "enum": [ "Unknown", "Scheduled", "Processing", "Success", "Failed", "Rescheduled", "Hold", "Resume", "Delete", "Fail", "RunNow" ] }, "runOn": { "type": "string", "format": "date-time" }, "runTime": { "type": "string", "format": "date-time" }, "active": { "type": "boolean" }, "dependent": { "type": "string" }, "startTime": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" }, "queueId": { "type": "integer", "format": "int32" }, "serviceTeamRecon": { "type": "string" }, "serviceTeamMember": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "downloadSourceName": { "type": "string" }, "noteCount": { "type": "integer", "format": "int32" }, "notesSummary": { "type": "string" }, "reason": { "type": "string" }, "recordType": { "type": "string", "enum": [ "Name", "Position", "Transaction", "Price", "Dividend", "Product", "NotImported", "Header", "Security", "CorpAction", "TranDetail", "Generic", "CostBasis", "Beneficiary", "StoredPerformance", "Systematic", "RMD", "Banking" ] }, "resolvedDate": { "type": "string", "format": "date-time" }, "signOffBy": { "type": "string" }, "signOffDate": { "type": "string", "format": "date-time" }, "databaseName": { "type": "string" }, "signOffByUserId": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "downloadFormatId": { "type": "integer", "format": "int32" }, "downloadSourceId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "downloadFormatName": { "type": "string" } }, "xml": { "name": "ScheduleJobsConfirmOverviewDashboardDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Dashboard.ManualExclusionsConfirmOverviewDashboardDto": { "properties": { "accountNumber": { "type": "string" }, "productSymbol": { "type": "string" }, "serviceTeamRecon": { "type": "string" }, "serviceTeamMember": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "downloadSourceName": { "type": "string" }, "noteCount": { "type": "integer", "format": "int32" }, "notesSummary": { "type": "string" }, "reason": { "type": "string" }, "recordType": { "type": "string", "enum": [ "Name", "Position", "Transaction", "Price", "Dividend", "Product", "NotImported", "Header", "Security", "CorpAction", "TranDetail", "Generic", "CostBasis", "Beneficiary", "StoredPerformance", "Systematic", "RMD", "Banking" ] }, "resolvedDate": { "type": "string", "format": "date-time" }, "signOffBy": { "type": "string" }, "signOffDate": { "type": "string", "format": "date-time" }, "databaseName": { "type": "string" }, "signOffByUserId": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "downloadFormatId": { "type": "integer", "format": "int32" }, "downloadSourceId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "downloadFormatName": { "type": "string" } }, "xml": { "name": "ManualExclusionsConfirmOverviewDashboardDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Dashboard.ExclusionTableConfirmOverviewDashboardDto": { "properties": { "accountNumber": { "type": "string" }, "productSymbol": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "downloadSourceName": { "type": "string" }, "noteCount": { "type": "integer", "format": "int32" }, "notesSummary": { "type": "string" }, "reason": { "type": "string" }, "recordType": { "type": "string", "enum": [ "Name", "Position", "Transaction", "Price", "Dividend", "Product", "NotImported", "Header", "Security", "CorpAction", "TranDetail", "Generic", "CostBasis", "Beneficiary", "StoredPerformance", "Systematic", "RMD", "Banking" ] }, "resolvedDate": { "type": "string", "format": "date-time" }, "signOffBy": { "type": "string" }, "signOffDate": { "type": "string", "format": "date-time" }, "databaseName": { "type": "string" }, "signOffByUserId": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "downloadFormatId": { "type": "integer", "format": "int32" }, "downloadSourceId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "downloadFormatName": { "type": "string" } }, "xml": { "name": "ExclusionTableConfirmOverviewDashboardDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.UnmappedTransTypeConfirmMappingRequestDto": { "properties": { "fileTranCode": { "type": "string" }, "mappings": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.UnmappedTransTypeConfirmMappingItemDto" }, "xml": { "name": "UnmappedTransTypeConfirmMappingItemDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "UnmappedTransTypeConfirmMappingRequestDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.UnmappedTransTypeConfirmMappingItemDto": { "properties": { "transTypeId": { "type": "integer", "format": "int32" }, "noteMappingChoice": { "type": "string" }, "searchFor": { "type": "string" }, "translateTo": { "type": "string" } }, "xml": { "name": "UnmappedTransTypeConfirmMappingItemDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.ImportCommonDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "importTypeId": { "type": "integer", "format": "int32" }, "importName": { "type": "string" }, "originalFileName": { "type": "string" }, "numberOfDatasets": { "type": "integer", "format": "int32" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "canDelete": { "type": "boolean" } }, "xml": { "name": "ImportCommonDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Recon.ReconSignOffCreateRequestDto": { "properties": { "alClientId": { "type": "integer", "format": "int32" }, "sourceId": { "type": "integer", "format": "int32" }, "notes": { "type": "string" } }, "xml": { "name": "ReconSignOffCreateRequestDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Recon.ReconJobStatusDto": { "properties": { "id": { "type": "integer", "format": "int64" }, "processName": { "type": "string" }, "jobName": { "type": "string" }, "processStartDate": { "type": "string", "format": "date-time" }, "processEndDate": { "type": "string", "format": "date-time" }, "runTimeInSeconds": { "type": "integer", "format": "int32" }, "processStatus": { "type": "string" }, "rowsInsertTarget": { "type": "integer", "format": "int64" }, "rowsInsertTargetError": { "type": "integer", "format": "int64" }, "errorCode": { "type": "integer", "format": "int32" }, "errorDescription": { "type": "string" }, "jobSettings": { "type": "string" } }, "xml": { "name": "ReconJobStatusDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.ConfirmGroupDataQueryResultDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "confirmGroupId": { "type": "integer", "format": "int32" }, "customReportId": { "type": "integer", "format": "int32" }, "resultCount": { "type": "integer", "format": "int32" }, "exceptionCount": { "type": "integer", "format": "int32" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "advisorBlobId": { "type": "integer", "format": "int32" } }, "xml": { "name": "ConfirmGroupDataQueryResultDto" }, "type": "object" }, "OAS.DataModel.Confirm.ConfirmGroupDataQueryResult": { "required": [ "id", "alClientId", "confirmGroupId", "customReportId", "resultCount", "exceptionCount", "auditedDate", "advisorBlobId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "confirmGroupId": { "type": "integer", "format": "int32" }, "customReportId": { "type": "integer", "format": "int32" }, "resultCount": { "type": "integer", "format": "int32" }, "exceptionCount": { "type": "integer", "format": "int32" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "advisorBlobId": { "type": "integer", "format": "int32" } }, "xml": { "name": "ConfirmGroupDataQueryResult" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Recon.RulesDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "syncType": { "type": "string", "enum": [ "Daily", "Weekly", "Exclusion", "Price" ] }, "syncTypeId": { "type": "integer", "format": "int32" }, "numDaysAnalyst": { "type": "integer", "format": "int32" }, "numDaysManager": { "type": "integer", "format": "int32" }, "statusType": { "type": "string", "enum": [ "Unknown", "Error" ] }, "statusTypeId": { "type": "integer", "format": "int32" }, "statusTypeDescription": { "type": "string" }, "notificationInbox": { "type": "boolean" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "RulesDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.SchedulerMaintenanceDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "ruleId": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "description": { "type": "string" }, "runOrder": { "type": "integer", "format": "int32" }, "maintenanceOptionJSON": { "type": "string" } }, "xml": { "name": "SchedulerMaintenanceDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.SignOffDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "type": "string", "enum": [ "NotConfirmed", "NotConfirmedFile", "MissingFile", "AssetCompareFile", "ExclusionsCommon", "ExclusionsLocal", "ExclusionsManual", "SignOffItem" ] }, "description": { "type": "string" }, "recordEntryDate": { "type": "string", "format": "date-time" }, "recordId": { "type": "integer", "format": "int32" }, "userSignOffId": { "type": "integer", "format": "int32" }, "signOffDate": { "type": "string", "format": "date-time" }, "notes": { "type": "string" }, "recordType": { "type": "string", "enum": [ "Name", "Position", "Transaction", "Price", "Dividend", "Product", "NotImported", "Header", "Security", "CorpAction", "TranDetail", "Generic", "CostBasis", "Beneficiary", "StoredPerformance", "Systematic", "RMD", "Banking" ] } }, "xml": { "name": "SignOffDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.SleeveUserRuleDto": { "properties": { "journalRules": { "type": "string" }, "allocationRules": { "type": "string" }, "journalUserDefinedID": { "type": "integer", "format": "int32" }, "allocationUserDefinedID": { "type": "integer", "format": "int32" } }, "xml": { "name": "SleeveUserRuleDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Recon.StatusTypeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "statusType": { "type": "string" } }, "xml": { "name": "StatusTypeDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Recon.SyncDashboardDto": { "properties": { "summaryDate": { "type": "string", "format": "date-time" }, "groups": { "additionalProperties": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Recon.SyncDashboardGroupDto" }, "type": "object" } }, "xml": { "name": "SyncDashboardDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Recon.SyncDashboardGroupDto": { "properties": { "description": { "type": "string" }, "errorCount": { "type": "integer", "format": "int32" }, "details": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Recon.SyncDashboardDetailDto" }, "xml": { "name": "SyncDashboardDetailDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "SyncDashboardGroupDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Recon.SyncDashboardDetailDto": { "properties": { "analystLoginUserId": { "type": "string" }, "serviceTeamName": { "type": "string" }, "databaseName": { "type": "string" }, "downloadSourceName": { "type": "string" }, "groupErrorCount": { "type": "integer", "format": "int32" } }, "xml": { "name": "SyncDashboardDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Recon.SyncCountsDto": { "properties": { "summaryDate": { "type": "string", "format": "date-time" }, "dateErrorCount": { "type": "integer", "format": "int32" }, "dailySyncErrorCount": { "type": "integer", "format": "int32" }, "weeklySyncErrorCount": { "type": "integer", "format": "int32" }, "exclusionSyncErrorCount": { "type": "integer", "format": "int32" }, "priceSyncErrorCount": { "type": "integer", "format": "int32" } }, "xml": { "name": "SyncCountsDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.Recon.SyncTypeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "syncType": { "type": "string" } }, "xml": { "name": "SyncTypeDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.CostBasis.TaxCenterCountsDto": { "properties": { "taxErrors": { "additionalProperties": { "type": "integer", "format": "int32" }, "type": "object" } }, "xml": { "name": "TaxCenterCountsDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.TaxCenterDownloadSourceSummaryDto": { "properties": { "downloadSourceId": { "type": "integer", "format": "int32" }, "downloadFormatId": { "type": "integer", "format": "int32" }, "downloadDescription": { "type": "string" }, "maxRealizedFileDate": { "type": "string", "format": "date-time" }, "maxUnrealizedFileDate": { "type": "string", "format": "date-time" }, "orionRealizedErrorCount": { "type": "integer", "format": "int32" }, "custodianRealizedErrorCount": { "type": "integer", "format": "int32" }, "orionUnrealizedErrorCount": { "type": "integer", "format": "int32" }, "custodianUnrealizedErrorCount": { "type": "integer", "format": "int32" }, "costBasisOverridesErrorCount": { "type": "integer", "format": "int32" }, "downloadFormatCostBasisType": { "type": "string", "enum": [ "None", "Unrealized", "Realized", "Both" ] }, "downloadFormatInformation": { "type": "string" } }, "xml": { "name": "TaxCenterDownloadSourceSummaryDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.TaxCenterAuditTypeCountDto": { "properties": { "auditType": { "type": "string", "enum": [ "CustodialRealizedSharesDoNotMatch", "CustodialRealizedMissing", "CustodialUnrealizedMissing", "CustodialRealizedUnknownAcquiredDate", "CustodialUnrealizedUnknownAcquiredDate", "CustodialRealizedUnknownCostBasis", "CustodialUnrealizedUnknownCostBasis", "OrionUnknownCostBasis", "MoneyMarketProducts", "OrionMissingCostBasis" ] }, "auditTypeId": { "readOnly": true, "type": "integer", "format": "int32" }, "errorCount": { "type": "integer", "format": "int32" } }, "xml": { "name": "TaxCenterAuditTypeCountDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.CostBasis.TaxCenterErrorDto": { "properties": { "errorStatusIcon": { "readOnly": true, "type": "string" }, "taxErrorId": { "type": "integer", "format": "int32" }, "auditType": { "type": "string", "enum": [ "CustodialRealizedSharesDoNotMatch", "CustodialRealizedMissing", "CustodialUnrealizedMissing", "CustodialRealizedUnknownAcquiredDate", "CustodialUnrealizedUnknownAcquiredDate", "CustodialRealizedUnknownCostBasis", "CustodialUnrealizedUnknownCostBasis", "OrionUnknownCostBasis", "MoneyMarketProducts", "OrionMissingCostBasis" ] }, "auditTypeId": { "type": "integer", "format": "int32" }, "resolutionMessage": { "readOnly": true, "type": "string" }, "expectedUnits": { "type": "number", "format": "double" }, "costUnits": { "type": "number", "format": "double" }, "reviewed": { "type": "boolean" } }, "xml": { "name": "TaxCenterErrorDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.CostBasis.TaxErrorPortfolioDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "errorMessage": { "type": "string" }, "accountNumber": { "type": "string" }, "assetId": { "type": "integer", "format": "int32" }, "ticker": { "type": "string" }, "productName": { "type": "string" }, "acquiredDate": { "type": "string", "format": "date-time" }, "longTermCost": { "type": "number", "format": "double" }, "shortTermCost": { "type": "number", "format": "double" }, "longTermUnits": { "type": "number", "format": "double" }, "shortTermUnits": { "type": "number", "format": "double" }, "custodian": { "type": "string" }, "reviewed": { "type": "boolean" }, "lotEditedDate": { "type": "string", "format": "date-time" }, "accountId": { "type": "integer", "format": "int32" }, "amortizedCost": { "type": "number", "format": "double" }, "auditTypeId": { "type": "integer", "format": "int32" }, "costUnits": { "type": "number", "format": "double" }, "custodianRecordId": { "type": "string" }, "downloadSourceId": { "type": "integer", "format": "int32" }, "downloadFormatId": { "type": "integer", "format": "int32" }, "expectedUnits": { "type": "number", "format": "double" }, "householdId": { "type": "integer", "format": "int32" }, "householdName": { "type": "string" }, "longTerm": { "type": "boolean" }, "productId": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "registrationType": { "type": "string" }, "qualified": { "type": "boolean" }, "registrationName": { "type": "string" }, "representativeNumber": { "type": "integer", "format": "int32" }, "resolutionMessage": { "type": "string" }, "assetCostCustodianId": { "type": "integer", "format": "int32" } }, "xml": { "name": "TaxErrorPortfolioDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.UploadFormatDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "formatName": { "type": "string" }, "className": { "type": "string" }, "formatType": { "type": "string", "enum": [ "Undefined", "FixAllocation", "FeeFile", "TradeFile", "NameFile", "TaxFiles" ] }, "minUploadTime": { "type": "integer", "format": "int32" } }, "xml": { "name": "UploadFormatDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.UploadTargetDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "uploadFormat": { "type": "integer", "format": "int32" }, "formatName": { "type": "string" }, "description": { "type": "string" }, "sqlText": { "type": "string" }, "parameters": { "type": "string" }, "blobType": { "type": "string" }, "url": { "type": "string" }, "transmitMethod": { "type": "string", "enum": [ "Empty", "None", "FTP", "DSTHTTP", "Network", "SFTP", "FTPS", "S3" ] }, "useForScrubs": { "type": "boolean" }, "finalProcess": { "type": "string" }, "instructionCode": { "type": "string" }, "className": { "type": "string" }, "formatType": { "type": "string", "enum": [ "Undefined", "FixAllocation", "FeeFile", "TradeFile", "NameFile", "TaxFiles" ] }, "minUploadTime": { "type": "integer", "format": "int32" }, "userID": { "type": "string" }, "password": { "type": "string" }, "pgpUserID": { "type": "string" } }, "xml": { "name": "UploadTargetDto" }, "type": "object" }, "OAS.WebApi.DTO.HomepageDashboard.CardSettingSaveDto": { "required": [ "cardId", "name", "size" ], "properties": { "dashboardCardId": { "type": "integer", "format": "int32" }, "cardId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "size": { "type": "integer", "format": "int32" }, "setting": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.CardSettingDto" }, "xml": { "name": "CardSettingDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "CardSettingSaveDto" }, "type": "object" }, "OAS.WebApi.DTO.HomepageDashboard.CardSettingDto": { "properties": { "displayName": { "type": "string" }, "promptType": { "type": "integer", "format": "int32" }, "selectedValue": { "type": "string" }, "code": { "type": "string" }, "dataType": { "type": "string" }, "availableValues": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.AvailableValueDto" }, "xml": { "name": "AvailableValueDto", "wrapped": true }, "type": "array" }, "valuesSource": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.ValuesSourceDto" }, "option": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.CardsettingOptionDto" }, "hidden": { "type": "boolean" }, "settings": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.CardSettingDto" }, "xml": { "name": "CardSettingDto", "wrapped": true }, "type": "array" }, "category": { "type": "string" }, "dragSortEnabled": { "type": "boolean" }, "useDefaultIfHidden": { "type": "boolean" }, "isThreeDotMenu": { "type": "boolean" }, "cardEventType": { "type": "integer", "format": "int32" }, "mappings": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.CardMappingDto" }, "listEditor": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.ListEditorConfigDto" }, "listEditorMenuTargetCode": { "type": "string" }, "maxOptionsAllowed": { "type": "integer", "format": "int32" } }, "xml": { "name": "CardSettingDto" }, "type": "object" }, "OAS.WebApi.DTO.HomepageDashboard.AvailableValueDto": { "properties": { "displayName": { "type": "string" }, "value": { "type": "string" }, "sortOrder": { "type": "integer", "format": "int32" }, "bucketValue": { "type": "string" }, "isHidden": { "type": "boolean" }, "dataText": { "type": "string" }, "cssClass": { "type": "string" }, "setting": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.CardSettingDto" } }, "xml": { "name": "AvailableValueDto" }, "type": "object" }, "OAS.WebApi.DTO.HomepageDashboard.ValuesSourceDto": { "properties": { "endpoint": { "type": "string" }, "labelField": { "type": "string" }, "valueField": { "type": "string" } }, "xml": { "name": "ValuesSourceDto" }, "type": "object" }, "OAS.WebApi.DTO.HomepageDashboard.CardsettingOptionDto": { "properties": { "inputOption": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.InputOption" }, "sliderOption": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.SliderOptionDto" } }, "xml": { "name": "CardsettingOptionDto" }, "type": "object" }, "OAS.WebApi.DTO.HomepageDashboard.CardMappingDto": { "properties": { "type": { "type": "string" }, "text": { "type": "string" }, "originalAvailableValues": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.AvailableValueDto" }, "xml": { "name": "AvailableValueDto", "wrapped": true }, "type": "array" }, "buckets": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.BucketMappingDto" }, "xml": { "name": "BucketMappingDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "CardMappingDto" }, "type": "object" }, "OAS.WebApi.DTO.HomepageDashboard.ListEditorConfigDto": { "description": "Declarative list editor UI config stored on card settings JSON (listEditor).", "properties": { "mode": { "type": "string" }, "labelField": { "type": "string" }, "valueField": { "type": "string" }, "readOnlyFields": { "items": { "type": "string" }, "type": "array" }, "maxItems": { "type": "integer", "format": "int32" }, "minItems": { "type": "integer", "format": "int32" }, "allowAdd": { "type": "boolean" }, "allowRemove": { "type": "boolean" }, "allowReorder": { "type": "boolean" }, "emptyMessage": { "type": "string" }, "persistStrategy": { "type": "string" } }, "xml": { "name": "ListEditorConfigDto" }, "type": "object" }, "OAS.WebApi.DTO.HomepageDashboard.InputOption": { "properties": { "min": { "type": "integer", "format": "int32" }, "max": { "type": "integer", "format": "int32" } }, "xml": { "name": "InputOption" }, "type": "object" }, "OAS.WebApi.DTO.HomepageDashboard.SliderOptionDto": { "properties": { "min": { "type": "integer", "format": "int32" }, "max": { "type": "integer", "format": "int32" }, "dimension": { "type": "integer", "format": "int32" } }, "xml": { "name": "SliderOptionDto" }, "type": "object" }, "OAS.WebApi.DTO.HomepageDashboard.BucketMappingDto": { "properties": { "name": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "includedValues": { "type": "string" } }, "xml": { "name": "BucketMappingDto" }, "type": "object" }, "OAS.WebApi.DTO.DataMaintenance.DataProvider.DataProviderSetupSendHelpEmailRequestDto": { "properties": { "message": { "type": "string" }, "setupStep": { "type": "string" }, "dataProviderSetupId": { "type": "integer", "format": "int32" } }, "xml": { "name": "DataProviderSetupSendHelpEmailRequestDto" }, "type": "object" }, "OAS.WebApi.DTO.DataMaintenance.DataProvider.DataProviderSetupDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "dataProviderSetupTypeId": { "type": "integer", "format": "int32" }, "dataProviderSetupName": { "type": "string" }, "dataProviderSetupStatus": { "type": "integer", "format": "int32" }, "downloadSourceId": { "type": "integer", "format": "int32" }, "fieldValuesJSON": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "acctCodeCount": { "type": "integer", "format": "int32" }, "acctCodes": { "items": { "type": "string" }, "type": "array" }, "repAccessIdForCombinedVerification": { "description": "When set by a rep completing account validation for a setup type that defines a rep-code field (IsRepCode in FieldsJSON),\r\nrep access can be activated in the same step as feed account validation (single verification UX).", "type": "integer", "format": "int32" } }, "xml": { "name": "DataProviderSetupDto" }, "type": "object" }, "OAS.WebApi.DTO.DataMaintenance.DataProvider.DataProviderSetupRepAccessDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "dataProviderSetupId": { "type": "integer", "format": "int32" }, "repId": { "type": "integer", "format": "int32" }, "repCode": { "type": "string" }, "isDefault": { "type": "boolean" }, "isShared": { "type": "boolean" }, "userId": { "type": "integer", "format": "int32" }, "repAccessStatus": { "type": "integer", "format": "int32" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedBy": { "type": "string" }, "repName": { "type": "string" }, "repCodeIsShared": { "type": "boolean" }, "isOwner": { "type": "boolean" }, "ownerEmail": { "type": "string" }, "acctCodeCount": { "type": "integer", "format": "int32" } }, "xml": { "name": "DataProviderSetupRepAccessDto" }, "type": "object" }, "OAS.WebApi.DTO.DataMaintenance.DataProvider.DataProviderSetupOwnerRepCodeAddDto": { "properties": { "repCode": { "type": "string" }, "repId": { "type": "integer", "format": "int32" } }, "xml": { "name": "DataProviderSetupOwnerRepCodeAddDto" }, "type": "object" }, "OAS.WebApi.DTO.DataMaintenance.DataProvider.DataProviderSetupTypeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "dataProviderName": { "type": "string" }, "formatName": { "type": "string" }, "formatSubtypeName": { "type": "string" }, "isActive": { "type": "boolean" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "downloadFormatId": { "type": "integer", "format": "int32" }, "downloadFormatSubTypeId": { "type": "integer", "format": "int32" }, "instructionsHTML": { "type": "string" }, "finishedHTML": { "type": "string" }, "fieldsJSON": { "type": "string" }, "downloadSourcePropertiesJSON": { "type": "string" }, "statusOrderJSON": { "type": "string" }, "privilegeCode": { "type": "string" }, "isSingleRep": { "type": "boolean" }, "description": { "type": "string" } }, "xml": { "name": "DataProviderSetupTypeDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.EmailMessageSettingDto": { "properties": { "clients": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleClient" }, "xml": { "name": "SimpleClient", "wrapped": true }, "type": "array" }, "subject": { "type": "string" }, "body": { "type": "string" }, "isHtml": { "type": "boolean" } }, "xml": { "name": "EmailMessageSettingDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.FileImportInstanceDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "uiguid": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "name": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "fileCount": { "type": "integer", "format": "int32" } }, "xml": { "name": "FileImportInstanceDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.BlobViewStatusDto": { "properties": { "isViewable": { "type": "boolean" }, "blobTextChecksum": { "type": "string", "format": "byte" }, "isViewableAdvisor": { "type": "boolean" }, "isViewableRep": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "id": { "type": "integer", "format": "int32" }, "openWith": { "type": "string" }, "fileName": { "type": "string" }, "blobDesc": { "type": "string" }, "blobText": { "type": "string" }, "category": { "type": "string" }, "isZip": { "type": "boolean" } }, "xml": { "name": "BlobViewStatusDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.FileImportRequestDto": { "required": [ "blobDescription", "blobText", "fileExtension", "fileType" ], "properties": { "fileNameConvention": { "type": "string" }, "method": { "type": "string", "enum": [ "Only Import Existing Files", "Import All Overwriting Existing", "Import All Skip Exising" ] }, "sendEmail": { "type": "boolean" }, "ignoreDash": { "type": "boolean" }, "ignoreLeadingZero": { "type": "boolean" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "blobDescription": { "type": "string", "maxLength": 200, "minLength": 0 }, "blobText": { "type": "string" }, "fileExtension": { "type": "string" }, "fileType": { "type": "string" }, "postLevel": { "type": "string", "enum": [ "Client", "Registration", "Account" ] }, "createdDate": { "type": "string", "format": "date-time" }, "totalNumberOfFile": { "type": "integer", "format": "int32" }, "instanceName": { "type": "string" }, "fileImportInstanceId": { "type": "integer", "format": "int32" } }, "xml": { "name": "FileImportRequestDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.FileImportSettingDto": { "required": [ "blobDescription", "blobText", "fileExtension", "fileType" ], "properties": { "sessionId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "fileNameConvention": { "type": "string" }, "method": { "type": "string", "enum": [ "Only Import Existing Files", "Import All Overwriting Existing", "Import All Skip Exising" ] }, "sendEmail": { "type": "boolean" }, "ignoreDash": { "type": "boolean" }, "ignoreLeadingZero": { "type": "boolean" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "blobDescription": { "type": "string", "maxLength": 200, "minLength": 0 }, "blobText": { "type": "string" }, "fileExtension": { "type": "string" }, "fileType": { "type": "string" }, "postLevel": { "type": "string", "enum": [ "Client", "Registration", "Account" ] }, "createdDate": { "type": "string", "format": "date-time" }, "totalNumberOfFile": { "type": "integer", "format": "int32" }, "instanceName": { "type": "string" }, "fileImportInstanceId": { "type": "integer", "format": "int32" } }, "xml": { "name": "FileImportSettingDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.FileImportSettingUploadDto": { "required": [ "file", "blobDescription", "blobText", "fileExtension", "fileType" ], "properties": { "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" }, "sessionId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "fileNameConvention": { "type": "string" }, "method": { "type": "string", "enum": [ "Only Import Existing Files", "Import All Overwriting Existing", "Import All Skip Exising" ] }, "sendEmail": { "type": "boolean" }, "ignoreDash": { "type": "boolean" }, "ignoreLeadingZero": { "type": "boolean" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "blobDescription": { "type": "string", "maxLength": 200, "minLength": 0 }, "blobText": { "type": "string" }, "fileExtension": { "type": "string" }, "fileType": { "type": "string" }, "postLevel": { "type": "string", "enum": [ "Client", "Registration", "Account" ] }, "createdDate": { "type": "string", "format": "date-time" }, "totalNumberOfFile": { "type": "integer", "format": "int32" }, "instanceName": { "type": "string" }, "fileImportInstanceId": { "type": "integer", "format": "int32" } }, "xml": { "name": "FileImportSettingUploadDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.FileImportUploadDto": { "required": [ "file" ], "properties": { "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" } }, "xml": { "name": "FileImportUploadDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.FileImportDownloadLogsRequestDto": { "properties": { "files": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.FileImportDto" }, "xml": { "name": "FileImportDto", "wrapped": true }, "type": "array" }, "settings": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.FileImportSettingDto" } }, "xml": { "name": "FileImportDownloadLogsRequestDto" }, "type": "object" }, "OAS.WebApi.DTO.Fuse.IntegrationDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "webhookGuid": { "type": "string" }, "partnerAppId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "active": { "type": "boolean" }, "label": { "type": "string" }, "custom": { "type": "boolean" }, "partnerUserName": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "IntegrationDto" }, "type": "object" }, "OAS.WebApi.DTO.Fuse.RegisteredAppsDto": { "properties": { "partnerAppID": { "type": "integer", "format": "int32" }, "partnerName": { "type": "string" }, "productName": { "type": "string" }, "productDescription": { "type": "string" }, "enabled": { "type": "boolean" }, "useIPRestrictions": { "type": "boolean" }, "useCustodianRestrictions": { "type": "boolean" }, "contactName": { "type": "string" }, "contactPhone": { "type": "string" }, "contactEmail": { "type": "string" }, "supportName": { "type": "string" }, "supportPhone": { "type": "string" }, "supportEmail": { "type": "string" }, "homePageURL": { "type": "string" }, "termsOfService": { "type": "string" }, "productShortDescription": { "type": "string" } }, "xml": { "name": "RegisteredAppsDto" }, "type": "object" }, "OAS.WebApi.DTO.Fuse.CategoryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string" } }, "xml": { "name": "CategoryDto" }, "type": "object" }, "OAS.WebApi.DTO.Fuse.WebhookUrlRouteDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "environment": { "type": "string" }, "partnerAppId": { "type": "integer", "format": "int32" }, "urlFormat": { "type": "string" } }, "xml": { "name": "WebhookUrlRouteDto" }, "type": "object" }, "OAS.WebApi.DTO.Fuse.SlackSlashDto": { "properties": { "token": { "type": "string" }, "team_id": { "type": "string" }, "team_domain": { "type": "string" }, "channel_id": { "type": "string" }, "channel_name": { "type": "string" }, "user_id": { "type": "string" }, "user_name": { "type": "string" }, "command": { "type": "string" }, "text": { "type": "string" }, "response_url": { "type": "string" } }, "xml": { "name": "SlackSlashDto" }, "type": "object" }, "OAS.WebApi.DTO.Fuse.SlackOutgoingWebhookDto": { "properties": { "token": { "type": "string" }, "team_id": { "type": "string" }, "team_domain": { "type": "string" }, "channel_id": { "type": "string" }, "channel_name": { "type": "string" }, "timestamp": { "type": "string" }, "user_id": { "type": "string" }, "user_name": { "type": "string" }, "text": { "type": "string" }, "trigger_word": { "type": "string" } }, "xml": { "name": "SlackOutgoingWebhookDto" }, "type": "object" }, "OAS.WebApi.DTO.Fuse.NotificationDto": { "description": "A notification that is pushed to users.\r\n\r\nCan be viewed (Read Only) in a slick grid.", "properties": { "id": { "type": "integer", "format": "int32" }, "firmId": { "type": "integer", "format": "int32" }, "partnerUserName": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "subject": { "type": "string" }, "body": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string", "enum": [ "Unread", "Read", "Deleted" ] }, "partnerAppName": { "type": "string" }, "categoryName": { "type": "string" }, "integrationId": { "type": "integer", "format": "int32" }, "actionName": { "type": "string", "enum": [ "Undefined", "Download", "Link", "Share", "DownloadShare", "LinkToRedtail" ] }, "partnerAppId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "commandBody": { "type": "string" }, "clientId": { "type": "integer", "format": "int32" } }, "xml": { "name": "NotificationDto" }, "type": "object" }, "OAT.CloudStorage.ShareFile.Models.WebhookCallbackBody": { "properties": { "webhookSubscriptionId": { "type": "string" }, "accountInfo": { "$ref": "#/definitions/OAT.CloudStorage.ShareFile.Models.WebhookAccountInfo" }, "event": { "$ref": "#/definitions/OAT.CloudStorage.ShareFile.Models.WebHookCallbackEvent" } }, "xml": { "name": "WebhookCallbackBody" }, "type": "object" }, "OAT.CloudStorage.ShareFile.Models.WebhookAccountInfo": { "properties": { "accountId": { "type": "string" }, "subdomain": { "type": "string" }, "appControlPlane": { "type": "string" }, "apiControlPlane": { "type": "string" } }, "xml": { "name": "WebhookAccountInfo" }, "type": "object" }, "OAT.CloudStorage.ShareFile.Models.WebHookCallbackEvent": { "properties": { "resourceType": { "type": "string" }, "timestamp": { "type": "string" }, "resource": { "$ref": "#/definitions/OAT.CloudStorage.ShareFile.Models.WebhookCallbackResource" }, "operationName": { "type": "string" } }, "xml": { "name": "WebHookCallbackEvent" }, "type": "object" }, "OAT.CloudStorage.ShareFile.Models.WebhookCallbackResource": { "properties": { "id": { "type": "string" }, "parent": { "$ref": "#/definitions/OAT.CloudStorage.ShareFile.Models.WebhookCallbackResource" } }, "xml": { "name": "WebhookCallbackResource" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.CorporateActionVerboseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "portfolio": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CorporateActionDto" }, "processes": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.CorpAction.CorporateActionProcessingDto" }, "xml": { "name": "CorporateActionProcessingDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "CorporateActionVerboseDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.CorporateActionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "statusIcon": { "type": "string", "enum": [ "Pending", "Complete", "Cancelled" ] }, "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "entryDate": { "type": "string", "format": "date-time" }, "remarks": { "type": "string" }, "notifyType": { "type": "string" }, "notifyTypeUpdate": { "type": "string" }, "recordStatus": { "type": "string" }, "numOptions": { "type": "integer", "format": "int32" }, "securityType": { "type": "string" }, "effectiveDate": { "type": "string", "format": "date-time" }, "cusip": { "type": "string" }, "oldCusip": { "type": "string" }, "ticker": { "type": "string" }, "name": { "type": "string" }, "oldName": { "type": "string" }, "expireDate": { "type": "string", "format": "date-time" }, "cash": { "type": "number", "format": "double" }, "cashCode": { "type": "string" }, "stateCode": { "type": "string" }, "tenderAgent": { "type": "string" }, "infoAgent": { "type": "string" }, "maturityDate": { "type": "string", "format": "date-time" }, "rate1": { "type": "number", "format": "double" }, "rateCode": { "type": "string" }, "rate2": { "type": "number", "format": "double" }, "voluntaryMandatory": { "type": "string" }, "dtc": { "type": "string" }, "prorationRate": { "type": "string" }, "prorationDate": { "type": "string", "format": "date-time" }, "note": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "textNo": { "type": "integer", "format": "int32" }, "dealNo": { "type": "integer", "format": "int32" }, "costBasisFactor": { "type": "number", "format": "double" }, "textNoUpdate": { "type": "integer", "format": "int32" }, "fairMarketValue": { "type": "number", "format": "double" }, "fairMarketValueOut": { "type": "number", "format": "double" }, "moreInfoUrl": { "type": "string" } }, "xml": { "name": "CorporateActionDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.DividendDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "dividendTypeId": { "type": "integer", "format": "int32" }, "dividendType": { "type": "string" }, "payDate": { "type": "string", "format": "date-time" }, "exDate": { "type": "string", "format": "date-time" }, "oldSymbol": { "type": "string" }, "newSymbol": { "type": "string" }, "oldName": { "type": "string" }, "newName": { "type": "string" }, "grossDivRate": { "type": "number", "format": "double" }, "shortTermRate": { "type": "number", "format": "double" }, "longTermRate": { "type": "number", "format": "double" }, "splitFactor": { "type": "number", "format": "double" }, "shareFactor": { "type": "number", "format": "double" }, "costFactor": { "type": "number", "format": "double" }, "cashInLieuPrice": { "type": "number", "format": "double" }, "cash": { "type": "number", "format": "double" }, "note": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "netDivRate": { "type": "number", "format": "double" }, "divFeeRate": { "type": "number", "format": "double" }, "specialDivRate": { "type": "number", "format": "double" }, "approvalStatus": { "type": "string" }, "capitalRate": { "type": "number", "format": "double" }, "qualifiedRateDollar": { "type": "number", "format": "double" }, "qualifiedRatePercent": { "type": "number", "format": "double" }, "declarationDate": { "type": "string", "format": "date-time" }, "declarationType": { "type": "integer", "format": "int32" }, "currencyCode": { "type": "string" }, "taxStatusCodeId": { "type": "integer", "format": "int32" }, "announcementType": { "type": "integer", "format": "int32" }, "frequency": { "type": "string" }, "recordDate": { "type": "string", "format": "date-time" }, "divOnlyRate": { "type": "number", "format": "double" }, "fileRecordID": { "type": "string" }, "indicatedAnnualDividend": { "type": "number", "format": "double" } }, "xml": { "name": "DividendDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.DownloadSymbolSimpleDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "symbol": { "type": "string" }, "isNASDAQPlatformSymbol": { "type": "boolean" } }, "xml": { "name": "DownloadSymbolSimpleDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.DownloadSymbolFullDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "symbol": { "type": "string" }, "isNASDAQPlatformSymbol": { "type": "boolean" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" } }, "xml": { "name": "DownloadSymbolFullDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.FundFamilyDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "isActive": { "type": "boolean" }, "isAnnuity": { "type": "boolean" }, "unitScale": { "type": "integer", "format": "int32" }, "priceScale": { "type": "integer", "format": "int32" }, "isShareClassSensitive": { "type": "boolean" }, "isAcctNumUnique": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "isCreateDistribution": { "type": "boolean" }, "sungardBrokerId": { "type": "integer", "format": "int32" }, "custComplexes": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CustComplexDto" }, "xml": { "name": "CustComplexDto", "wrapped": true }, "type": "array" }, "custodianTradeFileFormats": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CustodianTradeFileFormatDto" }, "xml": { "name": "CustodianTradeFileFormatDto", "wrapped": true }, "type": "array" }, "userDefinedFields": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.FundFamilyEntityOptionDto" }, "xml": { "name": "FundFamilyEntityOptionDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "FundFamilyDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.CustComplexDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "custodianName": { "type": "string" }, "isDefault": { "type": "boolean" }, "fundFamilyId": { "type": "integer", "format": "int32" }, "fundFamilyName": { "type": "string" }, "collectFormatId": { "type": "integer", "format": "int32" }, "collectFormatName": { "type": "string" }, "collectMethodName": { "type": "string" }, "collectMethodId": { "type": "integer", "format": "int32" }, "newAcctFormatId": { "type": "integer", "format": "int32" }, "chkReqFormatId": { "type": "integer", "format": "int32" }, "swdFormatId": { "type": "integer", "format": "int32" } }, "xml": { "name": "CustComplexDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.CustodianTradeFileFormatDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "fundFamilyId": { "type": "integer", "format": "int32" }, "registrationTypeId": { "type": "integer", "format": "int32" }, "platformId": { "type": "integer", "format": "int32" }, "trExFmtId": { "type": "integer", "format": "int32" }, "tPlusDays": { "type": "integer", "format": "int32" }, "isNAAllowed": { "type": "boolean" }, "trExFmtEndResultId": { "type": "integer", "format": "int32" } }, "xml": { "name": "CustodianTradeFileFormatDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.FundFamilyEntityOptionDto": { "properties": { "entityId": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "userDefineDataId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "name": { "type": "string" }, "code": { "type": "string" }, "securityCode": { "type": "string" }, "definition": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.FundFamilyDefinitionDto" } }, "xml": { "name": "FundFamilyEntityOptionDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.FundFamilyDefinitionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "type": "string", "enum": [ "MultiLineEditor", "DropDownEditor", "DropDownList", "CheckBox", "Currency", "Date", "DateTime", "Integer", "String", "Double", "Time", "Long", "CustomObject", "Email" ] }, "description": { "type": "string" }, "mask": { "type": "string" }, "defaultValue": { "type": "string" }, "sequence": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "code": { "type": "string" }, "category": { "type": "string" }, "customObject": { "type": "string" }, "controlProperties": { "type": "string" }, "securityCode": { "type": "string" }, "isTimeSensitive": { "type": "boolean" }, "options": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.FundFamilyOptionDto" }, "xml": { "name": "FundFamilyOptionDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "FundFamilyDefinitionDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.FundFamilyOptionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "listValue": { "type": "string" }, "isDefault": { "type": "boolean" }, "sequence": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "FundFamilyOptionDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.PriceGlobalAuditReviewDto": { "properties": { "productId": { "type": "integer", "format": "int32" }, "custodianCommonId": { "type": "integer", "format": "int32" }, "custodianCommonName": { "type": "string" }, "priceDate": { "type": "string", "format": "date-time" }, "navPrice": { "type": "number", "format": "double" }, "firstPriceSymbol": { "type": "string" }, "currentPriceSymbol": { "type": "string" }, "priceSwingNextDay": { "type": "boolean" }, "priceSwingPrevDay": { "type": "integer", "format": "int32" }, "priceVariance": { "type": "boolean" }, "priceStale": { "type": "boolean" }, "dividendType": { "type": "integer", "format": "int32" }, "totalDividendRate": { "type": "number", "format": "double" }, "inUse": { "type": "boolean" }, "splitFactor": { "type": "number", "format": "double" }, "zScore": { "type": "number", "format": "double" } }, "xml": { "name": "PriceGlobalAuditReviewDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.PriceGlobalAuditReviewStatisticsDto": { "properties": { "productId": { "type": "integer", "format": "int32" }, "custodianCountRange": { "type": "integer", "format": "int32" }, "custodianCountAllTime": { "type": "integer", "format": "int32" }, "priceHigh": { "type": "number", "format": "double" }, "priceLow": { "type": "number", "format": "double" }, "prevTwoYearHigh": { "type": "number", "format": "double" }, "prevTwoYearLow": { "type": "number", "format": "double" }, "priceGapStart": { "type": "string", "format": "date-time" }, "priceGapEnd": { "type": "string", "format": "date-time" }, "potentiallyStalePrices": { "type": "boolean" }, "priceBeforeInception": { "type": "boolean" }, "symbolReview": { "type": "boolean" }, "sameSymbolLargePriceDiff": { "type": "boolean" }, "inUse": { "type": "boolean" }, "laggingPriceSources": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PriceGlobalAuditReviewLaggingPriceSourceDto" }, "xml": { "name": "PriceGlobalAuditReviewLaggingPriceSourceDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "PriceGlobalAuditReviewStatisticsDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.PriceGlobalAuditReviewLaggingPriceSourceDto": { "properties": { "custodianCommonId": { "type": "integer", "format": "int32" }, "custodianCommon": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "PriceGlobalAuditReviewLaggingPriceSourceDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.PriceFactorDto": { "properties": { "productId": { "type": "integer", "format": "int32" }, "factorDate": { "type": "string", "format": "date-time" }, "factor": { "type": "number", "format": "double" } }, "xml": { "name": "PriceFactorDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.PriceFactorKeyDto": { "properties": { "productId": { "type": "integer", "format": "int32" }, "factorDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "PriceFactorKeyDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.PriceGlobalDto": { "properties": { "productId": { "type": "integer", "format": "int32" }, "priceDate": { "type": "string", "format": "date-time" }, "navPrice": { "type": "number", "format": "double" }, "custodianCommonName": { "type": "string" }, "custodianCommonId": { "type": "integer", "format": "int32" } }, "xml": { "name": "PriceGlobalDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.PriceGlobalKeyDto": { "properties": { "productId": { "type": "integer", "format": "int32" }, "custodianCommonId": { "type": "integer", "format": "int32" }, "priceDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "PriceGlobalKeyDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.PriceAuditDto": { "properties": { "productId": { "type": "integer", "format": "int32" }, "priceDate": { "type": "string", "format": "date-time" }, "navPrice": { "type": "number", "format": "double" }, "custodianCommonName": { "type": "string" }, "custodianCommonId": { "type": "integer", "format": "int32" }, "timestamp": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string" }, "modifiedType": { "type": "string" }, "reason": { "type": "string" }, "notes": { "type": "string" } }, "xml": { "name": "PriceAuditDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ProductCombineDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "createdByDisplay": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "completedDate": { "type": "string", "format": "date-time" }, "combinedObject": { "type": "object" }, "isCompleted": { "readOnly": true, "type": "boolean" } }, "xml": { "name": "ProductCombineDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ProductGlobalSearchDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "ticker": { "type": "string" }, "currentPrice": { "type": "number", "format": "double" }, "defaultPrice": { "type": "number", "format": "double" }, "currentPriceDate": { "type": "string", "format": "date-time" }, "productType": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "isAssignedToModelItem": { "type": "boolean" } }, "xml": { "name": "ProductGlobalSearchDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.GlobalProductDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "ticker": { "type": "string" }, "cusip": { "type": "string" }, "currentOrionPrice": { "type": "number", "format": "double" }, "currentOrionPriceDate": { "type": "string", "format": "date-time" }, "productType": { "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, "productSubTypeName": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "productSubTypeId": { "type": "integer", "format": "int32" }, "shareClassId": { "type": "integer", "format": "int32" }, "shareClassName": { "type": "string" }, "shareClassDescription": { "type": "string" }, "fundNumber": { "type": "string" }, "globalFundFamilyId": { "type": "integer", "format": "int32" }, "globalFundFamilyName": { "type": "string" }, "isActive": { "type": "boolean" }, "is144A": { "type": "boolean" }, "isUsePriceTime": { "type": "boolean" }, "defaultPrice": { "type": "number", "format": "double" }, "expirationDate": { "type": "string", "format": "date-time" }, "priceStatus": { "type": "string", "enum": [ "Normal", "Default", "Manual", "ReceivedMoreThan1Day", "InfrequentPricing", "SecurityIsWorthless", "IndeterminableValue", "NotActiveProduct" ] }, "productParentId": { "type": "integer", "format": "int32" }, "productParentName": { "type": "string" }, "repurchaseBlockDays": { "type": "integer", "format": "int32" }, "apcCode": { "type": "string" }, "shortTermTradeFeeDays": { "type": "integer", "format": "int32" }, "shortTermTradeFeePercent": { "type": "number", "format": "double" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "micropalCode": { "type": "string" }, "estimatedDividendFrequency": { "type": "number", "format": "double" }, "subHoldingId": { "type": "integer", "format": "int32" }, "strikePrice": { "type": "number", "format": "double" }, "optionLotSize": { "type": "integer", "format": "int32" }, "excludeFromCB": { "type": "boolean" }, "riskScore": { "type": "integer", "format": "int32" }, "isFederallyTaxable": { "type": "boolean" }, "isStateTaxable": { "type": "boolean" }, "includeByDefault": { "type": "boolean" }, "allowIncomeOverride": { "type": "boolean" }, "isDividendSuspended": { "type": "boolean" }, "isin": { "type": "string" }, "inceptionDate": { "type": "string", "format": "date-time" }, "shortTermDiscountObligation": { "type": "boolean" }, "isAdvisorProduct": { "type": "boolean" }, "advisorPrefix": { "type": "string" } }, "xml": { "name": "GlobalProductDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.GlobalProductCoreDto": { "properties": { "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "ticker": { "type": "string" }, "cusip": { "type": "string" }, "isin": { "type": "string" }, "productType": { "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, "productSubTypeName": { "type": "string" }, "productSubTypeId": { "type": "integer", "format": "int32" }, "defaultPrice": { "type": "number", "format": "double" }, "priceStatus": { "type": "string", "enum": [ "Normal", "Default", "Manual", "ReceivedMoreThan1Day", "InfrequentPricing", "SecurityIsWorthless", "IndeterminableValue", "NotActiveProduct" ] }, "inceptionDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "GlobalProductCoreDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.GlobalProductSymbolExistsResult": { "properties": { "symbol": { "description": "The symbol that was checked.", "type": "string" }, "exists": { "description": "Whether the symbol already exists as a product Ticker or Download Symbol.", "type": "boolean" } }, "xml": { "name": "GlobalProductSymbolExistsResult" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SubHoldingWithAssetClassDto": { "properties": { "asOfDate": { "type": "string", "format": "date-time" }, "subHoldingAllocations": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SubHoldingAllocWithAssetClassDto" }, "xml": { "name": "SubHoldingAllocWithAssetClassDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "SubHoldingWithAssetClassDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SubHoldingAllocWithAssetClassDto": { "properties": { "productId": { "type": "integer", "format": "int32" }, "allocationPercent": { "type": "number", "format": "double" }, "ticker": { "type": "string" }, "productName": { "type": "string" }, "assetClass": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetClassDto" } }, "xml": { "name": "SubHoldingAllocWithAssetClassDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AssetClassDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string" } }, "xml": { "name": "AssetClassDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.GlobalProductSearchSimpleDto": { "properties": { "searchString": { "type": "string" }, "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "ticker": { "type": "string" }, "cusip": { "type": "string" }, "isin": { "type": "string" }, "productType": { "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, "productSubTypeName": { "type": "string" }, "productSubTypeId": { "type": "integer", "format": "int32" }, "defaultPrice": { "type": "number", "format": "double" }, "priceStatus": { "type": "string", "enum": [ "Normal", "Default", "Manual", "ReceivedMoreThan1Day", "InfrequentPricing", "SecurityIsWorthless", "IndeterminableValue", "NotActiveProduct" ] }, "inceptionDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "GlobalProductSearchSimpleDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.GlobalProductVerboseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "portfolio": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.GlobalProductPortfolioDto" }, "downloadSymbols": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DownloadSymbolFullDto" }, "xml": { "name": "DownloadSymbolFullDto", "wrapped": true }, "type": "array" }, "fundFamilies": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.FundFamilyDto" }, "xml": { "name": "FundFamilyDto", "wrapped": true }, "type": "array" }, "corporateActions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CorporateActionDto" }, "xml": { "name": "CorporateActionDto", "wrapped": true }, "type": "array" }, "bondRates": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BondRateDto" }, "xml": { "name": "BondRateDto", "wrapped": true }, "type": "array" }, "preferredRates": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PreferredRateDto" }, "xml": { "name": "PreferredRateDto", "wrapped": true }, "type": "array" }, "alClients": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "subHoldings": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SubHoldingDto" }, "xml": { "name": "SubHoldingDto", "wrapped": true }, "type": "array" }, "gics": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductGICSMappingDto" }, "localProduct": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.LocalProductVerboseDto" } }, "xml": { "name": "GlobalProductVerboseDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.GlobalProductPortfolioDto": { "properties": { "fundFamilyId": { "type": "integer", "format": "int32" }, "ticker": { "type": "string" }, "cusip": { "type": "string" }, "isActive": { "type": "boolean" }, "productName": { "type": "string" }, "shareClassId": { "type": "integer", "format": "int32" }, "apcCode": { "type": "string" }, "defaultPrice": { "type": "number", "format": "double" }, "convSchSells": { "type": "boolean" }, "productType": { "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, "fundNumber": { "type": "string" }, "isUsePriceTime": { "type": "boolean" }, "shortTermTradeFeeDays": { "type": "integer", "format": "int32" }, "shortTermTradeFeePercent": { "type": "number", "format": "double" }, "repurchaseBlockDays": { "type": "integer", "format": "int32" }, "productSubTypeId": { "type": "integer", "format": "int32" }, "is144A": { "type": "boolean" }, "productParentId": { "type": "integer", "format": "int32" }, "priceStatus": { "type": "string", "enum": [ "Normal", "Default", "Manual", "ReceivedMoreThan1Day", "InfrequentPricing", "SecurityIsWorthless", "IndeterminableValue", "NotActiveProduct" ] }, "subHoldingId": { "type": "integer", "format": "int32" }, "strikePrice": { "type": "number", "format": "double" }, "optionLotSize": { "type": "integer", "format": "int32" }, "expirationDate": { "type": "string", "format": "date-time" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "isDerivative": { "type": "boolean" }, "includeByDefault": { "type": "boolean" }, "allowIncomeOverride": { "type": "boolean" }, "isDividendSuspended": { "type": "boolean" }, "excludeFromCB": { "type": "boolean" }, "riskScore": { "type": "integer", "format": "int32" }, "isFederallyTaxable": { "type": "boolean" }, "isStateTaxable": { "type": "boolean" }, "advAssetCategoryId": { "type": "integer", "format": "int32" }, "isin": { "type": "string" }, "isMLP": { "type": "boolean" }, "isIntervalFund": { "type": "boolean" }, "inceptionDate": { "type": "string", "format": "date-time" }, "shortTermDiscountObligation": { "type": "boolean" } }, "xml": { "name": "GlobalProductPortfolioDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.BondRateDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "datedDate": { "type": "string", "format": "date-time" }, "couponRate": { "type": "number", "format": "double" }, "maturityDate": { "type": "string", "format": "date-time" }, "alternateMaturityDate": { "type": "string", "format": "date-time" }, "parValue": { "type": "number", "format": "double" }, "paymentFrequency": { "type": "string", "enum": [ "AtMaturity", "Monthly", "BiMonthly", "Quarterly", "Triannually", "Semiannually", "Annually", "Biennially" ] }, "isCompounding": { "type": "boolean" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "issueDate": { "type": "string", "format": "date-time" }, "interestAccrualDate": { "type": "string", "format": "date-time" }, "isFederallyTaxable": { "type": "boolean" }, "isStateTaxable": { "type": "boolean" }, "stateId": { "type": "integer", "format": "int32" }, "dayCount": { "type": "string", "enum": [ "ThirtyThreeSixty", "ActualActual", "ActualThreeSixtyFive", "ActualThreeSixty", "ActualActualIsda" ] }, "isVariableRate": { "type": "boolean" }, "isInDefault": { "type": "boolean" }, "callDate": { "type": "string", "format": "date-time" }, "callPrice": { "type": "number", "format": "double" }, "initialCouponDate": { "type": "string", "format": "date-time" }, "isOID": { "type": "boolean" }, "isAMT": { "type": "boolean" }, "inDefaultDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "BondRateDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.PreferredRateDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "dividendRate": { "type": "number", "format": "double" }, "frequency": { "type": "integer", "format": "int32" }, "parValue": { "type": "number", "format": "double" }, "isFixedRate": { "type": "boolean" }, "isConvertible": { "type": "boolean" }, "isVotingRights": { "type": "boolean" }, "isCallable": { "type": "boolean" }, "isCumulative": { "type": "boolean" }, "isParticipating": { "type": "boolean" }, "isInDefault": { "type": "boolean" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "PreferredRateDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SubHoldingDto": { "properties": { "asOfDate": { "type": "string", "format": "date-time" }, "subHoldingAllocations": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SubHoldingAllocDto" }, "xml": { "name": "SubHoldingAllocDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "SubHoldingDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ProductGICSMappingDto": { "properties": { "sector": { "type": "string" }, "industryGroup": { "type": "string" }, "industry": { "type": "string" }, "subIndustry": { "type": "string" } }, "xml": { "name": "ProductGICSMappingDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.LocalProductVerboseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "productType": { "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, "portfolio": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.LocalProductPortfolioDto" }, "productGroup": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductGroupDto" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" }, "userDefinedFields": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" }, "userDefinedTimeFields": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionTimeDto" }, "xml": { "name": "EntityOptionTimeDto", "wrapped": true }, "type": "array" }, "alternativeExpectedReturns": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.ExpectedReturnDto" }, "xml": { "name": "ExpectedReturnDto", "wrapped": true }, "type": "array" }, "assumedRates": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssumedRateDto" }, "xml": { "name": "AssumedRateDto", "wrapped": true }, "type": "array" }, "alternative": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AlternativeDto" }, "billing": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillProductDto" } }, "xml": { "name": "LocalProductVerboseDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SubHoldingAllocDto": { "properties": { "productId": { "type": "integer", "format": "int32" }, "allocationPercent": { "type": "number", "format": "double" }, "ticker": { "type": "string" }, "productName": { "type": "string" } }, "xml": { "name": "SubHoldingAllocDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.LocalProductPortfolioDto": { "properties": { "assetClassId": { "type": "integer", "format": "int32" }, "riskCategoryId": { "type": "integer", "format": "int32" }, "isDisabled": { "type": "boolean" }, "productStatus": { "type": "string", "enum": [ "Open", "SoftClose", "HardClose", "SellOnly", "PurchaseOnly", "Exclude" ] }, "snPRatingId": { "type": "integer", "format": "int32" }, "moodyRatingId": { "type": "integer", "format": "int32" }, "isAutoAssign": { "type": "boolean" }, "isUsed": { "type": "string", "enum": [ "UsedInCurrentDB", "UsedInOtherDB", "NotUsed" ] }, "isCustodialCash": { "type": "boolean" }, "isManaged": { "type": "boolean" }, "is13fReportable": { "type": "boolean" }, "isAdvReportable": { "type": "boolean" }, "allowIntraDayPerformance": { "type": "boolean" }, "hasFees": { "type": "boolean" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "useGlobalSetting": { "type": "boolean" }, "isFederallyTaxable": { "type": "boolean" }, "isStateTaxable": { "type": "boolean" }, "useLocalPricesOnly": { "type": "boolean" }, "color": { "type": "string" }, "annualIncomeRate": { "type": "number", "format": "double" }, "paymentFrequency": { "type": "string", "enum": [ "AtMaturity", "Monthly", "BiMonthly", "Quarterly", "Triannually", "Semiannually", "Annually", "Biennially" ] }, "advAssetCategoryId": { "type": "integer", "format": "int32" }, "useDailyInterestAccrual": { "type": "boolean" }, "excludeBondAccrualFromValuations": { "type": "boolean" }, "productNameOverride": { "type": "string" }, "isRiskCategoryExcluded": { "type": "boolean" }, "paymentCycleDateType": { "type": "string", "enum": [ "Normal", "NextBusinessDay", "PreviousBusinessDay" ] } }, "xml": { "name": "LocalProductPortfolioDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ProductGroupDto": { "properties": { "groupCode": { "type": "string" }, "isActive": { "type": "boolean" }, "items": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductGroupItemDto" }, "xml": { "name": "ProductGroupItemDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProductGroupDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AssumedRateDto": { "properties": { "productId": { "type": "integer", "format": "int32" }, "rateType": { "type": "string", "enum": [ "AssumedDividend", "AssumedTurnover" ] }, "asOfDate": { "type": "string", "format": "date-time" }, "value": { "type": "number", "format": "double" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "AssumedRateDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AlternativeDto": { "properties": { "managerId": { "type": "integer", "format": "int32" }, "isDirectInvestment": { "type": "boolean" }, "vintageYear": { "type": "integer", "format": "int32" }, "comment": { "type": "string" }, "isK1": { "type": "boolean" }, "k1DeliveryDate": { "type": "string", "format": "date-time" }, "k1EstimatedDeliveryDate": { "type": "string", "format": "date-time" }, "isOrionVisionPending": { "type": "boolean" }, "isOrionVision": { "type": "boolean" }, "manager": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ManagerDto" } }, "xml": { "name": "AlternativeDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ProductGroupItemDto": { "properties": { "productId": { "type": "integer", "format": "int32" }, "ticker": { "type": "string" }, "productName": { "type": "string" } }, "xml": { "name": "ProductGroupItemDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ManagerDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "ManagerDto" }, "type": "object" }, "OAS.WebApi.DTO.Authorization.ServiceTeamMemberDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "serviceTeamId": { "type": "integer", "format": "int32" }, "serviceTeam": { "type": "string" }, "userId": { "type": "integer", "format": "int32" }, "userName": { "type": "string" }, "isAnalyst": { "type": "boolean" }, "isAccountManager": { "type": "boolean" }, "userManagerId": { "type": "integer", "format": "int32" }, "userManagerName": { "type": "string" }, "alClients": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Authorization.ALClientDto" }, "xml": { "name": "ALClientDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ServiceTeamMemberDto" }, "type": "object" }, "OAS.WebApi.DTO.Authorization.SimpleServiceTeamMemberUserManagerDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "SimpleServiceTeamMemberUserManagerDto" }, "type": "object" }, "OAS.WebApi.DTO.Authorization.ServiceTeamMemberAlClientDto": { "properties": { "serviceTeamMemberId": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "databaseName": { "type": "string" }, "userName": { "type": "string" }, "userId": { "type": "integer", "format": "int32" } }, "xml": { "name": "ServiceTeamMemberAlClientDto" }, "type": "object" }, "OAS.WebApi.DTO.Authorization.ServiceTeamDatabaseAssignRequestDto": { "properties": { "serviceTeamId": { "type": "integer", "format": "int32" }, "teamType": { "type": "string", "enum": [ "ServiceTeam", "ReconTeam", "ApplicationTeam", "AlternateApplicationTeam", "RemovedServiceTeam" ] }, "alClientIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, "xml": { "name": "ServiceTeamDatabaseAssignRequestDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.StateMunicipalBondTaxDto": { "properties": { "addressStateName": { "type": "string" }, "issueStateName": { "type": "string" }, "taxable": { "type": "boolean" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "addressStateId": { "type": "integer", "format": "int32" }, "issueStateId": { "type": "integer", "format": "int32" } }, "xml": { "name": "StateMunicipalBondTaxDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.StateMunicipalBondTaxKeyDto": { "properties": { "addressStateId": { "type": "integer", "format": "int32" }, "issueStateId": { "type": "integer", "format": "int32" } }, "xml": { "name": "StateMunicipalBondTaxKeyDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.GlobalStaticFileDto": { "properties": { "blobType": { "type": "string", "enum": [ "CustodialCostBasisForm" ] }, "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" }, "openWith": { "type": "string" }, "blobDesc": { "type": "string" } }, "xml": { "name": "GlobalStaticFileDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.UserFeedbackResponseDto": { "description": "DTO for user feedback responses.", "required": [ "code" ], "properties": { "id": { "description": "The unique identifier of the feedback response.", "type": "integer", "format": "int32" }, "alClientId": { "description": "The ALClient ID associated with the feedback.", "type": "integer", "format": "int32" }, "code": { "description": "A code identifier for the type of feedback (e.g., \"NPS\", \"FEATURE_RATING\", \"SATISFACTION\").", "type": "string", "maxLength": 50, "minLength": 0 }, "note": { "description": "Additional notes or comments from the user.", "type": "string", "maxLength": 2000, "minLength": 0 }, "ratingValue": { "description": "A numeric rating value provided by the user.", "type": "integer", "format": "int32", "maximum": 32767, "minimum": -32768 } }, "xml": { "name": "UserFeedbackResponseDto" }, "type": "object" }, "OAS.WebApi.DTO.HomepageDashboard.DataSourceDataRequestDto": { "properties": { "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "parameters": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.ParameterDto" }, "xml": { "name": "ParameterDto", "wrapped": true }, "type": "array" }, "accountInclusion": { "type": "string", "enum": [ "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationONly", "RegistrationWithValue", "ManagedOnly", "UnmanagedOnly" ] }, "enableCache": { "type": "boolean" }, "refreshCacheIfExists": { "type": "boolean" }, "accountsInclusionOverrides": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.PortfolioViewAccountManagementOverride" }, "xml": { "name": "PortfolioViewAccountManagementOverride", "wrapped": true }, "type": "array" }, "selectedEntity": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.SelectedEntity" } }, "xml": { "name": "DataSourceDataRequestDto" }, "type": "object" }, "OAS.WebApi.DTO.HomepageDashboard.ParameterDto": { "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "displayName": { "type": "string" }, "options": { "type": "string" }, "code": { "type": "string" } }, "xml": { "name": "ParameterDto" }, "type": "object" }, "OAS.WebApi.DTO.HomepageDashboard.PortfolioViewAccountManagementOverride": { "properties": { "isSelectedForQuickGroup": { "type": "boolean" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "isManaged": { "type": "boolean" }, "isIncluded": { "type": "boolean" } }, "xml": { "name": "PortfolioViewAccountManagementOverride" }, "type": "object" }, "OAS.WebApi.DTO.HomepageDashboard.SelectedEntity": { "properties": { "entityType": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" } }, "xml": { "name": "SelectedEntity" }, "type": "object" }, "OAS.WebApi.DTO.HomepageDashboard.DataSourceDto": { "required": [ "connector", "setting" ], "properties": { "id": { "type": "integer", "format": "int32" }, "text": { "type": "string" }, "description": { "type": "string" }, "privilegeId": { "type": "integer", "format": "int32" }, "connector": { "type": "string", "enum": [ "DB", "RestApi", "DirectRestApi", "Eclipse", "RB3", "AWSPOC" ] }, "type": { "type": "string", "enum": [ "External", "Internal" ] }, "setting": { "type": "object" } }, "xml": { "name": "DataSourceDto" }, "type": "object" }, "OAS.WebApi.DTO.HomepageDashboard.CardDto": { "properties": { "dashboardCardId": { "type": "integer", "format": "int32" }, "isGlobal": { "type": "boolean" }, "position": { "type": "integer", "format": "int32" }, "isVisible": { "type": "boolean" }, "hideIfRestricted": { "type": "boolean" }, "setting": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.CardSettingDto" }, "xml": { "name": "CardSettingDto", "wrapped": true }, "type": "array" }, "components": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.ComponentDto" }, "xml": { "name": "ComponentDto", "wrapped": true }, "type": "array" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string" }, "size": { "type": "integer", "format": "int32" }, "category": { "type": "string", "enum": [ "General", "Billing", "Compliance", "Data", "Reporting", "Trading", "Performance", "Query", "NewAccountCenter", "ReconcilliationStatus", "QuarterEndDashboard", "Trends", "Eclipse", "Custodian", "Integrations", "Allocation", "Activity", "TargetAllocation", "Alternatives", "GainLoss", "Income", "Planning", "CustomIndexing", "IFrame" ] }, "icon": { "type": "string" } }, "xml": { "name": "CardDto" }, "type": "object" }, "OAS.WebApi.DTO.HomepageDashboard.ComponentDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "parentComponentId": { "type": "integer", "format": "int32" }, "dataSourceId": { "type": "integer", "format": "int32" }, "title": { "type": "string" }, "type": { "type": "string", "enum": [ "Text", "Header", "Footer", "Table", "Chart", "BigNumber", "Hr", "Grid", "ComponentButtonList", "ActionSteps", "SchwabStatus", "RiskProfile", "ComponentIFrame", "Message", "Gauge", "ThreeDRiskProfile", "BeFi20", "MgpInsurancePolicy", "SimpleGroupingTable", "MgpPlanSummary", "ImageDisplay", "QueryStudioResultsGrid" ] }, "setting": { "type": "object" }, "sort": { "type": "integer", "format": "int32" }, "dataSource": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.DataSource" }, "components": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.ComponentDto" }, "xml": { "name": "ComponentDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ComponentDto" }, "type": "object" }, "OAS.WebApi.DTO.HomepageDashboard.DataSource": { "properties": { "id": { "type": "integer", "format": "int32" }, "text": { "type": "string" }, "description": { "type": "string" }, "privilegeId": { "type": "integer", "format": "int32" }, "hasAccess": { "type": "boolean" }, "connector": { "type": "string", "enum": [ "DB", "RestApi", "DirectRestApi", "Eclipse", "RB3", "AWSPOC" ] }, "type": { "type": "string", "enum": [ "External", "Internal" ] }, "configurationJson": { "type": "string" }, "parameters": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.ParameterDto" }, "xml": { "name": "ParameterDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "DataSource" }, "type": "object" }, "OAS.WebApi.DTO.HomepageDashboard.AddCardDto": { "properties": { "name": { "type": "string" }, "setting": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.CardSettingDto" }, "xml": { "name": "CardSettingDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "AddCardDto" }, "type": "object" }, "OAS.WebApi.DTO.HomepageDashboard.UserHomepageDashboardWithRoleDto": { "properties": { "parentDashboardId": { "type": "integer", "format": "int32" }, "roles": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "isShared": { "type": "boolean" }, "isVisible": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "isGlobal": { "type": "boolean" }, "isPortfolioView": { "type": "boolean" }, "userId": { "type": "integer", "format": "int32" }, "dashboardType": { "type": "string", "enum": [ "Homepage", "View", "Tool" ] }, "id": { "type": "integer", "format": "int32" }, "dashboardName": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "UserHomepageDashboardWithRoleDto" }, "type": "object" }, "OAS.WebApi.DTO.HomepageDashboard.HomepageDashboardDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "isDefault": { "type": "boolean" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "isGlobal": { "type": "boolean" }, "parentDashboardId": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "isShared": { "type": "boolean" }, "dashboardType": { "type": "string", "enum": [ "Homepage", "View", "Tool" ] }, "cards": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.CardDto" }, "xml": { "name": "CardDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "HomepageDashboardDto" }, "type": "object" }, "OAS.DataModel.Homepage.PortfolioViewSearchHistoryResult": { "properties": { "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "entityName": { "type": "string" }, "isActive": { "type": "boolean" }, "dateSearched": { "type": "string", "format": "date-time" }, "accountNumber": { "type": "string" } }, "xml": { "name": "PortfolioViewSearchHistoryResult" }, "type": "object" }, "OAS.WebApi.DTO.HomepageDashboard.ODataQueryCountsRequestDto": { "properties": { "slots": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.ODataQuerySlotDto" }, "xml": { "name": "ODataQuerySlotDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ODataQueryCountsRequestDto" }, "type": "object" }, "OAS.WebApi.DTO.HomepageDashboard.ODataQuerySlotDto": { "properties": { "name": { "type": "string" }, "entityRoute": { "type": "string" }, "odataFilter": { "type": "string" }, "linkPath": { "type": "string" } }, "xml": { "name": "ODataQuerySlotDto" }, "type": "object" }, "OAS.WebApi.DTO.HomepageDashboard.ODataQuerySlotsUpdateDto": { "properties": { "slots": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.ODataQuerySlotDto" }, "xml": { "name": "ODataQuerySlotDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ODataQuerySlotsUpdateDto" }, "type": "object" }, "OAS.WebApi.DTO.HomepageDashboard.HomepagePerformanceRequestDto": { "properties": { "entityIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "benchmarkKey": { "type": "string" } }, "xml": { "name": "HomepagePerformanceRequestDto" }, "type": "object" }, "OAS.DataProcess.Integrations.OpenAI.MeetingAgenda": { "properties": { "reportId": { "type": "string" }, "fileId": { "type": "string" }, "items": { "items": { "$ref": "#/definitions/OAS.DataProcess.Integrations.OpenAI.Agenda" }, "xml": { "name": "Agenda", "wrapped": true }, "type": "array" } }, "xml": { "name": "MeetingAgenda" }, "type": "object" }, "OAS.DataProcess.Integrations.OpenAI.Agenda": { "properties": { "title": { "type": "string" }, "allocatedTime": { "type": "integer", "format": "int32" }, "allocatedTimeInMinute": { "readOnly": true, "type": "string" }, "keyPoints": { "items": { "type": "string" }, "type": "array" } }, "xml": { "name": "Agenda" }, "type": "object" }, "OAS.WebApi.Domains.Homepage.CachedData": { "properties": { "key": { "type": "string" }, "data": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.DataSourceDataResultOfSystem.Object" } }, "xml": { "name": "CachedData" }, "type": "object" }, "OAS.WebApi.DTO.HomepageDashboard.DataSourceDataResultOfSystem.Object": { "properties": { "dataSourceId": { "description": "", "type": "integer", "format": "int32" }, "data": { "description": "", "readOnly": true, "type": "object" }, "isCached": { "type": "boolean" }, "error": { "description": "", "type": "string" } }, "xml": { "name": "DataSourceDataResult`1" }, "type": "object" }, "OAS.WebApi.DTO.HomepageDashboard.HomepageDashboardForUpdateDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "dashboardName": { "type": "string" }, "isShared": { "type": "boolean" }, "roles": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, "xml": { "name": "HomepageDashboardForUpdateDto" }, "type": "object" }, "OAS.DataProcess.DTO.Integration.IntegrationPrivilegeRolesDto": { "properties": { "categoryId": { "type": "integer", "format": "int32" }, "categoryName": { "type": "string" }, "code": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "roles": { "items": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integration.IntegrationPrivilegeRoleDto" }, "xml": { "name": "IntegrationPrivilegeRoleDto", "wrapped": true }, "type": "array" }, "typeName": { "type": "string" } }, "xml": { "name": "IntegrationPrivilegeRolesDto" }, "type": "object" }, "OAS.DataProcess.DTO.Integration.IntegrationPrivilegeRoleDto": { "properties": { "alClientId": { "type": "integer", "format": "int32" }, "assignedProfileCount": { "type": "integer", "format": "int32" }, "associationExists": { "type": "boolean" }, "availableAccessType": { "type": "string" }, "deleteIsGranted": { "type": "boolean" }, "editIsGranted": { "type": "boolean" }, "enabled": { "type": "boolean" }, "id": { "type": "integer", "format": "int32" }, "isDirty": { "type": "boolean" }, "loginEntityId": { "type": "string" }, "loginEntityDescription": { "type": "string" }, "name": { "type": "string" }, "readIsGranted": { "type": "boolean" } }, "xml": { "name": "IntegrationPrivilegeRoleDto" }, "type": "object" }, "OAS.DataModel.Integration.Cetera.Token": { "properties": { "access_token": { "type": "string" }, "expires_in": { "type": "integer", "format": "int32" }, "expires_datetime": { "type": "string", "format": "date-time" } }, "xml": { "name": "Token" }, "type": "object" }, "OAS.DataModel.Integration.Cetera.ClientSearch": { "properties": { "name": { "type": "string" }, "orionRepId": { "type": "integer", "format": "int32" }, "status": { "type": "string" }, "repCode": { "type": "string" }, "ssn": { "type": "string" }, "dob": { "type": "string" }, "phoneNumber": { "type": "string" }, "sortOrder": { "type": "string" }, "sortBy": { "type": "string" }, "page": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" } }, "xml": { "name": "ClientSearch" }, "type": "object" }, "OAT.Integrations.Cetera.DTOs.ClientSearchResponse": { "properties": { "totalCount": { "type": "integer", "format": "int32" }, "page": { "type": "integer", "format": "int32" }, "data": { "items": { "$ref": "#/definitions/OAT.Integrations.Cetera.DTOs.Data" }, "xml": { "name": "Data", "wrapped": true }, "type": "array" } }, "xml": { "name": "ClientSearchResponse" }, "type": "object" }, "OAT.Integrations.Cetera.DTOs.Data": { "properties": { "clientId": { "type": "integer", "format": "int32" }, "totalInvAssets": { "type": "number", "format": "float" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "status": { "type": "string" }, "addresses": { "type": "object" }, "phones": { "items": { "$ref": "#/definitions/OAT.Integrations.Cetera.DTOs.CS_Phone" }, "xml": { "name": "CS_Phone", "wrapped": true }, "type": "array" }, "email": { "type": "string" }, "repCode": { "type": "string" }, "ssn": { "type": "string" } }, "xml": { "name": "Data" }, "type": "object" }, "OAT.Integrations.Cetera.DTOs.CS_Phone": { "properties": { "phoneNumber": { "type": "string" }, "type": { "type": "string" }, "isPrimary": { "type": "string" }, "desc": { "type": "string" }, "primaryPriority": { "type": "integer", "format": "int32" } }, "xml": { "name": "CS_Phone" }, "type": "object" }, "OAT.Integrations.Cetera.DTOs.ClientDetailsResponse": { "properties": { "profile": { "$ref": "#/definitions/OAT.Integrations.Cetera.DTOs.Profile" }, "isMinor": { "type": "boolean" }, "reps": { "items": { "$ref": "#/definitions/OAT.Integrations.Cetera.DTOs.Rep" }, "xml": { "name": "Rep", "wrapped": true }, "type": "array" }, "mails": { "items": { "$ref": "#/definitions/OAT.Integrations.Cetera.DTOs.Mail" }, "xml": { "name": "Mail", "wrapped": true }, "type": "array" }, "phones": { "items": { "$ref": "#/definitions/OAT.Integrations.Cetera.DTOs.Phone" }, "xml": { "name": "Phone", "wrapped": true }, "type": "array" }, "addresses": { "items": { "$ref": "#/definitions/OAT.Integrations.Cetera.DTOs.Address" }, "xml": { "name": "Address", "wrapped": true }, "type": "array" }, "affiliation": { "$ref": "#/definitions/OAT.Integrations.Cetera.DTOs.Affiliation" }, "employment": { "$ref": "#/definitions/OAT.Integrations.Cetera.DTOs.Employment" }, "identification": { "$ref": "#/definitions/OAT.Integrations.Cetera.DTOs.Identification" }, "financialInformation": { "$ref": "#/definitions/OAT.Integrations.Cetera.DTOs.Financialinformation" }, "trustedContactInformation": { "$ref": "#/definitions/OAT.Integrations.Cetera.DTOs.Trustedcontactinformation" } }, "xml": { "name": "ClientDetailsResponse" }, "type": "object" }, "OAT.Integrations.Cetera.DTOs.Profile": { "properties": { "countryOfCitizenShip": { "type": "string" }, "prefix": { "type": "string" }, "suffix": { "type": "string" }, "citizen": { "type": "string", "enum": [ "Y", "R", "N" ] }, "taxidType": { "type": "string", "enum": [ "TaxID", "SSN" ] }, "primaryAdvisor": { "$ref": "#/definitions/OAT.Integrations.Cetera.DTOs.PrimaryAdvisor" }, "gender": { "type": "string", "enum": [ "MALE", "FEMALE", "UNKNOWN" ] }, "martialStatus": { "type": "string", "enum": [ "SINGLE", "MARRIED", "SEPARATED", "DIVORCED", "WIDOWED", "UNKNOWN" ] }, "clientType": { "type": "string", "enum": [ "PERSON", "BUSINESS" ] }, "isClient": { "type": "string", "enum": [ "Y", "N" ] }, "clientSubType": { "type": "string" }, "isMinor": { "type": "boolean" }, "brokerDealer": { "type": "string" }, "firstname": { "type": "string" }, "middleName": { "type": "string" }, "lastName": { "type": "string" }, "clientId": { "type": "integer", "format": "int32" }, "brokerDealerId": { "type": "integer", "format": "int32" }, "swClientId": { "type": "string" }, "dob": { "type": "string" }, "ssn": { "type": "string" }, "tin": { "type": "string" }, "preferredName": { "type": "string" } }, "xml": { "name": "Profile" }, "type": "object" }, "OAT.Integrations.Cetera.DTOs.Rep": { "properties": { "repnumberid": { "type": "integer", "format": "int32" }, "repnumber": { "type": "string" }, "type": { "type": "string" }, "repcode": { "type": "string" }, "repNumberDescription": { "type": "string" }, "advisors": { "items": { "$ref": "#/definitions/OAT.Integrations.Cetera.DTOs.Advisor" }, "xml": { "name": "Advisor", "wrapped": true }, "type": "array" } }, "xml": { "name": "Rep" }, "type": "object" }, "OAT.Integrations.Cetera.DTOs.Mail": { "properties": { "emailId": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "email": { "type": "string" }, "status": { "type": "string" }, "isClientFacing": { "type": "boolean" } }, "xml": { "name": "Mail" }, "type": "object" }, "OAT.Integrations.Cetera.DTOs.Phone": { "properties": { "phoneNumberId": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "phoneNumber": { "type": "string" }, "status": { "type": "string" } }, "xml": { "name": "Phone" }, "type": "object" }, "OAT.Integrations.Cetera.DTOs.Address": { "properties": { "addressId": { "type": "integer", "format": "int32" }, "addressline1": { "type": "string" }, "addressline2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" }, "zipcode": { "type": "string" }, "addressType": { "type": "string" }, "isPrimary": { "type": "boolean" } }, "xml": { "name": "Address" }, "type": "object" }, "OAT.Integrations.Cetera.DTOs.Affiliation": { "properties": { "stakeholderOfPubliclyTradedCompany": { "type": "string" }, "politician": { "type": "string" }, "politicianCountry": { "type": "string" }, "brokerDealer": { "type": "string" }, "brokerDealerWithCeteraBD": { "type": "string" }, "brokerDealerFirm": { "type": "string" }, "affiliatedWithCeteraBD": { "type": "string" }, "affiliatedFirmName": { "type": "string" }, "affiliatedWithBrokerDealerOrFINRA": { "type": "string" }, "companyAffiliations": { "items": { "$ref": "#/definitions/OAT.Integrations.Cetera.DTOs.CompanyAffiliation" }, "xml": { "name": "CompanyAffiliation", "wrapped": true }, "type": "array" } }, "xml": { "name": "Affiliation" }, "type": "object" }, "OAT.Integrations.Cetera.DTOs.Employment": { "properties": { "employmentStatus": { "type": "string" }, "employerName": { "type": "string" }, "occupation": { "type": "string" }, "workPhoneNumber": { "type": "string" }, "extension": { "type": "string" }, "employerAddress": { "$ref": "#/definitions/OAT.Integrations.Cetera.DTOs.Employeraddress" } }, "xml": { "name": "Employment" }, "type": "object" }, "OAT.Integrations.Cetera.DTOs.Identification": { "properties": { "identificationType": { "type": "string", "enum": [ "ALEN", "CDLA", "DRVR", "GREN", "INSI", "MLTY", "NATL", "OGVT", "PASS", "VISA", "ArtOfInc", "GovIssBLic", "PartAgr", "TrustDoc", "LetterTest", "TINDoc", "InvestClub", "ArtOfOrg", "Other" ] }, "idNumber": { "type": "string" }, "issueDate": { "type": "string" }, "expirationDate": { "type": "string" }, "description": { "type": "string" }, "stateOfIssue": { "type": "string" }, "countryOfIssue": { "type": "string" }, "photoIdverified": { "type": "boolean" }, "typeOfIndustry": { "type": "string" }, "typeOfBusiness": { "type": "string" } }, "xml": { "name": "Identification" }, "type": "object" }, "OAT.Integrations.Cetera.DTOs.Financialinformation": { "properties": { "annualIncome": { "type": "string" }, "adjustedNetWorth": { "type": "string" }, "liquidNetWorth": { "type": "string" }, "riskTolerance": { "type": "string" }, "investmentObjective": { "type": "string" }, "federalTaxBracket": { "type": "string" }, "otherInvestments": { "$ref": "#/definitions/OAT.Integrations.Cetera.DTOs.Otherinvestments" }, "investmentExperience": { "$ref": "#/definitions/OAT.Integrations.Cetera.DTOs.Investmentexperience" }, "hasInvestentmentExperience": { "type": "boolean" } }, "xml": { "name": "Financialinformation" }, "type": "object" }, "OAT.Integrations.Cetera.DTOs.Trustedcontactinformation": { "properties": { "trustedContactId": { "type": "integer", "format": "int32" }, "isTrustedContactDeclined": { "type": "boolean" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "phoneNumber": { "type": "string" }, "otherRelationshipDesc": { "type": "string" }, "relationshipType": { "type": "string" } }, "xml": { "name": "Trustedcontactinformation" }, "type": "object" }, "OAT.Integrations.Cetera.DTOs.PrimaryAdvisor": { "properties": { "advisorId": { "type": "integer", "format": "int32" }, "firstname": { "type": "string" }, "middlename": { "type": "string" }, "lastname": { "type": "string" }, "crdNumber": { "type": "string" }, "isPrimary": { "type": "boolean" }, "emails": { "items": { "type": "string" }, "type": "array" } }, "xml": { "name": "PrimaryAdvisor" }, "type": "object" }, "OAT.Integrations.Cetera.DTOs.Advisor": { "properties": { "advisorId": { "type": "integer", "format": "int32" }, "firstname": { "type": "string" }, "middlename": { "type": "string" }, "lastname": { "type": "string" }, "startDate": { "type": "string" }, "crdNumber": { "type": "string" }, "isPrimary": { "type": "boolean" }, "isSplitRep": { "type": "boolean" }, "emails": { "items": { "type": "string" }, "type": "array" } }, "xml": { "name": "Advisor" }, "type": "object" }, "OAT.Integrations.Cetera.DTOs.CompanyAffiliation": { "properties": { "companyName": { "type": "string" }, "tradingSymbol": { "type": "string" } }, "xml": { "name": "CompanyAffiliation" }, "type": "object" }, "OAT.Integrations.Cetera.DTOs.Employeraddress": { "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" }, "zip": { "type": "string" } }, "xml": { "name": "Employeraddress" }, "type": "object" }, "OAT.Integrations.Cetera.DTOs.Otherinvestments": { "properties": { "investments": { "items": { "$ref": "#/definitions/OAT.Integrations.Cetera.DTOs.Investment" }, "xml": { "name": "Investment", "wrapped": true }, "type": "array" }, "clientDeclinedToDisclose": { "type": "boolean" } }, "xml": { "name": "Otherinvestments" }, "type": "object" }, "OAT.Integrations.Cetera.DTOs.Investmentexperience": { "properties": { "experience": { "items": { "$ref": "#/definitions/OAT.Integrations.Cetera.DTOs.Experience" }, "xml": { "name": "Experience", "wrapped": true }, "type": "array" } }, "xml": { "name": "Investmentexperience" }, "type": "object" }, "OAT.Integrations.Cetera.DTOs.Investment": { "properties": { "type": { "type": "string" }, "value": { "type": "number", "format": "float" }, "freeText": { "type": "string" } }, "xml": { "name": "Investment" }, "type": "object" }, "OAT.Integrations.Cetera.DTOs.Experience": { "properties": { "type": { "type": "string" }, "years": { "type": "integer", "format": "int32" } }, "xml": { "name": "Experience" }, "type": "object" }, "OAT.Integrations.Cetera.DTOs.ReserveAccountRequest": { "properties": { "type": { "type": "string" }, "data": { "$ref": "#/definitions/OAT.Integrations.Cetera.DTOs.ReserveAccountData" } }, "xml": { "name": "ReserveAccountRequest" }, "type": "object" }, "OAT.Integrations.Cetera.DTOs.ReserveAccountData": { "properties": { "reqIntKeySource": { "type": "string" }, "reqENVTarget": { "type": "string" }, "reqAPIVersionTarget": { "type": "string" }, "reqContext": { "type": "string" }, "reqUniqueId": { "type": "string" }, "reqDateTime": { "type": "string" }, "brokerDealerFirmCode": { "type": "string" }, "brokerDealerId": { "type": "integer", "format": "int32" }, "clearingFirm": { "type": "string" }, "reqProcessingLevel": { "type": "integer", "format": "int32" }, "tenantNameSource": { "type": "string" }, "accountInformation": { "$ref": "#/definitions/OAT.Integrations.Cetera.DTOs.Accountinformation" } }, "xml": { "name": "ReserveAccountData" }, "type": "object" }, "OAT.Integrations.Cetera.DTOs.Accountinformation": { "properties": { "acctUniqueIdSource": { "type": "integer", "format": "int32" }, "acctAction": { "type": "string" }, "acctUniqueIdTarget": { "type": "integer", "format": "int32" }, "acctGroup": { "type": "string" }, "acctType": { "type": "string" }, "acctRetirementType": { "type": "string" }, "acctRetirementTypeCode": { "type": "string" }, "advisoryProgram": { "type": "string" }, "advisorInfo": { "$ref": "#/definitions/OAT.Integrations.Cetera.DTOs.Advisorinfo" }, "acctOwners": { "items": { "$ref": "#/definitions/OAT.Integrations.Cetera.DTOs.Acctowner" }, "xml": { "name": "Acctowner", "wrapped": true }, "type": "array" } }, "xml": { "name": "Accountinformation" }, "type": "object" }, "OAT.Integrations.Cetera.DTOs.Advisorinfo": { "properties": { "repNumber": { "type": "string" }, "clearingFirmRepNumber": { "type": "string" }, "repCode": { "type": "string" }, "advOfficeNumber": { "type": "string" }, "advIDTarget": { "type": "string" }, "advNumberIDTarget": { "type": "string" } }, "xml": { "name": "Advisorinfo" }, "type": "object" }, "OAT.Integrations.Cetera.DTOs.Acctowner": { "properties": { "clientUniqueIdSource": { "type": "integer", "format": "int32" }, "clientIdTarget": { "type": "integer", "format": "int32" }, "acctOwnerType": { "type": "string" }, "firstName": { "type": "string" }, "middleName": { "type": "string" }, "lastNameOrEntityName": { "type": "string" }, "countryOfCitizenship": { "type": "string" }, "taxId": { "type": "string" }, "taxIdType": { "type": "string" }, "clientType": { "type": "string" }, "clientSubType": { "type": "string" } }, "xml": { "name": "Acctowner" }, "type": "object" }, "OAT.Integrations.Cetera.DTOs.ReserveAccountResponse": { "properties": { "hasError": { "type": "boolean" }, "data": { "$ref": "#/definitions/OAT.Integrations.Cetera.DTOs.Account_Data" } }, "xml": { "name": "ReserveAccountResponse" }, "type": "object" }, "OAT.Integrations.Cetera.DTOs.Account_Data": { "properties": { "reqIntKeySource": { "type": "string" }, "reqUniqueIdTarget": { "type": "string" }, "errorCode": { "type": "string" }, "reqENVTarget": { "type": "string" }, "reqUniqueId": { "type": "string" }, "acctUniqueIdSource": { "type": "string" }, "clientIdTarget": { "type": "string" }, "clientIdTargetclearingFirm": { "type": "string" }, "acctUniqueIdTarget": { "type": "string" }, "acctNumber": { "type": "string" }, "advIDTarget": { "type": "string" }, "brokerDealerFirmCode": { "type": "string" }, "clearingFirm": { "type": "string" }, "resCustomFields": { "type": "object" }, "reqContext": { "type": "string" }, "achId": { "type": "string" }, "wireId": { "type": "string" }, "resDateTime": { "type": "string" }, "messageLevel": { "type": "integer", "format": "int32" }, "achVerified": { "type": "string" }, "wireVerified": { "type": "string" }, "acctAction": { "type": "string" }, "tenantNameSource": { "type": "string" }, "errorMessages": { "type": "object" }, "status": { "type": "string" }, "message": { "type": "string" }, "detailsErrorMessage": { "type": "object" }, "errorSource": { "type": "object" } }, "xml": { "name": "Account_Data" }, "type": "object" }, "OAS.WebApi.Domains.Integrations.CeteraController.RepCustomData": { "properties": { "crd": { "type": "string" }, "brokerDealId": { "type": "string" } }, "xml": { "name": "RepCustomData" }, "type": "object" }, "OAS.Integrations.AdvisoryWorld.Dto.AdvisoryWorldSsoUrlDto": { "properties": { "ssoUrl": { "type": "string" } }, "xml": { "name": "AdvisoryWorldSsoUrlDto" }, "type": "object" }, "OAS.DataModel.Integration.AdvisoryWorld.IntegrationConfig": { "properties": { "userId": { "type": "string" }, "password": { "type": "string" } }, "xml": { "name": "IntegrationConfig" }, "type": "object" }, "OAS.Integrations.AdvisoryWorld.Dto.AdvisoryWorldCompariScanDto": { "properties": { "modelAllocations": { "additionalProperties": { "type": "number", "format": "double" }, "type": "object" }, "allocations": { "additionalProperties": { "type": "number", "format": "double" }, "type": "object" } }, "xml": { "name": "AdvisoryWorldCompariScanDto" }, "type": "object" }, "OAS.Integrations.AdvisoryWorld.Dto.AdvisoryWorldDetailedAnalyticsDto": { "properties": { "cashFlows": { "items": { "$ref": "#/definitions/OAS.Integrations.AdvisoryWorld.External.HypoReportService.CashFlow" }, "xml": { "name": "CashFlow", "wrapped": true }, "type": "array" }, "assumedReturn": { "type": "number", "format": "double" }, "allocations": { "additionalProperties": { "type": "number", "format": "double" }, "type": "object" } }, "xml": { "name": "AdvisoryWorldDetailedAnalyticsDto" }, "type": "object" }, "OAS.Integrations.AdvisoryWorld.External.HypoReportService.CashFlow": { "properties": { "description": { "type": "string" }, "type": { "type": "string", "enum": [ "CAmount", "CShares", "WGross", "WNet", "WPercentage", "WShares", "CPercentage" ] }, "amount": { "type": "number", "format": "double" }, "amountSpecified": { "type": "boolean" }, "shares": { "type": "number", "format": "double" }, "sharesSpecified": { "type": "boolean" }, "percentage": { "type": "number", "format": "double" }, "percentageSpecified": { "type": "boolean" }, "splitType": { "type": "string", "enum": [ "Evenly", "ProRata", "Explicit" ] }, "ticker": { "type": "string" }, "cusip": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "frequency": { "type": "string", "enum": [ "Once", "Monthly", "Quarterly", "SemiAnnually", "Annually" ] }, "inflation": { "$ref": "#/definitions/OAS.Integrations.AdvisoryWorld.External.HypoReportService.Inflation" } }, "xml": { "name": "CashFlow" }, "type": "object" }, "OAS.Integrations.AdvisoryWorld.External.HypoReportService.Inflation": { "properties": { "type": { "type": "string", "enum": [ "None", "Historical", "Custom" ] }, "value": { "type": "number", "format": "double" }, "valueSpecified": { "type": "boolean" } }, "xml": { "name": "Inflation" }, "type": "object" }, "OAS.Integrations.AdvisoryWorld.Dto.AdvisoryWorldCustomAllocationDto": { "properties": { "allocations": { "additionalProperties": { "type": "number", "format": "double" }, "type": "object" } }, "xml": { "name": "AdvisoryWorldCustomAllocationDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.AdvisoryWorld.AdvisoryWorldModelAggAndRiskScoreDto": { "properties": { "modelAggId": { "type": "integer", "format": "int32" }, "riskScore": { "type": "number", "format": "double" } }, "xml": { "name": "AdvisoryWorldModelAggAndRiskScoreDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.AdvisoryWorld.RiskScoreUpdateErrorListDto": { "properties": { "modelAggId": { "type": "integer", "format": "int32" }, "errorMessage": { "type": "string" } }, "xml": { "name": "RiskScoreUpdateErrorListDto" }, "type": "object" }, "OAS.DataModel.Integration.AdvisoryWorld.StrategyAllocations": { "properties": { "strategic": { "items": { "$ref": "#/definitions/OAS.DataModel.Integration.AdvisoryWorld.ModelAggAndAllocations" }, "xml": { "name": "ModelAggAndAllocations", "wrapped": true }, "type": "array" }, "tactical": { "items": { "$ref": "#/definitions/OAS.DataModel.Integration.AdvisoryWorld.ModelAggAndAllocations" }, "xml": { "name": "ModelAggAndAllocations", "wrapped": true }, "type": "array" }, "diversifier": { "items": { "$ref": "#/definitions/OAS.DataModel.Integration.AdvisoryWorld.ModelAggAndAllocations" }, "xml": { "name": "ModelAggAndAllocations", "wrapped": true }, "type": "array" } }, "xml": { "name": "StrategyAllocations" }, "type": "object" }, "OAS.DataModel.Integration.AdvisoryWorld.ModelAggAndAllocations": { "properties": { "modelAggId": { "type": "integer", "format": "int32" }, "allocation": { "type": "number", "format": "double" } }, "xml": { "name": "ModelAggAndAllocations" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.AdvisoryWorld.AdviosryWorldRiskStatisticsAndCompositesDto": { "properties": { "riskScore": { "type": "number", "format": "double" }, "alpha": { "type": "number", "format": "double" }, "beta": { "type": "number", "format": "double" }, "rSquared": { "type": "number", "format": "double" }, "maxDrawdown": { "type": "number", "format": "double" }, "annualizedMontlyReturns": { "$ref": "#/definitions/OAS.DataModel.Integration.AdvisoryWorld.AnnualizedMontlyReturns" }, "strategic": { "type": "number", "format": "double" }, "tactical": { "type": "number", "format": "double" }, "diversifier": { "type": "number", "format": "double" } }, "xml": { "name": "AdviosryWorldRiskStatisticsAndCompositesDto" }, "type": "object" }, "OAS.DataModel.Integration.AdvisoryWorld.AnnualizedMontlyReturns": { "properties": { "ytd": { "type": "number", "format": "double" }, "oneYear": { "type": "number", "format": "double" }, "threeYear": { "type": "number", "format": "double" }, "fiveYear": { "type": "number", "format": "double" } }, "xml": { "name": "AnnualizedMontlyReturns" }, "type": "object" }, "OAS.DataModel.Portfolio.IpsBuilderSection": { "properties": { "name": { "type": "string" }, "percentage": { "type": "number", "format": "double" } }, "xml": { "name": "IpsBuilderSection" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.AdvisoryWorld.AggAccountDto": { "description": "When we return accounts to AdvisoryWorld for proposals, show the \"aggregated\" account", "properties": { "householdId": { "description": "The license type of the advisory world product that has been updated.", "type": "integer", "format": "int32" }, "repId": { "type": "integer", "format": "int32" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "type": "string" }, "accountValue": { "type": "number", "format": "double" }, "accountNumber": { "readOnly": true, "type": "string" }, "accountCount": { "type": "integer", "format": "int32" }, "assets": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.AdvisoryWorld.AggAssetDto" }, "xml": { "name": "AggAssetDto", "wrapped": true }, "type": "array" }, "regType": { "type": "string" } }, "xml": { "name": "AggAccountDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.AdvisoryWorld.AggAssetDto": { "description": "The asset object that we aggregate and return to AdvisoryWorld for proposals", "properties": { "ticker": { "description": "asset.Ticker", "type": "string" }, "assetValue": { "description": "Total value of shares of that ticker", "type": "number", "format": "double" }, "shares": { "description": "Number of shares owned", "type": "number", "format": "double" } }, "xml": { "name": "AggAssetDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.AdvisoryWorld.CompatibleModelAttributesDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "eclipsePortfolioCompatible": { "type": "boolean" }, "mmsCompatible": { "type": "boolean" } }, "xml": { "name": "CompatibleModelAttributesDto" }, "type": "object" }, "OAS.DataModel.Integration.AdvisoryWorld.Proposal": { "properties": { "registrationId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "useSleeves": { "type": "boolean" }, "sleeveStrategyId": { "type": "integer", "format": "int32" }, "portfolioId": { "type": "integer", "format": "int32" }, "modelAggAssignmentList": { "items": { "$ref": "#/definitions/OAS.DataModel.Integration.AdvisoryWorld.ModelAggAssignment" }, "xml": { "name": "ModelAggAssignment", "wrapped": true }, "type": "array" } }, "xml": { "name": "Proposal" }, "type": "object" }, "OAS.DataModel.Integration.AdvisoryWorld.ModelAggAssignment": { "properties": { "modelAggId": { "type": "integer", "format": "int32" }, "eclipseModelId": { "type": "integer", "format": "int32" }, "weight": { "type": "number", "format": "double" } }, "xml": { "name": "ModelAggAssignment" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.AdvisoryWorld.AdvisoryWorldSetupCompleteDto": { "description": "The data provided from AdvisoryWorld's API to ours when the advisor finishes or updates their integration configuration in Advisory World.", "properties": { "licenseType": { "description": "The license type of the advisory world product that has been updated.", "type": "string" }, "advisoryWorldUsername": { "description": "The firms username in AdvisoryWorld.", "type": "string" }, "repChanges": { "description": "The list of changes to the licensed reps from advisory world. Only contains reps that need to be updated.", "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.AdvisoryWorld.RepConfigDto" }, "xml": { "name": "RepConfigDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "AdvisoryWorldSetupCompleteDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.AdvisoryWorld.RepConfigDto": { "properties": { "repId": { "type": "integer", "format": "int32" }, "isEnabled": { "type": "boolean" } }, "xml": { "name": "RepConfigDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.IntegrationSetupRequestDto": { "properties": { "key": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "termsAccepted": { "type": "boolean" } }, "xml": { "name": "IntegrationSetupRequestDto" }, "type": "object" }, "OAS.DataModel.Integration.Advizr.OrionPlanningNewHousehold": { "properties": { "orionFirmId": { "type": "string" }, "orionRepLoginUserId": { "type": "string" }, "orionRepresentativeId": { "type": "integer", "format": "int32" }, "emailAddress": { "type": "string" }, "orionConnectHousehold": { "type": "string" }, "globalId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "sendInvite": { "type": "boolean" }, "primary": { "$ref": "#/definitions/OAS.DataModel.Integration.Advizr.OrionPlanningUser" }, "spouse": { "$ref": "#/definitions/OAS.DataModel.Integration.Advizr.OrionPlanningUser" }, "address": { "$ref": "#/definitions/OAS.DataModel.Integration.Advizr.OrionPlanningAddress" }, "redtail": { "$ref": "#/definitions/OAS.DataModel.Integration.Advizr.RedtailHousehold" } }, "xml": { "name": "OrionPlanningNewHousehold" }, "type": "object" }, "OAS.DataModel.Integration.Advizr.OrionPlanningUser": { "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "dateOfBirth": { "type": "string" } }, "xml": { "name": "OrionPlanningUser" }, "type": "object" }, "OAS.DataModel.Integration.Advizr.OrionPlanningAddress": { "properties": { "state": { "type": "string" } }, "xml": { "name": "OrionPlanningAddress" }, "type": "object" }, "OAS.DataModel.Integration.Advizr.RedtailHousehold": { "properties": { "userId": { "type": "integer", "format": "int32" }, "databaseId": { "type": "integer", "format": "int32" }, "userKey": { "type": "string" }, "headOfFamilyContactId": { "type": "integer", "format": "int32" } }, "xml": { "name": "RedtailHousehold" }, "type": "object" }, "OAS.DataModel.Integration.Advizr.CreateDecumulationRequestDto": { "properties": { "orionPlanningHouseholdId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "accountType": { "type": "string" }, "currentValue": { "type": "number", "format": "double" }, "assets": { "items": { "$ref": "#/definitions/OAS.DataModel.Integration.Advizr.AssetAllocationDto" }, "xml": { "name": "AssetAllocationDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "CreateDecumulationRequestDto" }, "type": "object" }, "OAS.DataModel.Integration.Advizr.AssetAllocationDto": { "properties": { "assetClass": { "type": "string" }, "currentValue": { "type": "integer", "format": "int32" } }, "xml": { "name": "AssetAllocationDto" }, "type": "object" }, "OAS.Integrations.Advizr.OrionPlanningSAML": { "properties": { "urL_BASE": { "type": "string" }, "issuer": { "type": "string" }, "cerT_PATH": { "type": "string" }, "oP_ENCRYPT_CERT_PATH": { "type": "string" }, "uri": { "type": "string" } }, "xml": { "name": "OrionPlanningSAML" }, "type": "object" }, "OAS.DataProcess.Integrations.Apex.DTOs.ApexAccountOpeningDto": { "properties": { "OrionDatabaseId": { "type": "integer", "format": "int32" }, "OrionHouseholdId": { "type": "integer", "format": "int32" }, "ApexCorrespondentCode": { "type": "string" }, "ApexBranch": { "type": "string" }, "ApexRepCode": { "type": "string" }, "ApexAccountRequestId": { "type": "string" }, "ApexAccountType": { "type": "string" }, "ApexCustomerType": { "type": "string" }, "ApexIraType": { "type": "string" }, "ApexAccountNumber": { "type": "string" }, "ApexAccountStatus": { "type": "string" }, "RetirementAccountBeneficiaries": { "items": { "$ref": "#/definitions/OAS.DataProcess.Integrations.Apex.DTOs.RetirementAccountBeneficiary" }, "xml": { "name": "RetirementAccountBeneficiary", "wrapped": true }, "type": "array" }, "Household": { "$ref": "#/definitions/OAS.DataProcess.Integrations.Apex.DTOs.ApexProspectClient" } }, "xml": { "name": "ApexAccountOpeningDto" }, "type": "object" }, "OAS.DataProcess.Integrations.Apex.DTOs.RetirementAccountBeneficiary": { "properties": { "GivenName": { "type": "string" }, "FamilyName": { "type": "string" }, "DateOfBirth": { "type": "string", "format": "date-time" }, "BeneficiaryType": { "type": "string" }, "Relationship": { "type": "string" }, "SocialSecurityNumber": { "type": "string" }, "SharePercent": { "type": "integer", "format": "int64" } }, "xml": { "name": "RetirementAccountBeneficiary" }, "type": "object" }, "OAS.DataProcess.Integrations.Apex.DTOs.ApexProspectClient": { "properties": { "RepId": { "type": "integer", "format": "int32" }, "ModelId": { "type": "integer", "format": "int32" }, "FirstName": { "type": "string" }, "LastName": { "type": "string" }, "Phone": { "type": "string" }, "Address": { "type": "string" }, "City": { "type": "string" }, "Country": { "type": "string" }, "State": { "type": "string" }, "ZipCode": { "type": "string" }, "DateOfBirth": { "type": "string" }, "Email": { "type": "string" }, "SSN": { "type": "string" }, "JobTitle": { "type": "string" } }, "xml": { "name": "ApexProspectClient" }, "type": "object" }, "OAS.DataProcess.DTO.Integration.AkoyaUserDtl": { "properties": { "credentialId": { "type": "string" }, "akoya_token_id": { "type": "integer", "format": "int32" }, "token_name": { "type": "string" }, "id_token": { "type": "string" }, "expires_in": { "type": "integer", "format": "int32" }, "token_type": { "type": "string" }, "scope": { "type": "string" }, "refresh_token": { "type": "string" }, "expires_datetime": { "type": "string", "format": "date-time" }, "clientId": { "type": "integer", "format": "int32" }, "FinancialInstitution": { "type": "string" }, "old_refresh_tokens": { "additionalProperties": { "type": "string" }, "type": "object" }, "authorization_date": { "type": "string", "format": "date-time" } }, "xml": { "name": "AkoyaUserDtl" }, "type": "object" }, "OAT.Integrations.Akoya.AkoyaUser": { "properties": { "akoya_token_id": { "type": "integer", "format": "int32" }, "token_name": { "type": "string" }, "id_token": { "type": "string" }, "expires_in": { "type": "integer", "format": "int32" }, "token_type": { "type": "string" }, "scope": { "type": "string" }, "refresh_token": { "type": "string" }, "expires_datetime": { "type": "string", "format": "date-time" }, "clientId": { "type": "integer", "format": "int32" }, "FinancialInstitution": { "type": "string" }, "old_refresh_tokens": { "additionalProperties": { "type": "string" }, "type": "object" }, "authorization_date": { "type": "string", "format": "date-time" } }, "xml": { "name": "AkoyaUser" }, "type": "object" }, "OAT.Integrations.Akoya.AkoyaUserDetail": { "properties": { "user": { "items": { "$ref": "#/definitions/OAT.Integrations.Akoya.AkoyaUser" }, "xml": { "name": "AkoyaUser", "wrapped": true }, "type": "array" }, "appLinkDetailId": { "type": "integer", "format": "int32" } }, "xml": { "name": "AkoyaUserDetail" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.AkoyaHouseholdUpdateRequestDto": { "properties": { "householdId": { "type": "integer", "format": "int32" }, "credentialIds": { "items": { "type": "string" }, "type": "array" }, "token": { "type": "string" } }, "xml": { "name": "AkoyaHouseholdUpdateRequestDto" }, "type": "object" }, "OAT.Integrations.Akoya.DataModel.IntegrationConfig": { "properties": { "secret": { "type": "string" }, "clientId": { "type": "string" } }, "xml": { "name": "IntegrationConfig" }, "type": "object" }, "OAS.DataProcess.Settings.CustomSettingDto": { "properties": { "promptName": { "type": "string" }, "category": { "type": "string" }, "displayName": { "type": "string" }, "description": { "type": "string" }, "value": { "type": "string" }, "optionLevel": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "type": { "type": "string" }, "displayOrder": { "type": "integer", "format": "int32" }, "options": { "additionalProperties": { "type": "string" }, "type": "object" }, "canEdit": { "type": "boolean" }, "allowedEntities": { "items": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "xml": { "name": "Entity", "wrapped": true }, "type": "array" }, "customAppSetting": { "type": "string", "enum": [ "Global", "ClientPortal", "RepPortal", "Element" ] } }, "xml": { "name": "CustomSettingDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.CustodialIntegrator.AkoyaInstitutionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "fiId": { "type": "string" }, "fiName": { "type": "string" }, "isExcluded": { "type": "boolean" }, "alClientList": { "type": "string" }, "logo": { "type": "string" }, "logoType": { "type": "string" }, "institutionOptionJSON": { "type": "string" } }, "xml": { "name": "AkoyaInstitutionDto" }, "type": "object" }, "OAS.DataProcess.Integrations.Apex.DTOs.ApexFileUploadDto": { "required": [ "apexAccountNumber", "sketchId" ], "properties": { "apexAccountNumber": { "type": "string" }, "sketchId": { "type": "string" }, "description": { "type": "string" }, "documentTag": { "type": "string", "enum": [ "SIGNATURE_IMAGE", "ID_DOCUMENT", "AFFILIATED_APPROVAL", "DOCUMENT", "OTHER" ] } }, "xml": { "name": "ApexFileUploadDto" }, "type": "object" }, "OAS.DataProcess.Integrations.Apex.Code.RepBranchDto": { "properties": { "firmDefault": { "type": "boolean" }, "orionRepId": { "type": "integer", "format": "int32" }, "apexRepBranchId": { "type": "integer", "format": "int32" }, "repName": { "readOnly": true, "type": "string" }, "repCode": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "branchCode": { "type": "string" } }, "xml": { "name": "RepBranchDto" }, "type": "object" }, "OAS.DataProcess.Integrations.Apex.Code.ApexFirmDto": { "required": [ "alClientId", "correspondenceCode", "apexCustomerId", "ApexKey", "documentBaseUrl", "apiBaseUrl", "user", "secret" ], "properties": { "alClientId": { "type": "integer", "format": "int32" }, "correspondenceCode": { "type": "string", "pattern": "^[a-zA-Z0-9,-._, ]+$" }, "apexCustomerId": { "type": "string" }, "ApexKey": { "type": "string" }, "documentBaseUrl": { "type": "string" }, "apiBaseUrl": { "type": "string" }, "user": { "type": "string" }, "secret": { "type": "string" } }, "xml": { "name": "ApexFirmDto" }, "type": "object" }, "OAS.DataProcess.Integrations.Apex.DTOs.ApexHighWaterMark": { "properties": { "type": { "type": "string", "enum": [ "ACCOUNT_STATUS", "ACH_TRANSACTION", "INVESTIGATION_STATUS", "NOC", "ACH_TRANSACTION_V2", "NOC_V2", "ACAT" ] }, "highWaterMark": { "type": "integer", "format": "int64" }, "correspondentCode": { "type": "string" }, "sinceDateTime": { "type": "string", "format": "date-time" }, "alClientId": { "type": "integer", "format": "int32" } }, "xml": { "name": "ApexHighWaterMark" }, "type": "object" }, "OAT.Integrations.Apex.DTOs.ApexUserToken": { "properties": { "user": { "type": "string" }, "secret": { "type": "string" }, "baseUrl": { "type": "string" }, "correspondentCode": { "type": "string" }, "token": { "$ref": "#/definitions/System.IdentityModel.Tokens.Jwt.JwtSecurityToken" } }, "xml": { "name": "ApexUserToken" }, "type": "object" }, "System.IdentityModel.Tokens.Jwt.JwtSecurityToken": { "properties": { "actor": { "readOnly": true, "type": "string" }, "audiences": { "items": { "type": "string" }, "readOnly": true, "type": "array" }, "claims": { "items": { "$ref": "#/definitions/System.Security.Claims.Claim" }, "readOnly": true, "xml": { "name": "Claim", "wrapped": true }, "type": "array" }, "encodedHeader": { "readOnly": true, "type": "string" }, "encodedPayload": { "readOnly": true, "type": "string" }, "header": { "additionalProperties": { "type": "object" }, "readOnly": true, "type": "object" }, "id": { "readOnly": true, "type": "string" }, "issuer": { "readOnly": true, "type": "string" }, "payload": { "additionalProperties": { "type": "object" }, "readOnly": true, "type": "object" }, "innerToken": { "$ref": "#/definitions/System.IdentityModel.Tokens.Jwt.JwtSecurityToken", "readOnly": true }, "rawAuthenticationTag": { "readOnly": true, "type": "string" }, "rawCiphertext": { "readOnly": true, "type": "string" }, "rawData": { "readOnly": true, "type": "string" }, "rawEncryptedKey": { "readOnly": true, "type": "string" }, "rawInitializationVector": { "readOnly": true, "type": "string" }, "rawHeader": { "readOnly": true, "type": "string" }, "rawPayload": { "readOnly": true, "type": "string" }, "rawSignature": { "readOnly": true, "type": "string" }, "securityKey": { "$ref": "#/definitions/Microsoft.IdentityModel.Tokens.SecurityKey", "readOnly": true }, "signatureAlgorithm": { "readOnly": true, "type": "string" }, "signingCredentials": { "$ref": "#/definitions/Microsoft.IdentityModel.Tokens.SigningCredentials", "readOnly": true }, "encryptingCredentials": { "$ref": "#/definitions/Microsoft.IdentityModel.Tokens.EncryptingCredentials", "readOnly": true }, "signingKey": { "$ref": "#/definitions/Microsoft.IdentityModel.Tokens.SecurityKey" }, "subject": { "readOnly": true, "type": "string" }, "validFrom": { "readOnly": true, "type": "string", "format": "date-time" }, "validTo": { "readOnly": true, "type": "string", "format": "date-time" }, "issuedAt": { "readOnly": true, "type": "string", "format": "date-time" } }, "xml": { "name": "JwtSecurityToken" }, "type": "object" }, "System.Security.Claims.Claim": { "properties": { "issuer": { "readOnly": true, "type": "string" }, "originalIssuer": { "readOnly": true, "type": "string" }, "properties": { "additionalProperties": { "type": "string" }, "readOnly": true, "type": "object" }, "subject": { "$ref": "#/definitions/System.Security.Claims.ClaimsIdentity", "readOnly": true }, "type": { "readOnly": true, "type": "string" }, "value": { "readOnly": true, "type": "string" }, "valueType": { "readOnly": true, "type": "string" } }, "xml": { "name": "Claim" }, "type": "object" }, "Microsoft.IdentityModel.Tokens.SecurityKey": { "properties": { "keySize": { "readOnly": true, "type": "integer", "format": "int32" }, "keyId": { "type": "string" }, "cryptoProviderFactory": { "$ref": "#/definitions/Microsoft.IdentityModel.Tokens.CryptoProviderFactory" } }, "xml": { "name": "SecurityKey" }, "type": "object" }, "Microsoft.IdentityModel.Tokens.SigningCredentials": { "properties": { "algorithm": { "readOnly": true, "type": "string" }, "digest": { "readOnly": true, "type": "string" }, "cryptoProviderFactory": { "$ref": "#/definitions/Microsoft.IdentityModel.Tokens.CryptoProviderFactory" }, "key": { "$ref": "#/definitions/Microsoft.IdentityModel.Tokens.SecurityKey", "readOnly": true }, "kid": { "readOnly": true, "type": "string" } }, "xml": { "name": "SigningCredentials" }, "type": "object" }, "Microsoft.IdentityModel.Tokens.EncryptingCredentials": { "properties": { "alg": { "readOnly": true, "type": "string" }, "enc": { "readOnly": true, "type": "string" }, "keyExchangePublicKey": { "$ref": "#/definitions/Microsoft.IdentityModel.Tokens.SecurityKey" }, "cryptoProviderFactory": { "$ref": "#/definitions/Microsoft.IdentityModel.Tokens.CryptoProviderFactory" }, "setDefaultCtyClaim": { "type": "boolean" }, "key": { "$ref": "#/definitions/Microsoft.IdentityModel.Tokens.SecurityKey", "readOnly": true } }, "xml": { "name": "EncryptingCredentials" }, "type": "object" }, "System.Security.Claims.ClaimsIdentity": { "properties": { "authenticationType": { "readOnly": true, "type": "string" }, "isAuthenticated": { "readOnly": true, "type": "boolean" }, "actor": { "$ref": "#/definitions/System.Security.Claims.ClaimsIdentity" }, "bootstrapContext": { "type": "object" }, "claims": { "items": { "$ref": "#/definitions/System.Security.Claims.Claim" }, "readOnly": true, "xml": { "name": "Claim", "wrapped": true }, "type": "array" }, "label": { "type": "string" }, "name": { "readOnly": true, "type": "string" }, "nameClaimType": { "readOnly": true, "type": "string" }, "roleClaimType": { "readOnly": true, "type": "string" } }, "xml": { "name": "ClaimsIdentity" }, "type": "object" }, "Microsoft.IdentityModel.Tokens.CryptoProviderFactory": { "properties": { "cryptoProviderCache": { "$ref": "#/definitions/Microsoft.IdentityModel.Tokens.CryptoProviderCache", "readOnly": true }, "customCryptoProvider": { "$ref": "#/definitions/Microsoft.IdentityModel.Tokens.ICryptoProvider" }, "cacheSignatureProviders": { "type": "boolean", "default": true }, "signatureProviderObjectPoolCacheSize": { "type": "integer", "format": "int32" } }, "xml": { "name": "CryptoProviderFactory" }, "type": "object" }, "Microsoft.IdentityModel.Tokens.CryptoProviderCache": { "properties": {}, "xml": { "name": "CryptoProviderCache" }, "type": "object" }, "Microsoft.IdentityModel.Tokens.ICryptoProvider": { "properties": {}, "xml": { "name": "ICryptoProvider" }, "type": "object" }, "OAS.DataProcess.Integrations.Apex.DTOs.ApexDocumentSystemConfiguration": { "properties": { "alClientId": { "type": "integer", "format": "int32" }, "apexCustomerId": { "type": "string" }, "apexKey": { "type": "string" }, "baseUrl": { "type": "string" } }, "xml": { "name": "ApexDocumentSystemConfiguration" }, "type": "object" }, "OAS.DataModel.Security.PartnerAppUrlWhitelist": { "required": [ "id", "partnerAppId", "url", "sslRequired" ], "properties": { "id": { "type": "integer", "format": "int32" }, "partnerAppId": { "type": "integer", "format": "int32" }, "url": { "type": "string" }, "sslRequired": { "type": "boolean" } }, "xml": { "name": "PartnerAppUrlWhitelist" }, "type": "object" }, "OAS.WebApi.Domains.Integrations.AssetMapController.Configurations": { "properties": { "apiurl": { "type": "string" }, "orionRedirectUri": { "type": "string" } }, "xml": { "name": "Configurations" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.BasicIntegrationConfigDto": { "properties": { "partnerAppId": { "description": "The unique ID of the partner app.", "type": "integer", "format": "int32" }, "productName": { "description": "The unique name of the partner app product.", "type": "string" } }, "xml": { "name": "BasicIntegrationConfigDto" }, "type": "object" }, "OAS.Integrations.Astro.Models.TemplateSimple": { "properties": { "name": { "type": "string" }, "description": { "type": "string" } }, "xml": { "name": "TemplateSimple" }, "type": "object" }, "OAS.Integrations.Astro.RestServices.InvestorPreferencesSettingSaveRequest": { "properties": { "excludeHoldFromBuyList": { "type": "integer", "format": "int32" }, "withholdCashForTaxes": { "type": "string" }, "withholdCashForTransactionCosts": { "type": "string" }, "ownerID": { "type": "string" }, "restrictionData": { "type": "string" }, "accCode": { "type": "string" }, "istUser": { "type": "string" }, "strategyName": { "type": "string" }, "minPortCash": { "type": "number", "format": "double" }, "maxPortCash": { "type": "number", "format": "double" }, "maxCapitalGains": { "type": "number", "format": "double" }, "shortTermGainRate": { "type": "number", "format": "double" }, "longTermGainRate": { "type": "number", "format": "double" }, "ticketCharge": { "type": "number", "format": "double" }, "minTrackErr": { "type": "number", "format": "double" }, "maxTrackErr": { "type": "number", "format": "double" }, "maxNoSec": { "type": "number", "format": "double" }, "minSecExp": { "type": "number", "format": "double" }, "maxSecExp": { "type": "number", "format": "double" }, "maxTurnover": { "type": "number", "format": "double" }, "minThreshold": { "type": "number", "format": "double" }, "maxTrades": { "type": "number", "format": "double" }, "minTradeType": { "type": "string" }, "minTradeSize": { "type": "number", "format": "double" }, "isSaveSectorIndData": { "type": "integer", "format": "int32" }, "unsetCompositeAssets": { "type": "integer", "format": "int32" }, "restrictSTGains": { "type": "integer", "format": "int32" }, "isSaveAttributeData": { "type": "integer", "format": "int32" } }, "xml": { "name": "InvestorPreferencesSettingSaveRequest" }, "type": "object" }, "OAS.Integrations.Astro.RestServices.InvestorPreferencesSettings": { "properties": { "benchmarkID": { "type": "string" }, "riskModel": { "type": "string" }, "minPortCash": { "type": "number", "format": "double" }, "maxPortCash": { "type": "number", "format": "double" }, "maxCapitalGains": { "type": "number", "format": "double" }, "shortTermGainRate": { "type": "number", "format": "double" }, "longTermGainRate": { "type": "number", "format": "double" }, "ticketCharge": { "type": "number", "format": "double" }, "minTrackErr": { "type": "number", "format": "double" }, "maxTrackErr": { "type": "number", "format": "double" }, "maxNoSec": { "type": "integer", "format": "int32" }, "minSecExp": { "type": "number", "format": "double" }, "maxSecExp": { "type": "number", "format": "double" }, "maxTurnover": { "type": "number", "format": "double" }, "minThreshold": { "type": "number", "format": "double" }, "maxTrades": { "type": "integer", "format": "int32" }, "minTradeType": { "type": "string" }, "minTradeSize": { "type": "number", "format": "double" }, "industryStyle": { "type": "string" }, "sectorStyle": { "type": "string" }, "withholdCashForTransactionCosts": { "type": "boolean" }, "withholdCashForTaxes": { "type": "boolean" }, "strategyName": { "type": "string" }, "istUser": { "type": "string" }, "isPreferenceExist": { "type": "boolean" }, "buyStyle": { "type": "string" }, "excludeHoldFromBuyList": { "type": "boolean" }, "isAutoExposure": { "type": "boolean" }, "unsetCompositeAssets": { "type": "boolean" }, "restrictSTGains": { "type": "boolean" }, "saveAttributeData": { "type": "boolean" } }, "xml": { "name": "InvestorPreferencesSettings" }, "type": "object" }, "OAS.DataModel.Integration.Astro.AstroAccountData": { "properties": { "id": { "type": "integer", "format": "int32" }, "displayName": { "type": "string" }, "number": { "type": "string" }, "benchmark": { "$ref": "#/definitions/OAS.DataModel.Integration.Astro.AstroBenchmark" }, "template": { "type": "string" }, "isActive": { "type": "boolean" }, "value": { "type": "number", "format": "double" }, "isProspect": { "type": "boolean" }, "maxRealizedGain": { "type": "number", "format": "double" } }, "xml": { "name": "AstroAccountData" }, "type": "object" }, "OAS.DataModel.Integration.Astro.AstroBenchmark": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "isModel": { "type": "boolean" } }, "xml": { "name": "AstroBenchmark" }, "type": "object" }, "OAS.Integrations.Astro.Models.HoldingSimple": { "properties": { "productId": { "type": "integer", "format": "int32" }, "accountId": { "type": "string" }, "productName": { "type": "string" }, "ticker": { "type": "string" }, "pct_wt": { "type": "number", "format": "double" }, "price": { "type": "number", "format": "double" }, "shares": { "type": "number", "format": "double" }, "allocation": { "type": "number", "format": "double" }, "marketValue": { "type": "number", "format": "double" }, "aquiredDate": { "type": "string", "format": "date-time" }, "maxWeightPercent": { "type": "number", "format": "double" }, "minWeightPercent": { "type": "number", "format": "double" } }, "xml": { "name": "HoldingSimple" }, "type": "object" }, "OAS.Integrations.Astro.Models.OptimizerSettings": { "properties": { "accountTemplate": { "$ref": "#/definitions/OAS.Integrations.Astro.Models.AccountBenchmark" }, "template": { "$ref": "#/definitions/OAS.Integrations.Astro.Models.Template" } }, "xml": { "name": "OptimizerSettings" }, "type": "object" }, "OAS.Integrations.Astro.Models.AccountBenchmark": { "properties": { "accountId": { "type": "string" }, "accountName": { "type": "string" }, "benchmarkId": { "type": "string" }, "benchmarkName": { "type": "string" }, "isModel": { "type": "boolean" } }, "xml": { "name": "AccountBenchmark" }, "type": "object" }, "OAS.Integrations.Astro.Models.Template": { "properties": { "name": { "type": "string" }, "minNumberOfSecurities": { "type": "number", "format": "double" }, "maxNumberOfSecurities": { "type": "integer", "format": "int32" }, "minSecurityWeight": { "type": "number", "format": "double" }, "maxSecurityWeight": { "type": "number", "format": "double" }, "minCashWeight": { "type": "number", "format": "double" }, "maxCashWeight": { "type": "number", "format": "double" }, "minTrackingError": { "type": "number", "format": "double" }, "maxTrackingError": { "type": "number", "format": "double" }, "withholdCashForTransactionCosts": { "type": "boolean" }, "maxTurnover": { "type": "number", "format": "double" }, "minTradeSize": { "type": "number", "format": "double" }, "ticketCharge": { "type": "number", "format": "double" }, "withholdCashForTaxes": { "type": "boolean" }, "maxCapitalGain": { "type": "number", "format": "double" }, "netCapitalGain": { "type": "number", "format": "double" }, "shortTermGainRate": { "type": "number", "format": "double" }, "longTermGainRate": { "type": "number", "format": "double" }, "benchMarkId": { "type": "string" }, "isModel": { "type": "boolean" } }, "xml": { "name": "Template" }, "type": "object" }, "OAS.Integrations.Astro.Models.OptimizationSummary": { "properties": { "batchName": { "type": "string" }, "characteristics": { "$ref": "#/definitions/OAS.Integrations.Astro.Models.PortfolioCharacteristics" }, "sector": { "$ref": "#/definitions/OAS.Integrations.Astro.Models.SectorPercentages" } }, "xml": { "name": "OptimizationSummary" }, "type": "object" }, "OAS.Integrations.Astro.Models.PortfolioCharacteristics": { "properties": { "accountId": { "type": "string" }, "userId": { "type": "string" }, "currentHoldings": { "type": "integer", "format": "int32" }, "proposedHoldings": { "type": "integer", "format": "int32" }, "currentTrackingError": { "type": "number", "format": "double" }, "proposedTrackingError": { "type": "number", "format": "double" }, "currentRSquared": { "type": "number", "format": "double" }, "proposedRSquared": { "type": "number", "format": "double" }, "currentBeta": { "type": "number", "format": "double" }, "proposedBeta": { "type": "number", "format": "double" }, "targetBeta": { "type": "number", "format": "double" }, "currentRisk": { "type": "number", "format": "double" }, "proposedRisk": { "type": "number", "format": "double" }, "targetRisk": { "type": "number", "format": "double" }, "turnover": { "type": "number", "format": "double" }, "taxCost": { "type": "number", "format": "float" }, "proposedCapGain": { "type": "number", "format": "float" } }, "xml": { "name": "PortfolioCharacteristics" }, "type": "object" }, "OAS.Integrations.Astro.Models.SectorPercentages": { "properties": { "accountId": { "type": "string" }, "userId": { "type": "string" }, "optimizedIT": { "type": "number", "format": "double" }, "propoedIT": { "type": "number", "format": "double" }, "optimizedFinancial": { "type": "number", "format": "double" }, "propoedFinancial": { "type": "number", "format": "double" }, "optimizedHealthCare": { "type": "number", "format": "double" }, "propoedHealthCare": { "type": "number", "format": "double" }, "optimizedConsumerCyclical": { "type": "number", "format": "double" }, "propoedConsumerCyclical": { "type": "number", "format": "double" }, "optimizedIndustrial": { "type": "number", "format": "double" }, "propoedIndustrial": { "type": "number", "format": "double" }, "optimizedRealEstate": { "type": "number", "format": "double" }, "propoedRealEstate": { "type": "number", "format": "double" }, "optimizedConsumerDefensive": { "type": "number", "format": "double" }, "propoedConsumerDefensive": { "type": "number", "format": "double" }, "optimizedCommunication": { "type": "number", "format": "double" }, "propoedCommunication": { "type": "number", "format": "double" }, "optimizedEnergy": { "type": "number", "format": "double" }, "propoedEnergy": { "type": "number", "format": "double" }, "optimizedMaterial": { "type": "number", "format": "double" }, "propoedMaterial": { "type": "number", "format": "double" }, "optimizedUtilities": { "type": "number", "format": "double" }, "propoedUtilities": { "type": "number", "format": "double" } }, "xml": { "name": "SectorPercentages" }, "type": "object" }, "OAS.DataModel.Integration.Astro.AstroHolding": { "properties": { "id": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "accountId": { "type": "string" }, "ticker": { "type": "string" }, "allocation": { "type": "number", "format": "double" }, "value": { "type": "number", "format": "double" }, "valueToTrade": { "type": "number", "format": "double" }, "price": { "type": "number", "format": "double" }, "shares": { "type": "number", "format": "double" }, "sharesToTrade": { "type": "number", "format": "double" }, "eligibleToTrade": { "type": "number", "format": "double" }, "purchaseDate": { "type": "string" }, "costBasis": { "type": "number", "format": "double" }, "unrealizedShortGL": { "type": "number", "format": "double" }, "unrealizedLongGL": { "type": "number", "format": "double" }, "minWeightPercent": { "type": "number", "format": "double" }, "maxWeightPercent": { "type": "number", "format": "double" }, "minShares": { "type": "number", "format": "double" }, "maxShares": { "type": "number", "format": "double" }, "costBasisLots": { "items": { "$ref": "#/definitions/OAS.DataModel.Integration.Astro.AstroCostBasisLot" }, "xml": { "name": "AstroCostBasisLot", "wrapped": true }, "type": "array" } }, "xml": { "name": "AstroHolding" }, "type": "object" }, "OAS.DataModel.Integration.Astro.AstroCostBasisLot": { "properties": { "id": { "type": "integer", "format": "int32" }, "ticker": { "type": "string" }, "allocation": { "type": "number", "format": "double" }, "value": { "type": "number", "format": "double" }, "valueToTrade": { "type": "number", "format": "double" }, "price": { "type": "number", "format": "double" }, "shares": { "type": "number", "format": "double" }, "sharesToTrade": { "type": "number", "format": "double" }, "eligibleToTrade": { "type": "number", "format": "double" }, "purchaseDate": { "type": "string" }, "costBasis": { "type": "number", "format": "double" }, "unrealizedShortGL": { "type": "number", "format": "double" }, "unrealizedLongGL": { "type": "number", "format": "double" } }, "xml": { "name": "AstroCostBasisLot" }, "type": "object" }, "OAS.DataModel.Integration.Astro.AstroHoldingError": { "properties": { "ticker": { "type": "string" }, "errorCode": { "type": "string", "enum": [ "ProductNotFound", "PriceNotFound" ] }, "errorMessage": { "type": "string" } }, "xml": { "name": "AstroHoldingError" }, "type": "object" }, "OAS.Integrations.Astro.Models.Benchmark": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "isModel": { "type": "boolean" } }, "xml": { "name": "Benchmark" }, "type": "object" }, "OAS.Integrations.Astro.Models.TemplateName": { "properties": { "name": { "type": "string" } }, "xml": { "name": "TemplateName" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Astro.AstroSubReportDto": { "properties": { "summary": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.SubReportPortfolioSummaryDto" }, "sector": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.SubReportSectorPercentagesDto" }, "initGainLoss": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.SubReportGainLossDto" }, "optGainLoss": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.SubReportGainLossDto" }, "topTenIncrease": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.SubReportTopTenDto" }, "xml": { "name": "SubReportTopTenDto", "wrapped": true }, "type": "array" }, "topTenDecrease": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.SubReportTopTenDto" }, "xml": { "name": "SubReportTopTenDto", "wrapped": true }, "type": "array" }, "benchmarkSummary": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.BenchmarkSummaryDto" }, "benchmarkDetail": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.BenchmarkDetailDto" } }, "xml": { "name": "AstroSubReportDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Astro.SubReportPortfolioSummaryDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "initialMarketValue": { "type": "number", "format": "double" }, "optimalMarketValue": { "type": "number", "format": "double" }, "initialPercentCash": { "type": "number", "format": "double" }, "optimalPercentCash": { "type": "number", "format": "double" }, "targetPercentCash": { "type": "number", "format": "double" }, "initialHoldings": { "type": "number", "format": "double" }, "optimalHoldings": { "type": "number", "format": "double" }, "targetHoldings": { "type": "number", "format": "double" }, "initialTrackingError": { "type": "number", "format": "double" }, "optimalTrackingError": { "type": "number", "format": "double" }, "currentTrackingError": { "type": "number", "format": "double" }, "initialRSquared": { "type": "number", "format": "double" }, "optimalRSquared": { "type": "number", "format": "double" }, "initialBeta": { "type": "number", "format": "double" }, "optimalBeta": { "type": "number", "format": "double" }, "initialRisk": { "type": "number", "format": "double" }, "optimalRisk": { "type": "number", "format": "double" }, "targetRisk": { "type": "number", "format": "double" }, "turnover": { "type": "number", "format": "double" }, "initialTaxCost": { "type": "number", "format": "double" }, "optimalTaxCost": { "type": "number", "format": "double" }, "sold": { "type": "integer", "format": "int32" }, "purchased": { "type": "integer", "format": "int32" } }, "xml": { "name": "SubReportPortfolioSummaryDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Astro.SubReportSectorPercentagesDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "initialIT": { "type": "number", "format": "double" }, "optimizedIT": { "type": "number", "format": "double" }, "targetIT": { "type": "number", "format": "double" }, "initialFinancial": { "type": "number", "format": "double" }, "optimizedFinancial": { "type": "number", "format": "double" }, "targetFinancial": { "type": "number", "format": "double" }, "initialHealthCare": { "type": "number", "format": "double" }, "optimizedHealthCare": { "type": "number", "format": "double" }, "targetHealthCare": { "type": "number", "format": "double" }, "initialConsumerCyclical": { "type": "number", "format": "double" }, "optimizedConsumerCyclical": { "type": "number", "format": "double" }, "targetConsumerCyclical": { "type": "number", "format": "double" }, "initialConsumerIndustrial": { "type": "number", "format": "double" }, "optimizedIndustrial": { "type": "number", "format": "double" }, "targetIndustrial": { "type": "number", "format": "double" }, "initialRealEstate": { "type": "number", "format": "double" }, "optimizedRealEstate": { "type": "number", "format": "double" }, "targetRealEstate": { "type": "number", "format": "double" }, "initialConsumerDefensive": { "type": "number", "format": "double" }, "optimizedConsumerDefensive": { "type": "number", "format": "double" }, "targetConsumerDefensive": { "type": "number", "format": "double" }, "initialCommunication": { "type": "number", "format": "double" }, "optimizedCommunication": { "type": "number", "format": "double" }, "targetCommunication": { "type": "number", "format": "double" }, "initialEnergy": { "type": "number", "format": "double" }, "optimizedEnergy": { "type": "number", "format": "double" }, "targetEnergy": { "type": "number", "format": "double" }, "initialMaterials": { "type": "number", "format": "double" }, "optimizedMaterials": { "type": "number", "format": "double" }, "targetMaterials": { "type": "number", "format": "double" }, "initialUtilities": { "type": "number", "format": "double" }, "optimizedUtilities": { "type": "number", "format": "double" }, "targetUtilities": { "type": "number", "format": "double" } }, "xml": { "name": "SubReportSectorPercentagesDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Astro.SubReportGainLossDto": { "properties": { "accountName": { "type": "string" }, "shortTermGain": { "type": "number", "format": "double" }, "shortTermLoss": { "type": "number", "format": "double" }, "shortTermNet": { "type": "number", "format": "double" }, "longTermGain": { "type": "number", "format": "double" }, "longTermLoss": { "type": "number", "format": "double" }, "longTermNet": { "type": "number", "format": "double" }, "gainLossNet": { "type": "number", "format": "double" } }, "xml": { "name": "SubReportGainLossDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Astro.SubReportTopTenDto": { "properties": { "userId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "securityName": { "type": "string" }, "initialPercentWeight": { "type": "number", "format": "double" }, "optimalPercentWeight": { "type": "number", "format": "double" }, "changePercentWeight": { "type": "number", "format": "double" } }, "xml": { "name": "SubReportTopTenDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Astro.BenchmarkSummaryDto": { "properties": { "benchmarkId": { "type": "string" }, "benchmarkName": { "type": "string" }, "accountId": { "type": "string" }, "accountName": { "type": "string" }, "isModel": { "type": "boolean" } }, "xml": { "name": "BenchmarkSummaryDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Astro.BenchmarkDetailDto": { "properties": { "benchmarkName": { "type": "string" }, "numberOfHoldings": { "type": "integer", "format": "int32" }, "holdings": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.BenchmarkHoldingDto" }, "xml": { "name": "BenchmarkHoldingDto", "wrapped": true }, "type": "array" }, "sectorDetail": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.BenchmarkSectorDetailDto" }, "xml": { "name": "BenchmarkSectorDetailDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "BenchmarkDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Astro.BenchmarkHoldingDto": { "properties": { "productId": { "type": "string" }, "productName": { "type": "string" }, "ticker": { "type": "string" }, "holdingWeight": { "type": "number", "format": "float" } }, "xml": { "name": "BenchmarkHoldingDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Astro.BenchmarkSectorDetailDto": { "properties": { "sectorName": { "type": "string" }, "sectorWeight": { "type": "number", "format": "float" } }, "xml": { "name": "BenchmarkSectorDetailDto" }, "type": "object" }, "OAS.Remote.Trading.TradeDefinition": { "properties": { "routine": { "type": "string", "enum": [ "Undefined", "Rebalance", "GlobalTrades", "BuySell", "SellAll", "TargetPercent", "ProRated", "QuickTrade", "QuickTradeBlock", "Distribution", "OptionTrade" ] }, "scheduled": { "type": "boolean" }, "recalcInstance": { "type": "boolean" }, "scheduledRunTime": { "type": "object" }, "description": { "type": "string" }, "nsccTransactionType": { "type": "string", "enum": [ "UseDefault", "NormalPurchase", "Nav", "Roa", "Loi" ] }, "assetValues": { "type": "string", "enum": [ "UseDefault", "Current", "Pending", "PendingTransactionsAndOrders" ] }, "minTradeAmount": { "type": "number", "format": "double" }, "postProcess": { "type": "string", "enum": [ "Run", "Skip" ] }, "useProductSubstitution": { "type": "string", "enum": [ "UseDefault", "Use", "Ignore" ] }, "stfWarningDays": { "type": "integer", "format": "int32" }, "tradeInstanceID": { "type": "integer", "format": "int32" }, "includeCustodialCash": { "type": "boolean" }, "notes": { "type": "string" }, "inboxAlert": { "type": "boolean" }, "disableRealTimePrices": { "type": "boolean" }, "sessionID": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "caption": { "type": "string" }, "filename": { "type": "string" }, "runDisconnected": { "type": "boolean" }, "instanceType": { "type": "string", "enum": [ "Undefined", "GlobalTrade", "Modeling", "CheckReq", "FeeReq", "BuySell", "ACHReq", "EligibleTrades", "All", "CashFundADV", "CashFundSWD", "SWPDCA", "SysPurchTrade", "Distribution", "Contribution" ] }, "securityTicket": { "type": "string", "format": "byte" }, "commonSecurityTicket": { "type": "string", "format": "byte" }, "authToken": { "type": "string" }, "commonServer": { "type": "string" }, "databaseID": { "type": "integer", "format": "int32" }, "correlationId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "a_UserDetailId": { "type": "integer", "format": "int32" }, "i_UserDetailId": { "type": "integer", "format": "int32" } }, "xml": { "name": "TradeDefinition" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Astro.EsgSecurityRestrictionDto": { "properties": { "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "ticker": { "type": "string" }, "restrictionType": { "readOnly": true, "type": "string", "enum": [ "None", "DoNotBuy", "DoNotSell", "DoNotTrade", "SellAllShares", "BringWeightTo", "Percent" ] }, "esgCategoryID": { "type": "integer", "format": "int32" } }, "xml": { "name": "EsgSecurityRestrictionDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Astro.HoldingRestrictionValidationResultDto": { "properties": { "validationMessage": { "type": "string" }, "isValid": { "readOnly": true, "type": "boolean" }, "assetId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "source": { "type": "string" }, "restrictionType": { "type": "string", "enum": [ "None", "DoNotBuy", "DoNotSell", "DoNotTrade", "SellAllShares", "BringWeightTo", "Percent" ] }, "isCustodialCash": { "type": "boolean" }, "minPercentWeight": { "type": "number", "format": "double" }, "maxPercentWeight": { "type": "number", "format": "double" }, "ticker": { "type": "string" }, "shares": { "type": "number", "format": "double" }, "allocation": { "type": "number", "format": "double" } }, "xml": { "name": "HoldingRestrictionValidationResultDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Astro.AstroSyncAfterTaxReportingDto": { "properties": { "alClientId": { "type": "string" }, "accountId": { "type": "string" }, "maxCaptialGain": { "type": "number", "format": "double" }, "shortTermTaxGain": { "type": "number", "format": "double" }, "longGainTaxRate": { "type": "number", "format": "double" }, "initTrackErr": { "type": "number", "format": "double" }, "currentTrackError": { "type": "number", "format": "double" }, "optimalTrackError": { "type": "number", "format": "double" }, "optimizationDate": { "type": "string" } }, "xml": { "name": "AstroSyncAfterTaxReportingDto" }, "type": "object" }, "OAS.Integrations.Axos.Models.AxosCreds": { "properties": { "axosUser": { "type": "string" }, "axosWord": { "type": "string" } }, "xml": { "name": "AxosCreds" }, "type": "object" }, "OAS.Integrations.Axos.Models.AxosToken": { "properties": { "access_token": { "type": "string" }, "refresh_token": { "type": "string" }, "scope": { "type": "string" }, "token_type": { "type": "string" }, "expires_in": { "type": "integer", "format": "int32" }, "expires_datetime": { "type": "string", "format": "date-time" } }, "xml": { "name": "AxosToken" }, "type": "object" }, "OAS.DataModel.Integration.BizEquity.BizEquitySubDomain": { "properties": { "subDomain": { "type": "string" }, "affiliationId": { "type": "string" } }, "xml": { "name": "BizEquitySubDomain" }, "type": "object" }, "OAT.Integrations.BlackRock.Models.BlackRockCoriIncome": { "properties": { "age": { "type": "integer", "format": "int32" }, "retirementAge": { "type": "integer", "format": "int32" }, "additionalSavings": { "type": "integer", "format": "int32" }, "currentSavings": { "type": "integer", "format": "int32" }, "key": { "type": "integer", "format": "int32" }, "entity": { "type": "integer", "format": "int32" }, "currentIncome": { "type": "number", "format": "double" }, "incomeGoal": { "type": "integer", "format": "int32" } }, "xml": { "name": "BlackRockCoriIncome" }, "type": "object" }, "OAT.Integrations.BlackRock.Models.BlackRockCoriIncomeDto": { "properties": { "result": { "$ref": "#/definitions/OAT.Integrations.BlackRock.Models.BlackRockCoriResultDto" }, "request": { "$ref": "#/definitions/OAT.Integrations.BlackRock.Models.BlackRockCoriIncome" } }, "xml": { "name": "BlackRockCoriIncomeDto" }, "type": "object" }, "OAT.Integrations.BlackRock.Models.BlackRockCoriResultDto": { "properties": { "currentIncome": { "type": "number", "format": "double" }, "expectedIncome": { "type": "number", "format": "double" }, "lowerBoundIncome": { "type": "number", "format": "double" }, "upperBoundIncome": { "type": "number", "format": "double" }, "lowerBoundIncome1Year": { "type": "number", "format": "double" }, "upperBoundIncome1Year": { "type": "number", "format": "double" }, "lowerBoundIncomeAge1Year": { "type": "number", "format": "double" }, "lowerBoundIncomeSavings1Year": { "type": "number", "format": "double" } }, "xml": { "name": "BlackRockCoriResultDto" }, "type": "object" }, "OAT.Integrations.BlackRock.Models.ModelAssignment": { "properties": { "orion_householdId": { "type": "integer", "format": "int32" }, "eclipse_portfolioId": { "type": "integer", "format": "int32" }, "accountList": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "communityModelId": { "type": "integer", "format": "int32" } }, "xml": { "name": "ModelAssignment" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.PartnerAppConfigurationDto": { "properties": { "partnerAppId": { "description": "The unique ID of the partner app.", "type": "integer", "format": "int32" }, "productName": { "description": "The unique name of the partner app product.", "type": "string" }, "jobScheduleDescription": { "description": "The description of the scheduled job.", "type": "string" }, "jobScheduleId": { "description": "An optional ID of the Job scheduled for the current integration and firm. Defaults to zero if no Job is scheduled.", "type": "integer", "format": "int32" }, "lastRun": { "type": "string", "format": "date-time" }, "runOn": { "description": "The date and time of the next run of the scheduled jobs.", "type": "string", "format": "date-time" }, "status": { "description": "Gets or sets a JobStatus description of the last run.", "type": "string" }, "weekdaysOnly": { "description": "Indicates whether the job is run on weekdays only or everyday.", "type": "boolean" }, "routePrefix": { "description": "The prefix for this controller. Used by clients to determine the correct endpoints to call.", "type": "string" } }, "xml": { "name": "PartnerAppConfigurationDto" }, "type": "object" }, "OAS.WebApi.DTO.Scheduler.JobScheduleUpdateRequest": { "properties": { "jobRunTime": { "type": "string", "format": "date-time" }, "weekdaysOnly": { "type": "boolean" } }, "xml": { "name": "JobScheduleUpdateRequest" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.BluePay.BluePayBillingInfoDto": { "properties": { "ccFirstNameOnCard": { "type": "string" }, "ccLastNameOnCard": { "type": "string" }, "ccAddress1": { "type": "string" }, "ccAddress2": { "type": "string" }, "ccCity": { "type": "string" }, "ccState": { "type": "string" }, "ccZip": { "type": "string" }, "ccCountry": { "type": "string" }, "ccPhone": { "type": "string" }, "ccEmail": { "type": "string" }, "ccNumber": { "type": "string" }, "ccExpiration": { "type": "string" }, "cvv2": { "type": "string" }, "ccType": { "type": "string" }, "achRoutingNum": { "type": "string" }, "achAccountNum": { "type": "string" }, "achAccountType": { "type": "string" }, "achDocType": { "type": "string" }, "message": { "type": "string" } }, "xml": { "name": "BluePayBillingInfoDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.BluePay.BluePayBatchResponseDto": { "properties": { "trans_id": { "type": "string" }, "name2": { "type": "string" }, "message": { "type": "string" }, "merchdata": { "type": "string" }, "source_id": { "type": "string" }, "master_id": { "type": "string" }, "amount": { "type": "string" }, "custom_id1": { "type": "string" }, "custom_id2": { "type": "string" }, "trans_status": { "type": "string" }, "trans_type": { "type": "string" }, "origin": { "type": "string" }, "processor_id": { "type": "string" }, "email": { "type": "string" }, "company_name": { "type": "string" }, "fancy_status": { "type": "string" }, "country": { "type": "string" }, "vehicle_rental_data": { "type": "string" }, "dba_name": { "type": "string" }, "f_void": { "type": "string" }, "invoice_id": { "type": "string" }, "user_id": { "type": "string" }, "addr2": { "type": "string" }, "mid": { "type": "string" }, "bP_STAMP": { "type": "string" }, "name1": { "type": "string" }, "bank_name": { "type": "string" }, "tpS_HASH_TYPE": { "type": "string" }, "lodging_data": { "type": "string" }, "bluepay_blurb": { "type": "string" }, "mode": { "type": "string" }, "payment_type": { "type": "string" }, "f_card_present": { "type": "string" }, "auth_code": { "type": "string" }, "bP_STAMP_DEF": { "type": "string" }, "issue_date": { "type": "string" }, "card_country": { "type": "string" }, "cvv2_result": { "type": "string" }, "card_account": { "type": "string" }, "card_expire": { "type": "string" }, "addr1": { "type": "string" }, "city": { "type": "string" }, "order_id": { "type": "string" }, "zip": { "type": "string" }, "processor_type": { "type": "string" }, "doc_type": { "type": "string" }, "level_3_data": { "type": "string" }, "rebill_id": { "type": "string" }, "memo": { "type": "string" }, "cvv2_status": { "type": "string" }, "account_name": { "type": "string" }, "state": { "type": "string" }, "avs_result": { "type": "string" }, "card_type": { "type": "string" }, "phone": { "type": "string" }, "account_id": { "type": "string" } }, "xml": { "name": "BluePayBatchResponseDto" }, "type": "object" }, "OAT.Integrations.BluePay.IntegrationConfig": { "properties": { "mode": { "type": "string" }, "accountId": { "type": "string" }, "secretKey": { "type": "string" } }, "xml": { "name": "IntegrationConfig" }, "type": "object" }, "OAT.Integrations.ByAllAccounts.IntegrationConfig": { "properties": { "username": { "type": "string" }, "password": { "type": "string" }, "personId": { "type": "string" }, "financialProfileId": { "type": "string" } }, "xml": { "name": "IntegrationConfig" }, "type": "object" }, "OAT.Integrations.ByAllAccounts.DataGetResponse": { "properties": { "version": { "type": "string" }, "loginResponse": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.LoginResponse" }, "body": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.DataGetResponseBody" } }, "xml": { "name": "DataGetResponse" }, "type": "object" }, "OAT.Integrations.ByAllAccounts.DataGetResponseBody": { "properties": { "status": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.Status" }, "securityList": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.SecurityList" }, "fiList": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.FiList" }, "userList": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.UserList" }, "data": { "items": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.Data" }, "xml": { "name": "Data", "wrapped": true }, "type": "array" } }, "xml": { "name": "DataGetResponseBody" }, "type": "object" }, "OAT.Integrations.ByAllAccounts.SecurityList": { "properties": { "items": { "items": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.Security" }, "xml": { "name": "Security", "wrapped": true }, "type": "array" } }, "xml": { "name": "SecurityList" }, "type": "object" }, "OAT.Integrations.ByAllAccounts.FiList": { "properties": { "fi": { "items": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.FinancialInstitution" }, "xml": { "name": "FinancialInstitution", "wrapped": true }, "type": "array" } }, "xml": { "name": "FiList" }, "type": "object" }, "OAT.Integrations.ByAllAccounts.UserList": { "properties": { "user": { "items": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.UserItem" }, "xml": { "name": "UserItem", "wrapped": true }, "type": "array" } }, "xml": { "name": "UserList" }, "type": "object" }, "OAT.Integrations.ByAllAccounts.Data": { "properties": { "financialProfiles": { "items": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.FinancialProfile" }, "xml": { "name": "FinancialProfile", "wrapped": true }, "type": "array" }, "portfolios": { "items": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.Portfolio" }, "xml": { "name": "Portfolio", "wrapped": true }, "type": "array" }, "accountCredentials": { "items": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.AccountCredential" }, "xml": { "name": "AccountCredential", "wrapped": true }, "type": "array" }, "accounts": { "items": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.Account" }, "xml": { "name": "Account", "wrapped": true }, "type": "array" }, "holdings": { "items": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.Holding" }, "xml": { "name": "Holding", "wrapped": true }, "type": "array" }, "transactions": { "items": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.Transaction" }, "xml": { "name": "Transaction", "wrapped": true }, "type": "array" }, "investmentOptions": { "items": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.InvestmentOption" }, "xml": { "name": "InvestmentOption", "wrapped": true }, "type": "array" } }, "xml": { "name": "Data" }, "type": "object" }, "OAT.Integrations.ByAllAccounts.Security": { "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "secruityType": { "type": "string" }, "ticker": { "type": "string" }, "cusip": { "type": "string" }, "assetClass": { "type": "string" }, "assetSubClass": { "type": "string" }, "closePrice": { "type": "number", "format": "double" }, "bondMaturity": { "type": "string" }, "bondCoupon": { "type": "number", "format": "double" }, "morningStarSECID": { "type": "string" }, "morningSTartPERFID": { "type": "string" } }, "xml": { "name": "Security" }, "type": "object" }, "OAT.Integrations.ByAllAccounts.FinancialInstitution": { "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "serviceCategory": { "type": "string" } }, "xml": { "name": "FinancialInstitution" }, "type": "object" }, "OAT.Integrations.ByAllAccounts.UserItem": { "properties": { "person": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.Person" }, "login": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.LoginItems" }, "profileAccessList": { "items": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.ProfileAccess" }, "xml": { "name": "ProfileAccess", "wrapped": true }, "type": "array" } }, "xml": { "name": "UserItem" }, "type": "object" }, "OAT.Integrations.ByAllAccounts.FinancialProfile": { "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } }, "xml": { "name": "FinancialProfile" }, "type": "object" }, "OAT.Integrations.ByAllAccounts.Portfolio": { "properties": { "fpId": { "type": "integer", "format": "int64" }, "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } }, "xml": { "name": "Portfolio" }, "type": "object" }, "OAT.Integrations.ByAllAccounts.AccountCredential": { "properties": { "profileId": { "type": "integer", "format": "int64" }, "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "financialInstitutionId": { "type": "integer", "format": "int64" }, "accountLogin": { "type": "string" }, "credComplete": { "type": "boolean" }, "lastAuthenticationAttempt": { "type": "string" }, "authStatusErrCode": { "type": "string" }, "autoManage": { "type": "boolean" }, "gatherLots": { "type": "boolean" }, "authType": { "type": "string" } }, "xml": { "name": "AccountCredential" }, "type": "object" }, "OAT.Integrations.ByAllAccounts.Account": { "properties": { "fpId": { "type": "integer", "format": "int64" }, "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "portfolioId": { "type": "integer", "format": "int64" }, "accountType": { "type": "string" }, "onlineAccessEnabled": { "type": "string" }, "lastUpdated": { "type": "string" }, "accountNumber": { "type": "string" }, "updateStatusErrcode": { "type": "string" }, "lastUpdateAttempt": { "type": "string" }, "acId": { "type": "integer", "format": "int64" }, "dataBasis": { "type": "string" }, "gatherLots": { "type": "string" }, "fI_Supplied_Rep_ID": { "type": "string" }, "fI_Supplied_Firm_ID": { "type": "string" }, "fI_Supplied_Account_Tax_ID": { "type": "string" }, "fI_Supplied_Account_Name": { "type": "string" }, "fI_Supplied_Account_Title": { "type": "string" }, "fI_Supplied_Client_First": { "type": "string" }, "fI_Supplied_Client_Middle": { "type": "string" }, "fI_Supplied_Client_Last": { "type": "string" }, "fI_Supplied_Client_Address_Street": { "type": "string" }, "fI_Supplied_Client_Address_Line2": { "type": "string" }, "fI_Supplied_Client_Address_Line3": { "type": "string" }, "fI_Supplied_Client_Address_Line4": { "type": "string" }, "fI_Supplied_Client_Address_Line5": { "type": "string" }, "fI_Supplied_Client_Address_Line6": { "type": "string" }, "fI_Supplied_Client_Address_City": { "type": "string" }, "fI_Supplied_Client_Address_State": { "type": "string" }, "fI_Supplied_Client_Address_ZipCode": { "type": "string" }, "fI_Supplied_Client_Phone": { "type": "string" }, "fI_Supplied_Client_DOB": { "type": "string" }, "fI_Supplied_Client_EMail": { "type": "string" }, "fI_Supplied_Account_Type": { "type": "string" }, "fI_Supplied_Custodian_Code": { "type": "string" }, "fI_Supplied_Custodian_Name": { "type": "string" }, "planName": { "type": "string" }, "marketValue": { "type": "string" }, "externalServiceLevel": { "type": "string" }, "holdings": { "items": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.Holding" }, "readOnly": true, "xml": { "name": "Holding", "wrapped": true }, "type": "array" }, "accountCredential": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.AccountCredential" }, "financialInstitution": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.FinancialInstitution" } }, "xml": { "name": "Account" }, "type": "object" }, "OAT.Integrations.ByAllAccounts.Holding": { "properties": { "fpId": { "type": "integer", "format": "int64" }, "id": { "type": "integer", "format": "int64" }, "accountId": { "type": "integer", "format": "int64" }, "securityId": { "type": "integer", "format": "int64" }, "units": { "type": "number", "format": "double" }, "costBasis": { "type": "number", "format": "double" }, "marketValue": { "type": "number", "format": "double" }, "unitPrice": { "type": "number", "format": "double" }, "priceDataAsOf": { "type": "string" }, "lastUpdated": { "type": "string" }, "name": { "type": "string" }, "cusip": { "type": "string" }, "ticker": { "type": "string" }, "valueSource": { "type": "string" }, "secType": { "type": "string" }, "security": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.Security" } }, "xml": { "name": "Holding" }, "type": "object" }, "OAT.Integrations.ByAllAccounts.Transaction": { "properties": { "fpId": { "type": "integer", "format": "int64" }, "id": { "type": "integer", "format": "int64" }, "accountId": { "type": "integer", "format": "int64" }, "holdingId": { "type": "integer", "format": "int64" }, "securityId": { "type": "integer", "format": "int64" }, "txType": { "type": "string" }, "totalAmount": { "type": "number", "format": "double" }, "name": { "type": "string" }, "description": { "type": "string" }, "price": { "type": "number", "format": "double" }, "flowAmount": { "type": "number", "format": "double" }, "flowUnits": { "type": "number", "format": "double" }, "cusip": { "type": "string" }, "ticker": { "type": "string" }, "security": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.Security" } }, "xml": { "name": "Transaction" }, "type": "object" }, "OAT.Integrations.ByAllAccounts.InvestmentOption": { "properties": { "fpId": { "type": "integer", "format": "int64" }, "id": { "type": "integer", "format": "int64" }, "accountId": { "type": "integer", "format": "int64" }, "unitPrice": { "type": "number", "format": "double" }, "priceDataAsOf": { "type": "string" }, "lastUpdated": { "type": "string" }, "name": { "type": "string" }, "cusip": { "type": "string" }, "ticker": { "type": "string" }, "morningStarFundID": { "type": "string" }, "security": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.Security" } }, "xml": { "name": "InvestmentOption" }, "type": "object" }, "OAT.Integrations.ByAllAccounts.Person": { "properties": { "firmTag1": { "type": "string" }, "firmTag2": { "type": "string" }, "firmTag3": { "type": "string" }, "role": { "type": "string" }, "firstName": { "type": "string" }, "middleName": { "type": "string" }, "lastName": { "type": "string" }, "emailAddress": { "type": "string" }, "phone": { "type": "string" }, "taxId": { "type": "string" }, "isSso": { "type": "string" } }, "xml": { "name": "Person" }, "type": "object" }, "OAT.Integrations.ByAllAccounts.LoginItems": { "properties": { "username": { "type": "string" }, "personId": { "type": "string" }, "lastLoginDate": { "type": "string" } }, "xml": { "name": "LoginItems" }, "type": "object" }, "OAT.Integrations.ByAllAccounts.ProfileAccess": { "properties": { "personId": { "type": "integer", "format": "int64" }, "profileId": { "type": "integer", "format": "int64" }, "role": { "type": "string" }, "access": { "type": "string" } }, "xml": { "name": "ProfileAccess" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.ByAllAggregatedAccountDto": { "properties": { "baaId": { "type": "integer", "format": "int64" }, "baaAccountId": { "type": "integer", "format": "int64" }, "clientId": { "type": "integer", "format": "int32" }, "isLiability": { "type": "integer", "format": "int32" }, "accountName": { "type": "string" }, "accountValue": { "type": "number", "format": "double" } }, "xml": { "name": "ByAllAggregatedAccountDto" }, "type": "object" }, "OAT.Integrations.ByAllAccounts.DeleteAccountResponse": { "properties": { "version": { "type": "string" }, "loginResponse": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.LoginResponse" }, "body": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.DeleteAccountResponseBody" } }, "xml": { "name": "DeleteAccountResponse" }, "type": "object" }, "OAT.Integrations.ByAllAccounts.DeleteAccountResponseBody": { "properties": { "status": { "$ref": "#/definitions/OAT.Integrations.ByAllAccounts.Status" }, "fpId": { "type": "string" }, "id": { "type": "string" } }, "xml": { "name": "DeleteAccountResponseBody" }, "type": "object" }, "OAT.Integrations.Cetera.CeteraSFCaseDto": { "properties": { "caseNumber": { "type": "string" }, "ClientAccountNumber": { "type": "string" }, "UserIdentifier": { "type": "string" }, "requestType": { "type": "string" }, "requestSubType": { "type": "string" }, "description": { "type": "string" }, "status": { "readOnly": true, "type": "string" }, "recordType": { "readOnly": true, "type": "string" }, "queue": { "readOnly": true, "type": "string" }, "createdBy": { "readOnly": true, "type": "string" }, "integrationSource": { "readOnly": true, "type": "string" }, "ClientName": { "type": "string" }, "repCode": { "type": "string" }, "email": { "type": "string" }, "files": { "items": { "$ref": "#/definitions/OAT.Integrations.Cetera.CeteraSFCaseDtoFile" }, "xml": { "name": "CeteraSFCaseDtoFile", "wrapped": true }, "type": "array" } }, "xml": { "name": "CeteraSFCaseDto" }, "type": "object" }, "OAT.Integrations.Cetera.CeteraSFCaseDtoFile": { "properties": { "name": { "type": "string" }, "body": { "type": "string" }, "parentId": { "type": "string" }, "description": { "type": "string" } }, "xml": { "name": "CeteraSFCaseDtoFile" }, "type": "object" }, "OAS.DataProcess.Confirmation.Services.Cheetah.IntegrationConfig": { "properties": { "UserName": { "type": "string" }, "Password": { "type": "string" }, "ApiKey": { "type": "string" }, "BaseAddress": { "type": "string" } }, "xml": { "name": "IntegrationConfig" }, "type": "object" }, "OAS.WebApi.Domains.Integrations.CleverDomeController.IntegrationConfigDto": { "properties": { "cleverDomeUsername": { "type": "string" } }, "xml": { "name": "IntegrationConfigDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.ClientBoxFolderSetRequest": { "required": [ "clientId" ], "properties": { "clientId": { "type": "integer", "format": "int32" }, "boxFolderId": { "type": "string", "maxLength": 255, "minLength": 0 } }, "xml": { "name": "ClientBoxFolderSetRequest" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.ClientBoxFolderValidateRequest": { "required": [ "boxFolderId" ], "properties": { "boxFolderId": { "type": "string", "maxLength": 255, "minLength": 0 } }, "xml": { "name": "ClientBoxFolderValidateRequest" }, "type": "object" }, "OAS.DataProcess.DTO.Integration.Communities.CommunitiesStrategistAumReportRequestDto": { "properties": { "requestId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "asOfDate": { "type": "string", "format": "date-time" }, "strategistExternalIds": { "type": "string" }, "dataExportFiles": { "items": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integration.Communities.CommunitiesDataExportFileDto" }, "xml": { "name": "CommunitiesDataExportFileDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "CommunitiesStrategistAumReportRequestDto" }, "type": "object" }, "OAS.DataProcess.DTO.Integration.Communities.CommunitiesDataExportFileDto": { "properties": { "alClientId": { "type": "integer", "format": "int32" }, "fileId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "CommunitiesDataExportFileDto" }, "type": "object" }, "OAS.DataProcess.DTO.Integration.Communities.CommunitiesStrategistFlowReportRequestDto": { "properties": { "requestId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "strategistExternalIds": { "type": "string" }, "dataExportFiles": { "items": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integration.Communities.CommunitiesDataExportFileDto" }, "xml": { "name": "CommunitiesDataExportFileDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "CommunitiesStrategistFlowReportRequestDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Communities.CommunityModelDto": { "properties": { "modelId": { "type": "integer", "format": "int32" }, "communityModelId": { "type": "integer", "format": "int64" }, "communityModelName": { "type": "string" }, "targetRiskUpper": { "type": "number", "format": "double" }, "targetRiskLower": { "type": "number", "format": "double" }, "style": { "type": "string" }, "advisorFee": { "type": "number", "format": "double" }, "weightedAvgNetExpenses": { "type": "number", "format": "double" }, "currentRisk": { "type": "number", "format": "double" }, "minimumAmount": { "type": "number", "format": "double" }, "dateRebalanceRequested": { "type": "string", "format": "date-time" }, "lastRebalanceDate": { "type": "string", "format": "date-time" }, "needsRebalance": { "type": "boolean" }, "platFormId": { "type": "integer", "format": "int32" }, "shareClassId": { "type": "integer", "format": "int32" }, "notes": { "type": "string" }, "groupNum": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "strategistId": { "type": "integer", "format": "int32" }, "strategistName": { "type": "string" }, "modelManagerId": { "type": "integer", "format": "int32" }, "modelManagerName": { "type": "string" }, "name": { "type": "string" }, "isActive": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "modelCode": { "type": "string" }, "cashPerc": { "type": "integer", "format": "int32" }, "cashTol": { "type": "integer", "format": "int32" }, "fundList": { "type": "string" }, "modelNum": { "type": "integer", "format": "int32" }, "modelTol": { "type": "integer", "format": "int32" }, "isDynamic": { "type": "boolean" }, "modelType": { "type": "string" }, "percEquity": { "type": "integer", "format": "int32" }, "subAdvisorId": { "type": "integer", "format": "int32" }, "useRestrictions": { "type": "boolean" }, "fundName": { "type": "string" }, "class": { "type": "string" }, "managementStyle": { "type": "string" }, "custodian": { "type": "string" }, "subAdvisor": { "type": "string" }, "accountCount": { "type": "integer", "format": "int32" }, "aum": { "type": "number", "format": "double" }, "astroUsage": { "type": "string", "enum": [ "Undefined", "Disabled", "Restricted", "FullAccess" ] }, "opsTier": { "type": "string" }, "dateRebalanceExecutionRequested": { "type": "string", "format": "date-time" }, "benchmark": { "type": "string" }, "strategistExternalId": { "type": "integer", "format": "int32" } }, "xml": { "name": "CommunityModelDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Communities.CommunityModelWithDetailsDto": { "properties": { "items": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelItemFullDto" }, "xml": { "name": "ModelItemFullDto", "wrapped": true }, "type": "array" }, "modelId": { "type": "integer", "format": "int32" }, "communityModelId": { "type": "integer", "format": "int64" }, "communityModelName": { "type": "string" }, "targetRiskUpper": { "type": "number", "format": "double" }, "targetRiskLower": { "type": "number", "format": "double" }, "style": { "type": "string" }, "advisorFee": { "type": "number", "format": "double" }, "weightedAvgNetExpenses": { "type": "number", "format": "double" }, "currentRisk": { "type": "number", "format": "double" }, "minimumAmount": { "type": "number", "format": "double" }, "dateRebalanceRequested": { "type": "string", "format": "date-time" }, "lastRebalanceDate": { "type": "string", "format": "date-time" }, "needsRebalance": { "type": "boolean" }, "platFormId": { "type": "integer", "format": "int32" }, "shareClassId": { "type": "integer", "format": "int32" }, "notes": { "type": "string" }, "groupNum": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "strategistId": { "type": "integer", "format": "int32" }, "strategistName": { "type": "string" }, "modelManagerId": { "type": "integer", "format": "int32" }, "modelManagerName": { "type": "string" }, "name": { "type": "string" }, "isActive": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "modelCode": { "type": "string" }, "cashPerc": { "type": "integer", "format": "int32" }, "cashTol": { "type": "integer", "format": "int32" }, "fundList": { "type": "string" }, "modelNum": { "type": "integer", "format": "int32" }, "modelTol": { "type": "integer", "format": "int32" }, "isDynamic": { "type": "boolean" }, "modelType": { "type": "string" }, "percEquity": { "type": "integer", "format": "int32" }, "subAdvisorId": { "type": "integer", "format": "int32" }, "useRestrictions": { "type": "boolean" }, "fundName": { "type": "string" }, "class": { "type": "string" }, "managementStyle": { "type": "string" }, "custodian": { "type": "string" }, "subAdvisor": { "type": "string" }, "accountCount": { "type": "integer", "format": "int32" }, "aum": { "type": "number", "format": "double" }, "astroUsage": { "type": "string", "enum": [ "Undefined", "Disabled", "Restricted", "FullAccess" ] }, "opsTier": { "type": "string" }, "dateRebalanceExecutionRequested": { "type": "string", "format": "date-time" }, "benchmark": { "type": "string" }, "strategistExternalId": { "type": "integer", "format": "int32" } }, "xml": { "name": "CommunityModelWithDetailsDto" }, "type": "object" }, "OAS.DataModel.Integration.Communities.SimpleCommunityModel": { "properties": { "strategistId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "SimpleCommunityModel" }, "type": "object" }, "OAS.Eclipse.Lambda.Model.CommunitySyncMessageListOfOAS.Eclipse.Lambda.Model.CommunityModel": { "properties": { "data": { "items": { "$ref": "#/definitions/OAS.Eclipse.Lambda.Model.CommunityModel" }, "xml": { "name": "CommunityModel", "wrapped": true }, "type": "array" }, "orionBaseUrl": { "type": "string" }, "communitiesBaseUrl": { "type": "string" }, "strategist": { "$ref": "#/definitions/OAS.Eclipse.Lambda.Model.Strategist" }, "manager": { "$ref": "#/definitions/OAS.Eclipse.Lambda.Model.Manager" }, "orionFirmId": { "type": "integer", "format": "int32" }, "orionToken": { "type": "string" }, "userName": { "type": "string" }, "timeStamp": { "type": "string", "format": "date-time" }, "logId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "firmType": { "type": "integer", "format": "int32" }, "updateOrionConnect": { "type": "boolean" }, "tradeType": { "type": "integer", "format": "int32" }, "communitiesTradeQueueId": { "type": "integer", "format": "int32" } }, "xml": { "name": "CommunitySyncMessageList`1" }, "type": "object" }, "OAS.Eclipse.Lambda.Model.CommunityModel": { "properties": { "requiresRebalance": { "type": "boolean" }, "targetRiskUpper": { "type": "number", "format": "double" }, "targetRiskLower": { "type": "number", "format": "double" }, "style": { "type": "string" }, "advisorFee": { "type": "number", "format": "double" }, "weightedAvgNetExpenses": { "type": "number", "format": "double" }, "currentRisk": { "type": "number", "format": "double" }, "minimumAmount": { "type": "number", "format": "double" }, "strategistId": { "type": "integer", "format": "int32" }, "modelManagerId": { "type": "integer", "format": "int32" }, "modelAggTypeId": { "type": "integer", "format": "int32" }, "assetType": { "type": "string" }, "riskCategory": { "type": "string" }, "assetClass": { "type": "string" }, "strategyType": { "type": "string" }, "taxManaged": { "type": "boolean" }, "sociallyResponsible": { "type": "boolean" }, "morningStarTicker": { "type": "string" }, "morningstarProductId": { "type": "integer", "format": "int32" }, "mandate": { "type": "string" }, "investmentCategory": { "type": "string" }, "astroUsage": { "type": "integer", "format": "int32" }, "optionLevelApproval": { "type": "integer", "format": "int32" }, "allowAlternativeToleranceBands": { "type": "boolean" }, "allowOverlay": { "type": "boolean" }, "isDynamicSync": { "type": "boolean" }, "subAdvisorType": { "type": "string" }, "benchmark": { "type": "string" }, "researchedStatus": { "type": "string" }, "modelId": { "type": "integer", "format": "int32" }, "modelName": { "type": "string" }, "managementStyle": { "type": "string" }, "action": { "type": "string" }, "securities": { "items": { "$ref": "#/definitions/OAS.Eclipse.Lambda.Model.ModelItem" }, "xml": { "name": "ModelItem", "wrapped": true }, "type": "array" }, "accounts": { "items": { "$ref": "#/definitions/OAS.Eclipse.Lambda.Model.AssignedAccount" }, "xml": { "name": "AssignedAccount", "wrapped": true }, "type": "array" }, "isAstroEnabled": { "type": "boolean" }, "syncToAstro": { "type": "boolean" }, "communityModelId": { "type": "integer", "format": "int32" }, "sleeveSuffix": { "type": "string" }, "productTypes": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "orionConnectRiskCategory": { "type": "integer", "format": "int32" }, "orionConnectProductClass": { "type": "integer", "format": "int32" }, "isSma": { "type": "boolean" }, "astroTemplateId": { "type": "string" }, "altsManagedByStrategist": { "type": "boolean" }, "altsModelLevel": { "type": "boolean" }, "excludeRebalanceSleeve": { "type": "boolean" }, "modelTypeId": { "type": "integer", "format": "int32" }, "tags": { "items": { "type": "string" }, "type": "array" } }, "xml": { "name": "CommunityModel" }, "type": "object" }, "OAS.Eclipse.Lambda.Model.Strategist": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "abbreviation": { "type": "string" } }, "xml": { "name": "Strategist" }, "type": "object" }, "OAS.Eclipse.Lambda.Model.Manager": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "category": { "type": "string" }, "abbreviation": { "type": "string" } }, "xml": { "name": "Manager" }, "type": "object" }, "OAS.Eclipse.Lambda.Model.ModelItem": { "properties": { "ticker": { "type": "string" }, "orionConnectExternalId": { "type": "integer", "format": "int32" }, "targetPercent": { "type": "number", "format": "double" }, "upperTolerance": { "type": "number", "format": "double" }, "lowerTolerance": { "type": "number", "format": "double" }, "assetCategoryName": { "type": "string" }, "assetClassName": { "type": "string" }, "subClassName": { "type": "string" }, "tlhSecurities": { "items": { "$ref": "#/definitions/OAS.Eclipse.Lambda.Model.TLHSecurity" }, "xml": { "name": "TLHSecurity", "wrapped": true }, "type": "array" } }, "xml": { "name": "ModelItem" }, "type": "object" }, "OAS.Eclipse.Lambda.Model.AssignedAccount": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "orionAccountId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "orionConnectFirmId": { "type": "integer", "format": "int32" }, "portfolioId": { "type": "integer", "format": "int32" }, "modelAllocationSynchLevel": { "type": "string" } }, "xml": { "name": "AssignedAccount" }, "type": "object" }, "OAS.Eclipse.Lambda.Model.TLHSecurity": { "properties": { "productId": { "type": "integer", "format": "int32" } }, "xml": { "name": "TLHSecurity" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Communities.CommunitiesRebalanceRequestExecutionDto": { "properties": { "modelId": { "type": "integer", "format": "int32" }, "communityModelId": { "type": "integer", "format": "int32" }, "dateRebalanceExecutionRequested": { "type": "string", "format": "date-time" } }, "xml": { "name": "CommunitiesRebalanceRequestExecutionDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Communities.CommunityModelSimpleDto": { "properties": { "communityModelId": { "type": "integer", "format": "int64" }, "communityModelName": { "type": "string" }, "modelId": { "type": "integer", "format": "int32" }, "strategistId": { "type": "integer", "format": "int32" }, "strategistName": { "type": "string" } }, "xml": { "name": "CommunityModelSimpleDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.IntegrationConfigurationDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "integrationInfo": { "type": "string" }, "level": { "type": "string", "enum": [ "System", "Firm", "User", "UserProfile", "Client", "Custodian", "Rep" ] } }, "xml": { "name": "IntegrationConfigurationDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.ExternalIdEncryptionBackfillRequestDto": { "properties": { "appCode": { "type": "string" }, "level": { "type": "string", "enum": [ "System", "Firm", "User", "UserProfile", "Client", "Custodian", "Rep" ] }, "dryRun": { "type": "boolean" }, "maxRows": { "type": "integer", "format": "int32" }, "allFirms": { "type": "boolean" }, "alClientIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, "xml": { "name": "ExternalIdEncryptionBackfillRequestDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.CustodialIntegrator.PlaidAccountDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "plaidAccountId": { "type": "string" }, "secondaryAcctCode": { "type": "string" }, "institutionId": { "type": "string" }, "institutionName": { "type": "string" }, "isDisabled": { "type": "boolean" }, "accountName": { "type": "string" }, "accountType": { "type": "string" }, "isNotInSource": { "type": "boolean" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "PlaidAccountDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllTreatmentDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "fiId": { "type": "integer", "format": "int64" }, "byAllTreatmentTypeId": { "type": "integer", "format": "int32" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "treatmentTypeName": { "type": "string" }, "institutionName": { "type": "string" } }, "xml": { "name": "ByAllTreatmentDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllLocalSymbolDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "holdingId": { "type": "integer", "format": "int32" }, "securityId": { "type": "integer", "format": "int32" }, "ticker": { "type": "string" }, "fiId": { "type": "integer", "format": "int64" }, "webName": { "type": "string" }, "downloadSymbol": { "type": "string" }, "unitBalanceOverride": { "type": "number", "format": "double" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "institutionName": { "type": "string" } }, "xml": { "name": "ByAllLocalSymbolDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllOffsetSymbolDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "fI_ID": { "type": "integer", "format": "int64" }, "symbol": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "ByAllOffsetSymbolDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllTreatmentTypeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "treatmentName": { "type": "string" }, "treatmentDescription": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "ByAllTreatmentTypeDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllGlobalSymbolDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "securityId": { "type": "integer", "format": "int32" }, "ticker": { "type": "string" }, "fiId": { "type": "integer", "format": "int64" }, "webName": { "type": "string" }, "downloadSymbol": { "type": "string" }, "isTranslationBlocked": { "type": "boolean" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "institutionName": { "type": "string" } }, "xml": { "name": "ByAllGlobalSymbolDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.CustodialIntegrator.AkoyaGlobalSymbolDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "downloadSymbol": { "type": "string" }, "akoyaInstitutionId": { "type": "integer", "format": "int32" }, "akoyaInstitutionName": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "AkoyaGlobalSymbolDto" }, "type": "object" }, "OAS.DataModel.Integration.CustodialIntegrator.AkoyaInstitution": { "properties": { "id": { "type": "integer", "format": "int32" }, "fiName": { "type": "string" }, "fiId": { "type": "string" }, "isExcluded": { "type": "boolean" }, "alClientList": { "type": "string" }, "logo": { "type": "string", "format": "byte" }, "logoType": { "type": "string" }, "institutionOptionJSON": { "type": "string" } }, "xml": { "name": "AkoyaInstitution" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.CustodialIntegrator.PlaidNoteMappingDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "financialInstitutionId": { "type": "integer", "format": "int32" }, "institutionName": { "type": "string" }, "note": { "type": "string" }, "fileTransCode": { "type": "string" }, "replacementFileTransCode": { "type": "string" }, "priority": { "type": "integer", "format": "int32" }, "rationale": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "PlaidNoteMappingDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.CustodialIntegrator.PlaidUnitBalanceOverrideDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "connectionId": { "type": "integer", "format": "int32" }, "plaidAccountId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "effectiveDateRange": { "type": "string" }, "ticker": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "unitAmount": { "type": "number", "format": "double" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "PlaidUnitBalanceOverrideDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.CustodialIntegrator.AkoyaAccountDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "akoyaAccountId": { "type": "string" }, "accountType": { "type": "string" }, "displayName": { "type": "string" }, "secondaryAcctCode": { "type": "string" }, "accountNumber": { "type": "string" }, "isNotInSource": { "type": "boolean" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "institutionName": { "type": "string" }, "credentialId": { "type": "string" } }, "xml": { "name": "AkoyaAccountDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.CustodialIntegrator.AkoyaLogDto": { "properties": { "logId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "akoyaAccountId": { "type": "string" }, "accountNumber": { "type": "string" }, "accountType": { "type": "string" }, "displayName": { "type": "string" }, "institutionName": { "type": "string" }, "logMessage": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "correlationId": { "type": "string" }, "credentialId": { "type": "string" }, "isNotInSource": { "type": "boolean" }, "secondaryAcctCode": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "AkoyaLogDto" }, "type": "object" }, "OAS.DataModel.SimpleStringKeyEntity": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "xml": { "name": "SimpleStringKeyEntity" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllAccountDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int64" }, "financialProfileId": { "type": "integer", "format": "int64" }, "accountCode": { "type": "string" }, "secondaryAccountCode": { "type": "string" }, "lastUpdatedDateTime": { "type": "string", "format": "date-time" }, "clientFirstName": { "type": "string" }, "clientLastName": { "type": "string" }, "advisorFirstName": { "type": "string" }, "advisorLastName": { "type": "string" }, "fiId": { "type": "integer", "format": "int64" }, "accountName": { "type": "string" }, "maxByAllTransId": { "type": "integer", "format": "int64" }, "updateStatusErrorCode": { "type": "string" }, "updateStatusInfo": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "institutionName": { "type": "string" }, "hasAccountCode": { "type": "boolean" }, "isNotInSource": { "type": "boolean" }, "isBalanceOnly": { "type": "boolean" } }, "xml": { "name": "ByAllAccountDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.CustodialIntegrator.BackdateByAllAccountDto": { "properties": { "accounts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllAccountDto" }, "xml": { "name": "ByAllAccountDto", "wrapped": true }, "type": "array" }, "date": { "type": "string", "format": "date-time" } }, "xml": { "name": "BackdateByAllAccountDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.CustodialIntegrator.PlaidSecurityMappingDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "securityId": { "type": "integer", "format": "int32" }, "ticker": { "type": "string" }, "financialInstitutionId": { "type": "integer", "format": "int32" }, "institutionName": { "type": "string" }, "webName": { "type": "string" }, "downloadSymbol": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "PlaidSecurityMappingDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.CustodialIntegrator.ByAllNoteMappingDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "fiId": { "type": "integer", "format": "int64" }, "fileTransCode": { "type": "string" }, "note": { "type": "string" }, "replacementFileTransCode": { "type": "string" }, "rational": { "type": "string" }, "priority": { "type": "integer", "format": "int32" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "institutionName": { "type": "string" } }, "xml": { "name": "ByAllNoteMappingDto" }, "type": "object" }, "OAS.Integrations.DataTransmissionService.DTOs.FirmVendorInputDto": { "properties": { "clientId": { "type": "string" }, "clientSecret": { "type": "string" }, "username": { "type": "string" }, "isFirmUser": { "type": "boolean" } }, "xml": { "name": "FirmVendorInputDto" }, "type": "object" }, "OAS.Integrations.DataTransmissionService.VendorSsoContext": { "properties": { "memberId": { "type": "string" }, "accountId": { "type": "string" }, "accountNumber": { "type": "string" } }, "xml": { "name": "VendorSsoContext" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Docusign.DocusignAppLinkDtlDto": { "properties": { "appLinkDtl": { "type": "integer", "format": "int32" }, "info": { "$ref": "#/definitions/OAT.Integrations.DocuSign.Models.IntegrationInfo" }, "level": { "type": "string", "enum": [ "System", "Firm", "User", "UserProfile", "Client", "Custodian", "Rep" ] }, "refreshTokenExpired": { "type": "boolean" } }, "xml": { "name": "DocusignAppLinkDtlDto" }, "type": "object" }, "OAT.Integrations.DocuSign.Models.IntegrationInfo": { "properties": { "environmentUrl": { "type": "string" }, "name": { "type": "string" }, "access_token": { "type": "string" }, "token_type": { "type": "string" }, "refresh_token": { "type": "string" }, "expires_in": { "type": "string" }, "soboFlag": { "type": "boolean" }, "redirect_uri": { "type": "string" }, "secret": { "type": "string" }, "integratorKey": { "readOnly": true, "type": "string" } }, "xml": { "name": "IntegrationInfo" }, "type": "object" }, "OAT.Integrations.DocuSign.Models.LoginAccountContainer": { "properties": { "sub": { "type": "string" }, "name": { "type": "string" }, "given_name": { "type": "string" }, "family_name": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "email": { "type": "string" }, "accounts": { "items": { "$ref": "#/definitions/OAT.Integrations.DocuSign.Models.LoginAccount" }, "xml": { "name": "LoginAccount", "wrapped": true }, "type": "array" } }, "xml": { "name": "LoginAccountContainer" }, "type": "object" }, "OAT.Integrations.DocuSign.Models.LoginAccount": { "properties": { "account_id": { "type": "string" }, "is_default": { "type": "boolean" }, "account_name": { "type": "string" }, "base_uri": { "type": "string" } }, "xml": { "name": "LoginAccount" }, "type": "object" }, "OAT.Integrations.DocuSign.Models.Envelope": { "properties": { "envelopeId": { "type": "string" }, "status": { "type": "string" }, "documentsUri": { "type": "string" }, "recipientsUri": { "type": "string" }, "attachmentsUri": { "type": "string" }, "envelopeUri": { "type": "string" }, "createdDateTime": { "type": "string", "format": "date-time" }, "statusDateTime": { "type": "string", "format": "date-time" }, "lastModifiedDateTime": { "type": "string", "format": "date-time" }, "initialSentDateTime": { "type": "string", "format": "date-time" }, "sentDateTime": { "type": "string", "format": "date-time" }, "statusChangedDateTime": { "type": "string", "format": "date-time" } }, "xml": { "name": "Envelope" }, "type": "object" }, "OAS.DataModel.Integration.Docusign.DocusignEnvelope": { "required": [ "id", "auditedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "envelopeID": { "type": "string", "maxLength": 200, "minLength": 0 }, "entityId": { "type": "integer", "format": "int32" }, "entityEnum": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "status": { "type": "string", "maxLength": 20, "minLength": 0 }, "sentDate": { "type": "string", "format": "date-time" }, "completedDate": { "type": "string", "format": "date-time" }, "receivedJson": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "DocusignEnvelope" }, "type": "object" }, "OAT.Integrations.DocuSign.Models.EnvelopeResult": { "properties": { "ErrorCode": { "type": "integer", "format": "int32" }, "Message": { "type": "string" }, "ResultData": { "type": "string" } }, "xml": { "name": "EnvelopeResult" }, "type": "object" }, "OAS.Integrations.Eclipse.EclipseInitV2ImportOnEclipseRequest": { "required": [ "firmId", "isFullExtract" ], "properties": { "firmId": { "type": "integer", "format": "int32" }, "isFullExtract": { "type": "boolean" } }, "xml": { "name": "EclipseInitV2ImportOnEclipseRequest" }, "type": "object" }, "OAS.Integrations.Eclipse.EclipseExtractRequestV2": { "required": [ "eclipseFirmIds", "importType" ], "properties": { "eclipseFirmIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "apiUri": { "type": "string" }, "correlationId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "importType": { "type": "string" }, "s3BucketPath": { "type": "string" }, "bucketName": { "type": "string" } }, "xml": { "name": "EclipseExtractRequestV2" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Eclipse.EclipseFirmDto": { "properties": { "eclipseFirmId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "syncDate": { "type": "string", "format": "date-time" }, "syncBy": { "type": "string" }, "syncStatus": { "type": "string" }, "canDelete": { "type": "boolean" }, "accountNameType": { "description": "Contains a value such as FullName or lastFirst which indicates how the account name\r\nis configured to be displayed.", "type": "string" }, "assetClassMapping": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Eclipse.AssetClassMapping", "description": "Contains the mapping definitions for AssetClasses which indicate how assets should be classified" } }, "xml": { "name": "EclipseFirmDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Eclipse.AssetClassMapping": { "properties": { "classMappingType": { "type": "string", "enum": [ "AssetCategory", "AssetClass", "RiskCategory" ] }, "subClassMappingType": { "type": "string", "enum": [ "AssetCategory", "AssetClass", "RiskCategory" ] }, "categoryMappingType": { "type": "string", "enum": [ "AssetCategory", "AssetClass", "RiskCategory" ] } }, "xml": { "name": "AssetClassMapping" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Eclipse.EclipseFirmWithAlClientDto": { "properties": { "alClients": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Eclipse.EclipseFirmAlClientDto" }, "xml": { "name": "EclipseFirmAlClientDto", "wrapped": true }, "type": "array" }, "eclipseFirmId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "syncDate": { "type": "string", "format": "date-time" }, "syncBy": { "type": "string" }, "syncStatus": { "type": "string" }, "canDelete": { "type": "boolean" }, "accountNameType": { "description": "Contains a value such as FullName or lastFirst which indicates how the account name\r\nis configured to be displayed.", "type": "string" }, "assetClassMapping": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Eclipse.AssetClassMapping", "description": "Contains the mapping definitions for AssetClasses which indicate how assets should be classified" } }, "xml": { "name": "EclipseFirmWithAlClientDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Eclipse.EclipseFirmAlClientDto": { "properties": { "pkEclipseFirmAlClient": { "type": "integer", "format": "int32" }, "eclipseFirmId": { "type": "integer", "format": "int32" }, "fkAlClient": { "type": "integer", "format": "int32" }, "isDefault": { "type": "boolean" }, "isDefaultEclipseFirm": { "type": "boolean" }, "accountPrefix": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "EclipseFirmAlClientDto" }, "type": "object" }, "OAS.WebApi.DTO.Interface.IEclipseFirmWithAlClients": { "properties": { "alClients": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Eclipse.EclipseFirmAlClientDto" }, "xml": { "name": "EclipseFirmAlClientDto", "wrapped": true }, "type": "array" }, "eclipseFirmId": { "type": "integer", "format": "int32" }, "accountNameType": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "name": { "readOnly": true, "type": "string" }, "syncDate": { "type": "string", "format": "date-time" }, "syncBy": { "type": "string" }, "syncStatus": { "type": "string" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "canDelete": { "readOnly": true, "type": "boolean" } }, "xml": { "name": "IEclipseFirmWithAlClients" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Eclipse.MyEclipseSetupDto": { "description": "Used by the \"My Eclipse Setup\" page to update certain\r\nEclipse-related fields in the context of a specific AlClient", "required": [ "selectedDefaultEclipseFirmId" ], "properties": { "targetAlClientId": { "description": "The alClient the update request is targeting\r\nThis will be validated against the firm the user is\r\ncurrently logged into.", "type": "integer", "format": "int32", "maximum": 2147483647, "minimum": 1 }, "selectedDefaultEclipseFirmId": { "description": "The Eclipse Firm ID of the firm that should be the defaul\r\nfor the TargetAlClient.", "type": "integer", "format": "int32" } }, "xml": { "name": "MyEclipseSetupDto" }, "type": "object" }, "OAS.Integrations.Eclipse.Model.EclipseCustodianInfo": { "properties": { "portfolioId": { "type": "integer", "format": "int32" }, "custodialAccountNumber": { "type": "string" }, "name": { "type": "string" }, "accounts": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseCustodianInfoAccount" }, "xml": { "name": "EclipseCustodianInfoAccount", "wrapped": true }, "type": "array" } }, "xml": { "name": "EclipseCustodianInfo" }, "type": "object" }, "OAS.Integrations.Eclipse.Model.EclipseCustodianInfoAccount": { "properties": { "accountName": { "type": "string" }, "accountType": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "externalId": { "type": "integer", "format": "int32" }, "tradingProgress": { "type": "boolean" }, "incompatibleAssets": { "type": "boolean" }, "hasInvestmentRestrictions": { "type": "boolean" }, "pendingModelChange": { "type": "string", "format": "date-time" }, "initialInvestmentOccured": { "type": "string", "format": "date-time" }, "lastRebalnceDate": { "type": "string", "format": "date-time" }, "accountLevel": { "type": "string" } }, "xml": { "name": "EclipseCustodianInfoAccount" }, "type": "object" }, "OAS.Integrations.Eclipse.Model.EclipseAccountToUpdatePortfolio": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "doNotTrade": { "type": "boolean" } }, "xml": { "name": "EclipseAccountToUpdatePortfolio" }, "type": "object" }, "OAS.Integrations.Eclipse.Model.EclipsePrivilege": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "code": { "type": "string" }, "isDeleted": { "type": "boolean" } }, "xml": { "name": "EclipsePrivilege" }, "type": "object" }, "OAS.Integrations.Eclipse.Model.EclipseUserPrivilege": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "canAdd": { "type": "boolean" }, "canUpdate": { "type": "boolean" }, "canRead": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "isDeleted": { "type": "boolean" } }, "xml": { "name": "EclipseUserPrivilege" }, "type": "object" }, "OAS.Integrations.Eclipse.Model.EclipsePortfolio": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "model": { "type": "string" }, "managedValue": { "type": "number", "format": "double" }, "targetCash": { "type": "number", "format": "double" }, "currentCash": { "type": "number", "format": "double" }, "pendingCash": { "type": "number", "format": "double" }, "detail": { "type": "object" }, "accounts": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseAccount" }, "xml": { "name": "EclipseAccount", "wrapped": true }, "type": "array" } }, "xml": { "name": "EclipsePortfolio" }, "type": "object" }, "OAS.Integrations.Eclipse.Model.EclipseAccount": { "properties": { "id": { "type": "integer", "format": "int32" }, "accountId": { "type": "string" }, "name": { "type": "string" }, "accountNumber": { "type": "string" }, "custodian": { "type": "string" }, "accountType": { "type": "string" }, "model": { "type": "string" }, "style": { "type": "string" }, "managedValue": { "type": "number", "format": "double" }, "excludedValue": { "type": "number", "format": "double" }, "value": { "type": "number", "format": "double" }, "pendingValue": { "type": "number", "format": "double" }, "currentCash": { "type": "number", "format": "double" }, "targetCash": { "type": "number", "format": "double" }, "currentCashPercent": { "type": "number", "format": "double" }, "pendingCash": { "type": "number", "format": "double" }, "holdings": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseHolding" }, "xml": { "name": "EclipseHolding", "wrapped": true }, "type": "array" } }, "xml": { "name": "EclipseAccount" }, "type": "object" }, "OAS.Integrations.Eclipse.Model.EclipseHolding": { "properties": { "id": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "securityName": { "type": "string" }, "securitySymbol": { "type": "string" }, "securityId": { "type": "integer", "format": "int32" }, "price": { "type": "number", "format": "double" }, "shares": { "type": "number", "format": "double" }, "value": { "type": "number", "format": "double" }, "currentInPer": { "type": "number", "format": "double" }, "targetInPer": { "type": "number", "format": "double" }, "pendingShares": { "type": "number", "format": "double" }, "pendingValue": { "type": "number", "format": "double" }, "pendingInPer": { "type": "number", "format": "double" }, "excluded": { "type": "string" }, "inModel": { "type": "string" }, "isDeleted": { "type": "boolean" }, "isCash": { "type": "string" } }, "xml": { "name": "EclipseHolding" }, "type": "object" }, "OAS.Integrations.Eclipse.Model.EclipsePortfolioAllocation": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "currentInPercent": { "type": "number", "format": "double" }, "currentInAmt": { "type": "number", "format": "double" } }, "xml": { "name": "EclipsePortfolioAllocation" }, "type": "object" }, "OAS.Integrations.Eclipse.Models.EclipseV2PortfolioAllocationDto": { "properties": { "portfolioId": { "type": "integer", "format": "int32" }, "needAnalytics": { "type": "integer", "format": "int32" }, "failedReason": { "type": "string" }, "totalAUM": { "type": "number", "format": "double" }, "setAsideCash": { "type": "number", "format": "double" }, "reserveCash": { "type": "number", "format": "double" }, "reserveCashPercent": { "type": "number", "format": "double" }, "setAsideCashPercent": { "type": "number", "format": "double" }, "securities": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Models.EclipseSecurityDto" }, "xml": { "name": "EclipseSecurityDto", "wrapped": true }, "type": "array" }, "categories": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Models.EclipseModelCategoryDto" }, "xml": { "name": "EclipseModelCategoryDto", "wrapped": true }, "type": "array" }, "classes": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Models.EclipseModelClassDto" }, "xml": { "name": "EclipseModelClassDto", "wrapped": true }, "type": "array" }, "subClasses": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Models.EclipseModelSubClassDto" }, "xml": { "name": "EclipseModelSubClassDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "EclipseV2PortfolioAllocationDto" }, "type": "object" }, "OAS.Integrations.Eclipse.Models.EclipseSecurityDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "isMACSecurity": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "pendingInAmt": { "type": "number", "format": "double" }, "pendingInPercent": { "type": "number", "format": "double" }, "securityId": { "type": "integer", "format": "int32" }, "securitySetId": { "type": "integer", "format": "int32" }, "securitySetName": { "type": "string" }, "symbol": { "type": "string" }, "targetInAmt": { "type": "number", "format": "double" }, "targetInPercent": { "type": "number", "format": "double" }, "currentInAmt": { "type": "number", "format": "double" }, "currentInPercent": { "type": "number", "format": "double" }, "parentModelDetailId": { "type": "integer", "format": "int32" }, "smaLevel": { "type": "string" }, "modelElementId": { "type": "integer", "format": "int32" }, "isPortfolioSecurity": { "type": "boolean" }, "inTolerance": { "type": "boolean" } }, "xml": { "name": "EclipseSecurityDto" }, "type": "object" }, "OAS.Integrations.Eclipse.Models.EclipseModelCategoryDto": { "properties": { "categoryId": { "type": "integer", "format": "int32" }, "categoryName": { "type": "string" }, "pendingInAmount": { "type": "number", "format": "double" }, "pendingInPercent": { "type": "number", "format": "double" }, "targetInAmount": { "type": "number", "format": "double" }, "targetInPercent": { "type": "number", "format": "double" }, "currentInAmount": { "type": "number", "format": "double" }, "currentInPercent": { "type": "number", "format": "double" }, "accountId": { "type": "integer", "format": "int32" }, "aggregatedCurrentAmount": { "type": "number", "format": "double" }, "aggregatedCurrentPercent": { "type": "number", "format": "double" }, "aggregatedPostAmount": { "type": "number", "format": "double" }, "aggregatedPostPercent": { "type": "number", "format": "double" }, "effectiveTargetAmount": { "type": "number", "format": "double" }, "effectiveTargetPercentage": { "type": "number", "format": "double" }, "isMACSecurity": { "type": "integer", "format": "int64" }, "isSMANode": { "type": "integer", "format": "int64" }, "modelElementId": { "type": "integer", "format": "int32" }, "modelId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "nodeId": { "type": "integer", "format": "int64" }, "parentModelDetailId": { "type": "integer", "format": "int32" }, "portfolioId": { "type": "integer", "format": "int32" }, "relatedType": { "type": "string" }, "relatedTypeId": { "type": "integer", "format": "int64" }, "securityName": { "type": "string" }, "symbol": { "type": "string" }, "inTolerance": { "type": "boolean" } }, "xml": { "name": "EclipseModelCategoryDto" }, "type": "object" }, "OAS.Integrations.Eclipse.Models.EclipseModelClassDto": { "properties": { "classId": { "type": "integer", "format": "int32" }, "className": { "type": "string" }, "pendingInAmount": { "type": "number", "format": "double" }, "pendingInPercent": { "type": "number", "format": "double" }, "targetInAmount": { "type": "number", "format": "double" }, "targetInPercent": { "type": "number", "format": "double" }, "currentInAmount": { "type": "number", "format": "double" }, "currentInPercent": { "type": "number", "format": "double" }, "accountId": { "type": "integer", "format": "int32" }, "aggregatedCurrentAmount": { "type": "number", "format": "double" }, "aggregatedCurrentPercent": { "type": "number", "format": "double" }, "aggregatedPostAmount": { "type": "number", "format": "double" }, "aggregatedPostPercent": { "type": "number", "format": "double" }, "effectiveTargetAmount": { "type": "number", "format": "double" }, "effectiveTargetPercentage": { "type": "number", "format": "double" }, "isMACSecurity": { "type": "integer", "format": "int64" }, "isSMANode": { "type": "integer", "format": "int64" }, "modelElementId": { "type": "integer", "format": "int32" }, "modelId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "nodeId": { "type": "integer", "format": "int64" }, "parentModelDetailId": { "type": "integer", "format": "int32" }, "portfolioId": { "type": "integer", "format": "int32" }, "relatedType": { "type": "string" }, "relatedTypeId": { "type": "integer", "format": "int64" }, "securityName": { "type": "string" }, "symbol": { "type": "string" }, "inTolerance": { "type": "boolean" } }, "xml": { "name": "EclipseModelClassDto" }, "type": "object" }, "OAS.Integrations.Eclipse.Models.EclipseModelSubClassDto": { "properties": { "subClassId": { "type": "integer", "format": "int32" }, "subClassName": { "type": "string" }, "pendingInAmount": { "type": "number", "format": "double" }, "pendingInPercent": { "type": "number", "format": "double" }, "targetInAmount": { "type": "number", "format": "double" }, "targetInPercent": { "type": "number", "format": "double" }, "currentInAmount": { "type": "number", "format": "double" }, "currentInPercent": { "type": "number", "format": "double" }, "accountId": { "type": "integer", "format": "int32" }, "aggregatedCurrentAmount": { "type": "number", "format": "double" }, "aggregatedCurrentPercent": { "type": "number", "format": "double" }, "aggregatedPostAmount": { "type": "number", "format": "double" }, "aggregatedPostPercent": { "type": "number", "format": "double" }, "effectiveTargetAmount": { "type": "number", "format": "double" }, "effectiveTargetPercentage": { "type": "number", "format": "double" }, "isMACSecurity": { "type": "integer", "format": "int64" }, "isSMANode": { "type": "integer", "format": "int64" }, "modelElementId": { "type": "integer", "format": "int32" }, "modelId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "nodeId": { "type": "integer", "format": "int64" }, "parentModelDetailId": { "type": "integer", "format": "int32" }, "portfolioId": { "type": "integer", "format": "int32" }, "relatedType": { "type": "string" }, "relatedTypeId": { "type": "integer", "format": "int64" }, "securityName": { "type": "string" }, "symbol": { "type": "string" }, "inTolerance": { "type": "boolean" } }, "xml": { "name": "EclipseModelSubClassDto" }, "type": "object" }, "OAS.Integrations.Eclipse.Model.EclipseModelAllocation": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "symbol": { "type": "string" }, "targetInPercent": { "type": "number", "format": "double" } }, "xml": { "name": "EclipseModelAllocation" }, "type": "object" }, "OAS.Integrations.Eclipse.Model.EclipseModel": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string" }, "nameSpace": { "type": "string" }, "statusId": { "type": "integer", "format": "int32" }, "status": { "type": "string" }, "currentStatusId": { "type": "integer", "format": "int32" }, "currentStatus": { "type": "string" }, "tags": { "type": "string" }, "ownerUserId": { "type": "integer", "format": "int32" }, "ownerUser": { "type": "string" }, "strategistId": { "type": "integer", "format": "int32" }, "rank": { "type": "integer", "format": "int32" }, "approvedBy": { "type": "integer", "format": "int32" }, "managementStyleId": { "type": "integer", "format": "int32" }, "managementStyle": { "type": "string" }, "isCommunityModel": { "type": "boolean" }, "byCommunity": { "type": "boolean" }, "communityModelId": { "type": "integer", "format": "int32" }, "isSubstitutedForSleeve": { "type": "boolean" }, "lastSyncDate": { "type": "string", "format": "date-time" }, "approvedByUserId": { "type": "integer", "format": "int32" }, "approvedByUser": { "type": "string" }, "isDynamic": { "type": "boolean" }, "isDeleted": { "type": "boolean" }, "createdOn": { "type": "string", "format": "date-time" }, "editedOn": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedBy": { "type": "string" }, "isSMA": { "type": "boolean" }, "teamIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "teamId": { "type": "integer", "format": "int32" }, "macStatus": { "type": "integer", "format": "int32" }, "modelDetail": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseModelDetail" }, "portfolioCount": { "type": "integer", "format": "int32" }, "sleeveCount": { "type": "integer", "format": "int32" }, "modelAUM": { "type": "number", "format": "double" }, "forcefulModelSave": { "type": "boolean" }, "updateOtherModels": { "type": "boolean" }, "isSleeved": { "type": "boolean" }, "targetPercentUpdated": { "type": "boolean" }, "substitutedModelId": { "type": "integer", "format": "int32" }, "substitutedFor": { "type": "integer", "format": "int32" }, "astroEnabled": { "type": "boolean" }, "syncToAstro": { "type": "boolean" }, "astroUsage": { "type": "string", "enum": [ "Undefined", "Disabled", "Restricted", "FullAccess" ] }, "astroTemplateId": { "type": "string" } }, "xml": { "name": "EclipseModel" }, "type": "object" }, "OAS.Integrations.Eclipse.Model.EclipseModelDetail": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string" }, "modelDetailId": { "type": "integer", "format": "int32" }, "statusId": { "type": "integer", "format": "int32" }, "approvedByUserId": { "type": "integer", "format": "int32" }, "targetPercent": { "type": "number", "format": "double" }, "isCommunityModel": { "type": "boolean" }, "isDynamic": { "type": "boolean" }, "isDeleted": { "type": "boolean" }, "lowerModelTolerancePercent": { "type": "number", "format": "double" }, "upperModelTolerancePercent": { "type": "number", "format": "double" }, "toleranceTypeValue": { "type": "integer", "format": "int32" }, "rank": { "type": "integer", "format": "int32" }, "byCommunity": { "type": "boolean" }, "relatedType": { "type": "string" }, "relatedTypeId": { "type": "integer", "format": "int32" }, "lowerModelToleranceAmount": { "type": "number", "format": "double" }, "upperModelToleranceAmount": { "type": "number", "format": "double" }, "lowerTradeTolerancePercent": { "type": "number", "format": "double" }, "upperTradeTolerancePercent": { "type": "number", "format": "double" }, "isEdited": { "type": "boolean" }, "isSubstituted": { "type": "boolean" }, "substitutedOf": { "type": "integer", "format": "int32" }, "addedElements": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "modifiedElements": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "removedElements": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "isNewlySubstitutedNode": { "readOnly": true, "type": "boolean" }, "isEditSubstituted": { "readOnly": true, "type": "boolean" }, "modelDetail": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseModelDetail" }, "children": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseModelChild" }, "xml": { "name": "EclipseModelChild", "wrapped": true }, "type": "array" } }, "xml": { "name": "EclipseModelDetail" }, "type": "object" }, "OAS.Integrations.Eclipse.Model.EclipseModelChild": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "modelDetailId": { "type": "integer", "format": "int32" }, "modelTypeId": { "type": "integer", "format": "int32" }, "targetPercent": { "type": "number", "format": "double" }, "lowerModelTolerancePercent": { "type": "number", "format": "double" }, "upperModelTolerancePercent": { "type": "number", "format": "double" }, "toleranceTypeValue": { "type": "integer", "format": "int32" }, "rank": { "type": "integer", "format": "int32" }, "lowerModelToleranceAmount": { "type": "number", "format": "double" }, "upperModelToleranceAmount": { "type": "number", "format": "double" }, "lowerTradeTolerancePercent": { "type": "number", "format": "double" }, "upperTradeTolerancePercent": { "type": "number", "format": "double" }, "isEdited": { "type": "boolean" }, "isSubstituted": { "type": "boolean" }, "substitutedOf": { "type": "integer", "format": "int32" }, "securityAsset": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipsSecurityAsset" }, "children": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseModelChild" }, "xml": { "name": "EclipseModelChild", "wrapped": true }, "type": "array" }, "addedElements": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "modifiedElements": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "removedElements": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "isNewlySubstitutedNode": { "type": "boolean" }, "isEditSubstituted": { "type": "boolean" } }, "xml": { "name": "EclipseModelChild" }, "type": "object" }, "OAS.Integrations.Eclipse.Model.EclipsSecurityAsset": { "properties": { "id": { "type": "integer", "format": "int32" }, "meId": { "type": "integer", "format": "int32" }, "color": { "type": "string" } }, "xml": { "name": "EclipsSecurityAsset" }, "type": "object" }, "OAS.Integrations.Eclipse.Model.EclipsePendingModel": { "properties": { "portfolioId": { "type": "integer", "format": "int32" }, "modelId": { "type": "integer", "format": "int32" }, "createdDate": { "type": "string", "format": "date-time" }, "model": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseModel" } }, "xml": { "name": "EclipsePendingModel" }, "type": "object" }, "OAS.Integrations.Eclipse.Model.EclipseSecurity": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "orionConnectExternalId": { "type": "integer", "format": "int32" }, "symbol": { "type": "string" }, "price": { "type": "number", "format": "double" }, "status": { "type": "string" }, "securityType": { "type": "string" }, "securityTypeId": { "type": "integer", "format": "int32" }, "assetCategoryId": { "type": "integer", "format": "int32" }, "assetClassId": { "type": "integer", "format": "int32" }, "assetSubClassId": { "type": "integer", "format": "int32" }, "custodialCash": { "type": "boolean" } }, "xml": { "name": "EclipseSecurity" }, "type": "object" }, "OAS.Integrations.Eclipse.Model.EclipseSettings": { "properties": { "rebalanceAllowWashSale": { "type": "boolean" }, "rebalanceAllowShortTermGain": { "type": "boolean" }, "rebalanceMinTradeAmount": { "type": "number", "format": "double" } }, "xml": { "name": "EclipseSettings" }, "type": "object" }, "OAS.Integrations.Eclipse.Model.EclipseTradeOrder": { "properties": { "id": { "type": "integer", "format": "int32" }, "tradeInstanceId": { "type": "integer", "format": "int32" }, "requestType": { "type": "string" }, "isEnabled": { "type": "boolean" }, "notes": { "type": "string" }, "errorMessage": { "type": "string" }, "orderCount": { "type": "number", "format": "double" }, "executeStatus": { "type": "string" }, "closeOrderCount": { "type": "number", "format": "double" }, "entity": { "type": "string" }, "openOrderCount": { "type": "number", "format": "double" }, "errorStatus": { "type": "boolean" }, "instanceDescription": { "type": "string" }, "orderQty": { "type": "number", "format": "double" }, "account": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.AccountSimple" }, "security": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.SecurityExtended" }, "cashValue": { "type": "number", "format": "double" }, "warningMessage": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "EclipseTradeOrder" }, "type": "object" }, "OAS.Integrations.Eclipse.Model.AccountSimple": { "properties": { "number": { "type": "string" }, "type": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "accountId": { "type": "string" }, "name": { "type": "string" }, "accountNumber": { "type": "string" }, "custodian": { "type": "string" }, "accountType": { "type": "string" }, "model": { "type": "string" }, "style": { "type": "string" }, "managedValue": { "type": "number", "format": "double" }, "excludedValue": { "type": "number", "format": "double" }, "value": { "type": "number", "format": "double" }, "pendingValue": { "type": "number", "format": "double" }, "currentCash": { "type": "number", "format": "double" }, "targetCash": { "type": "number", "format": "double" }, "currentCashPercent": { "type": "number", "format": "double" }, "pendingCash": { "type": "number", "format": "double" }, "holdings": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseHolding" }, "xml": { "name": "EclipseHolding", "wrapped": true }, "type": "array" } }, "xml": { "name": "AccountSimple" }, "type": "object" }, "OAS.Integrations.Eclipse.Model.SecurityExtended": { "properties": { "id": { "type": "integer", "format": "int32" }, "externalId": { "type": "integer", "format": "int32" }, "symbol": { "type": "string" }, "name": { "type": "string" }, "price": { "type": "number", "format": "float" }, "securityType": { "type": "string" }, "assetCategory": { "type": "string" }, "assetClass": { "type": "string" }, "subClass": { "type": "string" }, "maturityDate": { "type": "string" }, "isCustodialCash": { "type": "boolean" } }, "xml": { "name": "SecurityExtended" }, "type": "object" }, "OAS.Integrations.Eclipse.Model.EclipseTrade": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "portfolioId": { "type": "integer", "format": "int32" }, "actionId": { "type": "string" }, "securityId": { "type": "integer", "format": "int32" }, "symbol": { "type": "string" }, "dollarAmount": { "type": "number", "format": "double" }, "quantity": { "type": "number", "format": "double" }, "percentage": { "type": "number", "format": "double" }, "isSendImmediately": { "type": "boolean" } }, "xml": { "name": "EclipseTrade" }, "type": "object" }, "OAS.Integrations.Eclipse.EclipseAccountResponse": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "portfolio": { "type": "string" }, "portfolioId": { "type": "integer", "format": "int32" }, "accountId": { "type": "string" }, "restrictedPlanId": { "type": "integer", "format": "int32" }, "orionConnectFirmId": { "type": "integer", "format": "int32" }, "orionConnectExternalId": { "type": "integer", "format": "int32" }, "astroEnabled": { "type": "boolean" }, "isDoNotBuySell": { "type": "boolean" }, "needAnalyticsStatus": { "type": "string" }, "tags": { "type": "string" } }, "xml": { "name": "EclipseAccountResponse" }, "type": "object" }, "OAS.Integrations.Eclipse.Model.EclipseTradeValidateResponse": { "properties": { "message": { "type": "string" }, "tradeAmount": { "type": "number", "format": "double" }, "cashValuePostTrade": { "type": "number", "format": "double" }, "warningMessage": { "items": { "type": "string" }, "type": "array" } }, "xml": { "name": "EclipseTradeValidateResponse" }, "type": "object" }, "OAS.Integrations.Eclipse.Model.EclipseDistributionTrade": { "properties": { "selectedMethodId": { "type": "integer", "format": "int32" }, "raiseFullAmount": { "type": "boolean" }, "filterType": { "readOnly": true, "type": "string" }, "accounts": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseDistributionAccount" }, "xml": { "name": "EclipseDistributionAccount", "wrapped": true }, "type": "array" }, "sleevedPortfolios": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseDistributionSleevedPortfolios" }, "xml": { "name": "EclipseDistributionSleevedPortfolios", "wrapped": true }, "type": "array" }, "emphasiedAccounts": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseDistributionEmphasizedAccount" }, "xml": { "name": "EclipseDistributionEmphasizedAccount", "wrapped": true }, "type": "array" }, "reason": { "type": "string" }, "isSetAsideCash": { "readOnly": true, "type": "boolean" }, "isExcelImport": { "readOnly": true, "type": "boolean" } }, "xml": { "name": "EclipseDistributionTrade" }, "type": "object" }, "OAS.Integrations.Eclipse.Model.EclipseDistributionAccount": { "properties": { "id": { "type": "integer", "format": "int32" }, "amount": { "type": "number", "format": "double" } }, "xml": { "name": "EclipseDistributionAccount" }, "type": "object" }, "OAS.Integrations.Eclipse.Model.EclipseDistributionSleevedPortfolios": { "properties": { "id": { "type": "integer", "format": "int32" }, "amount": { "type": "number", "format": "double" } }, "xml": { "name": "EclipseDistributionSleevedPortfolios" }, "type": "object" }, "OAS.Integrations.Eclipse.Model.EclipseDistributionEmphasizedAccount": { "properties": { "id": { "type": "integer", "format": "int32" }, "node": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.EclipseDistributionEmphasizedNode" }, "xml": { "name": "EclipseDistributionEmphasizedNode", "wrapped": true }, "type": "array" } }, "xml": { "name": "EclipseDistributionEmphasizedAccount" }, "type": "object" }, "OAS.Integrations.Eclipse.Model.EclipseDistributionEmphasizedNode": { "properties": { "level": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "amount": { "type": "number", "format": "double" } }, "xml": { "name": "EclipseDistributionEmphasizedNode" }, "type": "object" }, "OAS.Integrations.Eclipse.Model.EclipseTradeOrderObject": { "properties": { "id": { "type": "integer", "format": "int32" }, "isEnabled": { "type": "boolean" }, "status": { "type": "string" }, "account": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.AccountSimple" }, "warningMessage": { "type": "string" }, "action": { "type": "string" }, "orderQty": { "type": "number", "format": "double" }, "tradePercent": { "type": "number", "format": "double" }, "cashValuePostTrade": { "type": "number", "format": "double" }, "estimateAmount": { "type": "number", "format": "double" }, "price": { "type": "number", "format": "double" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string" }, "instanceDescription": { "type": "string" }, "custodian": { "type": "string" }, "security": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Model.SecurityExtended" }, "cashValue": { "type": "number", "format": "double" }, "pendingUnits": { "type": "string" }, "tradePercentOfAccount": { "type": "number", "format": "double" }, "representativeName": { "type": "string" }, "currentModelName": { "type": "string" }, "handleInst": { "type": "string" }, "instanceId": { "type": "integer", "format": "int32" } }, "xml": { "name": "EclipseTradeOrderObject" }, "type": "object" }, "OAS.Integrations.Eclipse.Model.EclipseTradeMethod": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "EclipseTradeMethod" }, "type": "object" }, "OAS.Eclipse.Lambda.Model.EclipseSyncMessageListOfOAS.Eclipse.Lambda.Model.ModelEdit": { "properties": { "data": { "items": { "$ref": "#/definitions/OAS.Eclipse.Lambda.Model.ModelEdit" }, "xml": { "name": "ModelEdit", "wrapped": true }, "type": "array" }, "orionBaseUrl": { "type": "string" }, "eclipseBaseUrl": { "type": "string" }, "eclipseFirmId": { "type": "integer", "format": "int32" }, "orionFirmId": { "type": "integer", "format": "int32" }, "firmId": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "orionToken": { "type": "string" }, "eclipseToken": { "type": "string" }, "userName": { "type": "string" }, "orionUserDetailId": { "type": "integer", "format": "int32" }, "timeStamp": { "type": "string", "format": "date-time" }, "logId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "EclipseSyncMessageList`1" }, "type": "object" }, "OAS.Eclipse.Lambda.Model.ModelEdit": { "properties": { "modelId": { "type": "integer", "format": "int32" }, "modelName": { "type": "string" }, "managementStyle": { "type": "string" }, "action": { "type": "string" }, "securities": { "items": { "$ref": "#/definitions/OAS.Eclipse.Lambda.Model.ModelItem" }, "xml": { "name": "ModelItem", "wrapped": true }, "type": "array" }, "accounts": { "items": { "$ref": "#/definitions/OAS.Eclipse.Lambda.Model.AssignedAccount" }, "xml": { "name": "AssignedAccount", "wrapped": true }, "type": "array" }, "isAstroEnabled": { "type": "boolean" }, "syncToAstro": { "type": "boolean" }, "communityModelId": { "type": "integer", "format": "int32" }, "sleeveSuffix": { "type": "string" }, "productTypes": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "orionConnectRiskCategory": { "type": "integer", "format": "int32" }, "orionConnectProductClass": { "type": "integer", "format": "int32" }, "isSma": { "type": "boolean" }, "astroTemplateId": { "type": "string" }, "altsManagedByStrategist": { "type": "boolean" }, "altsModelLevel": { "type": "boolean" }, "excludeRebalanceSleeve": { "type": "boolean" }, "modelTypeId": { "type": "integer", "format": "int32" }, "tags": { "items": { "type": "string" }, "type": "array" } }, "xml": { "name": "ModelEdit" }, "type": "object" }, "OAS.Eclipse.Lambda.Model.EclipseSyncMessageListOfOAS.Eclipse.Lambda.Model.Trades": { "properties": { "data": { "items": { "$ref": "#/definitions/OAS.Eclipse.Lambda.Model.Trades" }, "xml": { "name": "Trades", "wrapped": true }, "type": "array" }, "orionBaseUrl": { "type": "string" }, "eclipseBaseUrl": { "type": "string" }, "eclipseFirmId": { "type": "integer", "format": "int32" }, "orionFirmId": { "type": "integer", "format": "int32" }, "firmId": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "orionToken": { "type": "string" }, "eclipseToken": { "type": "string" }, "userName": { "type": "string" }, "orionUserDetailId": { "type": "integer", "format": "int32" }, "timeStamp": { "type": "string", "format": "date-time" }, "logId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "EclipseSyncMessageList`1" }, "type": "object" }, "OAS.Eclipse.Lambda.Model.Trades": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "orionAccountId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "securityExternalId": { "type": "integer", "format": "int32" }, "securityName": { "type": "string" }, "securityTicker": { "type": "string" }, "securityPrice": { "type": "number", "format": "double" }, "tradesId": { "type": "integer", "format": "int32" }, "tradesCreatedDate": { "type": "string", "format": "date-time" }, "tradesEstAmount": { "type": "number", "format": "double" }, "tradesOrderQty": { "type": "number", "format": "double" }, "tradesAction": { "type": "string" }, "positionExternalId": { "type": "integer", "format": "int32" }, "tradesStatus": { "type": "string" }, "description": { "type": "string" }, "isTradeGeneratedDuringJournalOnlyRebalance": { "type": "boolean" }, "tranLinkCode": { "type": "string" } }, "xml": { "name": "Trades" }, "type": "object" }, "OAS.Eclipse.Lambda.Model.EclipseSyncMessageListOfOAS.Eclipse.Lambda.Model.PendingTransactions": { "properties": { "data": { "items": { "$ref": "#/definitions/OAS.Eclipse.Lambda.Model.PendingTransactions" }, "xml": { "name": "PendingTransactions", "wrapped": true }, "type": "array" }, "orionBaseUrl": { "type": "string" }, "eclipseBaseUrl": { "type": "string" }, "eclipseFirmId": { "type": "integer", "format": "int32" }, "orionFirmId": { "type": "integer", "format": "int32" }, "firmId": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "orionToken": { "type": "string" }, "eclipseToken": { "type": "string" }, "userName": { "type": "string" }, "orionUserDetailId": { "type": "integer", "format": "int32" }, "timeStamp": { "type": "string", "format": "date-time" }, "logId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "EclipseSyncMessageList`1" }, "type": "object" }, "OAS.Eclipse.Lambda.Model.PendingTransactions": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "orionAccountId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "securityExternalId": { "type": "integer", "format": "int32" }, "securityName": { "type": "string" }, "securityTicker": { "type": "string" }, "securityPrice": { "type": "number", "format": "double" }, "tradesId": { "type": "integer", "format": "int32" }, "tradesCreatedDate": { "type": "string", "format": "date-time" }, "tradesEstAmount": { "type": "number", "format": "double" }, "tradesOrderQty": { "type": "number", "format": "double" }, "tradesAction": { "type": "string" }, "positionExternalId": { "type": "integer", "format": "int32" }, "tradesStatus": { "type": "string" }, "description": { "type": "string" }, "isTradeGeneratedDuringJournalOnlyRebalance": { "type": "boolean" }, "tranLinkCode": { "type": "string" } }, "xml": { "name": "PendingTransactions" }, "type": "object" }, "OAS.Eclipse.Lambda.Model.EclipseSyncMessageListOfSystem.Int32": { "properties": { "data": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "orionBaseUrl": { "type": "string" }, "eclipseBaseUrl": { "type": "string" }, "eclipseFirmId": { "type": "integer", "format": "int32" }, "orionFirmId": { "type": "integer", "format": "int32" }, "firmId": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "orionToken": { "type": "string" }, "eclipseToken": { "type": "string" }, "userName": { "type": "string" }, "orionUserDetailId": { "type": "integer", "format": "int32" }, "timeStamp": { "type": "string", "format": "date-time" }, "logId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "EclipseSyncMessageList`1" }, "type": "object" }, "OAS.Integrations.Eclipse.SleevedAccounts": { "properties": { "firmId": { "type": "integer", "format": "int32" }, "accounts": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.EclipseAccount" }, "xml": { "name": "EclipseAccount", "wrapped": true }, "type": "array" } }, "xml": { "name": "SleevedAccounts" }, "type": "object" }, "OAS.Integrations.Eclipse.EclipseAccount": { "properties": { "id": { "type": "integer", "format": "int32" }, "orionFirmId": { "type": "integer", "format": "int32" }, "externalId": { "type": "integer", "format": "int32" }, "accountId": { "type": "string" }, "accountNumber": { "type": "string" }, "accountName": { "type": "string" }, "portfolioId": { "type": "string" }, "portfolioName": { "type": "string" }, "householdId": { "type": "integer", "format": "int32" }, "householdName": { "type": "string" }, "accountType": { "type": "string" }, "taxable": { "type": "integer", "format": "int32" }, "accountYTDRealizedSTGL": { "type": "number", "format": "double" }, "accountYTDRealizedLTGL": { "type": "number", "format": "double" }, "sSN": { "type": "string" }, "sweepSymbol": { "type": "string" }, "sleeveType": { "type": "string" }, "sleeveTarget": { "type": "number", "format": "double" }, "sleeveTargetType": { "type": "integer", "format": "int32" }, "sleeveContributionPercent": { "type": "number", "format": "double" }, "sleeveDistributionPercent": { "type": "number", "format": "double" }, "sleeveToleranceLower": { "type": "number", "format": "double" }, "sleeveToleranceUpper": { "type": "number", "format": "double" }, "sMA": { "type": "boolean" }, "sMATradeable": { "type": "integer", "format": "int32" }, "billingAccount": { "type": "integer", "format": "int32" }, "systematicAmount": { "type": "number", "format": "double" }, "systematicDate": { "type": "string" }, "hashedSSN": { "type": "string" }, "sleeveStrategyName": { "type": "string" }, "sleeveContributionMethod": { "type": "integer", "format": "int32" }, "sleeveDistributionMethod": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "eclipseModelId": { "type": "integer", "format": "int32" }, "custodialAccountNumber": { "type": "string" }, "custodianName": { "type": "string" }, "advisorName": { "type": "string" }, "advisorExternalId": { "type": "integer", "format": "int32" }, "holdings": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Holding" }, "xml": { "name": "Holding", "wrapped": true }, "type": "array" }, "realizedGainLosses": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Realizedgainloss" }, "xml": { "name": "Realizedgainloss", "wrapped": true }, "type": "array" }, "securities": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Security" }, "xml": { "name": "Security", "wrapped": true }, "type": "array" }, "taxLots": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Taxlot" }, "xml": { "name": "Taxlot", "wrapped": true }, "type": "array" }, "transactions": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Transaction" }, "xml": { "name": "Transaction", "wrapped": true }, "type": "array" }, "doNotTrade": { "type": "integer", "format": "int32" }, "excludeRebalanceSleeve": { "type": "integer", "format": "int32" }, "monthlySystematicWithdrawal": { "type": "number", "format": "double" }, "nextMonthlySystematicWithdrawalDate": { "type": "string" }, "quarterlySystematicWithdrawal": { "type": "number", "format": "double" }, "nextQuarterlySystematicWithdrawalDate": { "type": "string" }, "semiAnnualSystematicWithdrawal": { "type": "number", "format": "double" }, "nextSemiAnnualSystematicWithdrawalDate": { "type": "string" }, "annualSystematicWithdrawal": { "type": "number", "format": "double" }, "nextAnnualSystematicWithdrawalDate": { "type": "string" }, "systematicPurchase": { "type": "number", "format": "double" }, "nextSystematicPurchaseDate": { "type": "string" }, "sleeveStrategyId": { "type": "string" }, "sleeveStrategyAggregateName": { "type": "string" }, "sleeveStrategyAggregateId": { "type": "string" }, "dcaAmount": { "type": "number", "format": "double" }, "dcaDate": { "type": "string" } }, "xml": { "name": "EclipseAccount" }, "type": "object" }, "OAS.Integrations.Eclipse.Holding": { "properties": { "externalId": { "type": "integer", "format": "int32" }, "symbol": { "type": "string" }, "price": { "type": "number", "format": "double" }, "marketValue": { "type": "number", "format": "double" }, "quantity": { "type": "number", "format": "double" }, "positionYTDRealizedSTGL": { "type": "number", "format": "double" }, "positionYTDRealizedLTGL": { "type": "number", "format": "double" } }, "xml": { "name": "Holding" }, "type": "object" }, "OAS.Integrations.Eclipse.Realizedgainloss": { "properties": { "externalId": { "type": "string" }, "symbol": { "type": "string" }, "grossProceeds": { "type": "number", "format": "double" }, "netProceeds": { "type": "number", "format": "double" }, "costAmount": { "type": "number", "format": "float" }, "dateAquired": { "type": "string" }, "sellDate": { "type": "string" }, "quantity": { "type": "number", "format": "float" }, "longTerm": { "type": "integer", "format": "int32" }, "sellMethod": { "type": "string" }, "totalGains": { "type": "number", "format": "double" } }, "xml": { "name": "Realizedgainloss" }, "type": "object" }, "OAS.Integrations.Eclipse.Security": { "properties": { "externalId": { "type": "integer", "format": "int32" }, "symbol": { "type": "string" }, "name": { "type": "string" }, "price": { "type": "number", "format": "float" }, "securityType": { "type": "string" }, "assetCategory": { "type": "string" }, "assetClass": { "type": "string" }, "subClass": { "type": "string" }, "maturityDate": { "type": "string" }, "isCustodialCash": { "type": "boolean" } }, "xml": { "name": "Security" }, "type": "object" }, "OAS.Integrations.Eclipse.Taxlot": { "properties": { "externalId": { "type": "string" }, "symbol": { "type": "string" }, "dateAcquired": { "type": "string" }, "quantity": { "type": "number", "format": "double" }, "costAmount": { "type": "number", "format": "double" }, "costPerShare": { "type": "number", "format": "double" }, "price": { "type": "number", "format": "double" }, "marketValue": { "type": "number", "format": "double" }, "priceDate": { "type": "string", "format": "date-time" }, "isLongTerm": { "type": "boolean" } }, "xml": { "name": "Taxlot" }, "type": "object" }, "OAS.Integrations.Eclipse.Transaction": { "properties": { "externalId": { "type": "integer", "format": "int32" }, "symbol": { "type": "string" }, "tradeDate": { "type": "string" }, "quantity": { "type": "number", "format": "double" }, "amount": { "type": "number", "format": "double" }, "type": { "type": "string" }, "action": { "type": "string" }, "tradeCost": { "type": "number", "format": "double" }, "eclipseTradeOrderId": { "type": "integer", "format": "int32" }, "status": { "type": "string" } }, "xml": { "name": "Transaction" }, "type": "object" }, "OAS.Eclipse.Lambda.Model.EclipseSyncMessageListOfOAS.Eclipse.Lambda.Model.ModelAssignment": { "properties": { "data": { "items": { "$ref": "#/definitions/OAS.Eclipse.Lambda.Model.ModelAssignment" }, "xml": { "name": "ModelAssignment", "wrapped": true }, "type": "array" }, "orionBaseUrl": { "type": "string" }, "eclipseBaseUrl": { "type": "string" }, "eclipseFirmId": { "type": "integer", "format": "int32" }, "orionFirmId": { "type": "integer", "format": "int32" }, "firmId": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "orionToken": { "type": "string" }, "eclipseToken": { "type": "string" }, "userName": { "type": "string" }, "orionUserDetailId": { "type": "integer", "format": "int32" }, "timeStamp": { "type": "string", "format": "date-time" }, "logId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "EclipseSyncMessageList`1" }, "type": "object" }, "OAS.Eclipse.Lambda.Model.ModelAssignment": { "properties": { "modelId": { "type": "integer", "format": "int32" }, "modelName": { "type": "string" }, "managementStyle": { "type": "string" }, "action": { "type": "string" }, "securities": { "items": { "$ref": "#/definitions/OAS.Eclipse.Lambda.Model.ModelItem" }, "xml": { "name": "ModelItem", "wrapped": true }, "type": "array" }, "accounts": { "items": { "$ref": "#/definitions/OAS.Eclipse.Lambda.Model.AssignedAccount" }, "xml": { "name": "AssignedAccount", "wrapped": true }, "type": "array" }, "isAstroEnabled": { "type": "boolean" }, "syncToAstro": { "type": "boolean" }, "communityModelId": { "type": "integer", "format": "int32" }, "sleeveSuffix": { "type": "string" }, "productTypes": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "orionConnectRiskCategory": { "type": "integer", "format": "int32" }, "orionConnectProductClass": { "type": "integer", "format": "int32" }, "isSma": { "type": "boolean" }, "astroTemplateId": { "type": "string" }, "altsManagedByStrategist": { "type": "boolean" }, "altsModelLevel": { "type": "boolean" }, "excludeRebalanceSleeve": { "type": "boolean" }, "modelTypeId": { "type": "integer", "format": "int32" }, "tags": { "items": { "type": "string" }, "type": "array" } }, "xml": { "name": "ModelAssignment" }, "type": "object" }, "OAS.Eclipse.Lambda.Model.EclipseSyncMessageListOfOAS.Eclipse.Lambda.Model.PortfolioAssignment": { "properties": { "data": { "items": { "$ref": "#/definitions/OAS.Eclipse.Lambda.Model.PortfolioAssignment" }, "xml": { "name": "PortfolioAssignment", "wrapped": true }, "type": "array" }, "orionBaseUrl": { "type": "string" }, "eclipseBaseUrl": { "type": "string" }, "eclipseFirmId": { "type": "integer", "format": "int32" }, "orionFirmId": { "type": "integer", "format": "int32" }, "firmId": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "orionToken": { "type": "string" }, "eclipseToken": { "type": "string" }, "userName": { "type": "string" }, "orionUserDetailId": { "type": "integer", "format": "int32" }, "timeStamp": { "type": "string", "format": "date-time" }, "logId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "EclipseSyncMessageList`1" }, "type": "object" }, "OAS.Eclipse.Lambda.Model.PortfolioAssignment": { "required": [ "orionFirmId", "clientId", "eclipsePortfolioId", "eclipsePortfolioName", "accounts" ], "properties": { "orionFirmId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "eclipsePortfolioId": { "type": "integer", "format": "int32" }, "eclipsePortfolioName": { "type": "string" }, "orionPortfolioGroupId": { "type": "integer", "format": "int32" }, "orionPortfolioGroupName": { "type": "string" }, "accounts": { "items": { "$ref": "#/definitions/OAS.Eclipse.Lambda.Model.PortfolioAssignmentAccount" }, "xml": { "name": "PortfolioAssignmentAccount", "wrapped": true }, "type": "array" } }, "xml": { "name": "PortfolioAssignment" }, "type": "object" }, "OAS.Eclipse.Lambda.Model.PortfolioAssignmentAccount": { "required": [ "eclipseAccountId", "orionAccountId" ], "properties": { "eclipseAccountId": { "type": "integer", "format": "int32" }, "orionAccountId": { "type": "integer", "format": "int32" } }, "xml": { "name": "PortfolioAssignmentAccount" }, "type": "object" }, "OAS.Eclipse.Lambda.Model.EclipseSyncMessageListOfOAS.Eclipse.Lambda.Model.UpdateDoNotTrade": { "properties": { "data": { "items": { "$ref": "#/definitions/OAS.Eclipse.Lambda.Model.UpdateDoNotTrade" }, "xml": { "name": "UpdateDoNotTrade", "wrapped": true }, "type": "array" }, "orionBaseUrl": { "type": "string" }, "eclipseBaseUrl": { "type": "string" }, "eclipseFirmId": { "type": "integer", "format": "int32" }, "orionFirmId": { "type": "integer", "format": "int32" }, "firmId": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "orionToken": { "type": "string" }, "eclipseToken": { "type": "string" }, "userName": { "type": "string" }, "orionUserDetailId": { "type": "integer", "format": "int32" }, "timeStamp": { "type": "string", "format": "date-time" }, "logId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "EclipseSyncMessageList`1" }, "type": "object" }, "OAS.Eclipse.Lambda.Model.UpdateDoNotTrade": { "properties": { "OrionConnectExternalId": { "type": "integer", "format": "int32" }, "EclipseAccountId.": { "type": "string" }, "IsTradeBlocked": { "type": "boolean" } }, "xml": { "name": "UpdateDoNotTrade" }, "type": "object" }, "OAS.Eclipse.Lambda.Model.EclipseSyncMessageListOfOAS.Eclipse.Lambda.Model.UpdateAccountSma": { "properties": { "data": { "items": { "$ref": "#/definitions/OAS.Eclipse.Lambda.Model.UpdateAccountSma" }, "xml": { "name": "UpdateAccountSma", "wrapped": true }, "type": "array" }, "orionBaseUrl": { "type": "string" }, "eclipseBaseUrl": { "type": "string" }, "eclipseFirmId": { "type": "integer", "format": "int32" }, "orionFirmId": { "type": "integer", "format": "int32" }, "firmId": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "orionToken": { "type": "string" }, "eclipseToken": { "type": "string" }, "userName": { "type": "string" }, "orionUserDetailId": { "type": "integer", "format": "int32" }, "timeStamp": { "type": "string", "format": "date-time" }, "logId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "EclipseSyncMessageList`1" }, "type": "object" }, "OAS.Eclipse.Lambda.Model.UpdateAccountSma": { "properties": { "OrionConnectExternalId": { "type": "integer", "format": "int32" }, "EclipseAccountId": { "type": "integer", "format": "int32" }, "AccountSmaDto": { "$ref": "#/definitions/OAS.Eclipse.Lambda.Model.AccountSmaDto" } }, "xml": { "name": "UpdateAccountSma" }, "type": "object" }, "OAS.Eclipse.Lambda.Model.AccountSmaDto": { "properties": { "isSma": { "type": "boolean" }, "eclipseSMA": { "type": "string", "enum": [ "False", "True", "FollowOrion" ] }, "smaAssetId": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "AccountSmaDto" }, "type": "object" }, "OAS.Eclipse.Lambda.Model.EclipseSyncMessageListOfOAS.Eclipse.Lambda.Model.TradeAnalysisReport": { "properties": { "data": { "items": { "$ref": "#/definitions/OAS.Eclipse.Lambda.Model.TradeAnalysisReport" }, "xml": { "name": "TradeAnalysisReport", "wrapped": true }, "type": "array" }, "orionBaseUrl": { "type": "string" }, "eclipseBaseUrl": { "type": "string" }, "eclipseFirmId": { "type": "integer", "format": "int32" }, "orionFirmId": { "type": "integer", "format": "int32" }, "firmId": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "orionToken": { "type": "string" }, "eclipseToken": { "type": "string" }, "userName": { "type": "string" }, "orionUserDetailId": { "type": "integer", "format": "int32" }, "timeStamp": { "type": "string", "format": "date-time" }, "logId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "EclipseSyncMessageList`1" }, "type": "object" }, "OAS.Eclipse.Lambda.Model.TradeAnalysisReport": { "properties": { "PortfolioId": { "type": "integer", "format": "int32" }, "PortfolioName": { "type": "string" }, "FirmId": { "type": "integer", "format": "int32" }, "householdIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "TradeAnalysisReportUrl": { "type": "string" } }, "xml": { "name": "TradeAnalysisReport" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Eclipse.EclipseAccountTradeInfoDto": { "properties": { "cashValue": { "type": "number", "format": "double" }, "cashValuePostTrade": { "type": "number", "format": "double" }, "minimumCashDollarAmount": { "type": "number", "format": "double" } }, "xml": { "name": "EclipseAccountTradeInfoDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.CurrentAccountModelDto": { "properties": { "currentPercent": { "type": "number", "format": "double" }, "currentValue": { "type": "number", "format": "double" }, "currentShares": { "type": "number", "format": "double" }, "productCategoryName": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "productClass": { "type": "string" }, "ticker": { "type": "string" }, "targetPercent": { "type": "number", "format": "double" }, "itemTol": { "type": "integer", "format": "int32" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "itemTolUpper": { "type": "number", "format": "double" }, "itemTolLower": { "type": "number", "format": "double" }, "oub": { "type": "number", "format": "double" }, "modelAggId": { "type": "integer", "format": "int32" }, "productRiskScore": { "type": "integer", "format": "int32" } }, "xml": { "name": "CurrentAccountModelDto" }, "type": "object" }, "OAS.WebApi.DTO.ValidateImport.ValidateOrderDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "action": { "type": "string" }, "ticker": { "type": "string" }, "dollars": { "type": "number", "format": "double" }, "shares": { "type": "number", "format": "double" }, "percent": { "type": "number", "format": "double" }, "productId": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "tradeType": { "type": "string", "enum": [ "Undefined", "Shares", "Dollars", "Percent" ] }, "navPrice": { "type": "number", "format": "double" }, "side": { "type": "string" }, "amount": { "type": "number", "format": "double" }, "exchangeTicker": { "type": "string" }, "exchangeProductId": { "type": "integer", "format": "int32" }, "cashTradeAmount": { "type": "number", "format": "double" }, "cashValuePostTrade": { "type": "number", "format": "double" }, "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" }, "warningMessage": { "type": "string" } }, "xml": { "name": "ValidateOrderDto" }, "type": "object" }, "OAS.Integrations.Element.Interfaces.RiskToleranceQuestionnaireRetakeDto": { "properties": { "clientSigners": { "items": { "$ref": "#/definitions/OAS.Integrations.Element.Interfaces.ClientSigner" }, "xml": { "name": "ClientSigner", "wrapped": true }, "type": "array" }, "entityId": { "type": "integer", "format": "int32" }, "entityType": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "oasToken": { "type": "string" } }, "xml": { "name": "RiskToleranceQuestionnaireRetakeDto" }, "type": "object" }, "OAS.Integrations.Element.Interfaces.ClientSigner": { "properties": { "email": { "type": "string" }, "name": { "type": "string" } }, "xml": { "name": "ClientSigner" }, "type": "object" }, "OAS.Integrations.Eclipse.Model.EclipseResponse": { "properties": { "status": { "type": "boolean" }, "message": { "type": "string" }, "entityId": { "type": "integer", "format": "int32" }, "platform": { "type": "string", "enum": [ "TOM", "Eclipse" ] } }, "xml": { "name": "EclipseResponse" }, "type": "object" }, "OAS.WebApi.Domains.Integrations.Element.ModelAggMinimal": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "subAdvisorId": { "type": "integer", "format": "int32" }, "subAdvisorName": { "type": "string" }, "riskScore": { "type": "number", "format": "double" }, "modelAggType": { "type": "string" }, "modelIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "modelAggTypeId": { "type": "integer", "format": "int32" }, "managementStyleId": { "type": "integer", "format": "int32" }, "minimumInvestmentAmount": { "type": "number", "format": "double" }, "isAstroEnabled": { "type": "boolean" }, "researchedStatus": { "type": "string" } }, "xml": { "name": "ModelAggMinimal" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Element.RiskScoreModelDto": { "properties": { "modelId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "isActive": { "type": "boolean" }, "subAdvisor": { "type": "integer", "format": "int32" }, "representative": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "eclipseModelId": { "type": "integer", "format": "int32" }, "modelAggId": { "type": "integer", "format": "int32" }, "parentId": { "type": "integer", "format": "int64" }, "riskScore": { "type": "integer", "format": "int32" }, "accounts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Element.RiskScoreModelAccountDto" }, "xml": { "name": "RiskScoreModelAccountDto", "wrapped": true }, "type": "array" }, "items": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Element.RiskScoreModelItemsDto" }, "xml": { "name": "RiskScoreModelItemsDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "RiskScoreModelDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Element.RiskScoreModelAccountDto": { "properties": { "name": { "type": "string" }, "value": { "type": "number", "format": "double" }, "registrationId": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "accountId": { "type": "integer", "format": "int32" } }, "xml": { "name": "RiskScoreModelAccountDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Element.RiskScoreModelItemsDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "itemTolUpper": { "type": "number", "format": "double" }, "itemTolLower": { "type": "number", "format": "double" }, "targetPercent": { "type": "number", "format": "double" } }, "xml": { "name": "RiskScoreModelItemsDto" }, "type": "object" }, "OAS.Integrations.Eclipse.Models.EclipsePreferenceResponse": { "properties": { "levelName": { "type": "string" }, "recordId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "preferenceId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "displayName": { "type": "string" }, "categoryType": { "type": "string" }, "securityPreferences": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Models.IndividualSecurityPreference" }, "xml": { "name": "IndividualSecurityPreference", "wrapped": true }, "type": "array" } }, "xml": { "name": "EclipsePreferenceResponse" }, "type": "object" }, "OAS.Integrations.Eclipse.Models.IndividualSecurityPreference": { "properties": { "alternatives": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "buyPriority": { "type": "integer", "format": "int32" }, "buyTradeMaxAmtBySecurity": { "type": "number", "format": "double" }, "buyTradeMaxPctBySecurity": { "type": "number", "format": "double" }, "buyTradeMinAmtBySecurity": { "type": "number", "format": "double" }, "buyTradeMinPctBySecurity": { "type": "number", "format": "double" }, "id": { "type": "integer", "format": "int32" }, "isAdd": { "type": "boolean" }, "isEdit": { "type": "boolean" }, "redemptionFeeAmount": { "type": "number", "format": "double" }, "redemptionFeeDays": { "type": "integer", "format": "int32" }, "redemptionFeeTypeId": { "type": "integer", "format": "int32" }, "securityName": { "type": "string" }, "securityType": { "type": "string" }, "sellPriority": { "type": "integer", "format": "int32" }, "sellTradeMaxAmtBySecurity": { "type": "number", "format": "double" }, "sellTradeMaxPctBySecurity": { "type": "number", "format": "double" }, "sellTradeMinAmtBySecurity": { "type": "number", "format": "double" }, "sellTradeMinPctBySecurity": { "type": "number", "format": "double" }, "symbol": { "type": "string" }, "taxableDivReInvest": { "type": "number", "format": "double" }, "taxDefDivReinvest": { "type": "number", "format": "double" }, "taxExemptDivReinvest": { "type": "number", "format": "double" }, "capGainReinvestTaxable": { "type": "number", "format": "double" }, "capGainsReinvestTaxExempt": { "type": "number", "format": "double" }, "capGainsReinvestTaxDef": { "type": "number", "format": "double" }, "sellTransactionFee": { "type": "number", "format": "double" }, "buyTransactionFee": { "type": "number", "format": "double" }, "custodianRedemptionFeeTypeId": { "type": "integer", "format": "int32" }, "custodianRedemptionDays": { "type": "integer", "format": "int32" }, "custodianRedemptionFeeAmount": { "type": "number", "format": "double" }, "custodianRedemptionFeeMinAmount": { "type": "number", "format": "double" }, "custodianRedemptionFeeMaxAmount": { "type": "number", "format": "double" }, "excludeHolding": { "type": "boolean" }, "tBuyPriority": { "type": "integer", "format": "int32" }, "tSellPriority": { "type": "integer", "format": "int32" }, "teBuyPriority": { "type": "integer", "format": "int32" }, "teSellPriority": { "type": "integer", "format": "int32" }, "tdBuyPriority": { "type": "integer", "format": "int32" }, "tdSellPriority": { "type": "integer", "format": "int32" }, "minInitialBuyAmount": { "type": "number", "format": "double" }, "tlh": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "doNotTLH": { "type": "boolean" }, "optionTradingDeltaMaxCalls": { "type": "integer", "format": "int32" }, "optionTradingDeltaMaxPuts": { "type": "integer", "format": "int32" }, "optionTradingDeltaMinCalls": { "type": "integer", "format": "int32" }, "optionTradingDeltaMinPuts": { "type": "integer", "format": "int32" }, "coveredCallPercent": { "type": "number", "format": "double" }, "protectivePutPercent": { "type": "number", "format": "double" }, "astroRestrictionMin": { "type": "integer", "format": "int32" }, "astroRestrictionMax": { "type": "integer", "format": "int32" }, "astroRestrictionType": { "type": "integer", "format": "int32" }, "taxableAlternate": { "type": "integer", "format": "int32" }, "taxDeferredAlternate": { "type": "integer", "format": "int32" }, "taxExemptAlternate": { "type": "integer", "format": "int32" }, "alternateCustodianId": { "type": "integer", "format": "int32" }, "custodianName": { "type": "string" }, "taxableSecurityId": { "type": "integer", "format": "int32" }, "taxableSecurity": { "type": "string" }, "taxDeferredSecurityId": { "type": "integer", "format": "int32" }, "taxExemptSecurityId": { "type": "integer", "format": "int32" }, "taxExemptSecurity": { "type": "string" }, "custodianSecuritySymbolId": { "type": "integer", "format": "int32" }, "optionsExpiringSoonDays": { "type": "integer", "format": "int32" }, "optionTradingStrikePrice": { "type": "number", "format": "double" }, "protectivePutCashPercent": { "type": "number", "format": "double" }, "redemptionFeeMaxAmount": { "type": "number", "format": "double" }, "redemptionFeeMinAmount": { "type": "number", "format": "double" }, "strikePriceMaxPercent": { "type": "number", "format": "double" } }, "xml": { "name": "IndividualSecurityPreference" }, "type": "object" }, "OAS.Integrations.Eclipse.Models.EclipsePreferenceRequest": { "properties": { "level": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "ids": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "securityPreferences": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Models.SecurityPreference" } }, "xml": { "name": "EclipsePreferenceRequest" }, "type": "object" }, "OAS.Integrations.Eclipse.Models.SecurityPreference": { "properties": { "id": { "type": "integer", "format": "int32" }, "isSetFromParent": { "type": "boolean" }, "preferenceId": { "type": "integer", "format": "int32" }, "resetToParent": { "type": "boolean" }, "addSecurities": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Models.IndividualSecurityPreference" }, "xml": { "name": "IndividualSecurityPreference", "wrapped": true }, "type": "array" }, "editSecurities": { "items": { "$ref": "#/definitions/OAS.Integrations.Eclipse.Models.IndividualSecurityPreference" }, "xml": { "name": "IndividualSecurityPreference", "wrapped": true }, "type": "array" }, "deleteSecurities": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, "xml": { "name": "SecurityPreference" }, "type": "object" }, "OAT.Integrations.eMoney.EmoneyUser": { "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string" }, "expires_in": { "type": "integer", "format": "int64" }, "expires_datetime": { "type": "string", "format": "date-time" } }, "xml": { "name": "EmoneyUser" }, "type": "object" }, "OAS.DataModel.Integration.Practifi.FocusUser": { "properties": { "enabled": { "type": "boolean" }, "userId": { "type": "integer", "format": "int32" } }, "xml": { "name": "FocusUser" }, "type": "object" }, "EchoTest.EchoResponse": { "properties": { "externalPrincipalIdentity": { "$ref": "#/definitions/EchoTest.ExternalPrincipalIdentity" }, "externalProcessingDirectives": { "$ref": "#/definitions/EchoTest.ExternalProcessingDirectives" }, "echoResponse1": { "$ref": "#/definitions/EchoTest.EchoResponseType" } }, "xml": { "name": "EchoResponse" }, "type": "object" }, "EchoTest.ExternalPrincipalIdentity": { "properties": { "b2BPartnerPrincipalId": { "type": "string" }, "requestorId": { "type": "string" }, "targetPrincipalId": { "type": "string" }, "thirdPartyPrincipalId": { "type": "string" }, "authMethod": { "type": "string" }, "authToken": { "type": "string" }, "securityTokens": { "items": { "$ref": "#/definitions/EchoTest.SecurityTokenType" }, "xml": { "name": "SecurityTokenType", "wrapped": true }, "type": "array" }, "principalDomain": { "type": "string" }, "principalRole": { "type": "string" }, "correspondentModel": { "type": "string" }, "marketSegment": { "type": "string" }, "scsCompanyId": { "type": "integer", "format": "int32" }, "scsCompanyIdSpecified": { "type": "boolean" }, "superBranch": { "type": "string" }, "branch": { "type": "string" }, "b2BUserAgent": { "type": "string" } }, "xml": { "name": "ExternalPrincipalIdentity" }, "type": "object" }, "EchoTest.ExternalProcessingDirectives": { "properties": { "logTrackingId": { "type": "string" }, "timeoutMillis": { "type": "integer", "format": "int32" }, "timeoutMillisSpecified": { "type": "boolean" } }, "xml": { "name": "ExternalProcessingDirectives" }, "type": "object" }, "EchoTest.EchoResponseType": { "properties": { "echo": { "type": "string" } }, "xml": { "name": "EchoResponseType" }, "type": "object" }, "EchoTest.SecurityTokenType": { "properties": { "tokenType": { "type": "string" }, "tokenValue": { "type": "string" } }, "xml": { "name": "SecurityTokenType" }, "type": "object" }, "OAT.Integrations.Fidelity.Classes.AccountBalanceResponse": { "properties": { "status": { "type": "string" }, "hasError": { "type": "boolean" }, "accountBalances": { "$ref": "#/definitions/OAT.Integrations.Fidelity.Classes.AccountBalancesDTO" } }, "xml": { "name": "AccountBalanceResponse" }, "type": "object" }, "OAT.Integrations.Fidelity.Classes.AccountBalancesDTO": { "properties": { "totalAccountValue": { "type": "number", "format": "double" }, "totalSecuritiesMarketValue": { "type": "number", "format": "double" }, "coreSweepFund": { "type": "number", "format": "double" }, "cashDebitCredit": { "type": "number", "format": "double" }, "cashMarketValue": { "type": "number", "format": "double" }, "settledCash": { "type": "number", "format": "double" }, "unsettledCashCredit": { "type": "number", "format": "double" }, "unsettledCashDebit": { "type": "number", "format": "double" }, "cashAvailableWithdraw": { "type": "number", "format": "double" }, "buyingPowerCashOnly": { "type": "number", "format": "double" } }, "xml": { "name": "AccountBalancesDTO" }, "type": "object" }, "OAT.Integrations.Fidelity.Classes.AccountHistoryResponse": { "properties": { "status": { "type": "string" }, "hasError": { "type": "boolean" }, "accountHistoryLst": { "items": { "$ref": "#/definitions/OAT.Integrations.Fidelity.Classes.AccountHistoryDTO" }, "xml": { "name": "AccountHistoryDTO", "wrapped": true }, "type": "array" } }, "xml": { "name": "AccountHistoryResponse" }, "type": "object" }, "OAT.Integrations.Fidelity.Classes.AccountHistoryDTO": { "properties": { "entrydate": { "type": "string", "format": "date-time" }, "tradedate": { "type": "string", "format": "date-time" }, "settledate": { "type": "string", "format": "date-time" }, "price": { "type": "number", "format": "double" }, "netAmount": { "type": "number", "format": "double" }, "secId": { "type": "string" }, "description": { "type": "string" }, "quantity": { "type": "number", "format": "double" }, "transactionType": { "type": "string" } }, "xml": { "name": "AccountHistoryDTO" }, "type": "object" }, "OAT.Integrations.Fidelity.Classes.AccountPositionsResponse": { "properties": { "status": { "type": "string" }, "hasError": { "type": "boolean" }, "accountPositionsLst": { "items": { "$ref": "#/definitions/OAT.Integrations.Fidelity.Classes.PositionsDTO" }, "xml": { "name": "PositionsDTO", "wrapped": true }, "type": "array" } }, "xml": { "name": "AccountPositionsResponse" }, "type": "object" }, "OAT.Integrations.Fidelity.Classes.PositionsDTO": { "properties": { "securityId": { "type": "string" }, "closingQuantity": { "type": "number", "format": "double" }, "closingPrice": { "type": "number", "format": "double" }, "cost": { "type": "number", "format": "double" }, "closingMarketValue": { "type": "number", "format": "double" }, "currencyCode": { "type": "string" }, "description": { "type": "string" } }, "xml": { "name": "PositionsDTO" }, "type": "object" }, "OAT.Integrations.Fidelity.Classes.ResultListOfOAT.Integrations.Fidelity.Classes.CurrentInvestorAlertsMessagesTypeDTO": { "properties": { "items": { "items": { "$ref": "#/definitions/OAT.Integrations.Fidelity.Classes.CurrentInvestorAlertsMessagesTypeDTO" }, "xml": { "name": "CurrentInvestorAlertsMessagesTypeDTO", "wrapped": true }, "type": "array" }, "hasError": { "type": "boolean" }, "status": { "type": "string" } }, "xml": { "name": "ResultList`1" }, "type": "object" }, "OAT.Integrations.Fidelity.Classes.CurrentInvestorAlertsMessagesTypeDTO": { "properties": { "messageId": { "type": "string" }, "classCode": { "type": "string" }, "classDesc": { "type": "string" }, "superCategoryCode": { "type": "string" }, "superCategoryDesc": { "type": "string" }, "categoryCode": { "type": "string" }, "categoryDesc": { "type": "string" }, "subCategoryCode": { "type": "string" }, "subCategoryDesc": { "type": "string" }, "userStatusCode": { "type": "string" }, "clientId": { "type": "string" }, "creationTmstmp": { "type": "string", "format": "date-time" }, "creationTmstmpSpecified": { "type": "boolean" }, "branchCode": { "type": "string" }, "regRep1Code": { "type": "string" }, "regRep2Code": { "type": "string" }, "agencyCode": { "type": "string" }, "gNum": { "type": "string" }, "acctNum": { "type": "string" }, "userActionCode": { "type": "string" }, "messageSubject": { "type": "string" }, "rowNum": { "type": "integer", "format": "int32" }, "rowNumSpecified": { "type": "boolean" }, "deepLink": { "type": "string" } }, "xml": { "name": "CurrentInvestorAlertsMessagesTypeDTO" }, "type": "object" }, "OAT.Integrations.Fidelity.Classes.ResultListOfOAT.Integrations.Fidelity.Classes.CurrentAlertsMessagesTypeDTO": { "properties": { "items": { "items": { "$ref": "#/definitions/OAT.Integrations.Fidelity.Classes.CurrentAlertsMessagesTypeDTO" }, "xml": { "name": "CurrentAlertsMessagesTypeDTO", "wrapped": true }, "type": "array" }, "hasError": { "type": "boolean" }, "status": { "type": "string" } }, "xml": { "name": "ResultList`1" }, "type": "object" }, "OAT.Integrations.Fidelity.Classes.CurrentAlertsMessagesTypeDTO": { "properties": { "messageSentTmstmpFieldSpecified": { "type": "boolean" }, "creationTmstmpFieldSpecified": { "type": "boolean" }, "messageId": { "type": "string" }, "associatedMessageId": { "type": "string" }, "requestorId": { "type": "string" }, "businessLineCode": { "type": "string" }, "classCode": { "type": "string" }, "classDesc": { "type": "string" }, "superCategoryCode": { "type": "string" }, "superCategoryDesc": { "type": "string" }, "categoryCode": { "type": "string" }, "categoryDesc": { "type": "string" }, "subCategoryCode": { "type": "string" }, "subCategoryDesc": { "type": "string" }, "userStatusCode": { "type": "string" }, "clientId": { "type": "string" }, "messageSentTmstmp": { "type": "string", "format": "date-time" }, "creationTmstmp": { "type": "string", "format": "date-time" }, "branchCode": { "type": "string" }, "regRep1Code": { "type": "string" }, "regRep2Code": { "type": "string" }, "agencyCode": { "type": "string" }, "gNum": { "type": "string" }, "acctNum": { "type": "string" }, "userActionCode": { "type": "string" }, "clientName": { "type": "string" }, "givingAcctNum": { "type": "string" }, "fbsiShortName": { "type": "string" }, "wcCustomShortName": { "type": "string" }, "accountOwner": { "type": "string" }, "groupName": { "type": "string" }, "itemNumber": { "type": "string" }, "productClass": { "type": "string" }, "deepLink": { "type": "string" } }, "xml": { "name": "CurrentAlertsMessagesTypeDTO" }, "type": "object" }, "OAT.Integrations.Fidelity.Classes.ResultListOfOAT.Integrations.Fidelity.Classes.SubscriberAlertMessagesCountDetailsTypeDTO": { "properties": { "items": { "items": { "$ref": "#/definitions/OAT.Integrations.Fidelity.Classes.SubscriberAlertMessagesCountDetailsTypeDTO" }, "xml": { "name": "SubscriberAlertMessagesCountDetailsTypeDTO", "wrapped": true }, "type": "array" }, "hasError": { "type": "boolean" }, "status": { "type": "string" } }, "xml": { "name": "ResultList`1" }, "type": "object" }, "OAT.Integrations.Fidelity.Classes.SubscriberAlertMessagesCountDetailsTypeDTO": { "properties": { "subscriberAlertMessagesCountResults": { "items": { "$ref": "#/definitions/OAT.Integrations.Fidelity.Classes.SubscriberAlertMessagesCountResultsType" }, "xml": { "name": "SubscriberAlertMessagesCountResultsType", "wrapped": true }, "type": "array" }, "requestorId": { "type": "string" }, "recipientTypeCode": { "type": "string" } }, "xml": { "name": "SubscriberAlertMessagesCountDetailsTypeDTO" }, "type": "object" }, "OAT.Integrations.Fidelity.Classes.SubscriberAlertMessagesCountResultsType": { "properties": { "classCode": { "type": "string" }, "superCategoryCode": { "type": "string" }, "categoryCode": { "type": "string" }, "subCategoryCode": { "type": "string" }, "unReadCount": { "type": "integer", "format": "int32" }, "unReadCountFieldSpecified": { "type": "boolean" } }, "xml": { "name": "SubscriberAlertMessagesCountResultsType" }, "type": "object" }, "OAT.Integrations.Fidelity.Classes.ResultItemOfOAT.Integrations.Fidelity.Classes.MessageCountDetailsDTO": { "properties": { "item": { "$ref": "#/definitions/OAT.Integrations.Fidelity.Classes.MessageCountDetailsDTO" }, "hasError": { "type": "boolean" }, "status": { "type": "string" } }, "xml": { "name": "ResultItem`1" }, "type": "object" }, "OAT.Integrations.Fidelity.Classes.MessageCountDetailsDTO": { "properties": { "totalMessageCount": { "type": "integer", "format": "int32" }, "totalMessageCountFieldSpecified": { "type": "boolean" }, "readMessageCount": { "type": "integer", "format": "int32" }, "readMessageCountFieldSpecified": { "type": "boolean" }, "unReadMessageCount": { "type": "integer", "format": "int32" }, "unReadMessageCountFieldSpecified": { "type": "boolean" }, "flaggedMessageCount": { "type": "integer", "format": "int32" }, "flaggedMessageCountFieldSpecified": { "type": "boolean" } }, "xml": { "name": "MessageCountDetailsDTO" }, "type": "object" }, "OAS.Integrations.FidelityDocuments.FidelityDocumentTokenInputDto": { "required": [ "firstName", "lastName", "dateOfBirth", "last4SSN" ], "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "dateOfBirth": { "type": "string", "format": "date-time" }, "last4SSN": { "type": "string" }, "userGuid": { "type": "string" } }, "xml": { "name": "FidelityDocumentTokenInputDto" }, "type": "object" }, "OAS.WebApi.Code.Integrations.FidelityPreGenInDto": { "properties": { "numberOfAccounts": { "type": "integer", "format": "int32" }, "repId": { "type": "integer", "format": "int32" }, "isRepSelf": { "readOnly": true, "type": "boolean" } }, "xml": { "name": "FidelityPreGenInDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.FinMason.MonteCarloInput": { "properties": { "id": { "type": "integer", "format": "int32" }, "assets": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.FinMason.AssetSummary" }, "xml": { "name": "AssetSummary", "wrapped": true }, "type": "array" }, "currentAge": { "type": "integer", "format": "int32" }, "retirementAge": { "type": "integer", "format": "int32" }, "deathAge": { "type": "integer", "format": "int32" }, "monthlyContributions": { "type": "number", "format": "double" }, "monthlyExpenses": { "type": "number", "format": "double" }, "expectedCashFlows": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.FinMason.ExpectedCashFlow" }, "xml": { "name": "ExpectedCashFlow", "wrapped": true }, "type": "array" } }, "xml": { "name": "MonteCarloInput" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.FinMason.AssetSummary": { "properties": { "shares": { "type": "number", "format": "double" }, "ticker": { "type": "string" }, "value": { "type": "number", "format": "double" }, "isCashOrEquivalent": { "type": "boolean" } }, "xml": { "name": "AssetSummary" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.FinMason.ExpectedCashFlow": { "properties": { "amount": { "type": "number", "format": "double" }, "cashFlowDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "ExpectedCashFlow" }, "type": "object" }, "OAS.Integrations.Flourish.Models.FlourishToken": { "properties": { "access_token": { "type": "string" }, "refresh_token": { "type": "string" }, "scope": { "type": "string" }, "token_type": { "type": "string" }, "code_verifier": { "type": "string" }, "expires_in": { "type": "integer", "format": "int32" }, "expires_datetime": { "type": "string", "format": "date-time" }, "error": { "type": "string" }, "flourish_tos_status": { "type": "string", "enum": [ "Unaccepted", "Accepted", "Rejected" ] }, "last_flourish_tos_interaction": { "type": "string", "format": "date-time" } }, "xml": { "name": "FlourishToken" }, "type": "object" }, "OAS.Integrations.Flourish.Models.Rates": { "properties": { "rateSchedules": { "items": { "$ref": "#/definitions/OAS.Integrations.Flourish.Models.Rateschedule" }, "xml": { "name": "Rateschedule", "wrapped": true }, "type": "array" } }, "xml": { "name": "Rates" }, "type": "object" }, "OAS.Integrations.Flourish.Models.Rateschedule": { "properties": { "fdicCoverage": { "type": "number", "format": "double" }, "fdicEffectiveDate": { "type": "string", "format": "date-time" }, "rateEffectiveDate": { "type": "string", "format": "date-time" }, "scheduleType": { "type": "string" }, "tiers": { "items": { "$ref": "#/definitions/OAS.Integrations.Flourish.Models.Tier" }, "xml": { "name": "Tier", "wrapped": true }, "type": "array" } }, "xml": { "name": "Rateschedule" }, "type": "object" }, "OAS.Integrations.Flourish.Models.Tier": { "properties": { "rangeBottom": { "type": "number", "format": "double" }, "rangeTop": { "type": "number", "format": "double" }, "rate": { "type": "number", "format": "double" } }, "xml": { "name": "Tier" }, "type": "object" }, "OAS.Integrations.Flourish.Models.EmailSearchRequest": { "properties": { "emails": { "items": { "type": "string" }, "type": "array" } }, "xml": { "name": "EmailSearchRequest" }, "type": "object" }, "OAS.Integrations.Flourish.Models.UserIdSearchRequest": { "properties": { "userIds": { "items": { "type": "string" }, "type": "array" } }, "xml": { "name": "UserIdSearchRequest" }, "type": "object" }, "OAS.Integrations.Flourish.Models.CreateUserRequest": { "properties": { "email": { "type": "string" }, "firstName": { "type": "string" }, "isCurrentAdvisoryClient": { "type": "boolean" }, "lastName": { "type": "string" }, "secondaryEmail": { "type": "string" }, "secondaryFirstName": { "type": "string" }, "secondaryLastName": { "type": "string" } }, "xml": { "name": "CreateUserRequest" }, "type": "object" }, "OAS.Integrations.Flourish.Models.ContactRequest": { "properties": { "contactData": { "$ref": "#/definitions/OAS.Integrations.Flourish.Models.Contactdata" }, "email": { "type": "string" }, "externalId": { "type": "string" }, "firstName": { "type": "string" }, "household": { "$ref": "#/definitions/OAS.Integrations.Flourish.Models.Household" }, "lastName": { "type": "string" } }, "xml": { "name": "ContactRequest" }, "type": "object" }, "OAS.Integrations.Flourish.Models.Contactdata": { "properties": { "alienResidencyStatus": { "type": "string" }, "annualIncome": { "type": "string" }, "citizenship": { "type": "string" }, "currentEmployerAddress": { "$ref": "#/definitions/OAS.Integrations.Flourish.Models.AddressObject" }, "currentEmployerName": { "type": "string" }, "dateOfBirth": { "type": "string" }, "employmentStatus": { "type": "string" }, "gender": { "type": "string" }, "hasFinraAffiliation": { "type": "boolean" }, "homePhone": { "type": "string" }, "liquidNetWorth": { "type": "string" }, "mailingAddress": { "$ref": "#/definitions/OAS.Integrations.Flourish.Models.AddressObject" }, "middleName": { "type": "string" }, "mobilePhone": { "type": "string" }, "occupation": { "type": "string" }, "otherPhone": { "type": "string" }, "primaryAddress": { "$ref": "#/definitions/OAS.Integrations.Flourish.Models.AddressObject" }, "primarySourceOfWealth": { "type": "string" }, "taxId": { "type": "string" }, "usePrimaryAddressAsMailingAddress": { "type": "boolean" }, "workPhone": { "type": "string" } }, "xml": { "name": "Contactdata" }, "type": "object" }, "OAS.Integrations.Flourish.Models.Household": { "properties": { "externalId": { "type": "string" }, "name": { "type": "string" } }, "xml": { "name": "Household" }, "type": "object" }, "OAS.Integrations.Flourish.Models.AddressObject": { "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "postalCode": { "type": "string" }, "state": { "type": "string", "enum": [ "AK", "AL", "AR", "AZ", "CA", "CO", "CT", "DC", "DE", "FL", "GA", "HI", "IA", "ID", "IL", "IN", "KS", "KY", "LA", "MA", "MD", "ME", "MI", "MN", "MO", "MS", "MT", "NC", "ND", "NE", "NH", "NJ", "NM", "NV", "NY", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VA", "VT", "WA", "WI", "WV", "WY" ] } }, "xml": { "name": "AddressObject" }, "type": "object" }, "OAS.Integrations.Flourish.Models.InviteAndApplyRequest": { "properties": { "email": { "type": "string" }, "firstName": { "type": "string" }, "isCurrentAdvisoryClient": { "type": "boolean" }, "lastName": { "type": "string" }, "primaryUserData": { "$ref": "#/definitions/OAS.Integrations.Flourish.Models.Primaryuserdata" }, "secondaryEmail": { "type": "string" }, "secondaryFirstName": { "type": "string" }, "secondaryLastName": { "type": "string" }, "secondaryUserData": { "$ref": "#/definitions/OAS.Integrations.Flourish.Models.Secondaryuserdata" } }, "xml": { "name": "InviteAndApplyRequest" }, "type": "object" }, "OAS.Integrations.Flourish.Models.Primaryuserdata": { "properties": { "alienResidencyStatus": { "type": "string" }, "annualIncome": { "type": "string" }, "citizenship": { "type": "string", "enum": [ "ABW", "AFG", "AGO", "AIA", "ALA", "ALB", "AND", "ARE", "ARG", "ARM", "ASM", "ATA", "ATF", "ATG", "AUS", "AUT", "AZE", "BDI", "BEL", "BEN", "BES", "BFA", "BGD", "BGR", "BHR", "BHS", "BIH", "BLM", "BLR", "BLZ", "BMU", "BOL", "BRA", "BRB", "BRN", "BTN", "BVT", "BWA", "CAF", "CAN", "CCK", "CHE", "CHL", "CHN", "CIV", "CMR", "COD", "COG", "COK", "COL", "COM", "CPV", "CRI", "CUB", "CUW", "CXR", "CYM", "CYP", "CZE", "DEU", "DJI", "DMA", "DNK", "DOM", "DZA", "ECU", "EGY", "ERI", "ESH", "ESP", "EST", "ETH", "FIN", "FJI", "FLK", "FRA", "FRO", "FSM", "GAB", "GBR", "GEO", "GGY", "GHA", "GIB", "GIN", "GLP", "GMB", "GNB", "GNQ", "GRC", "GRD", "GRL", "GTM", "GUF", "GUM", "GUY", "HKG", "HMD", "HND", "HRV", "HTI", "HUN", "IDN", "IMN", "IND", "IOT", "IRL", "IRN", "IRQ", "ISL", "ISR", "ITA", "JAM", "JEY", "JOR", "JPN", "KAZ", "KEN", "KGZ", "KHM", "KIR", "KNA", "KOR", "KWT", "LAO", "LBN", "LBR", "LBY", "LCA", "LIE", "LKA", "LSO", "LTU", "LUX", "LVA", "MAC", "MAF", "MAR", "MCO", "MDA", "MDG", "MDV", "MEX", "MHL", "MKD", "MLI", "MLT", "MMR", "MNE", "MNG", "MNP", "MOZ", "MRT", "MSR", "MTQ", "MUS", "MWI", "MYS", "MYT", "NAM", "NCL", "NER", "NFK", "NGA", "NIC", "NIU", "NLD", "NOR", "NPL", "NRU", "NZL", "OMN", "PAK", "PAN", "PCN", "PER", "PHL", "PLW", "PNG", "POL", "PRI", "PRK", "PRT", "PRY", "PSE", "PYF", "QAT", "REU", "ROU", "RUS", "RWA", "SAU", "SDN", "SEN", "SGP", "SGS", "SHN", "SJM", "SLB", "SLE", "SLV", "SMR", "SOM", "SPM", "SRB", "SSD", "STP", "SUR", "SVK", "SVN", "SWE", "SWZ", "SXM", "SYC", "SYR", "TCA", "TCD", "TGO", "THA", "TJK", "TKL", "TKM", "TLS", "TON", "TTO", "TUN", "TUR", "TUV", "TWN", "TZA", "UGA", "UKR", "UMI", "URY", "USA", "UZB", "VAT", "VCT", "VEN", "VGB", "VIR", "VNM", "VUT", "WLF", "WSM", "YEM", "ZAF", "ZMB", "ZWE" ] }, "currentEmployerAddress": { "$ref": "#/definitions/OAS.Integrations.Flourish.Models.AddressObjectNoCountry" }, "currentEmployerName": { "type": "string" }, "dateOfBirth": { "type": "string", "format": "date-time" }, "employmentStatus": { "type": "string" }, "gender": { "type": "string" }, "hasFinraAffiliation": { "type": "boolean" }, "homePhone": { "type": "string" }, "liquidNetWorth": { "type": "string" }, "mailingAddress": { "$ref": "#/definitions/OAS.Integrations.Flourish.Models.AddressObjectNoCountry" }, "middleName": { "type": "string" }, "mobilePhone": { "type": "string" }, "occupation": { "type": "string", "enum": [ "ACCOUNTING_PROFESSIONAL", "CLERICAL_ADMINISTRATIVE_SERVICES", "CONSULTANT", "EDUCATOR", "EXECUTIVE_SENIOR_MANAGEMENT", "FINANCIAL_SERVICES_BANKING_PROFESSIONAL", "FOREIGN_GOVERNMENT_EMPLOYEE_NON_US", "INFORMATION_TECHNOLOGY_PROFESSIONAL", "LEGAL_PROFESSIONAL", "MEDICAL_PROFESSIONAL", "MILITARY", "OTHER", "SALES_MARKETING", "TRADE_SERVICE_CAREER_LABOR_MANUFACTURING_PRODUCTION", "US_GOVERNMENT_EMPLOYEE_FEDERAL_STATE_LOCAL" ] }, "occupationOther": { "type": "string" }, "otherPhone": { "type": "string" }, "primaryAddress": { "$ref": "#/definitions/OAS.Integrations.Flourish.Models.AddressObjectNoCountry" }, "primarySourceOfWealth": { "type": "string", "enum": [ "FAMILY_RELATIVES_INHERITANCE", "GAMBLING_LOTTERY", "GIFTS", "INVESTMENT_CAPITAL_GAINS", "OTHER", "SALARY_WAGES", "SALE_OR_PROPERTY_BUSINESS", "SOCIAL_SECURITY_BENEFITS" ] }, "primarySourceOfWealthOther": { "type": "string" }, "reportingHouseholdId": { "type": "string" }, "taxId": { "type": "string" }, "usePrimaryAddressAsMailingAddress": { "type": "boolean" }, "workPhone": { "type": "string" } }, "xml": { "name": "Primaryuserdata" }, "type": "object" }, "OAS.Integrations.Flourish.Models.Secondaryuserdata": { "properties": { "alienResidencyStatus": { "type": "string" }, "annualIncome": { "type": "string" }, "citizenship": { "type": "string", "enum": [ "ABW", "AFG", "AGO", "AIA", "ALA", "ALB", "AND", "ARE", "ARG", "ARM", "ASM", "ATA", "ATF", "ATG", "AUS", "AUT", "AZE", "BDI", "BEL", "BEN", "BES", "BFA", "BGD", "BGR", "BHR", "BHS", "BIH", "BLM", "BLR", "BLZ", "BMU", "BOL", "BRA", "BRB", "BRN", "BTN", "BVT", "BWA", "CAF", "CAN", "CCK", "CHE", "CHL", "CHN", "CIV", "CMR", "COD", "COG", "COK", "COL", "COM", "CPV", "CRI", "CUB", "CUW", "CXR", "CYM", "CYP", "CZE", "DEU", "DJI", "DMA", "DNK", "DOM", "DZA", "ECU", "EGY", "ERI", "ESH", "ESP", "EST", "ETH", "FIN", "FJI", "FLK", "FRA", "FRO", "FSM", "GAB", "GBR", "GEO", "GGY", "GHA", "GIB", "GIN", "GLP", "GMB", "GNB", "GNQ", "GRC", "GRD", "GRL", "GTM", "GUF", "GUM", "GUY", "HKG", "HMD", "HND", "HRV", "HTI", "HUN", "IDN", "IMN", "IND", "IOT", "IRL", "IRN", "IRQ", "ISL", "ISR", "ITA", "JAM", "JEY", "JOR", "JPN", "KAZ", "KEN", "KGZ", "KHM", "KIR", "KNA", "KOR", "KWT", "LAO", "LBN", "LBR", "LBY", "LCA", "LIE", "LKA", "LSO", "LTU", "LUX", "LVA", "MAC", "MAF", "MAR", "MCO", "MDA", "MDG", "MDV", "MEX", "MHL", "MKD", "MLI", "MLT", "MMR", "MNE", "MNG", "MNP", "MOZ", "MRT", "MSR", "MTQ", "MUS", "MWI", "MYS", "MYT", "NAM", "NCL", "NER", "NFK", "NGA", "NIC", "NIU", "NLD", "NOR", "NPL", "NRU", "NZL", "OMN", "PAK", "PAN", "PCN", "PER", "PHL", "PLW", "PNG", "POL", "PRI", "PRK", "PRT", "PRY", "PSE", "PYF", "QAT", "REU", "ROU", "RUS", "RWA", "SAU", "SDN", "SEN", "SGP", "SGS", "SHN", "SJM", "SLB", "SLE", "SLV", "SMR", "SOM", "SPM", "SRB", "SSD", "STP", "SUR", "SVK", "SVN", "SWE", "SWZ", "SXM", "SYC", "SYR", "TCA", "TCD", "TGO", "THA", "TJK", "TKL", "TKM", "TLS", "TON", "TTO", "TUN", "TUR", "TUV", "TWN", "TZA", "UGA", "UKR", "UMI", "URY", "USA", "UZB", "VAT", "VCT", "VEN", "VGB", "VIR", "VNM", "VUT", "WLF", "WSM", "YEM", "ZAF", "ZMB", "ZWE" ] }, "currentEmployerAddress": { "$ref": "#/definitions/OAS.Integrations.Flourish.Models.AddressObjectNoCountry" }, "currentEmployerName": { "type": "string" }, "dateOfBirth": { "type": "string", "format": "date-time" }, "employmentStatus": { "type": "string" }, "gender": { "type": "string" }, "hasFinraAffiliation": { "type": "boolean" }, "homePhone": { "type": "string" }, "liquidNetWorth": { "type": "string" }, "mailingAddress": { "$ref": "#/definitions/OAS.Integrations.Flourish.Models.AddressObjectNoCountry" }, "middleName": { "type": "string" }, "mobilePhone": { "type": "string" }, "occupation": { "type": "string", "enum": [ "ACCOUNTING_PROFESSIONAL", "CLERICAL_ADMINISTRATIVE_SERVICES", "CONSULTANT", "EDUCATOR", "EXECUTIVE_SENIOR_MANAGEMENT", "FINANCIAL_SERVICES_BANKING_PROFESSIONAL", "FOREIGN_GOVERNMENT_EMPLOYEE_NON_US", "INFORMATION_TECHNOLOGY_PROFESSIONAL", "LEGAL_PROFESSIONAL", "MEDICAL_PROFESSIONAL", "MILITARY", "OTHER", "SALES_MARKETING", "TRADE_SERVICE_CAREER_LABOR_MANUFACTURING_PRODUCTION", "US_GOVERNMENT_EMPLOYEE_FEDERAL_STATE_LOCAL" ] }, "occupationOther": { "type": "string" }, "otherPhone": { "type": "string" }, "primaryAddress": { "$ref": "#/definitions/OAS.Integrations.Flourish.Models.AddressObjectNoCountry" }, "primarySourceOfWealth": { "type": "string", "enum": [ "FAMILY_RELATIVES_INHERITANCE", "GAMBLING_LOTTERY", "GIFTS", "INVESTMENT_CAPITAL_GAINS", "OTHER", "SALARY_WAGES", "SALE_OR_PROPERTY_BUSINESS", "SOCIAL_SECURITY_BENEFITS" ] }, "primarySourceOfWealthOther": { "type": "string" }, "reportingHouseholdId": { "type": "string" }, "taxId": { "type": "string" }, "usePrimaryAddressAsMailingAddress": { "type": "boolean" }, "workPhone": { "type": "string" } }, "xml": { "name": "Secondaryuserdata" }, "type": "object" }, "OAS.Integrations.Flourish.Models.AddressObjectNoCountry": { "properties": { "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "postalCode": { "type": "string" }, "state": { "type": "string", "enum": [ "AK", "AL", "AR", "AZ", "CA", "CO", "CT", "DC", "DE", "FL", "GA", "HI", "IA", "ID", "IL", "IN", "KS", "KY", "LA", "MA", "MD", "ME", "MI", "MN", "MO", "MS", "MT", "NC", "ND", "NE", "NH", "NJ", "NM", "NV", "NY", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VA", "VT", "WA", "WI", "WV", "WY" ] } }, "xml": { "name": "AddressObjectNoCountry" }, "type": "object" }, "OAS.Integrations.Flourish.Models.FlourishTosDto": { "properties": { "flourishTosStatus": { "type": "string", "enum": [ "Unaccepted", "Accepted", "Rejected" ] } }, "xml": { "name": "FlourishTosDto" }, "type": "object" }, "OAT.Integrations.FPAlpha.FPAlphaToken": { "properties": { "access_token": { "type": "string" }, "refresh_token": { "type": "string" }, "scope": { "type": "string" }, "token_type": { "type": "string" }, "expires_in": { "type": "integer", "format": "int32" }, "expires_datetime": { "type": "string", "format": "date-time" }, "created_at": { "type": "integer", "format": "int64" } }, "xml": { "name": "FPAlphaToken" }, "type": "object" }, "OAS.DataModel.Integration.HiddenLevers.PortfolioSyncAssetDto": { "properties": { "shares": { "type": "number", "format": "double" }, "price": { "type": "number", "format": "double" }, "value": { "type": "number", "format": "double" }, "productId": { "type": "integer", "format": "int32" }, "ticker": { "type": "string" }, "assetClass": { "type": "string" }, "isCustodialCash": { "type": "boolean" }, "accountId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "isin": { "type": "string" }, "productType": { "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, "productSubTypeId": { "type": "integer", "format": "int32" }, "productSubTypeName": { "type": "string" } }, "xml": { "name": "PortfolioSyncAssetDto" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.RiskProfile.RiskProfileV3Request": { "properties": { "allocationType": { "type": "string", "enum": [ "dollar", "qty", "pct" ] }, "portfolio": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.RiskProfileRequestProfileDto" }, "duration": { "type": "string", "enum": [ "_all", "_10yr", "_5yr", "_3yr", "_2yr", "_1yr", "_ytd", "_6mth", "_3mth", "_1mth", "_1wk" ] }, "options": { "items": { "type": "string" }, "type": "array" } }, "xml": { "name": "RiskProfileV3Request" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.RiskProfile.RiskProfileRequestProfileDto": { "properties": { "jsonPositions": { "items": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.RiskProfileRequestPositionDto" }, "xml": { "name": "RiskProfileRequestPositionDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "RiskProfileRequestProfileDto" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.RiskProfile.RiskProfileRequestPositionDto": { "properties": { "ticker": { "type": "string" }, "quantity": { "type": "number", "format": "double" } }, "xml": { "name": "RiskProfileRequestPositionDto" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.RiskProfile.RiskProfileV3Response": { "properties": { "portfolio": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.Portfolio" }, "benchmark": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.Benchmark" }, "correlations": { "items": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.Correlation" }, "xml": { "name": "Correlation", "wrapped": true }, "type": "array" } }, "xml": { "name": "RiskProfileV3Response" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.RiskProfile.Portfolio": { "properties": { "ccrScore": { "type": "number", "format": "double" }, "expectedReturn": { "type": "number", "format": "double" }, "expectedReturn5Yr": { "type": "number", "format": "double" }, "liquidity": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.Liquidity" }, "strategyFee": { "type": "number", "format": "double" }, "usePctAllocation": { "type": "string" }, "timeframe": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.Timeframe" }, "portStartDate": { "type": "string", "format": "date-time" }, "jsonPositions": { "items": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.JsonPosition" }, "xml": { "name": "JsonPosition", "wrapped": true }, "type": "array" }, "value": { "type": "number", "format": "double" }, "averageYield": { "type": "number", "format": "double" }, "feeAnalysis": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.FeeAnalysis" }, "timeframesp500Beta": { "type": "number", "format": "double" }, "pvh": { "items": { "type": "object" }, "type": "array" }, "leversToWatch": { "items": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.LeversToWatch" }, "xml": { "name": "LeversToWatch", "wrapped": true }, "type": "array" }, "riskMeasures": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.RiskMeasures" }, "mddstart": { "type": "string", "format": "date-time" }, "worstScenarioImpact": { "type": "number", "format": "double" }, "excludedSymbols": { "items": { "type": "object" }, "type": "array" }, "averageDuration": { "type": "number", "format": "double" }, "mpt": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.Mpt" }, "pctLiquid": { "type": "number", "format": "double" }, "famaFactors": { "items": { "type": "object" }, "type": "array" }, "analyzableValue": { "type": "number", "format": "double" }, "assetClasses": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.AssetClasses" }, "mddend": { "type": "string", "format": "date-time" } }, "xml": { "name": "Portfolio" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.RiskProfile.Benchmark": { "properties": { "expectedReturn": { "type": "number", "format": "double" }, "expectedReturn5Yr": { "type": "number", "format": "double" }, "liquidity": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.Liquidity" }, "strategyFee": { "type": "number", "format": "double" }, "usePctAllocation": { "type": "string" }, "timeframe": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.Timeframe" }, "portStartDate": { "type": "string", "format": "date-time" }, "jsonPositions": { "items": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.JsonPosition" }, "xml": { "name": "JsonPosition", "wrapped": true }, "type": "array" }, "id": { "type": "string" }, "value": { "type": "number", "format": "double" }, "feeAnalysis": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.FeeAnalysis" }, "timeframesp500Beta": { "type": "number", "format": "double" }, "pvh": { "items": { "type": "object" }, "type": "array" }, "leversToWatch": { "items": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.LeversToWatch" }, "xml": { "name": "LeversToWatch", "wrapped": true }, "type": "array" }, "riskMeasures": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.RiskMeasures" }, "isTickerWrapper": { "type": "string" }, "mddstart": { "type": "string", "format": "date-time" }, "worstScenarioImpact": { "type": "number", "format": "double" }, "excludedSymbols": { "items": { "type": "object" }, "type": "array" }, "assetType": { "type": "string" }, "mpt": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.Mpt" }, "industryid": { "type": "string" }, "name": { "type": "string" }, "pctLiquid": { "type": "number", "format": "double" }, "famaFactors": { "items": { "type": "object" }, "type": "array" }, "analyzableValue": { "type": "number", "format": "double" }, "assetClasses": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.AssetClasses" }, "mddend": { "type": "string", "format": "date-time" } }, "xml": { "name": "Benchmark" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.RiskProfile.Correlation": { "properties": { "correlation": { "type": "number", "format": "double" }, "ticker1": { "type": "string" }, "pvalue": { "type": "number", "format": "double" }, "ticker2": { "type": "string" }, "name2": { "type": "string" }, "name1": { "type": "string" } }, "xml": { "name": "Correlation" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.RiskProfile.Liquidity": { "properties": { "5y": { "type": "number", "format": "double" }, "3y": { "type": "number", "format": "double" }, "now": { "type": "number", "format": "double" }, "1y": { "type": "number", "format": "double" }, "3m": { "type": "number", "format": "double" }, "10y": { "type": "number", "format": "double" } }, "xml": { "name": "Liquidity" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.RiskProfile.Timeframe": { "properties": { "endDate": { "type": "string", "format": "date-time" }, "timeString": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "Timeframe" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.RiskProfile.JsonPosition": { "properties": { "pricedatemap": { "type": "string" }, "industry": { "type": "string" }, "liquidity": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.Liquidity" }, "volatility": { "type": "number", "format": "double" }, "type": { "type": "string" }, "firstHistory": { "type": "string", "format": "date-time" }, "indDesc": { "type": "string" }, "price": { "type": "number", "format": "double" }, "yield": { "type": "number", "format": "double" }, "lastGoodPrice": { "type": "number", "format": "double" }, "pctAllocation": { "type": "number", "format": "double" }, "marketCap": { "type": "number", "format": "double" }, "ticker": { "type": "string" }, "mgrStartDate": { "type": "string" }, "quantity": { "type": "number", "format": "double" }, "pricedate": { "type": "string" }, "mddstart": { "type": "string" }, "trueYield": { "type": "number", "format": "double" }, "tradedcurrencyid": { "type": "integer", "format": "int32" }, "expenseRatio": { "type": "number", "format": "double" }, "name": { "type": "string" }, "orionProductId": { "type": "integer", "format": "int32" }, "mddend": { "type": "string" }, "monthAgoValue": { "type": "number", "format": "double" }, "range": { "type": "number", "format": "double" }, "leverid": { "type": "integer", "format": "int32" }, "originalTicker": { "type": "string" }, "duration": { "type": "number", "format": "double" }, "value": { "type": "number", "format": "double" }, "impact2yr": { "type": "number", "format": "double" }, "yearAgoValue": { "type": "number", "format": "double" }, "stderror": { "type": "number", "format": "double" }, "impact": { "type": "number", "format": "double" }, "unit": { "type": "string" }, "leverdesc": { "type": "string" }, "levername": { "type": "string" }, "litype": { "type": "string" }, "bookValuePerShare": { "type": "number", "format": "double" } }, "xml": { "name": "JsonPosition" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.RiskProfile.FeeAnalysis": { "properties": { "totalPctFee": { "type": "number", "format": "double" }, "aumFee": { "type": "number", "format": "double" }, "expenseRatio": { "type": "number", "format": "double" }, "name": { "type": "string" }, "currency": { "type": "string" } }, "xml": { "name": "FeeAnalysis" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.RiskProfile.LeversToWatch": { "properties": { "operatingMargin": { "type": "number", "format": "double" }, "priceToEarnings": { "type": "number", "format": "double" }, "volatility": { "type": "number", "format": "double" }, "type": { "type": "string" }, "bookValuePerShare": { "type": "number", "format": "double" }, "revenue": { "type": "number", "format": "double" }, "price": { "type": "number", "format": "double" }, "marketCap": { "type": "number", "format": "double" }, "impact": { "type": "number", "format": "double" }, "eps": { "type": "number", "format": "double" }, "mdd": { "type": "number", "format": "double" }, "tags": { "type": "string" }, "unit": { "type": "string" }, "cashPerShare": { "type": "number", "format": "double" }, "name": { "type": "string" }, "payoutRatio": { "type": "number", "format": "double" }, "debt": { "type": "number", "format": "double" }, "monthAgoValue": { "type": "number", "format": "double" }, "range": { "type": "number", "format": "double" }, "industry": { "type": "string" }, "priceStartDate": { "type": "string", "format": "date-time" }, "pegRatio": { "type": "number", "format": "double" }, "yield": { "type": "number", "format": "double" }, "profitMargin": { "type": "number", "format": "double" }, "sharesOutstanding": { "type": "number", "format": "double" }, "value": { "type": "number", "format": "double" }, "ticker": { "type": "string" }, "portfolioImpact": { "type": "number", "format": "double" }, "yearAgoValue": { "type": "number", "format": "double" }, "avgVolume": { "type": "number", "format": "double" }, "returnOnAssets": { "type": "number", "format": "double" }, "trueYield": { "type": "number", "format": "double" }, "debtToEquity": { "type": "number", "format": "double" }, "jsonInfo": { "type": "string" }, "priceToSales": { "type": "number", "format": "double" }, "returnOnEquity": { "type": "number", "format": "double" }, "priceToBook": { "type": "number", "format": "double" }, "leverid": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "impact2yr": { "type": "number", "format": "double" }, "pricedate": { "type": "string", "format": "date-time" }, "stderror": { "type": "number", "format": "double" }, "leverdesc": { "type": "string" }, "levername": { "type": "string" }, "mddstart": { "type": "string", "format": "date-time" }, "mddend": { "type": "string", "format": "date-time" }, "tickerid": { "type": "integer", "format": "int32" }, "industryid": { "type": "integer", "format": "int32" }, "52wkChange": { "type": "number", "format": "double" }, "locationid": { "type": "integer", "format": "int32" }, "litype": { "type": "string" }, "orionProductId": { "type": "integer", "format": "int32" }, "mgrStartDate": { "type": "string", "format": "date-time" }, "expenseRatio": { "type": "number", "format": "double" }, "duration": { "type": "number", "format": "double" } }, "xml": { "name": "LeversToWatch" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.RiskProfile.RiskMeasures": { "properties": { "aumfee": { "type": "string" }, "sharperatio": { "type": "string" }, "annualizedReturn": { "type": "string" }, "totalReturn": { "type": "string" }, "yield": { "type": "string" }, "expenseRatio": { "type": "string" }, "volatility": { "type": "string" }, "mdd": { "type": "string" }, "sortinoRatio": { "type": "string" } }, "xml": { "name": "RiskMeasures" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.RiskProfile.Mpt": { "properties": { "styleRawBreakdown": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.StyleRawBreakdown" }, "avgCreditRating": { "type": "string" }, "fiCountries": { "items": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.FiCountry" }, "xml": { "name": "FiCountry", "wrapped": true }, "type": "array" }, "fiCouponDetails": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.FiCouponDetails" }, "fiMaturityBreakdown": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.FiMaturityBreakdown" }, "fiSectorDetails": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.FiSectorDetails" }, "fiRegions": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.FiRegions" }, "sectorBreakdown": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.SectorBreakdown" }, "avgCreditQuality": { "type": "number", "format": "double" }, "econBreakdown": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.EconBreakdown" }, "fiCreditBreakdown": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.FiCreditBreakdown" }, "regionBreakdown": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.RegionBreakdown" }, "avgWeightedCoupon": { "type": "number", "format": "double" }, "avgMaturity": { "type": "number", "format": "double" }, "mktCapBreakdown": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.MktCapBreakdown" }, "styleBoxBreakdown": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.StyleBoxBreakdown" }, "fiMaturityDetails": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.FiMaturityDetails" }, "fiSectorBreakdown": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.FiSectorBreakdown" } }, "xml": { "name": "Mpt" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.RiskProfile.AssetClasses": { "properties": { "detailed": { "items": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.Detailed" }, "xml": { "name": "Detailed", "wrapped": true }, "type": "array" }, "industry": { "items": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.Industry" }, "xml": { "name": "Industry", "wrapped": true }, "type": "array" }, "basic": { "items": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.RiskProfile.Basic" }, "xml": { "name": "Basic", "wrapped": true }, "type": "array" } }, "xml": { "name": "AssetClasses" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.RiskProfile.StyleRawBreakdown": { "properties": { "large-blend": { "type": "number", "format": "double" }, "mid-blend": { "type": "number", "format": "double" }, "small-blend": { "type": "number", "format": "double" }, "large-value": { "type": "number", "format": "double" }, "mid-value": { "type": "number", "format": "double" }, "small-value": { "type": "number", "format": "double" }, "large-growth": { "type": "number", "format": "double" }, "mid-growth": { "type": "number", "format": "double" }, "small-growth": { "type": "number", "format": "double" } }, "xml": { "name": "StyleRawBreakdown" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.RiskProfile.FiCountry": { "properties": { "country": { "type": "string" }, "value": { "type": "number", "format": "double" } }, "xml": { "name": "FiCountry" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.RiskProfile.FiCouponDetails": { "properties": { "0%": { "type": "number", "format": "double" }, "0-4%": { "type": "number", "format": "double" }, "4-6%": { "type": "number", "format": "double" }, "6-8%": { "type": "number", "format": "double" }, "8-10%": { "type": "number", "format": "double" }, "10-12%": { "type": "number", "format": "double" }, "Over 12%": { "type": "number", "format": "double" } }, "xml": { "name": "FiCouponDetails" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.RiskProfile.FiMaturityBreakdown": { "properties": { "Intermediate": { "type": "number", "format": "double" }, "Long": { "type": "number", "format": "double" }, "Less than 1 Year": { "type": "number", "format": "double" }, "Short": { "type": "number", "format": "double" } }, "xml": { "name": "FiMaturityBreakdown" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.RiskProfile.FiSectorDetails": { "properties": { "Non-Agency MBS": { "type": "number", "format": "double" }, "Cash Equivalent": { "type": "number", "format": "double" }, "Corporate Bond": { "type": "number", "format": "double" }, "Municipal": { "type": "number", "format": "double" }, "Convertible": { "type": "number", "format": "double" }, "Commercial MBS": { "type": "number", "format": "double" }, "Bank Loan": { "type": "number", "format": "double" }, "Agency MBS": { "type": "number", "format": "double" }, "Asset-Backed": { "type": "number", "format": "double" }, "US Treasury": { "type": "number", "format": "double" }, "Foreign Govt": { "type": "number", "format": "double" }, "Other": { "type": "number", "format": "double" }, "TIPS": { "type": "number", "format": "double" } }, "xml": { "name": "FiSectorDetails" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.RiskProfile.FiRegions": { "properties": { "None": { "type": "number", "format": "double" }, "Middle East + Africa": { "type": "number", "format": "double" }, "Europe": { "type": "number", "format": "double" }, "Supranational/Other": { "type": "number", "format": "double" }, "North America": { "type": "number", "format": "double" }, "Asia + Pacific": { "type": "number", "format": "double" }, "Latin America": { "type": "number", "format": "double" } }, "xml": { "name": "FiRegions" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.RiskProfile.SectorBreakdown": { "properties": { "Utilities": { "type": "number", "format": "double" }, "Energy": { "type": "number", "format": "double" }, "Consumer Staples": { "type": "number", "format": "double" }, "Technology": { "type": "number", "format": "double" }, "Real Estate": { "type": "number", "format": "double" }, "Materials": { "type": "number", "format": "double" }, "Financials": { "type": "number", "format": "double" }, "Communications": { "type": "number", "format": "double" }, "Healthcare": { "type": "number", "format": "double" }, "Industrials": { "type": "number", "format": "double" }, "Consumer Discretionary": { "type": "number", "format": "double" } }, "xml": { "name": "SectorBreakdown" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.RiskProfile.EconBreakdown": { "properties": { "US Stock": { "type": "number", "format": "double" }, "International Developed Markets": { "type": "number", "format": "double" }, "Emerging Markets": { "type": "number", "format": "double" } }, "xml": { "name": "EconBreakdown" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.RiskProfile.FiCreditBreakdown": { "properties": { "AAA": { "type": "number", "format": "double" }, "AA": { "type": "number", "format": "double" }, "A": { "type": "number", "format": "double" }, "BBB": { "type": "number", "format": "double" }, "BB": { "type": "number", "format": "double" }, "B": { "type": "number", "format": "double" }, "Below B / Unrated": { "type": "number", "format": "double" } }, "xml": { "name": "FiCreditBreakdown" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.RiskProfile.RegionBreakdown": { "properties": { "Middle East + Africa": { "type": "number", "format": "double" }, "Europe": { "type": "number", "format": "double" }, "North America": { "type": "number", "format": "double" }, "Asia + Pacific": { "type": "number", "format": "double" }, "Latin America": { "type": "number", "format": "double" } }, "xml": { "name": "RegionBreakdown" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.RiskProfile.MktCapBreakdown": { "properties": { "small": { "type": "number", "format": "double" }, "large": { "type": "number", "format": "double" }, "mid": { "type": "number", "format": "double" } }, "xml": { "name": "MktCapBreakdown" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.RiskProfile.StyleBoxBreakdown": { "properties": { "Blend": { "type": "number", "format": "double" }, "Growth": { "type": "number", "format": "double" }, "Value": { "type": "number", "format": "double" } }, "xml": { "name": "StyleBoxBreakdown" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.RiskProfile.FiMaturityDetails": { "properties": { "<1 Yr": { "type": "number", "format": "double" }, "1-3 Yrs": { "type": "number", "format": "double" }, "3-5 Yrs": { "type": "number", "format": "double" }, "5-7 Yrs": { "type": "number", "format": "double" }, "7-10 Yrs": { "type": "number", "format": "double" }, "10-15 Yrs": { "type": "number", "format": "double" }, "15-20 Yrs": { "type": "number", "format": "double" }, "20-30 Yrs": { "type": "number", "format": "double" }, "30+ Yrs": { "type": "number", "format": "double" } }, "xml": { "name": "FiMaturityDetails" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.RiskProfile.FiSectorBreakdown": { "properties": { "Government": { "type": "number", "format": "double" }, "Cash Equivalent": { "type": "number", "format": "double" }, "Corporate": { "type": "number", "format": "double" }, "Securitized": { "type": "number", "format": "double" }, "Other": { "type": "number", "format": "double" }, "Municipal": { "type": "number", "format": "double" } }, "xml": { "name": "FiSectorBreakdown" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.RiskProfile.Detailed": { "properties": { "pct": { "type": "number", "format": "double" }, "ticker": { "type": "string" }, "quantity": { "type": "number", "format": "double" }, "price": { "type": "number", "format": "double" }, "name": { "type": "string" } }, "xml": { "name": "Detailed" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.RiskProfile.Industry": { "properties": { "pct": { "type": "number", "format": "double" }, "ticker": { "type": "string" }, "quantity": { "type": "number", "format": "double" }, "price": { "type": "number", "format": "double" }, "name": { "type": "string" } }, "xml": { "name": "Industry" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.RiskProfile.Basic": { "properties": { "pct": { "type": "number", "format": "double" }, "ticker": { "type": "string" }, "quantity": { "type": "number", "format": "double" }, "price": { "type": "number", "format": "double" }, "name": { "type": "string" } }, "xml": { "name": "Basic" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.StressTest.StressTestV3Request": { "properties": { "allocationType": { "type": "string", "enum": [ "dollar", "qty", "pct" ] }, "portfolio": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.StressTest.StressTestRequestPortfolioDto" }, "scenarioIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "firmId": { "type": "string" }, "userId": { "type": "string" }, "firmNames": { "items": { "type": "string" }, "type": "array" } }, "xml": { "name": "StressTestV3Request" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.StressTest.StressTestRequestPortfolioDto": { "properties": { "jsonPositions": { "items": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.StressTest.StressTestREquestPositionDto" }, "xml": { "name": "StressTestREquestPositionDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "StressTestRequestPortfolioDto" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.StressTest.StressTestREquestPositionDto": { "properties": { "ticker": { "type": "string" }, "quantity": { "type": "number", "format": "double" } }, "xml": { "name": "StressTestREquestPositionDto" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.CreateClient.CreateClientRequest": { "properties": { "name": { "type": "string" }, "extClientId": { "type": "string" }, "source": { "type": "string" } }, "xml": { "name": "CreateClientRequest" }, "type": "object" }, "OAS.WebApi.Domains.Integrations.HiddenLeversClientDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "representativeId": { "type": "integer", "format": "int32" }, "riskScore": { "type": "number", "format": "double" }, "proposalPdf": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" } }, "xml": { "name": "HiddenLeversClientDto" }, "type": "object" }, "OAS.WebApi.Domains.Integrations.RiskRewardScoresDto": { "properties": { "downsidePerformance": { "type": "number", "format": "double" }, "upsidePerformance": { "type": "number", "format": "double" }, "potentialDownside": { "readOnly": true, "type": "number", "format": "double" }, "expectedReturn5yr": { "readOnly": true, "type": "number", "format": "double" }, "riskScore": { "type": "number", "format": "double" }, "aum": { "type": "number", "format": "double" } }, "xml": { "name": "RiskRewardScoresDto" }, "type": "object" }, "OAS.WebApi.Domains.Integrations.HiddenLeversNewProposal": { "properties": { "externalId": { "type": "integer", "format": "int32" }, "proposalName": { "type": "string" }, "repId": { "type": "integer", "format": "int32" }, "investmentAmount": { "type": "number", "format": "double" } }, "xml": { "name": "HiddenLeversNewProposal" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.Portfolio_Rep_Managed.RepManagedRequest": { "properties": { "caller": { "type": "string" }, "clientName": { "type": "string" }, "accountName": { "type": "string" }, "repName": { "type": "string" }, "repEmail": { "type": "string" }, "data": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.Portfolio_Rep_Managed.RepManagedRequest.Data" } }, "xml": { "name": "RepManagedRequest" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.Portfolio_Rep_Managed.RepManagedRequest.Data": { "properties": { "portfolio": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.Portfolio_Rep_Managed.RepManagedRequest.Portfolio" }, "securityRestrictions": { "items": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.Portfolio_Rep_Managed.RepManagedRequest.Securityrestriction" }, "xml": { "name": "Securityrestriction", "wrapped": true }, "type": "array" }, "sectors": { "items": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.Portfolio_Rep_Managed.RepManagedRequest.Sector" }, "xml": { "name": "Sector", "wrapped": true }, "type": "array" }, "esgRestrictions": { "items": { "type": "string" }, "type": "array" }, "capitalGains": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.Portfolio_Rep_Managed.RepManagedRequest.Capitalgains" }, "strategyName": { "type": "string" } }, "xml": { "name": "Data" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.Portfolio_Rep_Managed.RepManagedRequest.Portfolio": { "properties": { "jsonPositions": { "items": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.Portfolio_Rep_Managed.RepManagedRequest.Jsonposition" }, "xml": { "name": "Jsonposition", "wrapped": true }, "type": "array" } }, "xml": { "name": "Portfolio" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.Portfolio_Rep_Managed.RepManagedRequest.Securityrestriction": { "properties": { "name": { "type": "string" }, "ticker": { "type": "string" }, "restrictionType": { "type": "string" }, "minWeight": { "type": "number", "format": "float" }, "maxWeight": { "type": "number", "format": "float" } }, "xml": { "name": "Securityrestriction" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.Portfolio_Rep_Managed.RepManagedRequest.Sector": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "penalty": { "type": "integer", "format": "int32" }, "minimumValue": { "type": "integer", "format": "int32" }, "maximumValue": { "type": "integer", "format": "int32" }, "industries": { "items": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.Portfolio_Rep_Managed.RepManagedRequest.Industry" }, "xml": { "name": "Industry", "wrapped": true }, "type": "array" }, "active": { "type": "string" }, "minWeight": { "type": "integer", "format": "int32" }, "warning": { "type": "boolean" }, "maxWeight": { "type": "integer", "format": "int32" } }, "xml": { "name": "Sector" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.Portfolio_Rep_Managed.RepManagedRequest.Capitalgains": { "properties": { "shortGain": { "type": "number", "format": "float" }, "longGain": { "type": "integer", "format": "int32" }, "maxCapitalGains1": { "type": "integer", "format": "int32" }, "maxCapitalGains2": { "type": "integer", "format": "int32" }, "maxCapitalGains3": { "type": "integer", "format": "int32" } }, "xml": { "name": "Capitalgains" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.Portfolio_Rep_Managed.RepManagedRequest.Jsonposition": { "properties": { "quantity": { "type": "integer", "format": "int32" }, "ticker": { "type": "string" }, "taxlots": { "items": { "$ref": "#/definitions/OAT.Integrations.HiddenLevers.Dto.Portfolio_Rep_Managed.RepManagedRequest.Taxlot" }, "xml": { "name": "Taxlot", "wrapped": true }, "type": "array" } }, "xml": { "name": "Jsonposition" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.Portfolio_Rep_Managed.RepManagedRequest.Industry": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "penalty": { "type": "integer", "format": "int32" }, "minimumValue": { "type": "number", "format": "float" }, "maximumValue": { "type": "number", "format": "float" }, "sectorId": { "type": "string" } }, "xml": { "name": "Industry" }, "type": "object" }, "OAT.Integrations.HiddenLevers.Dto.Portfolio_Rep_Managed.RepManagedRequest.Taxlot": { "properties": { "purchaseDate": { "type": "string" }, "quantity": { "type": "number", "format": "float" }, "purchaseAmt": { "type": "number", "format": "float" } }, "xml": { "name": "Taxlot" }, "type": "object" }, "OAS.Integrations.Instream.InstreamAuthenticationTokenDto": { "properties": { "token": { "type": "string" }, "expiresIn": { "type": "integer", "format": "int32" }, "isBam": { "type": "boolean" } }, "xml": { "name": "InstreamAuthenticationTokenDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamProfileDto": { "properties": { "advisorDetails": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamAdvisorDto" }, "clientAdvisorsList": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamPersonDto" }, "xml": { "name": "InstreamPersonDto", "wrapped": true }, "type": "array" }, "clientDetails": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamClientDto" }, "communityContacts": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamPersonDto" }, "xml": { "name": "InstreamPersonDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "InstreamProfileDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamAdvisorDto": { "properties": { "advisorId": { "type": "integer", "format": "int32" }, "dob": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "personId": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" } }, "xml": { "name": "InstreamAdvisorDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamPersonDto": { "properties": { "peopleId": { "type": "integer", "format": "int32" }, "relationshipId": { "type": "integer", "format": "int32" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "dob": { "type": "string" }, "gender": { "type": "string" }, "appliesTo": { "type": "integer", "format": "int32" }, "appliesToType": { "type": "string" }, "relationshipType": { "type": "string" }, "addresses": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamAddressDto" }, "xml": { "name": "InstreamAddressDto", "wrapped": true }, "type": "array" }, "phoneNumbers": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamPhoneNumberDto" }, "xml": { "name": "InstreamPhoneNumberDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "InstreamPersonDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamClientDto": { "properties": { "addresses": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamAddressDto" }, "xml": { "name": "InstreamAddressDto", "wrapped": true }, "type": "array" }, "clientId": { "type": "integer", "format": "int32" }, "dob": { "type": "string" }, "dod": { "type": "string" }, "dor": { "type": "string" }, "emailAddresses": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamEmailAddressDto" }, "xml": { "name": "InstreamEmailAddressDto", "wrapped": true }, "type": "array" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "familyMembers": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamPersonDto" }, "xml": { "name": "InstreamPersonDto", "wrapped": true }, "type": "array" }, "householdId": { "type": "integer", "format": "int32" }, "phoneNumbers": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamPhoneNumberDto" }, "xml": { "name": "InstreamPhoneNumberDto", "wrapped": true }, "type": "array" }, "communityContacts": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamCommunityContactDto" }, "xml": { "name": "InstreamCommunityContactDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "InstreamClientDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamAddressDto": { "properties": { "addressId": { "type": "integer", "format": "int32" }, "addressLine": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" }, "postalCode": { "type": "string" }, "notes": { "type": "string" }, "objectScope": { "type": "string" } }, "xml": { "name": "InstreamAddressDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamPhoneNumberDto": { "properties": { "phoneNumberId": { "type": "integer", "format": "int32" }, "phoneNumber": { "type": "string" }, "phoneNumberType": { "type": "string" }, "preferred": { "type": "boolean" }, "note": { "type": "string" } }, "xml": { "name": "InstreamPhoneNumberDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamEmailAddressDto": { "properties": { "emailAddressId": { "type": "integer", "format": "int32" }, "emailAddress": { "type": "string" }, "emailAddressType": { "type": "string" }, "note": { "type": "string" }, "preferred": { "type": "boolean" }, "objectScope": { "type": "string" } }, "xml": { "name": "InstreamEmailAddressDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamCommunityContactDto": { "properties": { "addresses": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamAddressDto" }, "xml": { "name": "InstreamAddressDto", "wrapped": true }, "type": "array" }, "appliesTo": { "type": "integer", "format": "int32" }, "appliesToType": { "type": "string" }, "clientId": { "type": "integer", "format": "int32" }, "emailAddresses": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamEmailAddressDto" }, "xml": { "name": "InstreamEmailAddressDto", "wrapped": true }, "type": "array" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "contactId": { "type": "integer", "format": "int32" }, "contactType": { "type": "string" }, "contactTypeOtherValue": { "type": "string" }, "dob": { "type": "string" }, "gender": { "type": "string" }, "peopleId": { "type": "integer", "format": "int32" }, "phoneNumbers": { "type": "string" }, "relationshipId": { "type": "integer", "format": "int32" }, "relationshipType": { "type": "string" } }, "xml": { "name": "InstreamCommunityContactDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamPlanDto": { "properties": { "glidePathId": { "type": "integer", "format": "int32" }, "isTaxGlidePathIncluded": { "type": "boolean" }, "simulationCount": { "type": "integer", "format": "int32" }, "expectedProbability": { "type": "number", "format": "double" }, "safeSavingsRate": { "type": "number", "format": "double" }, "goalLists": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamGoalCategoriesDto" }, "distribution": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamDistributionDto" }, "incomeList": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamIncomeDto" }, "xml": { "name": "InstreamIncomeDto", "wrapped": true }, "type": "array" }, "accountList": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamAccountDto" }, "xml": { "name": "InstreamAccountDto", "wrapped": true }, "type": "array" }, "allocationPeriods": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamAllocationDto" }, "xml": { "name": "InstreamAllocationDto", "wrapped": true }, "type": "array" }, "taxPeriodLists": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamTaxCategoriesDto" }, "inflationPeriods": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamInflationPeriodDto" }, "xml": { "name": "InstreamInflationPeriodDto", "wrapped": true }, "type": "array" }, "notifications": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamNotificationDto" }, "xml": { "name": "InstreamNotificationDto", "wrapped": true }, "type": "array" }, "planMatrices": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamPlanMatrixDto" }, "xml": { "name": "InstreamPlanMatrixDto", "wrapped": true }, "type": "array" }, "planRules": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamPlanRules" }, "planTracking": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamPlanTrackingDto" }, "planSharing": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamPlanSharingDto" }, "calculationRequired": { "type": "boolean" }, "lastCalculatedDate": { "type": "integer", "format": "int64" }, "lastUpdateDate": { "type": "integer", "format": "int64" }, "statistics": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamStatisticsDto" }, "probabilityCalculated": { "type": "boolean" }, "planId": { "type": "integer", "format": "int32" }, "planName": { "type": "string" }, "isPrimary": { "type": "boolean" } }, "xml": { "name": "InstreamPlanDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamGoalCategoriesDto": { "properties": { "educationGoals": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamGoalDto" }, "xml": { "name": "InstreamGoalDto", "wrapped": true }, "type": "array" }, "legacyGoals": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamGoalDto" }, "xml": { "name": "InstreamGoalDto", "wrapped": true }, "type": "array" }, "lifestyleGoals": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamGoalDto" }, "xml": { "name": "InstreamGoalDto", "wrapped": true }, "type": "array" }, "retirementGoals": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamGoalDto" }, "xml": { "name": "InstreamGoalDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "InstreamGoalCategoriesDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamDistributionDto": { "properties": { "distributionId": { "type": "integer", "format": "int32" }, "planId": { "type": "integer", "format": "int32" }, "appliesTo": { "type": "string" }, "appliesToType": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "startYear": { "type": "integer", "format": "int64" }, "endYear": { "type": "integer", "format": "int64" }, "annualAmount": { "type": "number", "format": "double" } }, "xml": { "name": "InstreamDistributionDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamIncomeDto": { "properties": { "annualAmount": { "type": "number", "format": "double" }, "appliesTo": { "type": "integer", "format": "int32" }, "appliesToType": { "type": "string" }, "clientId": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "endYear": { "type": "integer", "format": "int32" }, "includedInTaxCalc": { "type": "boolean" }, "incomeId": { "type": "integer", "format": "int32" }, "incomeName": { "type": "string" }, "incomeTaxClassificationList": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamIncomeTaxClassification" }, "xml": { "name": "InstreamIncomeTaxClassification", "wrapped": true }, "type": "array" }, "incomeType": { "type": "string", "enum": [ "PAYROLL", "SOCIAL_SECURITY", "PENSION", "BUSINESS", "OTHER" ] }, "incomeTypeOtherValue": { "type": "string" }, "inflationRate": { "type": "number", "format": "double" }, "isIncludedInTaxCalc": { "type": "boolean" }, "needChange": { "type": "boolean" }, "notes": { "items": { "type": "string" }, "type": "array" }, "objectScope": { "type": "string" }, "passive": { "type": "boolean" }, "relativeEndDateNum": { "type": "integer", "format": "int32" }, "relativeEndDateType": { "type": "integer", "format": "int32" }, "relativeStartDateNum": { "type": "integer", "format": "int32" }, "relativeStartDateType": { "type": "integer", "format": "int32" }, "startYear": { "type": "integer", "format": "int32" }, "usedInPlans": { "items": { "type": "string" }, "type": "array" } }, "xml": { "name": "InstreamIncomeDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamAccountDto": { "properties": { "accountContributions": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamAccountContribution" }, "xml": { "name": "InstreamAccountContribution", "wrapped": true }, "type": "array" }, "accountCustodian": { "type": "string" }, "accountCustodianOtherValue": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "accountName": { "type": "string" }, "accountType": { "type": "string" }, "accountTypeOtherValue": { "type": "string" }, "appliesTo": { "type": "integer", "format": "int32" }, "appliesToType": { "type": "string" }, "clientId": { "type": "integer", "format": "int32" }, "costBasis": { "type": "number", "format": "double" }, "currentValue": { "type": "number", "format": "double" }, "currentValueLastUpdated": { "type": "string" }, "custodianAccountNum": { "type": "string" }, "custodianURL": { "type": "string" }, "managedStatus": { "type": "string", "enum": [ "MANAGED", "FULL_CUSTODY", "NOT_MANAGED" ] }, "managedBy": { "type": "string" }, "managedUserName": { "type": "string" }, "managedPassword": { "type": "string" }, "notes": { "items": { "type": "string" }, "type": "array" }, "taxType": { "type": "string", "enum": [ "TAXABLE", "TAX_DEFERRED", "TAX_EXEMPT" ] }, "usedInPlans": { "items": { "type": "string" }, "type": "array" }, "objectScope": { "type": "string" } }, "xml": { "name": "InstreamAccountDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamAllocationDto": { "properties": { "allocationPeriodId": { "type": "integer", "format": "int32" }, "createdDate": { "type": "integer", "format": "int64" }, "lastUpdateDate": { "type": "integer", "format": "int64" }, "createdBy": { "type": "string" }, "lastUpdatedBy": { "type": "string" }, "planId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "title": { "type": "string" }, "relativeStartDateType": { "type": "string" }, "relativeEndDateType": { "type": "string" }, "relativeStartDateNum": { "type": "integer", "format": "int32" }, "relativeEndDateNum": { "type": "integer", "format": "int32" }, "startYear": { "type": "integer", "format": "int32" }, "endYear": { "type": "integer", "format": "int32" }, "allocationModel": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamAllocationModelDto" }, "isPortfolio": { "type": "boolean" }, "isPortfolioModelDeleted": { "type": "boolean" }, "isCustomPortfolio": { "type": "boolean" }, "customReturnRate": { "type": "number", "format": "double" }, "customRisk": { "type": "number", "format": "double" }, "customAnnualizedReturn": { "type": "number", "format": "double" } }, "xml": { "name": "InstreamAllocationDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamTaxCategoriesDto": { "properties": { "incomeTaxPeriods": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamTaxPeriodDto" }, "xml": { "name": "InstreamTaxPeriodDto", "wrapped": true }, "type": "array" }, "capitalGainsTaxPeriods": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamTaxPeriodDto" }, "xml": { "name": "InstreamTaxPeriodDto", "wrapped": true }, "type": "array" }, "stateTaxPeriods": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamTaxPeriodDto" }, "xml": { "name": "InstreamTaxPeriodDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "InstreamTaxCategoriesDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamInflationPeriodDto": { "properties": { "inflationPeriodId": { "type": "integer", "format": "int32" }, "planId": { "type": "integer", "format": "int32" }, "title": { "type": "string" }, "inflationRate": { "type": "number", "format": "double" }, "standardDeviation": { "type": "number", "format": "double" }, "startYear": { "type": "integer", "format": "int64" }, "endYear": { "type": "integer", "format": "int64" } }, "xml": { "name": "InstreamInflationPeriodDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamNotificationDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "date": { "type": "integer", "format": "int64" }, "author": { "type": "string" }, "type": { "type": "string" } }, "xml": { "name": "InstreamNotificationDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamPlanMatrixDto": { "properties": { "matrixId": { "type": "integer", "format": "int32" }, "planId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "rowVariable": { "type": "string" }, "columnVariable": { "type": "string" }, "planMatrixCell": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamPlanMatrixCellDto" }, "xml": { "name": "InstreamPlanMatrixCellDto", "wrapped": true }, "type": "array" }, "calculationRequired": { "type": "boolean" } }, "xml": { "name": "InstreamPlanMatrixDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamPlanRules": { "properties": { "planRulesId": { "type": "integer", "format": "int32" }, "planId": { "type": "integer", "format": "int32" }, "title": { "type": "string" }, "inflationAdjustmentOn": { "type": "boolean" }, "distributionInflationCapOn": { "type": "boolean" }, "floorOn": { "type": "boolean" }, "ceilingOn": { "type": "boolean" }, "maxDistributionOn": { "type": "boolean" }, "minDistributionOn": { "type": "boolean" }, "portfolioReturnDistributionFreezeOn": { "type": "boolean" }, "maxInflationAdjustmentPercent": { "type": "number", "format": "double" }, "floorAmount": { "type": "number", "format": "double" }, "ceilingAmount": { "type": "number", "format": "double" }, "maxPercentOfPortfolio": { "type": "number", "format": "double" }, "maxPercentOfPortfolioAdjustment": { "type": "number", "format": "double" }, "minPercentOfPortfolio": { "type": "number", "format": "double" }, "minPercentOfPortfolioAdjustment": { "type": "number", "format": "double" }, "minPortfolioReturnPercent": { "type": "number", "format": "double" }, "maxContributionAmount": { "type": "number", "format": "double" }, "startDate": { "type": "integer", "format": "int64" }, "endDate": { "type": "integer", "format": "int64" } }, "xml": { "name": "InstreamPlanRules" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamPlanTrackingDto": { "properties": { "planTrackingId": { "type": "integer", "format": "int32" }, "enabled": { "type": "boolean" }, "thresholdLow": { "type": "number", "format": "double" }, "thresholdHigh": { "type": "number", "format": "double" }, "alertEvent": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamAlertEventDto" } }, "xml": { "name": "InstreamPlanTrackingDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamPlanSharingDto": { "properties": { "planSharingId": { "type": "integer", "format": "int32" }, "orionEnabled": { "type": "boolean" }, "clientPortalEnabled": { "type": "boolean" }, "sharedOnDate": { "type": "integer", "format": "int64" } }, "xml": { "name": "InstreamPlanSharingDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamStatisticsDto": { "properties": { "planType": { "type": "string" }, "portfolioDetails": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamPortfolioDetailsDto" }, "objectivesDetails": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamObjectivesDetailsDto" }, "distributionView": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamDistributionViewDto" }, "incomeDetailsList": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamIncomeDetailsDto" }, "savingsDetailsList": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamSavingsDetailsDto" }, "printoutView": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamPrintoutViewDto" }, "magnitudeOfFailureYear": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamMagnitudeOfFailureYearDto" }, "magnitudeOfFailureEPV": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamMagnitudeOfFailureEPVDto" }, "assumptions": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamAssumptionsDto" }, "cashFlowList": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamCashFlowDto" }, "xml": { "name": "InstreamCashFlowDto", "wrapped": true }, "type": "array" }, "networthDetails": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamNetworthDetailsDto" }, "wealthOverTime": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamWealthOverTimeDto" }, "xml": { "name": "InstreamWealthOverTimeDto", "wrapped": true }, "type": "array" }, "taxGlidePathMedian": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamTaxGlidePathMedianDto" }, "xml": { "name": "InstreamTaxGlidePathMedianDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "InstreamStatisticsDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamGoalDto": { "properties": { "goalId": { "type": "integer", "format": "int32" }, "goalType": { "type": "string", "enum": [ "RETIREMENT", "EDUCATION", "LIFESTYLE", "LEGACY" ] }, "clientId": { "type": "integer", "format": "int32" }, "objectScope": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "annualAmount": { "type": "number", "format": "double" }, "inflationRate": { "type": "number", "format": "double" }, "startYear": { "type": "integer", "format": "int32" }, "endYear": { "type": "integer", "format": "int32" }, "appliesTo": { "type": "integer", "format": "int32" }, "appliesToType": { "type": "string" }, "notes": { "items": { "type": "string" }, "type": "array" }, "relativeStartDateType": { "type": "integer", "format": "int32" }, "relativeEndDateType": { "type": "integer", "format": "int32" }, "relativeStartDateNum": { "type": "integer", "format": "int32" }, "relativeEndDateNum": { "type": "integer", "format": "int32" }, "needChange": { "type": "boolean" } }, "xml": { "name": "InstreamGoalDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamIncomeTaxClassification": { "properties": { "id": { "type": "integer", "format": "int32" }, "incomeId": { "type": "integer", "format": "int32" }, "incomeCategory": { "type": "string" }, "percentageAllocated": { "type": "number", "format": "double" }, "amount": { "type": "number", "format": "double" } }, "xml": { "name": "InstreamIncomeTaxClassification" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamAccountContribution": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "accountName": { "type": "string" }, "contributionId": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "annualAmount": { "type": "number", "format": "double" }, "startYear": { "type": "integer", "format": "int32" }, "endYear": { "type": "integer", "format": "int32" }, "inflationRate": { "type": "number", "format": "double" }, "relativeStartDateType": { "type": "integer", "format": "int32" }, "relativeEndDateType": { "type": "integer", "format": "int32" }, "relativeStartDateNum": { "type": "integer", "format": "int32" }, "relativeEndDateNum": { "type": "integer", "format": "int32" }, "needChange": { "type": "boolean" } }, "xml": { "name": "InstreamAccountContribution" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamAllocationModelDto": { "properties": { "allocationModelId": { "type": "integer", "format": "int32" }, "allocationModelName": { "type": "string" }, "objectScope": { "type": "string" }, "assets": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamAssetDto" }, "xml": { "name": "InstreamAssetDto", "wrapped": true }, "type": "array" }, "returnRate": { "type": "number", "format": "double" }, "risk": { "type": "number", "format": "double" }, "annualizedReturn": { "type": "number", "format": "double" }, "historicalAnnualizedReturn": { "type": "number", "format": "double" }, "expenseRatio": { "type": "number", "format": "double" }, "customValues": { "type": "boolean" }, "customReturnRate": { "type": "number", "format": "double" }, "customRisk": { "type": "number", "format": "double" }, "customAnnualizedReturn": { "type": "number", "format": "double" }, "taxDrag": { "type": "number", "format": "double" }, "createdDate": { "type": "integer", "format": "int64" }, "lastUpdateDate": { "type": "integer", "format": "int64" }, "createdBy": { "type": "string" }, "lastUpdatedBy": { "type": "string" } }, "xml": { "name": "InstreamAllocationModelDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamTaxPeriodDto": { "properties": { "taxPeriodId": { "type": "integer", "format": "int32" }, "planId": { "type": "integer", "format": "int32" }, "title": { "type": "string" }, "taxPeriodType": { "type": "string" }, "taxRate": { "type": "number", "format": "double" }, "startYear": { "type": "integer", "format": "int64" }, "endYear": { "type": "integer", "format": "int64" }, "relativeStartDateType": { "type": "string" }, "relativeEndDateType": { "type": "string" }, "relativeStartDateNum": { "type": "integer", "format": "int32" }, "relativeEndDateNum": { "type": "integer", "format": "int32" } }, "xml": { "name": "InstreamTaxPeriodDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamPlanMatrixCellDto": { "properties": { "matrixCellId": { "type": "integer", "format": "int32" }, "matrixId": { "type": "integer", "format": "int32" }, "cellLocation": { "type": "string" }, "probability": { "type": "string" }, "percentileValue": { "type": "number", "format": "double" }, "percentileValueFuture": { "type": "number", "format": "double" }, "planMatrixCellInfo": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamPlanMatrixCellInfoDto" }, "xml": { "name": "InstreamPlanMatrixCellInfoDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "InstreamPlanMatrixCellDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamAlertEventDto": { "properties": { "alertEventId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "alertEventName": { "type": "string" }, "alertEventMessage": { "type": "string" }, "alertEventType": { "type": "string" }, "alertEventStartDate": { "type": "integer", "format": "int64" }, "alertEventFrequency": { "type": "string" }, "alertEventPriority": { "type": "string" }, "alertEventStatus": { "type": "string" }, "alertEventReminderTimeQty": { "type": "integer", "format": "int32" }, "alertEventReminderTimeUnit": { "type": "integer", "format": "int32" } }, "xml": { "name": "InstreamAlertEventDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamPortfolioDetailsDto": { "properties": { "taxFreeView": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamTaxViewDto" }, "xml": { "name": "InstreamTaxViewDto", "wrapped": true }, "type": "array" }, "taxDeferredView": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamTaxViewDto" }, "xml": { "name": "InstreamTaxViewDto", "wrapped": true }, "type": "array" }, "taxableView": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamTaxViewDto" }, "xml": { "name": "InstreamTaxViewDto", "wrapped": true }, "type": "array" }, "pbaAccountTaxCategoryView": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamSummaryObjectViewDto" } }, "xml": { "name": "InstreamPortfolioDetailsDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamObjectivesDetailsDto": { "properties": { "retView": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamPbaPlanObjectiveDto" }, "xml": { "name": "InstreamPbaPlanObjectiveDto", "wrapped": true }, "type": "array" }, "eduView": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamPbaPlanObjectiveDto" }, "xml": { "name": "InstreamPbaPlanObjectiveDto", "wrapped": true }, "type": "array" }, "legView": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamPbaPlanObjectiveDto" }, "xml": { "name": "InstreamPbaPlanObjectiveDto", "wrapped": true }, "type": "array" }, "lifestyleView": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamPbaPlanObjectiveDto" }, "xml": { "name": "InstreamPbaPlanObjectiveDto", "wrapped": true }, "type": "array" }, "insuranceView": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamPbaPlanObjectiveDto" }, "xml": { "name": "InstreamPbaPlanObjectiveDto", "wrapped": true }, "type": "array" }, "totalsListView": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamTotalsListViewDto" }, "xml": { "name": "InstreamTotalsListViewDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "InstreamObjectivesDetailsDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamDistributionViewDto": { "properties": { "planDistributionId": { "type": "integer", "format": "int32" }, "startYear": { "type": "integer", "format": "int64" }, "endYear": { "type": "integer", "format": "int64" }, "annualAmount": { "type": "number", "format": "double" }, "desiredProbability": { "type": "number", "format": "double" }, "medianDistribution": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamMedianDistributionDto" }, "xml": { "name": "InstreamMedianDistributionDto", "wrapped": true }, "type": "array" }, "portfolioReturnFreeze": { "type": "boolean" }, "inflationCap": { "type": "boolean" }, "inflationAdjustment": { "type": "boolean" }, "maximumDistributionPercent": { "type": "boolean" }, "minimumDistributionPercent": { "type": "boolean" }, "floor": { "type": "boolean" }, "ceiling": { "type": "boolean" }, "maximumContribution": { "type": "boolean" }, "badInvestmentReturn": { "type": "number", "format": "double" }, "maximumInflationRate": { "type": "number", "format": "double" }, "maximumDistribution": { "type": "number", "format": "double" }, "maximumDistributionAdjustment": { "type": "number", "format": "double" }, "minimumDistribution": { "type": "number", "format": "double" }, "minimumDistributionAdjustment": { "type": "number", "format": "double" }, "floorAmount": { "type": "number", "format": "double" }, "ceilingAmount": { "type": "number", "format": "double" }, "distribution10Range": { "type": "number", "format": "double" }, "distribution50Range": { "type": "number", "format": "double" }, "distribution90Range": { "type": "number", "format": "double" }, "maximumContributionAmount": { "type": "number", "format": "double" }, "contributionPer": { "type": "number", "format": "double" } }, "xml": { "name": "InstreamDistributionViewDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamIncomeDetailsDto": { "properties": { "payrollView": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamPlanIncomeDto" }, "xml": { "name": "InstreamPlanIncomeDto", "wrapped": true }, "type": "array" }, "socialsecurityView": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamPlanIncomeDto" }, "xml": { "name": "InstreamPlanIncomeDto", "wrapped": true }, "type": "array" }, "pensionView": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamPlanIncomeDto" }, "xml": { "name": "InstreamPlanIncomeDto", "wrapped": true }, "type": "array" }, "businessView": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamPlanIncomeDto" }, "xml": { "name": "InstreamPlanIncomeDto", "wrapped": true }, "type": "array" }, "otherView": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamPlanIncomeDto" }, "xml": { "name": "InstreamPlanIncomeDto", "wrapped": true }, "type": "array" }, "totalsListView": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamTotalsListViewDto" }, "xml": { "name": "InstreamTotalsListViewDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "InstreamIncomeDetailsDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamSavingsDetailsDto": { "properties": { "taxFreeListView": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamTaxListView" }, "xml": { "name": "InstreamTaxListView", "wrapped": true }, "type": "array" }, "taxableListView": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamTaxListView" }, "xml": { "name": "InstreamTaxListView", "wrapped": true }, "type": "array" }, "taxDeferredListView": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamTaxListView" }, "xml": { "name": "InstreamTaxListView", "wrapped": true }, "type": "array" }, "totalsListView": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamTotalsListViewDto" }, "xml": { "name": "InstreamTotalsListViewDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "InstreamSavingsDetailsDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamPrintoutViewDto": { "properties": { "estateObj": { "type": "number", "format": "double" }, "optValue": { "type": "number", "format": "double" }, "pessValue": { "type": "number", "format": "double" }, "medianValue": { "type": "number", "format": "double" }, "futureOptValue": { "type": "number", "format": "double" }, "futurePessValue": { "type": "number", "format": "double" }, "futureMedianValue": { "type": "number", "format": "double" } }, "xml": { "name": "InstreamPrintoutViewDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamMagnitudeOfFailureYearDto": { "properties": { "successProb": { "type": "number", "format": "double" }, "optValue": { "type": "integer", "format": "int32" }, "pessValue": { "type": "integer", "format": "int32" }, "medianValue": { "type": "integer", "format": "int32" }, "optAge": { "type": "integer", "format": "int32" }, "pessAge": { "type": "integer", "format": "int32" }, "medianAge": { "type": "integer", "format": "int32" }, "totalFailure": { "type": "number", "format": "double" }, "probabilityCalculated": { "type": "boolean" } }, "xml": { "name": "InstreamMagnitudeOfFailureYearDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamMagnitudeOfFailureEPVDto": { "properties": { "successProb": { "type": "number", "format": "double" }, "optValue": { "type": "number", "format": "double" }, "pessValue": { "type": "number", "format": "double" }, "medianValue": { "type": "number", "format": "double" }, "optValueFuture": { "type": "number", "format": "double" }, "pessValueFuture": { "type": "number", "format": "double" }, "medianValueFuture": { "type": "number", "format": "double" }, "totalFailure": { "type": "number", "format": "double" }, "probabilityCalculated": { "type": "boolean" } }, "xml": { "name": "InstreamMagnitudeOfFailureEPVDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamAssumptionsDto": { "properties": { "inflationPeriods": { "type": "integer", "format": "int32" }, "clientDOB": { "type": "string" }, "coClientDOB": { "type": "string" }, "clientRetirementAge": { "type": "integer", "format": "int32" }, "clientLifeExpectancy": { "type": "integer", "format": "int32" }, "coClientlifeExpectancy": { "type": "integer", "format": "int32" }, "firstYearOfSimulation": { "type": "integer", "format": "int32" }, "targetTerminalNetWorth": { "type": "integer", "format": "int32" }, "inflationRate": { "type": "number", "format": "double" }, "discountRate": { "type": "number", "format": "double" }, "percentileLow": { "type": "number", "format": "double" }, "percentileMedian": { "type": "number", "format": "double" }, "percentileHigh": { "type": "number", "format": "double" }, "cashflowPercentile": { "type": "number", "format": "double" } }, "xml": { "name": "InstreamAssumptionsDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamCashFlowDto": { "properties": { "year": { "type": "integer", "format": "int32" }, "beginningPortfolioValue": { "type": "number", "format": "double" }, "totalContributions": { "type": "number", "format": "double" }, "totalTaxFreeContributions": { "type": "number", "format": "double" }, "totalTaxDeferedContributions": { "type": "number", "format": "double" }, "totalTaxableContributions": { "type": "number", "format": "double" }, "grossTaxableDistributions": { "type": "number", "format": "double" }, "grossQualifiedDistributions": { "type": "number", "format": "double" }, "taxFreeDistributions": { "type": "number", "format": "double" }, "capitalGainsTaxes": { "type": "number", "format": "double" }, "incomeTaxes": { "type": "number", "format": "double" }, "returnAfterDrag": { "type": "number", "format": "double" }, "grossTaxDeferredDistributions": { "type": "number", "format": "double" }, "taxExemptDistributions": { "type": "number", "format": "double" }, "totalDistributions": { "type": "number", "format": "double" }, "totalCapitalGainsTaxes": { "type": "number", "format": "double" }, "totalIncometaxes": { "type": "number", "format": "double" }, "expectedNetReturn": { "type": "number", "format": "double" }, "netChange": { "type": "number", "format": "double" }, "endingPortfolioValue": { "type": "number", "format": "double" }, "percentileValueForEndingValue": { "type": "number", "format": "double" }, "totalNetGoals": { "type": "number", "format": "double" }, "totalNetIncome": { "type": "number", "format": "double" }, "totalNeed": { "type": "number", "format": "double" }, "inflationRate": { "type": "number", "format": "double" }, "endingTotalValue": { "type": "number", "format": "double" }, "percentileForEndingValue": { "type": "number", "format": "double" }, "taxableGrossPension": { "type": "number", "format": "double" }, "effectiveTaxRate": { "type": "number", "format": "double" }, "totalTaxableWithdrawals": { "type": "number", "format": "double" }, "totalTaxDeferredWithdrawals": { "type": "number", "format": "double" }, "totalTaxFreeWithdrawals": { "type": "number", "format": "double" } }, "xml": { "name": "InstreamCashFlowDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamNetworthDetailsDto": { "properties": { "netWorthAccounts": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamNetworthDetailDto" }, "xml": { "name": "InstreamNetworthDetailDto", "wrapped": true }, "type": "array" }, "netWorthProperties": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamNetworthDetailDto" }, "xml": { "name": "InstreamNetworthDetailDto", "wrapped": true }, "type": "array" }, "netWorthInsurance": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamNetworthDetailDto" }, "xml": { "name": "InstreamNetworthDetailDto", "wrapped": true }, "type": "array" }, "netWorthLiabilityLoan": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamNetworthDetailDto" }, "xml": { "name": "InstreamNetworthDetailDto", "wrapped": true }, "type": "array" }, "netWorthSummaryLiabilityExpense": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamNetworthDetailDto" }, "xml": { "name": "InstreamNetworthDetailDto", "wrapped": true }, "type": "array" }, "totalAssets": { "type": "number", "format": "double" }, "totalLiabilities": { "type": "number", "format": "double" }, "totalNetWorth": { "type": "number", "format": "double" } }, "xml": { "name": "InstreamNetworthDetailsDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamWealthOverTimeDto": { "properties": { "percentileAndEpvList": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamPercentileAndEpvDto" }, "xml": { "name": "InstreamPercentileAndEpvDto", "wrapped": true }, "type": "array" }, "year": { "type": "integer", "format": "int32" } }, "xml": { "name": "InstreamWealthOverTimeDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamTaxGlidePathMedianDto": { "properties": { "year": { "type": "integer", "format": "int32" }, "clientAge": { "type": "integer", "format": "int32" }, "coClientAge": { "type": "integer", "format": "int32" }, "adgustedGrossIncome": { "type": "number", "format": "double" }, "topMarginalRate": { "type": "number", "format": "double" }, "effectiveRate": { "type": "number", "format": "double" } }, "xml": { "name": "InstreamTaxGlidePathMedianDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamAssetDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "classification": { "type": "string" }, "location": { "type": "string" }, "sortOrder": { "type": "integer", "format": "int32" }, "returnRate": { "type": "number", "format": "double" }, "standardDeviation": { "type": "number", "format": "double" }, "dividendRate": { "type": "number", "format": "double" }, "ordinaryDividendRate": { "type": "number", "format": "double" }, "historicalAnnualizedReturn": { "type": "number", "format": "double" }, "allocatedWeight": { "type": "number", "format": "double" } }, "xml": { "name": "InstreamAssetDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamPlanMatrixCellInfoDto": { "properties": { "matrixCellId": { "type": "integer", "format": "int32" }, "typeName": { "type": "string" }, "typeId": { "type": "integer", "format": "int32" }, "typeValue": { "type": "integer", "format": "int32" }, "equityLevel": { "type": "number", "format": "double" } }, "xml": { "name": "InstreamPlanMatrixCellInfoDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamTaxViewDto": { "properties": { "accountType": { "type": "string" }, "accountName": { "type": "string" }, "planAccountId": { "type": "integer", "format": "int32" }, "currentValue": { "type": "number", "format": "double" }, "accountNumber": { "type": "string" }, "costBasis": { "type": "number", "format": "double" }, "percentIncl": { "type": "number", "format": "double" } }, "xml": { "name": "InstreamTaxViewDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamSummaryObjectViewDto": { "properties": { "taxFreeAccount": { "type": "number", "format": "double" }, "taxdeferredAccount": { "type": "number", "format": "double" }, "taxableAccount": { "type": "number", "format": "double" }, "taxFreeCostBasis": { "type": "number", "format": "double" }, "taxdeferredCostBasis": { "type": "number", "format": "double" }, "taxableCostBasis": { "type": "number", "format": "double" }, "sumAccount": { "type": "number", "format": "double" }, "sumCostBasis": { "type": "number", "format": "double" } }, "xml": { "name": "InstreamSummaryObjectViewDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamPbaPlanObjectiveDto": { "properties": { "pbaPlanObjectiveId": { "type": "integer", "format": "int32" }, "annualAmountNeeded": { "type": "number", "format": "double" }, "startYear": { "type": "integer", "format": "int64" }, "endYear": { "type": "integer", "format": "int64" }, "growthRate": { "type": "number", "format": "double" }, "objectiveType": { "type": "string" }, "objectiveName": { "type": "string" }, "yob": { "type": "integer", "format": "int32" } }, "xml": { "name": "InstreamPbaPlanObjectiveDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamTotalsListViewDto": { "properties": { "categoryName": { "type": "string" }, "todayDollars": { "type": "number", "format": "double" }, "futureDollars": { "type": "number", "format": "double" }, "todayDollarsPostDist": { "type": "number", "format": "double" }, "futureDollarsPostDist": { "type": "number", "format": "double" } }, "xml": { "name": "InstreamTotalsListViewDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamMedianDistributionDto": { "properties": { "year": { "type": "integer", "format": "int32" }, "value": { "type": "number", "format": "double" } }, "xml": { "name": "InstreamMedianDistributionDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamPlanIncomeDto": { "properties": { "incomeName": { "type": "string" }, "planIncomeId": { "type": "integer", "format": "int32" }, "inflationRate": { "type": "number", "format": "double" }, "startYear": { "type": "integer", "format": "int32" }, "endYear": { "type": "integer", "format": "int32" }, "appliesTo": { "type": "integer", "format": "int32" }, "appliesToType": { "type": "integer", "format": "int32" }, "incomeType": { "type": "string" }, "annualAmount": { "type": "number", "format": "double" }, "yob": { "type": "integer", "format": "int32" } }, "xml": { "name": "InstreamPlanIncomeDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamTaxListView": { "properties": { "savingsName": { "type": "string" }, "savingsType": { "type": "string" }, "inflationRate": { "type": "number", "format": "double" }, "startYear": { "type": "integer", "format": "int32" }, "endYear": { "type": "integer", "format": "int32" }, "annualAmount": { "type": "number", "format": "double" }, "planSavingsId": { "type": "integer", "format": "int32" }, "yob": { "type": "integer", "format": "int32" } }, "xml": { "name": "InstreamTaxListView" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamNetworthDetailDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "amount": { "type": "number", "format": "double" }, "appliesToType": { "type": "integer", "format": "int32" }, "appliesTo": { "type": "integer", "format": "int32" } }, "xml": { "name": "InstreamNetworthDetailDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamPercentileAndEpvDto": { "properties": { "percentileValue": { "type": "number", "format": "double" }, "futureEPVForPercentile": { "type": "number", "format": "double" }, "epvforPercentile": { "type": "number", "format": "double" } }, "xml": { "name": "InstreamPercentileAndEpvDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamStaticContentDto": { "properties": { "capitalMarketAssumptions": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.CapitalMarketAssumptions" } }, "xml": { "name": "InstreamStaticContentDto" }, "type": "object" }, "OAS.Integrations.Instream.Dto.CapitalMarketAssumptions": { "properties": { "header": { "type": "string" }, "body": { "type": "string" }, "equityTable": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.EquityTable" }, "xml": { "name": "EquityTable", "wrapped": true }, "type": "array" }, "alternativesTable": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.AlternativesTable" }, "xml": { "name": "AlternativesTable", "wrapped": true }, "type": "array" }, "fixedIncomeTable": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.FixedIncomeTable" }, "xml": { "name": "FixedIncomeTable", "wrapped": true }, "type": "array" }, "notes": { "type": "string" }, "taxTable": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.TaxTable" }, "xml": { "name": "TaxTable", "wrapped": true }, "type": "array" }, "disclosure": { "type": "string" } }, "xml": { "name": "CapitalMarketAssumptions" }, "type": "object" }, "OAS.Integrations.Instream.Dto.EquityTable": { "properties": { "equity": { "type": "string" }, "source": { "type": "string" }, "notes": { "type": "string" } }, "xml": { "name": "EquityTable" }, "type": "object" }, "OAS.Integrations.Instream.Dto.AlternativesTable": { "properties": { "alternatives": { "type": "string" }, "source": { "type": "string" }, "notes": { "type": "string" } }, "xml": { "name": "AlternativesTable" }, "type": "object" }, "OAS.Integrations.Instream.Dto.FixedIncomeTable": { "properties": { "fixed income": { "type": "string" }, "source": { "type": "string" }, "notes": { "type": "string" } }, "xml": { "name": "FixedIncomeTable" }, "type": "object" }, "OAS.Integrations.Instream.Dto.TaxTable": { "properties": { "type": { "type": "string" }, "rate": { "type": "string" } }, "xml": { "name": "TaxTable" }, "type": "object" }, "OAS.Integrations.Instream.Dto.InstreamClientReportOverviewDto": { "properties": { "profile": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamProfileDto" }, "plans": { "items": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamPlanDto" }, "xml": { "name": "InstreamPlanDto", "wrapped": true }, "type": "array" }, "staticContent": { "$ref": "#/definitions/OAS.Integrations.Instream.Dto.InstreamStaticContentDto" } }, "xml": { "name": "InstreamClientReportOverviewDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.IntegrationSyncDto": { "properties": { "entityEnum": { "type": "integer", "format": "int32" }, "fkEntity": { "type": "integer", "format": "int32" }, "syncType": { "type": "integer", "format": "int32" }, "recordId": { "type": "string" }, "recordType": { "type": "string" }, "householdID": { "type": "integer", "format": "int32" }, "individualHouseholdID": { "type": "integer", "format": "int32" }, "parentHouseholdID": { "type": "integer", "format": "int32" } }, "xml": { "name": "IntegrationSyncDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.iRebal.IntegrationConfigDto": { "properties": { "username": { "description": "The service user name.", "type": "string" }, "password": { "description": "The service user password.", "type": "string" }, "partnerAppId": { "description": "The unique ID of the partner app.", "type": "integer", "format": "int32" }, "productName": { "description": "The unique name of the partner app product.", "type": "string" }, "jobScheduleDescription": { "description": "The description of the scheduled job.", "type": "string" }, "jobScheduleId": { "description": "An optional ID of the Job scheduled for the current integration and firm. Defaults to zero if no Job is scheduled.", "type": "integer", "format": "int32" }, "lastRun": { "type": "string", "format": "date-time" }, "runOn": { "description": "The date and time of the next run of the scheduled jobs.", "type": "string", "format": "date-time" }, "status": { "description": "Gets or sets a JobStatus description of the last run.", "type": "string" }, "weekdaysOnly": { "description": "Indicates whether the job is run on weekdays only or everyday.", "type": "boolean" }, "routePrefix": { "description": "The prefix for this controller. Used by clients to determine the correct endpoints to call.", "type": "string" } }, "xml": { "name": "IntegrationConfigDto" }, "type": "object" }, "OAT.Integrations.LaserApp.IntegrationConfig": { "properties": { "partnerId": { "type": "string" }, "formsServiceUserName": { "type": "string" }, "formsServiceAuthCode": { "type": "string" }, "formsServiceURL": { "type": "string" }, "anywhereServiceAuthCode": { "type": "string" }, "anywhereServiceURL": { "type": "string" }, "postUrl": { "type": "string" }, "postFormat": { "type": "string", "enum": [ "Raw_no_image", "PDF", "TIF", "Fillable_PDF" ] }, "theme": { "type": "string", "enum": [ "brown_chocolate", "black_stripes", "blue_spirit", "orange_oktoberfest", "red_firehouse", "green_fairway", "blue_overcast" ] }, "sigMethod": { "type": "string", "enum": [ "NoFormsSignable", "Basic", "DocuSign", "Silanis", "SIGNiX" ] }, "remoteSigAuth": { "type": "string" }, "remoteSigPass": { "type": "string" }, "remoteSigId": { "type": "boolean" }, "postButtonCaption": { "type": "string" }, "signIXClientId": { "type": "string" }, "signIXSubmitterEmail": { "type": "string" }, "printButtonState": { "type": "string", "enum": [ "Print_button_enabled", "Print_button_disabled", "Print_button_invisible" ] }, "smartEnforce": { "type": "string", "enum": [ "Smart_fields_optional", "Smart_fields_required" ] } }, "xml": { "name": "IntegrationConfig" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.Paperwork.FormRecordDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "guid": { "type": "string" }, "title": { "type": "string" }, "majorVersion": { "type": "integer", "format": "int32" }, "minorVersion": { "type": "integer", "format": "int32" }, "cDate": { "type": "string", "format": "date-time" }, "rDate": { "type": "string", "format": "date-time" }, "pages": { "type": "integer", "format": "int32" }, "isRequired": { "type": "boolean" }, "paperworkSource": { "type": "string", "enum": [ "LaserApp", "AdvisoryWorld", "Firm", "Quik" ] } }, "xml": { "name": "FormRecordDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.Paperwork.FormRecordFullDto": { "properties": { "selections": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.Paperwork.FormSelectionDto" }, "xml": { "name": "FormSelectionDto", "wrapped": true }, "type": "array" }, "id": { "type": "integer", "format": "int32" }, "guid": { "type": "string" }, "title": { "type": "string" }, "majorVersion": { "type": "integer", "format": "int32" }, "minorVersion": { "type": "integer", "format": "int32" }, "cDate": { "type": "string", "format": "date-time" }, "rDate": { "type": "string", "format": "date-time" }, "pages": { "type": "integer", "format": "int32" }, "isRequired": { "type": "boolean" }, "paperworkSource": { "type": "string", "enum": [ "LaserApp", "AdvisoryWorld", "Firm", "Quik" ] } }, "xml": { "name": "FormRecordFullDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.Paperwork.FormSelectionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "custodian": { "type": "string" }, "custodianId": { "type": "integer", "format": "int32" }, "brokerDealer": { "type": "string" }, "brokerDealerId": { "type": "integer", "format": "int32" }, "managementStyle": { "type": "string" }, "platformId": { "type": "integer", "format": "int32" }, "fundFamily": { "type": "string" }, "fundFamilyId": { "type": "integer", "format": "int32" }, "accountType": { "type": "string" }, "registrationTypeId": { "type": "integer", "format": "int32" }, "representative": { "type": "string" }, "representativeId": { "type": "integer", "format": "int32" }, "subAdvisor": { "type": "string" }, "subAdvisorId": { "type": "integer", "format": "int32" }, "sourceOfFunds": { "type": "string", "enum": [ "Rollover", "Transfer", "ACHWIRE", "CashCheck" ] }, "formType": { "type": "string", "enum": [ "NewAccount", "Distribution" ] }, "feeScheduleId": { "type": "integer", "format": "int32" }, "feeSchedule": { "type": "string" } }, "xml": { "name": "FormSelectionDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.LexisNexis.IntegrationConfigDto": { "description": "The configuration details for the Lexis Nexis integration.", "properties": { "lastRun": { "description": "The date and time of the last completed run; null if not run.", "type": "string", "format": "date-time" }, "enabled": { "description": "True if a watchlist search is enabled.\r\n\r\nIf the user is scanning all registrations manually, this value is ignored.", "type": "boolean" }, "installed": { "description": "True if the integration is installed for the firm.\r\n\r\nIf the user is scanning all registrations manually, this value is ignored.", "type": "boolean" }, "selectedFrequency": { "description": "The SearchFrequency that has been selected by the user.", "type": "string", "enum": [ "OnDemand", "DailyNewAccounts", "Monthly", "Quarterly" ] }, "selectedDetailLevel": { "description": "The SearchDetailLevel that has been selected by the user.", "type": "string", "enum": [ "Basic", "Premium" ] }, "lastSearch": { "description": "The DateTime of the last attempted search to Lexis Nexis.", "type": "string", "format": "date-time" }, "searchStatus": { "description": "The Search Status of the last attempted search to Lexis Nexis.", "type": "string", "enum": [ "NoRuns", "Success", "Error" ] }, "lastError": { "description": "The error message of the last attempted search to Lexis Nexis, if an error occurred.", "type": "string" }, "isProcessing": { "description": "Flag indicating whether the search is currently being processed.", "type": "boolean" }, "lastQuery": { "description": "Nullable date and time of the last query for data for the search.", "type": "string", "format": "date-time" }, "lastSent": { "description": "Nullable date and time the data was sent to LexisNexis for the search.", "type": "string", "format": "date-time" }, "lastFetched": { "description": "Nullable date and time the result file was fetched from LexisNexis.", "type": "string", "format": "date-time" }, "partnerAppId": { "description": "The unique ID of the partner app.", "type": "integer", "format": "int32" }, "productName": { "description": "The unique name of the partner app product.", "type": "string" } }, "xml": { "name": "IntegrationConfigDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.LexisNexis.SearchResultDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "issueStatusIcon": { "readOnly": true, "type": "string" }, "issueStatus": { "readOnly": true, "type": "string" }, "hasIssue": { "type": "boolean" }, "lexisNexisSearchId": { "type": "string" }, "registrationId": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "registrationType": { "type": "string" }, "registrationCreated": { "type": "string", "format": "date-time" }, "clientId": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "dbName": { "type": "string" }, "ria": { "type": "string" }, "brokerDealer": { "type": "string" }, "representative": { "type": "string" }, "approvedBy": { "type": "string" }, "approvedId": { "type": "integer", "format": "int32" }, "approvedDate": { "type": "string", "format": "date-time" }, "approvalReason": { "type": "string" }, "alClientId": { "type": "integer", "format": "int32" } }, "xml": { "name": "SearchResultDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.LexisNexis.SearchScheduleDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "enabled": { "type": "boolean" }, "searchFrequency": { "type": "string", "enum": [ "OnDemand", "DailyNewAccounts", "Monthly", "Quarterly" ] }, "uploadTargetId": { "type": "integer", "format": "int32" }, "isProcessing": { "type": "boolean" }, "lastQuery": { "type": "string", "format": "date-time" }, "lastSent": { "type": "string", "format": "date-time" }, "lastFetched": { "type": "string", "format": "date-time" }, "lastSearch": { "type": "string", "format": "date-time" }, "lastError": { "type": "string" }, "searchSelection": { "type": "string", "enum": [ "ALL", "NEW" ] } }, "xml": { "name": "SearchScheduleDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.LexisNexis.ApprovalDto": { "properties": { "ids": { "description": "The collection of Search Result Ids to apply the reason to.", "items": { "type": "integer", "format": "int32" }, "type": "array" }, "reason": { "description": "The reason to apply to the search results with the above ids.", "type": "string" }, "hasIssue": { "description": "Whether the issue is valid or not.", "type": "boolean" } }, "xml": { "name": "ApprovalDto" }, "type": "object" }, "OAS.DataProcess.DTO.Integration.LexisNexis.SearchResultDetailsDto": { "properties": { "registrationId": { "type": "integer", "format": "int32" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "address3": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "country": { "type": "string" }, "firstName": { "type": "string" }, "fullName": { "type": "string" }, "lastName": { "type": "string" }, "businessPhone": { "type": "string" }, "homePhone": { "type": "string" }, "mobilePhone": { "type": "string" }, "ssn": { "type": "string" }, "match": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integration.LexisNexis.Results.WatchListMatch" } }, "xml": { "name": "SearchResultDetailsDto" }, "type": "object" }, "OAS.DataProcess.DTO.Integration.LexisNexis.Results.WatchListMatch": { "properties": { "entityName": { "type": "string" }, "entityScore": { "type": "string" }, "gatewayOFACScreeningIndicator": { "type": "string" }, "secondaryOFACScreeningIndicator": { "type": "string" }, "bestCountry": { "type": "string" }, "bestCountryScore": { "type": "string" }, "bestName": { "type": "string" }, "bestNameScore": { "type": "string" }, "fileName": { "type": "string" }, "sourceDate": { "type": "string" }, "distributionDate": { "type": "string" }, "resultDate": { "type": "string" }, "entityUniqueID": { "type": "string" }, "gatewayOFACScreeningIndicatorMatch": { "type": "string" }, "secondaryOFACScreeningIndicatorMatch": { "type": "string" }, "errorCode": { "type": "string" }, "errorMessage": { "type": "string" }, "matchSummary": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integration.LexisNexis.Results.MatchSummary" }, "matchDetails": { "items": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integration.LexisNexis.Results.MatchEntity" }, "xml": { "name": "MatchEntity", "wrapped": true }, "type": "array" }, "id": { "type": "integer", "format": "int32" }, "idSpecified": { "type": "boolean" }, "xmlString": { "type": "string" } }, "xml": { "name": "WatchListMatch" }, "type": "object" }, "OAS.DataProcess.DTO.Integration.LexisNexis.Results.MatchSummary": { "properties": { "gender": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integration.LexisNexis.Results.BasicInputList" }, "addressMatches": { "items": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integration.LexisNexis.Results.BasicScoredTypeInputList" }, "xml": { "name": "BasicScoredTypeInputList", "wrapped": true }, "type": "array" }, "dobMatches": { "items": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integration.LexisNexis.Results.BasicScoredInputList" }, "xml": { "name": "BasicScoredInputList", "wrapped": true }, "type": "array" }, "idMatches": { "items": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integration.LexisNexis.Results.BasicScoredTypeInputList" }, "xml": { "name": "BasicScoredTypeInputList", "wrapped": true }, "type": "array" }, "phoneMatches": { "items": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integration.LexisNexis.Results.BasicScoredTypeInputList" }, "xml": { "name": "BasicScoredTypeInputList", "wrapped": true }, "type": "array" } }, "xml": { "name": "MatchSummary" }, "type": "object" }, "OAS.DataProcess.DTO.Integration.LexisNexis.Results.MatchEntity": { "properties": { "country": { "type": "string" }, "number": { "type": "string" }, "date": { "type": "string" }, "reason": { "type": "string" }, "checkSum": { "type": "string" }, "gender": { "type": "string" }, "name": { "items": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integration.LexisNexis.Results.MatchEntityName" }, "xml": { "name": "MatchEntityName", "wrapped": true }, "type": "array" }, "notes": { "type": "string" }, "altNames": { "items": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integration.LexisNexis.Results.MatchEntityNamedItem" }, "xml": { "name": "MatchEntityNamedItem", "wrapped": true }, "type": "array" }, "codes": { "items": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integration.LexisNexis.Results.MatchEntityNamedItem" }, "xml": { "name": "MatchEntityNamedItem", "wrapped": true }, "type": "array" }, "terms": { "items": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integration.LexisNexis.Results.MatchEntityNamedItem" }, "xml": { "name": "MatchEntityNamedItem", "wrapped": true }, "type": "array" }, "cities": { "items": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integration.LexisNexis.Results.MatchEntityNamedItem" }, "xml": { "name": "MatchEntityNamedItem", "wrapped": true }, "type": "array" }, "ports": { "items": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integration.LexisNexis.Results.MatchEntityNamedItem" }, "xml": { "name": "MatchEntityNamedItem", "wrapped": true }, "type": "array" }, "akas": { "items": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integration.LexisNexis.Results.MatchEntityAka" }, "xml": { "name": "MatchEntityAka", "wrapped": true }, "type": "array" }, "addresses": { "items": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integration.LexisNexis.Results.MatchEntityAddress" }, "xml": { "name": "MatchEntityAddress", "wrapped": true }, "type": "array" }, "phones": { "items": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integration.LexisNexis.Results.MatchEntityPhone" }, "xml": { "name": "MatchEntityPhone", "wrapped": true }, "type": "array" }, "ids": { "items": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integration.LexisNexis.Results.MatchEntityId" }, "xml": { "name": "MatchEntityId", "wrapped": true }, "type": "array" }, "descriptions": { "items": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integration.LexisNexis.Results.MatchEntityDescription" }, "xml": { "name": "MatchEntityDescription", "wrapped": true }, "type": "array" }, "type": { "type": "string" } }, "xml": { "name": "MatchEntity" }, "type": "object" }, "OAS.DataProcess.DTO.Integration.LexisNexis.Results.BasicInputList": { "properties": { "input": { "type": "string" }, "list": { "type": "string" } }, "xml": { "name": "BasicInputList" }, "type": "object" }, "OAS.DataProcess.DTO.Integration.LexisNexis.Results.BasicScoredTypeInputList": { "properties": { "type": { "type": "integer", "format": "int32" }, "typeSpecified": { "type": "boolean" }, "score": { "type": "integer", "format": "int32" }, "scoreSpecified": { "type": "boolean" }, "input": { "type": "string" }, "list": { "type": "string" } }, "xml": { "name": "BasicScoredTypeInputList" }, "type": "object" }, "OAS.DataProcess.DTO.Integration.LexisNexis.Results.BasicScoredInputList": { "properties": { "score": { "type": "integer", "format": "int32" }, "scoreSpecified": { "type": "boolean" }, "input": { "type": "string" }, "list": { "type": "string" } }, "xml": { "name": "BasicScoredInputList" }, "type": "object" }, "OAS.DataProcess.DTO.Integration.LexisNexis.Results.MatchEntityName": { "properties": { "title": { "type": "string" }, "full": { "type": "string" }, "first": { "type": "string" }, "middle": { "type": "string" }, "last": { "type": "string" }, "generation": { "type": "string" } }, "xml": { "name": "MatchEntityName" }, "type": "object" }, "OAS.DataProcess.DTO.Integration.LexisNexis.Results.MatchEntityNamedItem": { "properties": { "id": { "type": "integer", "format": "int32" }, "idSpecified": { "type": "boolean" }, "type": { "type": "integer", "format": "int32" }, "typeSpecified": { "type": "boolean" }, "text": { "type": "string" } }, "xml": { "name": "MatchEntityNamedItem" }, "type": "object" }, "OAS.DataProcess.DTO.Integration.LexisNexis.Results.MatchEntityAka": { "properties": { "title": { "type": "string" }, "full": { "type": "string" }, "first": { "type": "string" }, "middle": { "type": "string" }, "last": { "type": "string" }, "generation": { "type": "string" }, "notes": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "idSpecified": { "type": "boolean" }, "type": { "type": "integer", "format": "int32" }, "typeSpecified": { "type": "boolean" }, "category": { "type": "integer", "format": "int32" }, "categorySpecified": { "type": "boolean" } }, "xml": { "name": "MatchEntityAka" }, "type": "object" }, "OAS.DataProcess.DTO.Integration.LexisNexis.Results.MatchEntityAddress": { "properties": { "full": { "type": "string" }, "street_1": { "type": "string" }, "street_2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "postalCode": { "type": "string" }, "country": { "type": "string" }, "notes": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "idSpecified": { "type": "boolean" }, "type": { "type": "integer", "format": "int32" }, "typeSpecified": { "type": "boolean" } }, "xml": { "name": "MatchEntityAddress" }, "type": "object" }, "OAS.DataProcess.DTO.Integration.LexisNexis.Results.MatchEntityPhone": { "properties": { "number": { "type": "string" }, "notes": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "idSpecified": { "type": "boolean" }, "type": { "type": "integer", "format": "int32" }, "typeSpecified": { "type": "boolean" } }, "xml": { "name": "MatchEntityPhone" }, "type": "object" }, "OAS.DataProcess.DTO.Integration.LexisNexis.Results.MatchEntityId": { "properties": { "label": { "type": "string" }, "number": { "type": "string" }, "issuer": { "type": "string" }, "issueDate": { "type": "string" }, "expDate": { "type": "string" }, "notes": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "idSpecified": { "type": "boolean" }, "type": { "type": "integer", "format": "int32" }, "typeSpecified": { "type": "boolean" } }, "xml": { "name": "MatchEntityId" }, "type": "object" }, "OAS.DataProcess.DTO.Integration.LexisNexis.Results.MatchEntityDescription": { "properties": { "value": { "type": "string" }, "notes": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "idSpecified": { "type": "boolean" }, "type": { "type": "integer", "format": "int32" }, "typeSpecified": { "type": "boolean" } }, "xml": { "name": "MatchEntityDescription" }, "type": "object" }, "OAS.DataProcess.Integrations.MFE.ModelSearch.Dtos.CompareModelRiskMetricsRequestDto": { "properties": { "modelIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "duration": { "type": "string", "enum": [ "_all", "_10yr", "_5yr", "_3yr", "_2yr", "_1yr", "_ytd", "_6mth", "_3mth", "_1mth", "_1wk" ] } }, "xml": { "name": "CompareModelRiskMetricsRequestDto" }, "type": "object" }, "OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.MonteCarloMeterResponse": { "properties": { "highlightHtmlColor": { "type": "string" }, "image": { "type": "string", "format": "byte" }, "imageExtension": { "type": "string" }, "isLegacyImage": { "type": "boolean" }, "probabilityOfSuccess": { "type": "string" }, "refreshPositionsResponse": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.RefreshPositionsResponse" }, "targetRangeHigh": { "type": "string" }, "targetRangeLow": { "type": "string" }, "targetText": { "type": "string" } }, "xml": { "name": "MonteCarloMeterResponse" }, "type": "object" }, "OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.RefreshPositionsResponse": { "properties": { "messages": { "items": { "type": "string" }, "type": "array" }, "status": { "type": "string", "enum": [ "Success", "Failure", "NotFound", "Error" ] } }, "xml": { "name": "RefreshPositionsResponse" }, "type": "object" }, "OAS.DataModel.Integration.MoneyGuidePro.MPGPlanSummary": { "properties": { "categories": { "items": { "$ref": "#/definitions/OAS.DataModel.Integration.MoneyGuidePro.Category" }, "xml": { "name": "Category", "wrapped": true }, "type": "array" }, "refreshPositionsResponse": { "$ref": "#/definitions/OAS.DataModel.Integration.MoneyGuidePro.Refreshpositionsresponse" }, "results": { "$ref": "#/definitions/OAS.DataModel.Integration.MoneyGuidePro.Results" }, "asOfDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "MPGPlanSummary" }, "type": "object" }, "OAS.DataModel.Integration.MoneyGuidePro.Category": { "properties": { "description": { "type": "string" }, "header": { "$ref": "#/definitions/OAS.DataModel.Integration.MoneyGuidePro.Header" }, "topics": { "items": { "$ref": "#/definitions/OAS.DataModel.Integration.MoneyGuidePro.Topic" }, "xml": { "name": "Topic", "wrapped": true }, "type": "array" } }, "xml": { "name": "Category" }, "type": "object" }, "OAS.DataModel.Integration.MoneyGuidePro.Refreshpositionsresponse": { "properties": { "messages": { "type": "object" }, "status": { "type": "string" } }, "xml": { "name": "Refreshpositionsresponse" }, "type": "object" }, "OAS.DataModel.Integration.MoneyGuidePro.Results": { "properties": { "current": { "$ref": "#/definitions/OAS.DataModel.Integration.MoneyGuidePro.Current" }, "monteCarloTargetRangeHigh": { "type": "string" }, "monteCarloTargetRangeLow": { "type": "string" }, "recommended": { "$ref": "#/definitions/OAS.DataModel.Integration.MoneyGuidePro.Recommended" } }, "xml": { "name": "Results" }, "type": "object" }, "OAS.DataModel.Integration.MoneyGuidePro.Header": { "properties": { "changes": { "type": "string" }, "current": { "type": "string" }, "description": { "type": "string" }, "recommended": { "type": "string" } }, "xml": { "name": "Header" }, "type": "object" }, "OAS.DataModel.Integration.MoneyGuidePro.Topic": { "properties": { "items": { "items": { "$ref": "#/definitions/OAS.DataModel.Integration.MoneyGuidePro.Item" }, "xml": { "name": "Item", "wrapped": true }, "type": "array" }, "changes": { "type": "string" }, "current": { "type": "string" }, "description": { "type": "string" }, "recommended": { "type": "string" } }, "xml": { "name": "Topic" }, "type": "object" }, "OAS.DataModel.Integration.MoneyGuidePro.Current": { "properties": { "calculations": { "items": { "$ref": "#/definitions/OAS.DataModel.Integration.MoneyGuidePro.Calculation" }, "xml": { "name": "Calculation", "wrapped": true }, "type": "array" }, "monteCarloMeter": { "$ref": "#/definitions/OAS.DataModel.Integration.MoneyGuidePro.Montecarlometer" } }, "xml": { "name": "Current" }, "type": "object" }, "OAS.DataModel.Integration.MoneyGuidePro.Recommended": { "properties": { "calculations": { "items": { "$ref": "#/definitions/OAS.DataModel.Integration.MoneyGuidePro.Calculation" }, "xml": { "name": "Calculation", "wrapped": true }, "type": "array" }, "monteCarloMeter": { "$ref": "#/definitions/OAS.DataModel.Integration.MoneyGuidePro.Montecarlometer" } }, "xml": { "name": "Recommended" }, "type": "object" }, "OAS.DataModel.Integration.MoneyGuidePro.Item": { "properties": { "details": { "items": { "$ref": "#/definitions/OAS.DataModel.Integration.MoneyGuidePro.Detail" }, "xml": { "name": "Detail", "wrapped": true }, "type": "array" }, "changes": { "type": "string" }, "current": { "type": "string" }, "description": { "type": "string" }, "recommended": { "type": "string" } }, "xml": { "name": "Item" }, "type": "object" }, "OAS.DataModel.Integration.MoneyGuidePro.Calculation": { "properties": { "description": { "type": "string" }, "probabilityOfSuccess": { "type": "string" }, "safetyMarginCurrent": { "type": "object" }, "safetyMarginFuture": { "type": "string" } }, "xml": { "name": "Calculation" }, "type": "object" }, "OAS.DataModel.Integration.MoneyGuidePro.Montecarlometer": { "properties": { "highlightHtmlColor": { "type": "string" }, "image": { "type": "string", "format": "byte" }, "imageExtension": { "type": "string" }, "isLegacyImage": { "type": "boolean" }, "probabilityOfSuccess": { "type": "string" }, "refreshPositionsResponse": { "type": "object" }, "targetRangeHigh": { "type": "string" }, "targetRangeLow": { "type": "string" }, "targetText": { "type": "string" } }, "xml": { "name": "Montecarlometer" }, "type": "object" }, "OAS.DataModel.Integration.MoneyGuidePro.Detail": { "properties": { "changes": { "type": "string" }, "current": { "type": "string" }, "description": { "type": "string" }, "recommended": { "type": "string" } }, "xml": { "name": "Detail" }, "type": "object" }, "OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.PlanSummaryResponse": { "properties": { "categories": { "items": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.PlanSummaryCategory" }, "xml": { "name": "PlanSummaryCategory", "wrapped": true }, "type": "array" }, "refreshPositionsResponse": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.RefreshPositionsResponse" }, "results": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.PlanSummaryResults" } }, "xml": { "name": "PlanSummaryResponse" }, "type": "object" }, "OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.PlanSummaryCategory": { "properties": { "description": { "type": "string" }, "header": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.PlanSummaryCategoryHeader" }, "topics": { "items": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.PlanSummaryTopic" }, "xml": { "name": "PlanSummaryTopic", "wrapped": true }, "type": "array" } }, "xml": { "name": "PlanSummaryCategory" }, "type": "object" }, "OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.PlanSummaryResults": { "properties": { "current": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.PlanSummaryResultsScenario" }, "monteCarloTargetRangeHigh": { "type": "string" }, "monteCarloTargetRangeLow": { "type": "string" }, "recommended": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.PlanSummaryResultsScenario" } }, "xml": { "name": "PlanSummaryResults" }, "type": "object" }, "OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.PlanSummaryCategoryHeader": { "properties": { "changes": { "type": "string" }, "current": { "type": "string" }, "description": { "type": "string" }, "recommended": { "type": "string" } }, "xml": { "name": "PlanSummaryCategoryHeader" }, "type": "object" }, "OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.PlanSummaryTopic": { "properties": { "items": { "items": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.PlanSummaryItem" }, "xml": { "name": "PlanSummaryItem", "wrapped": true }, "type": "array" }, "changes": { "type": "string" }, "current": { "type": "string" }, "description": { "type": "string" }, "recommended": { "type": "string" } }, "xml": { "name": "PlanSummaryTopic" }, "type": "object" }, "OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.PlanSummaryResultsScenario": { "properties": { "calculations": { "items": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.PlanSummaryResultCalculation" }, "xml": { "name": "PlanSummaryResultCalculation", "wrapped": true }, "type": "array" }, "monteCarloMeter": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.MonteCarloMeterResponse" } }, "xml": { "name": "PlanSummaryResultsScenario" }, "type": "object" }, "OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.PlanSummaryItem": { "properties": { "details": { "items": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.PlanSummaryDetail" }, "xml": { "name": "PlanSummaryDetail", "wrapped": true }, "type": "array" }, "changes": { "type": "string" }, "current": { "type": "string" }, "description": { "type": "string" }, "recommended": { "type": "string" } }, "xml": { "name": "PlanSummaryItem" }, "type": "object" }, "OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.PlanSummaryResultCalculation": { "properties": { "description": { "type": "string" }, "probabilityOfSuccess": { "type": "string" }, "safetyMarginCurrent": { "type": "string" }, "safetyMarginFuture": { "type": "string" } }, "xml": { "name": "PlanSummaryResultCalculation" }, "type": "object" }, "OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.PlanSummaryDetail": { "properties": { "changes": { "type": "string" }, "current": { "type": "string" }, "description": { "type": "string" }, "recommended": { "type": "string" } }, "xml": { "name": "PlanSummaryDetail" }, "type": "object" }, "OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.NetworthResponse": { "properties": { "investmentAssets": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.NetworthGroup" }, "liabilities": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.NetworthGroup" }, "networth": { "type": "number", "format": "double" }, "otherAssets": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.NetworthGroup" }, "refreshPositionsResponse": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.RefreshPositionsResponse" }, "totalAssets": { "type": "number", "format": "double" } }, "xml": { "name": "NetworthResponse" }, "type": "object" }, "OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.NetworthGroup": { "properties": { "categories": { "items": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.NetworthCategory" }, "xml": { "name": "NetworthCategory", "wrapped": true }, "type": "array" }, "name": { "type": "string" }, "totalValue": { "type": "number", "format": "double" } }, "xml": { "name": "NetworthGroup" }, "type": "object" }, "OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.NetworthCategory": { "properties": { "name": { "type": "string" }, "totalValue": { "type": "number", "format": "double" } }, "xml": { "name": "NetworthCategory" }, "type": "object" }, "OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.InsurancePoliciesResponse": { "properties": { "policies": { "items": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.InsurancePolicy" }, "xml": { "name": "InsurancePolicy", "wrapped": true }, "type": "array" } }, "xml": { "name": "InsurancePoliciesResponse" }, "type": "object" }, "OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.InsurancePolicy": { "properties": { "annualPremium": { "type": "number", "format": "double" }, "beneficiaries": { "items": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.InsurancePolicyBeneficiary" }, "xml": { "name": "InsurancePolicyBeneficiary", "wrapped": true }, "type": "array" }, "cashValue": { "type": "number", "format": "double" }, "deathBenefit": { "type": "number", "format": "double" }, "insuredName": { "type": "string" }, "isAsset": { "type": "boolean" }, "name": { "type": "string" }, "ownerName": { "type": "string" }, "premiumPaid": { "type": "string" }, "typeName": { "type": "string" } }, "xml": { "name": "InsurancePolicy" }, "type": "object" }, "OAS.Integrations.MoneyGuidePro.ExternalServices.MGP.InsurancePolicyBeneficiary": { "properties": { "name": { "type": "string" }, "percent": { "type": "number", "format": "double" } }, "xml": { "name": "InsurancePolicyBeneficiary" }, "type": "object" }, "OAS.Integrations.MoneyGuidePro.IntegrationConfig": { "properties": { "userId": { "type": "string" }, "password": { "type": "string" } }, "xml": { "name": "IntegrationConfig" }, "type": "object" }, "OAS.Integrations.MoneyGuidePro.ClientIntegrationConfig": { "properties": { "enabled": { "type": "boolean" } }, "xml": { "name": "ClientIntegrationConfig" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.MoneyGuidePro.MoneyGuideProSettingsDto": { "properties": { "institutionId": { "type": "integer", "format": "int32" }, "userName": { "type": "string" }, "password": { "type": "string" } }, "xml": { "name": "MoneyGuideProSettingsDto" }, "type": "object" }, "OAS.Integrations.MoneyGuidePro.DTO.MGPHouseholdInfo": { "properties": { "interface": { "type": "integer", "format": "int32" }, "integrationKey": { "type": "string" }, "integrationUserId": { "type": "string" }, "advisor": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.DTO.MGPAdvisorInfo" }, "participants": { "items": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.DTO.MGPParticipantInfo" }, "xml": { "name": "MGPParticipantInfo", "wrapped": true }, "type": "array" }, "assets": { "items": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.DTO.MGPAssetInfo" }, "xml": { "name": "MGPAssetInfo", "wrapped": true }, "type": "array" } }, "xml": { "name": "MGPHouseholdInfo" }, "type": "object" }, "OAS.Integrations.MoneyGuidePro.DTO.MGPAdvisorInfo": { "properties": { "admin": { "type": "string" }, "firstName": { "type": "string" }, "middleName": { "type": "string" }, "lastName": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "address3": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zipCode": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" }, "email2": { "type": "string" }, "cMgrAdvisorKey": { "type": "string" }, "securityToken": { "type": "string" }, "instId": { "type": "string" } }, "xml": { "name": "MGPAdvisorInfo" }, "type": "object" }, "OAS.Integrations.MoneyGuidePro.DTO.MGPParticipantInfo": { "properties": { "participantType": { "type": "integer", "format": "int32" }, "firstName": { "type": "string" }, "middleName": { "type": "string" }, "lastName": { "type": "string" }, "dob": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "address3": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zipCode": { "type": "string" }, "phone": { "type": "string" }, "fax": { "type": "string" }, "email": { "type": "string" }, "employmentStatus": { "type": "string" }, "sex": { "type": "integer", "format": "int32" }, "employmentIncome": { "type": "number", "format": "double" }, "cMgrKey": { "type": "string" }, "participantID": { "type": "integer", "format": "int32" }, "maritalStatus": { "type": "string" } }, "xml": { "name": "MGPParticipantInfo" }, "type": "object" }, "OAS.Integrations.MoneyGuidePro.DTO.MGPAssetInfo": { "properties": { "cmgrAssetKey": { "readOnly": true, "type": "string" }, "accountNumber": { "type": "string" }, "type": { "type": "string" }, "jointOwner": { "type": "string" }, "insured": { "type": "string" }, "deathBenefit": { "type": "string" }, "ticker": { "type": "string" }, "hasDetail": { "type": "string" }, "currentValue": { "type": "number", "format": "double" }, "costBasis": { "type": "string" }, "owner": { "type": "integer", "format": "int32" }, "interface": { "type": "integer", "format": "int32" }, "interfaceType": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "integrationDescription": { "type": "string" }, "assetKey": { "readOnly": true, "type": "string" }, "holdings": { "items": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.DTO.MGPHoldingInfo" }, "xml": { "name": "MGPHoldingInfo", "wrapped": true }, "type": "array" }, "registrationName": { "type": "string" } }, "xml": { "name": "MGPAssetInfo" }, "type": "object" }, "OAS.Integrations.MoneyGuidePro.DTO.MGPHoldingInfo": { "properties": { "cmgrAssetKey": { "readOnly": true, "type": "string" }, "type": { "type": "string" }, "description": { "type": "string" }, "ticker": { "type": "string" }, "cusip": { "type": "string" }, "costBasis": { "type": "number", "format": "double" }, "currentValue": { "type": "number", "format": "double" }, "assetKey": { "type": "string" }, "assetClasses": { "items": { "$ref": "#/definitions/OAS.Integrations.MoneyGuidePro.DTO.MGPAssetClassInfo" }, "xml": { "name": "MGPAssetClassInfo", "wrapped": true }, "type": "array" } }, "xml": { "name": "MGPHoldingInfo" }, "type": "object" }, "OAS.Integrations.MoneyGuidePro.DTO.MGPAssetClassInfo": { "properties": { "id": { "readOnly": true, "type": "string" }, "description": { "type": "string" }, "percent": { "type": "integer", "format": "int32" }, "assetClassAbbreviation": { "type": "string" }, "useAssetClassAbbreviation": { "type": "boolean" } }, "xml": { "name": "MGPAssetClassInfo" }, "type": "object" }, "OAS.Integrations.Element.DTOs.WorkflowDataDto": { "properties": { "_id": { "type": "integer", "format": "int32" }, "householdId": { "type": "integer", "format": "int32" }, "id": { "type": "string" }, "name": { "type": "string" }, "custodianId": { "type": "string" }, "registrationTypeId": { "type": "string" }, "contacts": { "items": { "$ref": "#/definitions/OAS.Integrations.Element.DTOs.Contact" }, "xml": { "name": "Contact", "wrapped": true }, "type": "array" }, "data": { "items": { "$ref": "#/definitions/OAS.Integrations.Element.DTOs.Datum" }, "xml": { "name": "Datum", "wrapped": true }, "type": "array" }, "uploads": { "items": { "$ref": "#/definitions/OAS.Integrations.Element.DTOs.FormSessionUpload" }, "xml": { "name": "FormSessionUpload", "wrapped": true }, "type": "array" }, "additionalInfo": { "type": "object" } }, "xml": { "name": "WorkflowDataDto" }, "type": "object" }, "OAS.Integrations.Element.DTOs.Contact": { "properties": { "_id": { "type": "integer", "format": "int32" }, "id": { "type": "string" }, "firstName": { "type": "string" }, "middleInitial": { "type": "object" }, "lastOrEntityName": { "type": "string" }, "dob": { "type": "object" }, "email": { "type": "string" }, "type": { "type": "string" }, "data": { "items": { "$ref": "#/definitions/OAS.Integrations.Element.DTOs.Datum" }, "xml": { "name": "Datum", "wrapped": true }, "type": "array" } }, "xml": { "name": "Contact" }, "type": "object" }, "OAS.Integrations.Element.DTOs.Datum": { "properties": { "category": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "object" } }, "xml": { "name": "Datum" }, "type": "object" }, "OAS.Integrations.Element.DTOs.FormSessionUpload": { "properties": { "id": { "type": "string" }, "size": { "type": "integer", "format": "int32" }, "fileType": { "type": "string" }, "fileBase64": { "type": "string" }, "fileName": { "type": "string" }, "parentFolderPath": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "markForDelete": { "type": "boolean" }, "entityType": { "type": "integer", "format": "int32" }, "entityId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "uploadId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "formCollectionId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "formSessionId": { "type": "string" }, "accountNumber": { "type": "string" }, "documentType": { "type": "string" }, "indexValues": { "items": { "$ref": "#/definitions/OAS.Integrations.Element.DTOs.UserFormData" }, "xml": { "name": "UserFormData", "wrapped": true }, "type": "array" } }, "xml": { "name": "FormSessionUpload" }, "type": "object" }, "OAS.Integrations.Element.DTOs.UserFormData": { "properties": { "syncType": { "type": "integer", "format": "int32" }, "key": { "type": "string" }, "value": { "type": "object" } }, "xml": { "name": "UserFormData" }, "type": "object" }, "System.ValueTupleOfSystem.StringAndSystem.Boolean": { "properties": { "item1": { "type": "string" }, "item2": { "type": "boolean" } }, "xml": { "name": "ValueTuple`2" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Onboarding.ConversionSourceDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "conversionTypeId": { "type": "integer", "format": "int32" }, "conversionStatusId": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "clientHistId": { "type": "integer", "format": "int32" }, "notes": { "type": "string" }, "setLocalPriceCutover": { "type": "boolean" }, "ibpNumber": { "type": "integer", "format": "int32" }, "programmerAssigned": { "type": "string" }, "internalData": { "type": "boolean" }, "type": { "type": "string" }, "status": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "ConversionSourceDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Onboarding.ConversionTypeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "fileMask": { "type": "string" } }, "xml": { "name": "ConversionTypeDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Onboarding.FileDataDTO": { "properties": { "name": { "type": "string" }, "size": { "type": "integer", "format": "int64" }, "conversionSourceId": { "type": "integer", "format": "int32" } }, "xml": { "name": "FileDataDTO" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Onboarding.ChunkDto": { "properties": { "_chunkSize": { "type": "integer", "format": "int32" }, "_currentChunkSize": { "type": "integer", "format": "int32" }, "_chunkNumber": { "type": "integer", "format": "int32" }, "_totalSize": { "type": "integer", "format": "int32" }, "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" }, "conversionSourceId": { "type": "integer", "format": "int32" } }, "xml": { "name": "ChunkDto" }, "type": "object" }, "OpenAI_API.Chat.ChatMessage": { "properties": { "role": { "type": "string" }, "content": { "type": "string" }, "name": { "type": "string" } }, "xml": { "name": "ChatMessage" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.EnvisionReportDto": { "properties": { "id": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "requiredOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportOption" }, "xml": { "name": "ReportOption", "wrapped": true }, "type": "array" }, "additionalOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportOptionCategory" }, "xml": { "name": "ReportOptionCategory", "wrapped": true }, "type": "array" }, "deliveryOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportOption" }, "xml": { "name": "ReportOption", "wrapped": true }, "type": "array" }, "hasAdditionalOptions": { "type": "boolean" }, "featureFlagOverrides": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IReportFeatureFlagOverrider" }, "groupingOptionOverrider": { "$ref": "#/definitions/OAS.DataModel.Reporting.Engine.IGroupingOptionOverrider" }, "isFavorite": { "type": "boolean" }, "reportName": { "type": "string" }, "reportDescription": { "type": "string" }, "parentCategory": { "type": "string" }, "category": { "type": "string" }, "runAssignedVersion": { "type": "boolean" } }, "xml": { "name": "EnvisionReportDto" }, "type": "object" }, "OAS.DataModel.Reporting.ReportOption": { "required": [ "id", "$type" ], "properties": { "id": { "type": "string" }, "$type": { "readOnly": true, "type": "string" }, "optionGuid": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "optionId": { "type": "integer", "format": "int32" }, "isDisabled": { "type": "boolean" }, "isGlobal": { "type": "boolean" }, "isIgnored": { "type": "boolean" }, "name": { "type": "string" }, "useInception": { "type": "boolean" }, "prompt": { "type": "string", "enum": [ "Never", "Always" ] } }, "xml": { "name": "ReportOption" }, "type": "object" }, "OAS.DataModel.Reporting.ReportOptionCategory": { "required": [ "category", "options" ], "properties": { "category": { "type": "string" }, "options": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportOption" }, "xml": { "name": "ReportOption", "wrapped": true }, "type": "array" } }, "xml": { "name": "ReportOptionCategory" }, "type": "object" }, "OAS.DataModel.Reporting.Interfaces.IReportFeatureFlagOverrider": { "properties": { "dynamicBenchmarkProcessType": { "readOnly": true, "type": "string", "enum": [ "Cloud", "LocalService" ] }, "forceAssetGroupingIntraDayPerformance": { "readOnly": true, "type": "boolean" }, "activityProcessType": { "readOnly": true, "type": "string", "enum": [ "Cloud", "LocalService" ] }, "costBasisProcessType": { "type": "string", "enum": [ "Old", "Cloud", "LocalService" ] }, "morningstarLevel2Assignment": { "type": "boolean" }, "localPriceCutOverDate": { "type": "string", "format": "date-time" }, "noScope": { "type": "boolean" }, "ensureAssetsUpdated": { "type": "boolean" }, "storeReportDataCompressed": { "type": "boolean" }, "showEInModelNames": { "type": "boolean" }, "performanceProcessType": { "type": "string", "enum": [ "Cloud", "LocalService" ] }, "forceNonSummaryPerformanceToUseTwr": { "type": "boolean" }, "forceNetOfFeesPerformance": { "type": "boolean" }, "costBasisStoredSource": { "type": "string", "enum": [ "Orion", "Custodian" ] }, "tradingWithParentGrouping": { "type": "boolean" }, "useGlobalSettingsUniqueIds": { "type": "boolean" }, "showEquations": { "type": "boolean" }, "isReportCompare": { "type": "boolean" }, "useBenchmarksInAccountChangeHistory": { "type": "boolean" }, "benchmarkAssignmentOverride": { "type": "string" }, "useAsOfDateForAdvizr": { "type": "boolean" }, "accountNumbersToShow": { "type": "integer", "format": "int32" }, "useBatchSettingsBulkCopy": { "type": "boolean" }, "showExcludedFromRebalance": { "type": "boolean" }, "useInMemoryForModelVsActual": { "type": "boolean" }, "useNewLineChartRenderer": { "type": "boolean" }, "useNewScatterPlotChartRenderer": { "type": "boolean" }, "useInMemoryIncomeCalculation": { "type": "boolean" }, "useModelAllocationHistory": { "type": "boolean" }, "useDisclaimerShadowDom": { "type": "boolean" } }, "xml": { "name": "IReportFeatureFlagOverrider" }, "type": "object" }, "OAS.DataModel.Reporting.Engine.IGroupingOptionOverrider": { "properties": { "allowExpireClientsToStorePerformance": { "type": "boolean" }, "ensureAssetsUpdated": { "type": "boolean" }, "groupCustodialCashTogether": { "type": "boolean" }, "groupLinksTogether": { "type": "boolean" }, "returnActiveLinkedEntity": { "type": "boolean" }, "useAccountChange": { "type": "boolean" }, "useSmaSettings": { "type": "boolean" }, "accountInclusion": { "type": "string" }, "includeHistoricalLinks": { "type": "string" } }, "xml": { "name": "IGroupingOptionOverrider" }, "type": "object" }, "OAS.Integrations.Pershing.DTOs.PershingHistoricalActivitiesInput": { "properties": { "activityTypeName": { "type": "string" }, "securityIdentifierTypeCode": { "type": "string" }, "securityIdentifier": { "type": "string" }, "asOfDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "recordReturnCount": { "type": "integer", "format": "int64" }, "scrollKey": { "type": "string" }, "accountIdentifier": { "type": "string" }, "multiTenantAuthenticationClientIdentifier": { "type": "string" } }, "xml": { "name": "PershingHistoricalActivitiesInput" }, "type": "object" }, "OAS.Integrations.Pershing.DTOs.PershingIntradayActivitiesInput": { "properties": { "activityTypeName": { "type": "string", "enum": [ "ALL", "TRADE_ONLY", "DIVIDEND_INTEREST", "CASH_WITHDRAWAL_OR_DEPOSIT", "COMMON_STOCK", "PREFERRED_STOCK", "OPTION", "MUTUAL_FUND", "BOND", "CD", "OTHER", "ACH_TRANSACTIONS", "JOURNAL_TRANSACTIONS", "CHECK_TRANSACTIONS" ] }, "securityIdentifierTypeCode": { "type": "string", "enum": [ "ALL", "CUSIP", "SYMBOL", "ISIN", "SEDOL" ] }, "securityIdentifier": { "type": "string" }, "recordReturnCount": { "type": "integer", "format": "int32" }, "scrollKey": { "type": "string" }, "accountIdentifier": { "type": "string" }, "multiTenantAuthenticationClientIdentifier": { "type": "string" } }, "xml": { "name": "PershingIntradayActivitiesInput" }, "type": "object" }, "OAS.Integrations.Pershing.DTOs.PershingIntradayHoldingsInput": { "properties": { "viewingCurrency": { "type": "string" }, "requestIdentifier": { "type": "integer", "format": "int64" }, "recordReturnCount": { "type": "integer", "format": "int64" }, "scrollKey": { "type": "string" }, "accountIdentifier": { "type": "string" }, "multiTenantAuthenticationClientIdentifier": { "type": "string" } }, "xml": { "name": "PershingIntradayHoldingsInput" }, "type": "object" }, "OAS.Integrations.Pershing.DTOs.PershingPriorDayBalancesInput": { "properties": { "viewingCurrency": { "type": "string" }, "accountIdentifier": { "type": "string" }, "multiTenantAuthenticationClientIdentifier": { "type": "string" } }, "xml": { "name": "PershingPriorDayBalancesInput" }, "type": "object" }, "OAS.Integrations.Pershing.DTOs.PershingPriorDayHoldingsInput": { "properties": { "viewingCurrency": { "type": "string" }, "recordReturnCount": { "type": "integer", "format": "int64" }, "scrollKey": { "type": "string" }, "accountIdentifier": { "type": "string" }, "multiTenantAuthenticationClientIdentifier": { "type": "string" } }, "xml": { "name": "PershingPriorDayHoldingsInput" }, "type": "object" }, "OAS.Integrations.Pershing.DTOs.PershingTransferableHoldingsInput": { "properties": { "holdingsRequestTypeCode": { "type": "string" }, "journalAccountProcessingTypeCode": { "type": "string" }, "scrollDirectionCode": { "type": "string" }, "scrollKey": { "type": "string" }, "accountTransferAssetTypeFilter": { "type": "string" }, "recordReturnCount": { "type": "integer", "format": "int64" }, "symbols": { "items": { "$ref": "#/definitions/OAS.Integrations.Pershing.DTOs.Symbol" }, "xml": { "name": "Symbol", "wrapped": true }, "type": "array" }, "accountIdentifier": { "type": "string" }, "multiTenantAuthenticationClientIdentifier": { "type": "string" } }, "xml": { "name": "PershingTransferableHoldingsInput" }, "type": "object" }, "OAS.Integrations.Pershing.DTOs.Symbol": { "properties": { "tickerSymbol": { "type": "string" } }, "xml": { "name": "Symbol" }, "type": "object" }, "OAS.DataModel.Integration.Pershing.netXuser": { "properties": { "username": { "type": "string" } }, "xml": { "name": "netXuser" }, "type": "object" }, "OAT.Integrations.Plaid.Classes.PlaidUserDto": { "properties": { "clientUserId": { "type": "string" }, "legalName": { "type": "string" }, "phoneNumber": { "type": "string" }, "phoneNumberVerifiedTime": { "type": "string" }, "emailAddress": { "type": "string" }, "emailAddressVerifiedTime": { "type": "string" }, "ssn": { "type": "string" }, "dateOfBirth": { "type": "string" } }, "xml": { "name": "PlaidUserDto" }, "type": "object" }, "OAT.Integrations.Plaid.Classes.PlaidAccountFiltersDto": { "properties": { "countryCodes": { "items": { "type": "string" }, "type": "array" }, "depositoryAccountFilter": { "items": { "type": "string" }, "type": "array" }, "creditAccountFilter": { "items": { "type": "string" }, "type": "array" }, "loanAccountFilter": { "items": { "type": "string" }, "type": "array" }, "investmentAccountFilter": { "items": { "type": "string" }, "type": "array" }, "otherAccountFilter": { "type": "string" } }, "xml": { "name": "PlaidAccountFiltersDto" }, "type": "object" }, "OAT.Integrations.Plaid.Classes.PlaidItemForUser": { "properties": { "IsInform": { "type": "boolean" }, "PlaidItemID": { "type": "string" }, "status": { "$ref": "#/definitions/OAT.Integrations.Plaid.Plaid.NET.Entity.PlaidStatus" }, "Error": { "type": "string" }, "InstitutionId": { "type": "string" }, "name": { "type": "string" }, "has_mfa": { "type": "boolean" }, "mfa": { "items": { "type": "string" }, "type": "array" }, "credentials": { "items": { "$ref": "#/definitions/OAT.Integrations.Plaid.Classes.PlaidItemForUser.Credential" }, "xml": { "name": "Credential", "wrapped": true }, "type": "array" }, "products": { "items": { "type": "string" }, "type": "array" } }, "xml": { "name": "PlaidItemForUser" }, "type": "object" }, "OAT.Integrations.Plaid.Plaid.NET.Entity.PlaidStatus": { "properties": { "investments": { "$ref": "#/definitions/OAT.Integrations.Plaid.Plaid.NET.Entity.StatusUpdate" }, "transactions": { "$ref": "#/definitions/OAT.Integrations.Plaid.Plaid.NET.Entity.StatusUpdate" }, "last_webhook": { "$ref": "#/definitions/OAT.Integrations.Plaid.Plaid.NET.Entity.WebHookUpdate" } }, "xml": { "name": "PlaidStatus" }, "type": "object" }, "OAT.Integrations.Plaid.Classes.PlaidItemForUser.Credential": { "properties": { "label": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "xml": { "name": "Credential" }, "type": "object" }, "OAT.Integrations.Plaid.Plaid.NET.Entity.StatusUpdate": { "properties": { "last_successful_update": { "type": "string" }, "last_failed_update": { "type": "string" } }, "xml": { "name": "StatusUpdate" }, "type": "object" }, "OAT.Integrations.Plaid.Plaid.NET.Entity.WebHookUpdate": { "properties": { "code_sent": { "type": "string" }, "sent_at": { "type": "string" } }, "xml": { "name": "WebHookUpdate" }, "type": "object" }, "OAT.Integrations.Plaid.IntegrationConfig": { "properties": { "secret": { "type": "string" }, "clientID": { "type": "string" }, "plaidEnvironment": { "type": "string" } }, "xml": { "name": "IntegrationConfig" }, "type": "object" }, "OAT.Integrations.Plaid.Acklann.Plaid.Entity.Institution": { "properties": { "institution_id": { "type": "string" }, "name": { "type": "string" }, "has_mfa": { "type": "boolean" }, "mfa": { "items": { "type": "string" }, "type": "array" }, "credentials": { "items": { "$ref": "#/definitions/OAT.Integrations.Plaid.Acklann.Plaid.Entity.Institution.Credential" }, "xml": { "name": "Credential", "wrapped": true }, "type": "array" }, "products": { "items": { "type": "string" }, "type": "array" } }, "xml": { "name": "Institution" }, "type": "object" }, "OAT.Integrations.Plaid.Acklann.Plaid.Entity.Institution.Credential": { "properties": { "label": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "xml": { "name": "Credential" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Quantum.QuantumJobDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "fileName": { "type": "string" }, "advisorNumber": { "type": "integer", "format": "int32" }, "dateReceived": { "type": "string", "format": "date-time" }, "status": { "type": "string" }, "lastUpdate": { "type": "string", "format": "date-time" } }, "xml": { "name": "QuantumJobDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.QuerySmith.ModifyRequestDto": { "properties": { "queryId": { "type": "integer", "format": "int32" }, "prompt": { "type": "string" }, "clarificationResponse": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.QuerySmith.ClarificationResponseDto" } }, "xml": { "name": "ModifyRequestDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.QuerySmith.ClarificationResponseDto": { "properties": { "option_id": { "type": "string" }, "text_input": { "type": "string" } }, "xml": { "name": "ClarificationResponseDto" }, "type": "object" }, "OAS.DataModel.Integrations.Quik.IntegrationConfig": { "properties": { "appLinkId": { "type": "integer", "format": "int32" }, "customerId": { "type": "string" }, "customerIdInt": { "readOnly": true, "type": "integer", "format": "int32" }, "username": { "type": "string" }, "password": { "type": "string" }, "userId": { "type": "integer", "format": "int32" }, "licenseId": { "type": "integer", "format": "int32" }, "docuSignIntegratorKey": { "type": "string" }, "docuSignApiDomain": { "type": "string" }, "docuSignUserId": { "type": "string" }, "docuSignPassword": { "type": "string" }, "docuSignOAuthToken": { "type": "string" }, "docuSignAccountId": { "type": "string" }, "tokenEndpoint": { "readOnly": true, "type": "string" }, "restBaseUri": { "readOnly": true, "type": "string" }, "docuSignDomain": { "readOnly": true, "type": "string" } }, "xml": { "name": "IntegrationConfig" }, "type": "object" }, "OAS.DataModel.Integrations.Quik.CustomerUser": { "properties": { "customerId": { "type": "integer", "format": "int32" }, "customerUserId": { "type": "string" }, "userId": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "licenseStatusId": { "type": "integer", "format": "int32" }, "expirationDate": { "type": "string", "format": "date-time" }, "userDetailId": { "type": "integer", "format": "int32" } }, "xml": { "name": "CustomerUser" }, "type": "object" }, "OAS.DataModel.Integrations.Quik.Dealer": { "properties": { "dealerId": { "type": "integer", "format": "int32" }, "dealerTypeId": { "type": "integer", "format": "int32" }, "dealerTypeName": { "type": "string" }, "dealerName": { "type": "string" }, "selected": { "type": "boolean" } }, "xml": { "name": "Dealer" }, "type": "object" }, "OAS.DataModel.Integrations.Quik.Form": { "properties": { "formId": { "type": "integer", "format": "int32" }, "dealerId": { "type": "integer", "format": "int32" }, "dealerName": { "type": "string" }, "formName": { "type": "string" }, "formDescription": { "type": "string" }, "publishDate": { "type": "string" }, "revisionDate": { "type": "string" }, "formPreviewUrl": { "type": "string" } }, "xml": { "name": "Form" }, "type": "object" }, "OAS.DataModel.Integrations.Quik.FormGroup": { "properties": { "formGroupId": { "type": "integer", "format": "int32" }, "formGroupName": { "type": "string" }, "description": { "type": "string" }, "isGlobal": { "type": "boolean" }, "userDetailId": { "type": "integer", "format": "int32" }, "forms": { "items": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.Form" }, "xml": { "name": "Form", "wrapped": true }, "type": "array" }, "associations": { "$ref": "#/definitions/OAS.DataModel.Integrations.Quik.Associations" } }, "xml": { "name": "FormGroup" }, "type": "object" }, "OAS.DataModel.Integrations.Quik.Associations": { "properties": { "custodianIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "accountTypeIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "fundFamilyIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "brokerDealerIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "platformIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "feeScheduleIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "subAdvisorIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, "xml": { "name": "Associations" }, "type": "object" }, "OAS.DataModel.Integrations.Quik.QuikNewAccount": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "accountTypeName": { "type": "string" }, "custodianName": { "type": "string" }, "platformName": { "type": "string" }, "paperworkStatus": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "signatureStatus": { "type": "string" } }, "xml": { "name": "QuikNewAccount" }, "type": "object" }, "OAS.DataModel.Integrations.QuikIntegration": { "required": [ "id", "entityId", "entity", "editedDate", "editedBy", "createdDate", "createdBy" ], "properties": { "id": { "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "formData": { "type": "string" }, "docuSignEnvelopeId": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 } }, "xml": { "name": "QuikIntegration" }, "type": "object" }, "OAS.WebApi.Domains.Integrations.QuikController.QuikResponseDto": { "properties": { "StatusCode": { "type": "string" }, "StatusMessage": { "type": "string" } }, "xml": { "name": "QuikResponseDto" }, "type": "object" }, "OAT.Integrations.Redtail.UserConfig": { "properties": { "userKey": { "type": "string" }, "syncEnabled": { "type": "boolean" }, "contactUpdatedId": { "type": "integer", "format": "int32" } }, "xml": { "name": "UserConfig" }, "type": "object" }, "OAS.DataProcess.DTO.Integrations.Redtail.FirmConfig": { "properties": { "emailAddresses": { "items": { "type": "string" }, "type": "array" }, "orionFirmId": { "type": "integer", "format": "int32" }, "redtailFirmId": { "type": "integer", "format": "int32" }, "reps": { "items": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integrations.Redtail.RepEntry" }, "xml": { "name": "RepEntry", "wrapped": true }, "type": "array" }, "users": { "items": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integrations.Redtail.RedtailUser" }, "xml": { "name": "RedtailUser", "wrapped": true }, "type": "array" }, "partnerAppId": { "description": "The unique ID of the partner app.", "type": "integer", "format": "int32" }, "productName": { "description": "The unique name of the partner app product.", "type": "string" } }, "xml": { "name": "FirmConfig" }, "type": "object" }, "OAS.DataProcess.DTO.Integrations.Redtail.RepEntry": { "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "name": { "type": "string" }, "repId": { "type": "integer", "format": "int32" } }, "xml": { "name": "RepEntry" }, "type": "object" }, "OAS.DataProcess.DTO.Integrations.Redtail.RedtailUser": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "repIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "reps": { "items": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integrations.Redtail.RepEntry" }, "xml": { "name": "RepEntry", "wrapped": true }, "type": "array" } }, "xml": { "name": "RedtailUser" }, "type": "object" }, "OAS.Integrations.RiskAlyze.Classes.Client": { "properties": { "id": { "type": "integer", "format": "int32" }, "client_id": { "type": "integer", "format": "int32" }, "client_user_id": { "type": "string" }, "advisor_user_id": { "type": "string" }, "fname": { "type": "string" }, "lname": { "type": "string" }, "risk_number": { "type": "number", "format": "double" }, "photo_path": { "type": "string" }, "phone": { "type": "string" }, "status": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "email": { "type": "string" }, "integrations": { "items": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Classes.Integration" }, "xml": { "name": "Integration", "wrapped": true }, "type": "array" }, "extras": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Classes.Extras" }, "latest_current_portfolio": { "type": "integer", "format": "int32" }, "latest_proposed_portfolio": { "type": "integer", "format": "int32" }, "questionnaires": { "items": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Classes.Questionnaire" }, "xml": { "name": "Questionnaire", "wrapped": true }, "type": "array" }, "portfolios": { "items": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Classes.Portfolio" }, "xml": { "name": "Portfolio", "wrapped": true }, "type": "array" }, "x_RiskScoreImage": { "type": "string", "format": "byte" }, "x_RiskScoreImageUri": { "type": "string" } }, "xml": { "name": "Client" }, "type": "object" }, "OAS.Integrations.RiskAlyze.Classes.Integration": { "properties": { "id": { "type": "string" }, "client_id": { "type": "string" }, "type": { "type": "string" }, "ex_id_1": { "type": "string" }, "ex_id_2": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" } }, "xml": { "name": "Integration" }, "type": "object" }, "OAS.Integrations.RiskAlyze.Classes.Extras": { "properties": { "type": { "type": "string" }, "database_id": { "type": "integer", "format": "int32" }, "contact_id": { "type": "integer", "format": "int32" } }, "xml": { "name": "Extras" }, "type": "object" }, "OAS.Integrations.RiskAlyze.Classes.Questionnaire": { "properties": { "id": { "type": "integer", "format": "int32" }, "user_id": { "type": "string" }, "client_id": { "type": "string" }, "advisor_id": { "type": "string" }, "fname": { "type": "string" }, "lname": { "type": "string" }, "ai": { "type": "string" }, "financial_status": { "type": "string" }, "financial_goals": { "type": "string" }, "archived": { "type": "string" }, "sent": { "type": "string" }, "sent_timestamp": { "type": "string", "format": "date-time" }, "timestamp": { "type": "string", "format": "date-time" }, "completed": { "type": "string" }, "deleted": { "type": "string" }, "rq4_simple": { "type": "string" }, "birth_year": { "type": "string" }, "retirement_age": { "type": "string" }, "retirement_year": { "type": "string" }, "risk_number": { "type": "number", "format": "double" }, "x_RiskScoreImage": { "type": "string", "format": "byte" }, "x_RiskScoreImageUri": { "type": "string" } }, "xml": { "name": "Questionnaire" }, "type": "object" }, "OAS.Integrations.RiskAlyze.Classes.Portfolio": { "properties": { "id": { "type": "integer", "format": "int32" }, "user_id": { "type": "string" }, "client_id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "total": { "type": "integer", "format": "int32" }, "analysis": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Classes.Analysis" }, "status": { "type": "string" }, "type": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "analyzed": { "type": "string", "format": "date-time" }, "data_model": { "type": "integer", "format": "int32" }, "deleted": { "type": "integer", "format": "int32" }, "editable": { "type": "integer", "format": "int32" }, "data_models": { "items": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Classes.DataModel" }, "xml": { "name": "DataModel", "wrapped": true }, "type": "array" }, "is_dirty": { "type": "integer", "format": "int32" }, "accounts": { "items": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Classes.Account" }, "xml": { "name": "Account", "wrapped": true }, "type": "array" }, "config": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Classes.Config" }, "permissions": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Classes.PortfolioPermissions" }, "result": { "type": "string" } }, "xml": { "name": "Portfolio" }, "type": "object" }, "OAS.Integrations.RiskAlyze.Classes.Analysis": { "properties": { "return": { "type": "number", "format": "double" }, "ttm_dividend": { "type": "number", "format": "double" }, "annual_fee": { "type": "number", "format": "double" }, "advisory_fee": { "type": "number", "format": "double" }, "stdev": { "type": "number", "format": "double" }, "risk_number": { "type": "number", "format": "double" }, "risk_metric": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Classes.RiskMetric" }, "worst": { "type": "number", "format": "double" }, "best": { "type": "number", "format": "double" }, "stresstests": { "items": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Classes.StressTest" }, "xml": { "name": "StressTest", "wrapped": true }, "type": "array" }, "categories": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Classes.Categories" }, "heatmap": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Classes.Heatmap" }, "alloclog_id": { "type": "integer", "format": "int32" }, "x_RiskScoreImage": { "type": "string", "format": "byte" }, "x_RiskScoreImageUri": { "type": "string" } }, "xml": { "name": "Analysis" }, "type": "object" }, "OAS.Integrations.RiskAlyze.Classes.DataModel": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "type": { "type": "string" }, "market": { "type": "number", "format": "double" }, "interest": { "type": "number", "format": "double" }, "risk_number": { "type": "integer", "format": "int32" } }, "xml": { "name": "DataModel" }, "type": "object" }, "OAS.Integrations.RiskAlyze.Classes.Account": { "properties": { "id": { "type": "integer", "format": "int32" }, "portfolio_id": { "type": "integer", "format": "int32" }, "asset_manager_id": { "type": "object" }, "custodian_id": { "type": "object" }, "type_id": { "type": "object" }, "name": { "type": "string" }, "total": { "type": "number", "format": "double" }, "status": { "type": "string" }, "type": { "type": "string" }, "order": { "type": "object" }, "analysis": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Classes.Analysis" }, "messages": { "items": { "type": "object" }, "type": "array" }, "created": { "type": "string" }, "updated": { "type": "object" }, "synced": { "type": "object" }, "settings": { "type": "object" }, "external_config": { "type": "object" }, "integrations": { "items": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Classes.AccountIntegration" }, "xml": { "name": "AccountIntegration", "wrapped": true }, "type": "array" }, "tracked_model_id": { "type": "object" }, "is_autopilot_enabled": { "type": "integer", "format": "int32" }, "trading_status": { "type": "string" }, "allocations": { "items": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Classes.Allocation" }, "xml": { "name": "Allocation", "wrapped": true }, "type": "array" }, "allocations_excluded": { "items": { "type": "object" }, "type": "array" } }, "xml": { "name": "Account" }, "type": "object" }, "OAS.Integrations.RiskAlyze.Classes.Config": { "properties": { "account_types": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Classes.AccountTypes" }, "lists": { "type": "object" }, "model_default_total": { "type": "integer", "format": "int32" } }, "xml": { "name": "Config" }, "type": "object" }, "OAS.Integrations.RiskAlyze.Classes.PortfolioPermissions": { "properties": { "read": { "type": "integer", "format": "int32" }, "write": { "type": "integer", "format": "int32" }, "delete": { "type": "integer", "format": "int32" } }, "xml": { "name": "PortfolioPermissions" }, "type": "object" }, "OAS.Integrations.RiskAlyze.Classes.RiskMetric": { "properties": { "type": { "type": "string" }, "value": { "type": "integer", "format": "int32" } }, "xml": { "name": "RiskMetric" }, "type": "object" }, "OAS.Integrations.RiskAlyze.Classes.StressTest": { "properties": { "slug": { "type": "string" }, "return": { "type": "number", "format": "double" }, "stdev": { "type": "number", "format": "double" }, "risk_number": { "type": "integer", "format": "int32" } }, "xml": { "name": "StressTest" }, "type": "object" }, "OAS.Integrations.RiskAlyze.Classes.Categories": { "properties": { "asset_class": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Classes.AssetClass" } }, "xml": { "name": "Categories" }, "type": "object" }, "OAS.Integrations.RiskAlyze.Classes.Heatmap": { "properties": { "diversified_risk": { "type": "number", "format": "double" }, "risk": { "type": "number", "format": "double" }, "reward": { "type": "number", "format": "double" } }, "xml": { "name": "Heatmap" }, "type": "object" }, "OAS.Integrations.RiskAlyze.Classes.AccountIntegration": { "properties": { "client_ex_api_link_id": { "type": "string" }, "custodial_account_number": { "type": "string" }, "custodian_id": { "type": "integer", "format": "int32" }, "custodian_slug": { "type": "string" }, "ex_account_id": { "type": "string" }, "service": { "type": "string" } }, "xml": { "name": "AccountIntegration" }, "type": "object" }, "OAS.Integrations.RiskAlyze.Classes.Allocation": { "properties": { "id": { "type": "integer", "format": "int32" }, "account_id": { "type": "integer", "format": "int32" }, "portfolio_id": { "type": "integer", "format": "int32" }, "sec_id": { "type": "integer", "format": "int64" }, "order": { "type": "object" }, "analysis": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Classes.Analysis" }, "settings": { "type": "object" }, "data": { "type": "object" }, "rank": { "type": "integer", "format": "int32" }, "hash": { "type": "object" }, "price": { "type": "number", "format": "double" }, "shares": { "type": "number", "format": "double" }, "amount": { "type": "number", "format": "double" }, "value_as_of_date": { "type": "object" }, "is_locked_for_trading": { "type": "integer", "format": "int32" }, "security": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Classes.Security" } }, "xml": { "name": "Allocation" }, "type": "object" }, "OAS.Integrations.RiskAlyze.Classes.AccountTypes": { "properties": { "standard": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Classes.Standard" }, "sma": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Classes.Sma" }, "uma": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Classes.Uma" }, "va": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Classes.Va" } }, "xml": { "name": "AccountTypes" }, "type": "object" }, "OAS.Integrations.RiskAlyze.Classes.AssetClass": { "properties": { "bonds": { "type": "number", "format": "double" }, "stocks": { "type": "number", "format": "double" }, "cash": { "type": "number", "format": "double" }, "other": { "type": "number", "format": "double" }, "unavailable": { "type": "number", "format": "double" } }, "xml": { "name": "AssetClass" }, "type": "object" }, "OAS.Integrations.RiskAlyze.Classes.Security": { "properties": { "shortname": { "type": "string" }, "longname": { "type": "string" }, "type": { "type": "string" } }, "xml": { "name": "Security" }, "type": "object" }, "OAS.Integrations.RiskAlyze.Classes.Standard": { "properties": { "order": { "type": "integer", "format": "int32" }, "label": { "type": "string" }, "description": { "type": "string" }, "default_allocations": { "items": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Classes.DefaultAllocations" }, "xml": { "name": "DefaultAllocations", "wrapped": true }, "type": "array" }, "permissions": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Classes.Permissions" } }, "xml": { "name": "Standard" }, "type": "object" }, "OAS.Integrations.RiskAlyze.Classes.Sma": { "properties": { "order": { "type": "integer", "format": "int32" }, "label": { "type": "string" }, "description": { "type": "string" }, "default_allocations": { "items": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Classes.DefaultAllocations" }, "xml": { "name": "DefaultAllocations", "wrapped": true }, "type": "array" }, "permissions": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Classes.Permissions" } }, "xml": { "name": "Sma" }, "type": "object" }, "OAS.Integrations.RiskAlyze.Classes.Uma": { "properties": { "order": { "type": "integer", "format": "int32" }, "label": { "type": "string" }, "description": { "type": "string" }, "default_allocations": { "items": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Classes.DefaultAllocations" }, "xml": { "name": "DefaultAllocations", "wrapped": true }, "type": "array" }, "permissions": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Classes.Permissions" } }, "xml": { "name": "Uma" }, "type": "object" }, "OAS.Integrations.RiskAlyze.Classes.Va": { "properties": { "order": { "type": "integer", "format": "int32" }, "label": { "type": "string" }, "description": { "type": "string" }, "default_allocations": { "items": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Classes.DefaultAllocations" }, "xml": { "name": "DefaultAllocations", "wrapped": true }, "type": "array" }, "permissions": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Classes.Permissions" } }, "xml": { "name": "Va" }, "type": "object" }, "OAS.Integrations.RiskAlyze.Classes.DefaultAllocations": { "properties": { "sec_id": { "type": "integer", "format": "int32" }, "security": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Classes.Security" } }, "xml": { "name": "DefaultAllocations" }, "type": "object" }, "OAS.Integrations.RiskAlyze.Classes.Permissions": { "properties": { "change_type": { "type": "integer", "format": "int32" }, "allocation_details": { "type": "integer", "format": "int32" }, "settings": { "type": "integer", "format": "int32" }, "optimizer": { "type": "integer", "format": "int32" }, "add": { "type": "integer", "format": "int32" }, "remove": { "type": "integer", "format": "int32" }, "delete": { "type": "integer", "format": "int32" }, "entry_type": { "items": { "type": "string" }, "type": "array" } }, "xml": { "name": "Permissions" }, "type": "object" }, "OAS.Integrations.RiskAlyze.Dto.RiskalyzeAnalysisDto": { "properties": { "clientId": { "type": "integer", "format": "int32" }, "riskalyzeClientId": { "type": "integer", "format": "int32" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "status": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "riskNumber": { "type": "number", "format": "double" }, "currentPortfolio": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Dto.RiskalyzePortfolioDto" }, "proposedPortfolio": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Dto.RiskalyzePortfolioDto" }, "questionnaire": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Dto.QuestionnaireDto" } }, "xml": { "name": "RiskalyzeAnalysisDto" }, "type": "object" }, "OAS.Integrations.RiskAlyze.Dto.RiskalyzePortfolioDto": { "properties": { "riskalyzePortfolioId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "string" }, "total": { "type": "integer", "format": "int32" }, "analysis": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Dto.AnalysisDto" }, "riskScoreImage": { "type": "string", "format": "byte" }, "accounts": { "items": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Dto.RiskalyzeAccountDto" }, "xml": { "name": "RiskalyzeAccountDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "RiskalyzePortfolioDto" }, "type": "object" }, "OAS.Integrations.RiskAlyze.Dto.QuestionnaireDto": { "properties": { "riskalyzeQuestionnaireId": { "type": "integer", "format": "int32" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "birthYear": { "type": "string" }, "retirementAge": { "type": "string" }, "retirementYear": { "type": "string" }, "timeStamp": { "type": "string", "format": "date-time" }, "riskNumber": { "type": "number", "format": "double" }, "riskScoreImage": { "type": "string", "format": "byte" }, "riskScoreImageUri": { "type": "string" } }, "xml": { "name": "QuestionnaireDto" }, "type": "object" }, "OAS.Integrations.RiskAlyze.Dto.AnalysisDto": { "properties": { "riskNumber": { "type": "number", "format": "double" }, "riskScoreImage": { "type": "string", "format": "byte" }, "riskScoreImageUri": { "type": "string" }, "best": { "type": "number", "format": "double" }, "worst": { "type": "number", "format": "double" } }, "xml": { "name": "AnalysisDto" }, "type": "object" }, "OAS.Integrations.RiskAlyze.Dto.RiskalyzeAccountDto": { "properties": { "riskalyzeAccountId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "string" }, "total": { "type": "number", "format": "double" }, "allocationPercent": { "type": "number", "format": "double" }, "analysis": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Dto.AnalysisDto" }, "allocations": { "items": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Dto.RiskalyzeAllocationDto" }, "xml": { "name": "RiskalyzeAllocationDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "RiskalyzeAccountDto" }, "type": "object" }, "OAS.Integrations.RiskAlyze.Dto.RiskalyzeAllocationDto": { "properties": { "riskalyzeAllocationId": { "type": "integer", "format": "int32" }, "longName": { "type": "string" }, "shortName": { "type": "string" }, "type": { "type": "string" }, "amount": { "type": "number", "format": "double" }, "allocationPercent": { "type": "number", "format": "double" }, "analysis": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Dto.AnalysisDto" } }, "xml": { "name": "RiskalyzeAllocationDto" }, "type": "object" }, "OAS.Integrations.RiskAlyze.Dto.RiskAlyzeAccountUpsertDto": { "properties": { "riskAlyzeId": { "type": "string" }, "orionAccountId": { "type": "integer", "format": "int32" }, "modelAggId": { "type": "integer", "format": "int32" }, "riskBudget": { "type": "integer", "format": "int32" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "repId": { "type": "integer", "format": "int32" }, "sessionAuthToken": { "type": "string" }, "custodian": { "type": "string" }, "allocations": { "items": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Dto.RiskAlyzeAccountUpsertDto.Allocation" }, "xml": { "name": "Allocation", "wrapped": true }, "type": "array" } }, "xml": { "name": "RiskAlyzeAccountUpsertDto" }, "type": "object" }, "OAS.Integrations.RiskAlyze.Dto.RiskAlyzeAccountUpsertDto.Allocation": { "properties": { "id": { "type": "integer", "format": "int32" }, "security": { "items": { "$ref": "#/definitions/OAS.Integrations.RiskAlyze.Dto.RiskAlyzeAccountUpsertDto.Security" }, "xml": { "name": "Security", "wrapped": true }, "type": "array" }, "amount": { "type": "integer", "format": "int32" } }, "xml": { "name": "Allocation" }, "type": "object" }, "OAS.Integrations.RiskAlyze.Dto.RiskAlyzeAccountUpsertDto.Security": { "properties": { "ticker": { "type": "string" }, "longname": { "type": "string" }, "type": { "type": "string" } }, "xml": { "name": "Security" }, "type": "object" }, "OAS.Integrations.RiskAlyze.Dto.TickerAllocationsDto": { "properties": { "ticker": { "type": "string" }, "allocation": { "type": "number", "format": "double" } }, "xml": { "name": "TickerAllocationsDto" }, "type": "object" }, "OAS.Integrations.RiskAlyze.IntegrationInfo": { "properties": { "client_secret": { "type": "string" }, "client_id": { "type": "string" }, "orionUid": { "type": "string" }, "orionPwd": { "type": "string" }, "redirect_uri": { "type": "string" }, "repId": { "type": "string" } }, "xml": { "name": "IntegrationInfo" }, "type": "object" }, "OAS.DataModel.Integration.RiskAlyze.RiskAlyzeUser": { "properties": { "access_token": { "type": "string" }, "expires_in": { "type": "integer", "format": "int32" }, "token_type": { "type": "string" }, "scope": { "type": "string" }, "refresh_token": { "type": "string" }, "deadRefreshToken": { "type": "boolean" }, "errorMessage": { "type": "string" }, "tokenExpiresIn": { "readOnly": true, "type": "string", "format": "date-time" } }, "xml": { "name": "RiskAlyzeUser" }, "type": "object" }, "OAS.DataProcess.Integrations.RiskAnalytics.PortfolioViewRiskScoreRequest": { "properties": { "selectedEntity": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.SelectedEntity" }, "accountsInclusionOverride": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.AccountManagementOverride" }, "xml": { "name": "AccountManagementOverride", "wrapped": true }, "type": "array" } }, "xml": { "name": "PortfolioViewRiskScoreRequest" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.AccountManagementOverride": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "isManaged": { "type": "boolean" }, "isIncluded": { "type": "boolean" } }, "xml": { "name": "AccountManagementOverride" }, "type": "object" }, "OAS.DataModel.Integration.RiskScoreGenericDto": { "properties": { "currentScore": { "type": "number", "format": "double" }, "targetScore": { "type": "number", "format": "double" }, "portfolioRiskScore": { "type": "number", "format": "double" }, "clientId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "scoreProvider": { "type": "string" }, "asOfDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "RiskScoreGenericDto" }, "type": "object" }, "OAT.Integrations.Glia.DTOs.OperatorPasswordDto": { "properties": { "password": { "type": "string" } }, "xml": { "name": "OperatorPasswordDto" }, "type": "object" }, "OAS.WebApi.DTO.Security.GliaServiceDto": { "properties": { "team": { "type": "string" }, "emailAddress": { "type": "string" }, "phone": { "type": "string" }, "chatUrl": { "type": "string" }, "chatSecurityCode": { "type": "string" }, "chatRouteIntendedRecipient": { "type": "string" } }, "xml": { "name": "GliaServiceDto" }, "type": "object" }, "OAS.Integrations.Salesforce.CompareRecordDto": { "properties": { "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "entityDescription": { "type": "string" }, "orgId": { "type": "string" }, "salesforceRecordId": { "type": "string" }, "salesforceEditBy": { "type": "string" }, "salesforceEditDate": { "type": "string", "format": "date-time" }, "orionEditBy": { "type": "string" }, "orionEditDate": { "type": "string", "format": "date-time" }, "isChanged": { "readOnly": true, "type": "boolean" }, "fields": { "items": { "$ref": "#/definitions/OAS.Integrations.Salesforce.CompareRecordFieldDto" }, "xml": { "name": "CompareRecordFieldDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "CompareRecordDto" }, "type": "object" }, "OAS.Integrations.Salesforce.CompareRecordFieldDto": { "properties": { "name": { "type": "string" }, "orionValue": { "type": "string" }, "salesforceValue": { "type": "string" }, "isChanged": { "readOnly": true, "type": "boolean" } }, "xml": { "name": "CompareRecordFieldDto" }, "type": "object" }, "OAS.Salesforce.OrionConnect.ProjectItemsDto": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "recordType": { "type": "string" } }, "xml": { "name": "ProjectItemsDto" }, "type": "object" }, "OAS.DataProcess.DTO.Integration.Salesforce.SyncJobStatus": { "properties": { "jobId": { "type": "string" }, "jobStatus": { "type": "string" }, "jobStateReason": { "type": "string" } }, "xml": { "name": "SyncJobStatus" }, "type": "object" }, "Hangfire.Storage.StateData": { "properties": { "name": { "type": "string" }, "reason": { "type": "string" }, "data": { "additionalProperties": { "type": "string" }, "type": "object" } }, "xml": { "name": "StateData" }, "type": "object" }, "OAS.Salesforce.CustomCommunitiesSamlConfig": { "properties": { "alclientid": { "type": "string" }, "urL_BASE": { "type": "string" }, "issuer": { "type": "string" }, "cerT_PATH": { "type": "string" }, "cerT_PASS": { "type": "string" }, "audience": { "type": "string" }, "recipienT_URL": { "type": "string" }, "relaystate": { "type": "string" }, "destination": { "type": "string" } }, "xml": { "name": "CustomCommunitiesSamlConfig" }, "type": "object" }, "OAS.WebApi.Code.Integrations.SalesforceSetIdentityDto": { "properties": { "auth_domain": { "type": "string" }, "access_token": { "type": "string" } }, "xml": { "name": "SalesforceSetIdentityDto" }, "type": "object" }, "OAS.DataModel.Integration.OrionConnect.SalesforceUser": { "required": [ "id", "alClientId", "dataSyncType", "ssisPackageID", "runSync" ], "properties": { "id": { "type": "integer", "format": "int32" }, "orgId": { "type": "string", "maxLength": 18, "minLength": 0 }, "userName": { "type": "string", "maxLength": 100, "minLength": 0 }, "password": { "type": "string", "maxLength": 100, "minLength": 0 }, "alClientId": { "type": "integer", "format": "int32" }, "namespace": { "type": "string", "maxLength": 50, "minLength": 0 }, "lastDataRefresh": { "type": "string", "format": "date-time" }, "audit": { "$ref": "#/definitions/OAT.DataModel.ComplexTypes.BasicAuditNotNullNotNull" }, "redtailApiKey": { "type": "string", "maxLength": 50, "minLength": 0 }, "retailSecretKey": { "type": "string", "maxLength": 100, "minLength": 0 }, "redtailUrlRegex": { "type": "string", "maxLength": 100, "minLength": 0 }, "redtailDatabaseId": { "type": "integer", "format": "int32" }, "dataSyncType": { "type": "integer", "format": "int32" }, "token": { "type": "string", "maxLength": 50, "minLength": 0 }, "salesforceMappingId": { "type": "integer", "format": "int32" }, "serviceURL": { "type": "string", "maxLength": 100, "minLength": 0 }, "ssisPackageID": { "type": "integer", "format": "int32" }, "versionNumber": { "type": "string", "maxLength": 8, "minLength": 0 }, "runSync": { "type": "integer", "format": "int32" }, "repId": { "type": "integer", "format": "int32" }, "mapping": { "$ref": "#/definitions/OAS.DataModel.Integration.OrionConnect.SalesforceMapping" } }, "xml": { "name": "SalesforceUser" }, "type": "object" }, "OAS.DataModel.Integration.OrionConnect.SalesforceMapping": { "required": [ "id", "name", "mappingXML" ], "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "maxLength": 50, "minLength": 0 }, "mappingXML": { "type": "string" } }, "xml": { "name": "SalesforceMapping" }, "type": "object" }, "OAS.WebApi.Code.Integrations.SalesForce.SfSyncPostDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "repId": { "type": "integer", "format": "int32" }, "orgId": { "type": "string" }, "userName": { "type": "string" }, "password": { "type": "string" }, "serviceURL": { "type": "string" } }, "xml": { "name": "SfSyncPostDto" }, "type": "object" }, "OAS.Integrations.SamlServices.Models.PartnerInfoDto": { "properties": { "partnerId": { "type": "integer", "format": "int32" }, "publicCertificate": { "type": "string" }, "certificateSerialNumber": { "type": "string" }, "certificateThumbprint": { "type": "string" }, "certificateEffectiveDateUtc": { "type": "string", "format": "date-time" }, "certificateExpirationUtc": { "type": "string", "format": "date-time" }, "samlIssuer": { "type": "string" }, "partnerName": { "type": "string" }, "productName": { "type": "string" }, "productDescription": { "type": "string" } }, "xml": { "name": "PartnerInfoDto" }, "type": "object" }, "OAS.Integrations.SchwabV2.Shared.SchwabSAPostDto": { "properties": { "alClientId": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "userDtlId": { "type": "integer", "format": "int32" }, "type": { "type": "string", "enum": [ "NotSet", "RMD", "BlockAccountNumber" ] } }, "xml": { "name": "SchwabSAPostDto" }, "type": "object" }, "OAS.Integrations.SchwabAlliance.SchwabAllianceToken": { "properties": { "access_token": { "type": "string" }, "refresh_token": { "type": "string" }, "scope": { "type": "string" }, "token_type": { "type": "string" }, "expires_in": { "type": "integer", "format": "int32" }, "expires_datetime": { "type": "string", "format": "date-time" }, "id_token": { "type": "string" } }, "xml": { "name": "SchwabAllianceToken" }, "type": "object" }, "OAS.Integrations.SchwabAlliance.Models.AccountBlockNumbersRetrieveResponse": { "properties": { "data": { "$ref": "#/definitions/OAS.Integrations.SchwabAlliance.Models.AccountBlockNumbersRetrieveResponseData" }, "errors": { "items": { "$ref": "#/definitions/OAS.Integrations.SchwabAlliance.Models.AccountBlockNumbersError" }, "xml": { "name": "AccountBlockNumbersError", "wrapped": true }, "type": "array" } }, "xml": { "name": "AccountBlockNumbersRetrieveResponse" }, "type": "object" }, "OAS.Integrations.SchwabAlliance.Models.AccountBlockNumbersRetrieveResponseData": { "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "attributes": { "$ref": "#/definitions/OAS.Integrations.SchwabAlliance.Models.AccountBlockNumbersRetrieveResponseAttributes" } }, "xml": { "name": "AccountBlockNumbersRetrieveResponseData" }, "type": "object" }, "OAS.Integrations.SchwabAlliance.Models.AccountBlockNumbersError": { "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "title": { "type": "string" }, "detail": { "type": "string" }, "source": { "$ref": "#/definitions/OAS.Integrations.SchwabAlliance.Models.AccountBlockNumbersErrorSource" } }, "xml": { "name": "AccountBlockNumbersError" }, "type": "object" }, "OAS.Integrations.SchwabAlliance.Models.AccountBlockNumbersRetrieveResponseAttributes": { "properties": { "status": { "type": "string" }, "maxLimit": { "type": "integer", "format": "int32" }, "available": { "type": "integer", "format": "int32" }, "reserved": { "type": "integer", "format": "int32" }, "accounts": { "items": { "$ref": "#/definitions/OAS.Integrations.SchwabAlliance.Models.AccountBlockNumbersRetrieveResponseAccount" }, "xml": { "name": "AccountBlockNumbersRetrieveResponseAccount", "wrapped": true }, "type": "array" } }, "xml": { "name": "AccountBlockNumbersRetrieveResponseAttributes" }, "type": "object" }, "OAS.Integrations.SchwabAlliance.Models.AccountBlockNumbersErrorSource": { "properties": { "header": { "type": "string" } }, "xml": { "name": "AccountBlockNumbersErrorSource" }, "type": "object" }, "OAS.Integrations.SchwabAlliance.Models.AccountBlockNumbersRetrieveResponseAccount": { "properties": { "account": { "type": "integer", "format": "int32" }, "updatedBy": { "type": "string" }, "UpdatedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "AccountBlockNumbersRetrieveResponseAccount" }, "type": "object" }, "OAS.Integrations.SchwabV2.ServiceRequest.Models.SchwabCreateServiceRequestRequestDto": { "properties": { "files": { "items": { "$ref": "#/definitions/System.Web.HttpPostedFile" }, "xml": { "name": "HttpPostedFile", "wrapped": true }, "type": "array" }, "masterAccount": { "type": "string" }, "account": { "type": "string" }, "topicName": { "type": "string" }, "subTopicName": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "schwabCaseId": { "type": "string" }, "ccEmail": { "type": "boolean" }, "showAccount": { "type": "string" } }, "xml": { "name": "SchwabCreateServiceRequestRequestDto" }, "type": "object" }, "System.Web.HttpPostedFile": { "properties": { "fileName": { "readOnly": true, "type": "string" }, "contentType": { "readOnly": true, "type": "string" }, "contentLength": { "readOnly": true, "type": "integer", "format": "int32" }, "inputStream": { "$ref": "#/definitions/System.IO.Stream", "readOnly": true } }, "xml": { "name": "HttpPostedFile" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.ServiceRequestData": { "properties": { "subTopic": { "type": "string" }, "topic": { "type": "string" }, "subAccount": { "type": "string" }, "masterAccount": { "type": "string" }, "requestName": { "type": "string" }, "requestDescription": { "type": "string" }, "clientChannelOverride": { "type": "string" }, "files": { "items": { "$ref": "#/definitions/System.Web.HttpPostedFile" }, "xml": { "name": "HttpPostedFile", "wrapped": true }, "type": "array" } }, "xml": { "name": "ServiceRequestData" }, "type": "object" }, "OAS.DataModel.Integration.ResultItemOfOAT.Integrations.Schwab.SII.Dto.SchwabServiceResponseDto": { "properties": { "item": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.SchwabServiceResponseDto" }, "hasError": { "type": "boolean" }, "status": { "type": "string" } }, "xml": { "name": "ResultItem`1" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.SchwabServiceResponseDto": { "properties": { "id": { "type": "string" }, "trackingId": { "type": "string" }, "lastUpdated": { "type": "string", "format": "date-time" }, "masterAccount": { "type": "string" }, "masterAccountName": { "type": "string" }, "fullSubAccountName": { "type": "string" }, "subAccountName": { "type": "string" }, "subAccount": { "type": "string" }, "topic": { "type": "string" }, "topicName": { "type": "string" }, "subtopic": { "type": "string" }, "name": { "type": "string" }, "firstLastName": { "type": "string" }, "description": { "type": "string" }, "carbonCopyTo": { "type": "string" }, "schwabCaseId": { "type": "string" }, "creator": { "type": "string" }, "campaignCode": { "type": "integer", "format": "int32" }, "firmId": { "type": "integer", "format": "int32" }, "firmName": { "type": "string" }, "createDate": { "type": "string", "format": "date-time" }, "hasAttachments": { "type": "boolean" }, "findYourTeamEmail": { "type": "string" }, "confirmationId": { "type": "string" }, "isArchived": { "type": "boolean" }, "source": { "type": "string" }, "statusId": { "type": "integer", "format": "int32" }, "forceError": { "type": "boolean" }, "attachmentData": { "items": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.Attachmentdata" }, "xml": { "name": "Attachmentdata", "wrapped": true }, "type": "array" }, "schwabChannelCode": { "type": "string" }, "carbonCopyEmail": { "type": "boolean" }, "phoneNumber": { "type": "string" }, "serviceRequestTrackingUrl": { "type": "string" } }, "xml": { "name": "SchwabServiceResponseDto" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.Attachmentdata": { "properties": { "location": { "type": "string" }, "name": { "type": "string" }, "size": { "type": "string" }, "id": { "type": "string" }, "isValidFileType": { "type": "boolean" } }, "xml": { "name": "Attachmentdata" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.SchwabRequestCenterDTO": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "subtopics": { "items": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.SchwabRequestCenterDTO.Subtopic" }, "xml": { "name": "Subtopic", "wrapped": true }, "type": "array" } }, "xml": { "name": "SchwabRequestCenterDTO" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.SchwabRequestCenterDTO.Subtopic": { "properties": { "name": { "type": "string" }, "attachmentAllowed": { "type": "boolean" }, "attachmentRequired": { "type": "boolean" }, "maxAttachmentSize": { "type": "integer", "format": "int32" } }, "xml": { "name": "Subtopic" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.SchwabSIIUnenrollDTO": { "properties": { "serviceStatusField": { "type": "boolean" }, "statusIndicatorField": { "type": "boolean" }, "responseDateTimeField": { "type": "string", "format": "date-time" }, "serviceMessagesField": { "items": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.SchwabSIIServiceMessageDto" }, "xml": { "name": "SchwabSIIServiceMessageDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "SchwabSIIUnenrollDTO" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.SchwabSIIEnrollmentStatusDto": { "properties": { "enrollmentStatus": { "type": "string" }, "statusIndicator": { "type": "string", "enum": [ "Active", "InActive" ] }, "enrollmentRequestData": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.SchwabSIIEnrollmentRequestDto" }, "serviceMessages": { "items": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.SchwabSIIServiceMessageDto" }, "xml": { "name": "SchwabSIIServiceMessageDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "SchwabSIIEnrollmentStatusDto" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.SchwabSIIEnrollmentRequestDto": { "properties": { "url": { "type": "string" }, "sourceData": { "type": "string" }, "digitalSignature": { "type": "string" } }, "xml": { "name": "SchwabSIIEnrollmentRequestDto" }, "type": "object" }, "OAS.Integrations.SchwabV2.User_Authorizations.SchwabUserAuthorizationsResponseDto": { "properties": { "data": { "$ref": "#/definitions/OAS.Integrations.SchwabV2.User_Authorizations.SchwabUAData" } }, "xml": { "name": "SchwabUserAuthorizationsResponseDto" }, "type": "object" }, "OAS.Integrations.SchwabV2.User_Authorizations.SchwabUAData": { "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "attributes": { "$ref": "#/definitions/OAS.Integrations.SchwabV2.User_Authorizations.SchwabUAAttributes" } }, "xml": { "name": "SchwabUAData" }, "type": "object" }, "OAS.Integrations.SchwabV2.User_Authorizations.SchwabUAAttributes": { "properties": { "isUserFsa": { "type": "boolean" }, "authorizations": { "items": { "$ref": "#/definitions/OAS.Integrations.SchwabV2.User_Authorizations.SchwabUAAuthorizations" }, "xml": { "name": "SchwabUAAuthorizations", "wrapped": true }, "type": "array" } }, "xml": { "name": "SchwabUAAttributes" }, "type": "object" }, "OAS.Integrations.SchwabV2.User_Authorizations.SchwabUAAuthorizations": { "properties": { "authorization": { "type": "string" }, "isAuthorized": { "type": "boolean" } }, "xml": { "name": "SchwabUAAuthorizations" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.SchwabSIIUserAuthorizationTokenDto": { "properties": { "sacoAuthToken": { "type": "string" }, "logOnUrl": { "type": "string" }, "responseDateTime": { "type": "string", "format": "date-time" }, "serviceMessages": { "items": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.SchwabSIIServiceMessageDto" }, "xml": { "name": "SchwabSIIServiceMessageDto", "wrapped": true }, "type": "array" }, "accountNumber": { "type": "string" } }, "xml": { "name": "SchwabSIIUserAuthorizationTokenDto" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.SchwabSIIAccountAlertsInquiryDtoRest": { "properties": { "alerts": { "items": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.Alert" }, "xml": { "name": "Alert", "wrapped": true }, "type": "array" }, "nextRowId": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "responseActual": { "type": "integer", "format": "int32" } }, "xml": { "name": "SchwabSIIAccountAlertsInquiryDtoRest" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.Alert": { "properties": { "accountId": { "type": "string" }, "alertId": { "type": "integer", "format": "int32" }, "msgAlertType": { "type": "string" }, "msgCategory": { "type": "string" }, "msgCreateDate": { "type": "string" }, "msgAlertDesc": { "type": "string" }, "masterAccountId": { "type": "integer", "format": "int32" }, "messageDetailText": { "type": "string" }, "msgPriority": { "type": "string" }, "status": { "type": "string" }, "subAccountName": { "type": "string" }, "msgSubject": { "type": "string" }, "msgText": { "type": "string" }, "msgTransferStatus": { "type": "string" }, "msgTransferStatusDate": { "type": "string" } }, "xml": { "name": "Alert" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.SchwabRestBalance": { "properties": { "accountBalances": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.Accountbalances" } }, "xml": { "name": "SchwabRestBalance" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.Accountbalances": { "properties": { "accountNetWorth": { "type": "number", "format": "double" }, "cash": { "type": "number", "format": "double" }, "marginBalance": { "type": "number", "format": "double" }, "moneyMarketFund": { "type": "number", "format": "double" }, "totalAccountBalance": { "type": "number", "format": "double" }, "totalMarketValue": { "type": "number", "format": "double" } }, "xml": { "name": "Accountbalances" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.SchwabRestPostionsDetail": { "properties": { "positions": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.Positions" } }, "xml": { "name": "SchwabRestPostionsDetail" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.Positions": { "properties": { "positionsDetails": { "items": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.Positionsdetail" }, "xml": { "name": "Positionsdetail", "wrapped": true }, "type": "array" } }, "xml": { "name": "Positions" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.Positionsdetail": { "properties": { "dayChange": { "type": "string" }, "marketValue": { "type": "number", "format": "double" }, "quantity": { "type": "number", "format": "double" }, "quotedPrice": { "type": "number", "format": "double" }, "securityName": { "type": "string" }, "securityType": { "type": "string" }, "symbol": { "type": "string" } }, "xml": { "name": "Positionsdetail" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.SchwabRestProfilesResponse": { "properties": { "profiles": { "items": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.SchwabRestProfileResponse" }, "xml": { "name": "SchwabRestProfileResponse", "wrapped": true }, "type": "array" } }, "xml": { "name": "SchwabRestProfilesResponse" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.SchwabRestProfileResponse": { "properties": { "accountId": { "type": "string" }, "contact": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.Contacts" }, "holders": { "items": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.Holder" }, "xml": { "name": "Holder", "wrapped": true }, "type": "array" }, "registrationType": { "type": "string" } }, "xml": { "name": "SchwabRestProfileResponse" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.Contacts": { "properties": { "city": { "type": "string" }, "country": { "type": "string" }, "mailingAddress": { "type": "string" }, "stateZip": { "type": "string" } }, "xml": { "name": "Contacts" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.Holder": { "properties": { "role": { "type": "string" }, "beneficiaryAssetPercentage": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "Holder" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.SchwabRestReportResponse": { "properties": { "documents": { "items": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.Document" }, "xml": { "name": "Document", "wrapped": true }, "type": "array" }, "actualResponseCount": { "type": "integer", "format": "int32" }, "nextRowId": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "serviceMessage": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.SchwabSIIServiceMessageDto" } }, "xml": { "name": "SchwabRestReportResponse" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.Document": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "preparedByDate": { "type": "string", "format": "date-time" }, "reportId": { "type": "string" }, "reportName": { "type": "string" }, "reportType": { "type": "string" }, "reportDescription": { "type": "string" } }, "xml": { "name": "Document" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.SchwabRestReportRequest": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "startRow": { "type": "integer", "format": "int32" }, "maxRows": { "type": "integer", "format": "int32" }, "startDate": { "type": "integer", "format": "int32" }, "endDate": { "type": "integer", "format": "int32" }, "reportType": { "type": "string" }, "reportName": { "type": "string" }, "reportId": { "type": "string" } }, "xml": { "name": "SchwabRestReportRequest" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.SchwabSIICostBasicPreferencesResponse": { "properties": { "accountPreferences": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.AccountPreferences" }, "actualResponseCount": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "nextRowId": { "type": "integer", "format": "int32" }, "errors": { "items": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.error" }, "xml": { "name": "error", "wrapped": true }, "type": "array" } }, "xml": { "name": "SchwabSIICostBasicPreferencesResponse" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.AccountPreferences": { "properties": { "summary": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.AccountPreferencesSummary" }, "details": { "items": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.AccountPreferencesDetail" }, "xml": { "name": "AccountPreferencesDetail", "wrapped": true }, "type": "array" } }, "xml": { "name": "AccountPreferences" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.error": { "properties": { "code": { "type": "string" }, "detail": { "type": "string" }, "id": { "type": "string" }, "status": { "type": "string" }, "title": { "type": "string" } }, "xml": { "name": "error" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.AccountPreferencesSummary": { "properties": { "initialCbSource": { "type": "string" }, "accountingMethod": { "type": "string" }, "averageMF": { "type": "boolean" }, "adjustCbFI": { "type": "boolean" }, "autoSubscribe": { "type": "boolean" }, "statementType": { "type": "string" }, "masterAccountId": { "type": "string" } }, "xml": { "name": "AccountPreferencesSummary" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.AccountPreferencesDetail": { "properties": { "accountNumber": { "type": "string" }, "accountName": { "type": "string" }, "nonTaxableAccount": { "type": "boolean" }, "initialCbProvider": { "type": "string" }, "accountingMethod": { "type": "string" }, "averageMF": { "type": "boolean" }, "adjustCostBasisFI": { "type": "boolean" }, "gainLossTab": { "type": "boolean" }, "schwabAllianceLogOn": { "type": "boolean" }, "cBonStatements": { "type": "boolean" }, "yearEndGainLossReport": { "type": "string" } }, "xml": { "name": "AccountPreferencesDetail" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.SchwabRestUnrealizedGainLossDetailResponse": { "properties": { "summary": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.UnRealizedSummary" }, "positions": { "items": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.UnRealizedPosition" }, "xml": { "name": "UnRealizedPosition", "wrapped": true }, "type": "array" }, "cacheId": { "type": "string" }, "isAmortized": { "type": "boolean" }, "actualResponseCount": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "nextRowId": { "type": "integer", "format": "int32" }, "errors": { "items": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.error" }, "xml": { "name": "error", "wrapped": true }, "type": "array" } }, "xml": { "name": "SchwabRestUnrealizedGainLossDetailResponse" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.UnRealizedSummary": { "properties": { "accountId": { "type": "string" }, "totalKnownCostBasis": { "type": "string" }, "totalKnownMarketValue": { "type": "string" }, "totalKnownUnrealizedGainLossDollar": { "type": "string" }, "totalKnownUnrealizedGainLossPercent": { "type": "string" } }, "xml": { "name": "UnRealizedSummary" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.UnRealizedPosition": { "properties": { "costBasis": { "type": "string" }, "marketValue": { "type": "string" }, "notes": { "type": "string" }, "positionId": { "type": "string" }, "quantity": { "type": "string" }, "securityName": { "type": "string" }, "symbol": { "type": "string" }, "unrealizedGainLossDollar": { "type": "string" }, "unrealizedGainLossPercent": { "type": "string" } }, "xml": { "name": "UnRealizedPosition" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.UnRealizedPositionLotDetailResponse": { "properties": { "positions": { "items": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.UnrealizedLotPosition" }, "xml": { "name": "UnrealizedLotPosition", "wrapped": true }, "type": "array" }, "errors": { "items": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.error" }, "xml": { "name": "error", "wrapped": true }, "type": "array" } }, "xml": { "name": "UnRealizedPositionLotDetailResponse" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.UnrealizedLotPosition": { "properties": { "lots": { "items": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.UnrealizedLotDetailLot" }, "xml": { "name": "UnrealizedLotDetailLot", "wrapped": true }, "type": "array" }, "positionId": { "type": "string" } }, "xml": { "name": "UnrealizedLotPosition" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.UnrealizedLotDetailLot": { "properties": { "acquiredOrOpened": { "type": "string" }, "costBasis": { "type": "string" }, "holdingPeriod": { "type": "string" }, "lotDetail": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.Lotdetail" }, "lotDetailType": { "type": "string" }, "lotId": { "type": "string" }, "marketValue": { "type": "string" }, "notes": { "type": "string" }, "quantity": { "type": "string" }, "unrealizedGainLossDollar": { "type": "string" }, "unrealizedGainLossPercent": { "type": "string" } }, "xml": { "name": "UnrealizedLotDetailLot" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.Lotdetail": { "properties": { "adjustedCostBasis": { "type": "string" }, "adjustedCostPerShare": { "type": "string" }, "adjustedUnrealizedGainLossDollar": { "type": "string" }, "adjustedUnrealizedGainLossPercent": { "type": "string" }, "costBasis": { "type": "string" }, "costPerShare": { "type": "string" }, "currentPrice": { "type": "string" }, "todaysChangeInPriceDollar": { "type": "string" }, "todaysChangeInPricePercent": { "type": "string" }, "todaysChangeInValueDollar": { "type": "string" }, "todaysChangeInValuePercent": { "type": "string" }, "unrealizedGainLossDollar": { "type": "string" }, "unrealizedGainLossPercent": { "type": "string" } }, "xml": { "name": "Lotdetail" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.SchwabRestRealizedGainLossResponse": { "properties": { "summary": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.RealizedGainLossSummary" }, "transactionList": { "items": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.RealizedGainLossTransactionlist" }, "xml": { "name": "RealizedGainLossTransactionlist", "wrapped": true }, "type": "array" }, "actualResponseCount": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int32" }, "nextRowId": { "type": "integer", "format": "int32" }, "errors": { "items": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.error" }, "xml": { "name": "error", "wrapped": true }, "type": "array" } }, "xml": { "name": "SchwabRestRealizedGainLossResponse" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.RealizedGainLossSummary": { "properties": { "accountId": { "type": "string" }, "totalKnownCostBasis": { "type": "string" }, "totalKnownLongTermRealizedGainLoss": { "type": "string" }, "totalKnownProceeds": { "type": "string" }, "totalKnownShortTermRealizedGainLoss": { "type": "string" }, "totalKnownRealizedGainLossDollar": { "type": "string" }, "totalKnownRealizedGainLossPercent": { "type": "string" }, "errors": { "items": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.error" }, "xml": { "name": "error", "wrapped": true }, "type": "array" } }, "xml": { "name": "RealizedGainLossSummary" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.RealizedGainLossTransactionlist": { "properties": { "acquiredOrOpened": { "type": "string" }, "costBasis": { "type": "string" }, "longTermRealizedGainLoss": { "type": "string" }, "lotsAvailable": { "type": "boolean" }, "transactionLotList": { "items": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.RealizedGainLossTransactionlotlist" }, "xml": { "name": "RealizedGainLossTransactionlotlist", "wrapped": true }, "type": "array" }, "notes": { "type": "string" }, "quantitySold": { "type": "string" }, "securityName": { "type": "string" }, "shortTermRealizedGainLoss": { "type": "string" }, "soldClosed": { "type": "string" }, "symbol": { "type": "string" }, "totalProceeds": { "type": "string" }, "totalRealizedGainLossDollar": { "type": "string" }, "totalRealizedGainLossPercent": { "type": "string" }, "transactionId": { "type": "string" } }, "xml": { "name": "RealizedGainLossTransactionlist" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.RealizedGainLossTransactionlotlist": { "properties": { "acquiredOrOpened": { "type": "string" }, "costBasis": { "type": "string" }, "longTermRealizedGainLoss": { "type": "string" }, "lotDetail": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.RealizedGainLossLotdetail" }, "lotDetailType": { "type": "string" }, "lotId": { "type": "string" }, "notes": { "type": "string" }, "quantitySold": { "type": "string" }, "shortTermRealizedGainLoss": { "type": "string" }, "soldClosed": { "type": "string" }, "totalProceeds": { "type": "string" }, "totalRealizedGainLossDollar": { "type": "string" }, "totalRealizedGainLossPercent": { "type": "string" } }, "xml": { "name": "RealizedGainLossTransactionlotlist" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.RealizedGainLossLotdetail": { "properties": { "adjustedCostBasis": { "type": "string" }, "adjustedCostPerShare": { "type": "string" }, "adjustedDisallowedLossW": { "type": "string" }, "adjustedRealizedGainLossDollar": { "type": "string" }, "adjustedRealizedGainLossPercent": { "type": "string" }, "costBasis": { "type": "string" }, "costPerShare": { "type": "string" }, "disallowedLossW": { "type": "string" }, "holdingPeriod": { "type": "string" }, "proceedsPerShare": { "type": "string" }, "realizedGainLossDollar": { "type": "string" }, "realizedGainLossPercent": { "type": "string" } }, "xml": { "name": "RealizedGainLossLotdetail" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.SchwabRestTransactionResponse": { "properties": { "transactionsResponse": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.Transactionsresponse" } }, "xml": { "name": "SchwabRestTransactionResponse" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.Transactionsresponse": { "properties": { "transactions": { "items": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.Transaction" }, "xml": { "name": "Transaction", "wrapped": true }, "type": "array" } }, "xml": { "name": "Transactionsresponse" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.Transaction": { "properties": { "action": { "type": "string" }, "tickerSymbol": { "type": "string" }, "description": { "type": "string" }, "price": { "type": "number", "format": "double" }, "quantity": { "type": "number", "format": "double" }, "securityType": { "type": "string" }, "symbol": { "type": "string" }, "totalAmount": { "type": "number", "format": "double" }, "executedDate": { "type": "string", "format": "date-time" }, "publishTimeStamp": { "type": "string", "format": "date-time" }, "tradeDate": { "type": "string" } }, "xml": { "name": "Transaction" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.SchwabRestTransDetailResponse": { "properties": { "transactionDetail": { "$ref": "#/definitions/OAT.Integrations.Schwab.SII.Dto.Transactiondetail" } }, "xml": { "name": "SchwabRestTransDetailResponse" }, "type": "object" }, "OAT.Integrations.Schwab.SII.Dto.Transactiondetail": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "actionCode": { "type": "string" }, "tickerSymbol": { "type": "string" }, "issueClassCode": { "type": "string" }, "majorIssueClassCode": { "type": "string" }, "maturityDate": { "type": "string", "format": "date-time" }, "optionFriendlySymbol": { "type": "string" }, "orderId": { "type": "integer", "format": "int32" }, "securityNumber": { "type": "integer", "format": "int32" }, "symbol": { "type": "string" }, "accruedInterest": { "type": "number", "format": "double" }, "amount": { "type": "number", "format": "double" }, "commission": { "type": "number", "format": "double" }, "description": { "type": "string" }, "priceAmount": { "type": "number", "format": "double" }, "executionDate": { "type": "string", "format": "date-time" }, "historyMessage": { "type": "string" }, "netAmount": { "type": "number", "format": "double" }, "orderHandlingAmount": { "type": "number", "format": "double" }, "otherAmount": { "type": "number", "format": "double" }, "primeBrokerAmount": { "type": "number", "format": "double" }, "redemptionFee": { "type": "number", "format": "double" }, "securityFee": { "type": "number", "format": "double" }, "settlementDate": { "type": "string", "format": "date-time" }, "shareQuantity": { "type": "number", "format": "double" }, "stateTax": { "type": "number", "format": "double" }, "tradeAwayAmount": { "type": "number", "format": "double" }, "withholdingTax": { "type": "number", "format": "double" } }, "xml": { "name": "Transactiondetail" }, "type": "object" }, "OAS.Integrations.SchwabV2.Models.SancContext": { "properties": { "subaccount": { "type": "string" }, "masteraccount": { "type": "string" }, "accountNumber": { "type": "string" }, "alertid": { "type": "string" }, "hidenavigation": { "type": "string" }, "trackingid": { "type": "string" }, "symbol": { "type": "string" } }, "xml": { "name": "SancContext" }, "type": "object" }, "OAS.Integrations.SchwabV2.Alerts.SchwabAlertsV2DetailDto": { "properties": { "detailId": { "type": "string" }, "masterAccount": { "type": "string" }, "account": { "type": "string" }, "showAccount": { "type": "boolean" } }, "xml": { "name": "SchwabAlertsV2DetailDto" }, "type": "object" }, "OAS.WebApi.Domains.Integrations.SmartIQController.SmartIqSync": { "properties": { "count": { "type": "integer", "format": "int32" }, "smartIqUser": { "items": { "$ref": "#/definitions/OAS.WebApi.Domains.Integrations.SmartIQController.SmartIqUser" }, "xml": { "name": "SmartIqUser", "wrapped": true }, "type": "array" } }, "xml": { "name": "SmartIqSync" }, "type": "object" }, "OAS.WebApi.Domains.Integrations.SmartIQController.SmartIqUser": { "properties": { "id": { "type": "integer", "format": "int32" }, "profileId": { "type": "integer", "format": "int32" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "entityEnum": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "userName": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "alClientId": { "type": "integer", "format": "int32" }, "firm": { "type": "string" }, "isActive": { "type": "boolean" }, "roleId": { "type": "integer", "format": "int32" } }, "xml": { "name": "SmartIqUser" }, "type": "object" }, "OAS.DataModel.Security.PartnerApp": { "required": [ "id", "partnerName", "productName", "enabled", "useIpRestrictions", "useCustodianRestrictions", "clientSecret", "createdDate", "createdBy", "editedDate", "editedBy", "defaultRefreshTokenLifetime", "partnerAppType" ], "properties": { "id": { "type": "integer", "format": "int32" }, "partnerName": { "type": "string", "maxLength": 255, "minLength": 0 }, "productName": { "type": "string", "maxLength": 255, "minLength": 0 }, "productDescription": { "type": "string", "maxLength": 2000, "minLength": 0 }, "enabled": { "type": "boolean" }, "useIpRestrictions": { "type": "boolean" }, "useCustodianRestrictions": { "type": "boolean" }, "clientSecret": { "type": "string", "maxLength": 100, "minLength": 0 }, "contactName": { "type": "string", "maxLength": 255, "minLength": 0 }, "contactPhone": { "type": "string", "maxLength": 50, "minLength": 0 }, "contactEmail": { "type": "string", "maxLength": 50, "minLength": 0 }, "supportName": { "type": "string", "maxLength": 255, "minLength": 0 }, "supportPhone": { "type": "string", "maxLength": 50, "minLength": 0 }, "supportEmail": { "type": "string", "maxLength": 50, "minLength": 0 }, "homePageURL": { "type": "string", "maxLength": 255, "minLength": 0 }, "learnMorePath": { "type": "string", "maxLength": 255, "minLength": 0 }, "productLogo": { "type": "string", "format": "byte" }, "termsOfService": { "type": "string", "maxLength": 255, "minLength": 0 }, "securityCode": { "type": "string", "maxLength": 25, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "defaultRefreshTokenLifetime": { "type": "integer", "format": "int32", "maximum": 9000, "minimum": 0 }, "smallProductLogo": { "type": "string", "format": "byte" }, "partnerAppType": { "type": "integer", "format": "int32" }, "productShortDescription": { "type": "string", "maxLength": 80, "minLength": 0 }, "connectLevel": { "type": "string", "enum": [ "None", "DevOrTestOnly", "Testers", "Administrators", "Advisors", "Users" ] }, "implementationStatus": { "type": "string", "enum": [ "NotImplemented", "InDevelopment", "InTesting", "Implemented" ] }, "jobId": { "type": "integer", "format": "int32" }, "privilegeId": { "type": "integer", "format": "int32" }, "confirmEmailTo": { "type": "string" }, "scopes": { "type": "string" }, "certificateThumbprint": { "type": "string" }, "certificateSerialNumber": { "type": "string" }, "certificateEffectiveDateUtc": { "type": "string", "format": "date-time" }, "certificateExpirationUtc": { "type": "string", "format": "date-time" }, "samlIssuer": { "type": "string" }, "publicCertificate": { "type": "string" }, "custodianRestrictions": { "items": { "$ref": "#/definitions/OAS.DataModel.Security.PartnerAppCustodianRestriction" }, "xml": { "name": "PartnerAppCustodianRestriction", "wrapped": true }, "type": "array" }, "ipRanges": { "items": { "$ref": "#/definitions/OAS.DataModel.Security.PartnerAppIpRange" }, "xml": { "name": "PartnerAppIpRange", "wrapped": true }, "type": "array" }, "urlWhitelist": { "items": { "$ref": "#/definitions/OAS.DataModel.Security.PartnerAppUrlWhitelist" }, "xml": { "name": "PartnerAppUrlWhitelist", "wrapped": true }, "type": "array" }, "samlDomains": { "items": { "$ref": "#/definitions/OAS.DataModel.Security.PartnerAppSamlEmailDomain" }, "xml": { "name": "PartnerAppSamlEmailDomain", "wrapped": true }, "type": "array" }, "refreshTokens": { "items": { "$ref": "#/definitions/OAS.DataModel.Security.PartnerAppUser" }, "xml": { "name": "PartnerAppUser", "wrapped": true }, "type": "array" }, "advisors": { "items": { "$ref": "#/definitions/OAS.DataModel.Security.PartnerAppAdvisor" }, "xml": { "name": "PartnerAppAdvisor", "wrapped": true }, "type": "array" }, "customUrls": { "items": { "$ref": "#/definitions/OAS.DataModel.Security.PartnerAppCustomUrl" }, "xml": { "name": "PartnerAppCustomUrl", "wrapped": true }, "type": "array" } }, "xml": { "name": "PartnerApp" }, "type": "object" }, "OAS.DataModel.Security.PartnerAppCustodianRestriction": { "required": [ "partnerAppId", "custodianCommonId", "createdDate", "createdBy", "editedDate", "editedBy" ], "properties": { "partnerAppId": { "type": "integer", "format": "int32" }, "custodianCommonId": { "type": "integer", "format": "int32" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "custodianCommon": { "$ref": "#/definitions/OAS.DataModel.Portfolio.CustodianCommon" } }, "xml": { "name": "PartnerAppCustodianRestriction" }, "type": "object" }, "OAS.DataModel.Security.PartnerAppIpRange": { "required": [ "id", "partnerAppId", "startAddress", "endAddress", "createdBy", "createdDate", "editedBy", "editedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "partnerAppId": { "type": "integer", "format": "int32" }, "description": { "type": "string", "maxLength": 255, "minLength": 0 }, "startAddress": { "type": "string", "maxLength": 15, "minLength": 0, "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$" }, "endAddress": { "type": "string", "maxLength": 15, "minLength": 0, "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$" }, "isBlacklist": { "readOnly": true, "type": "boolean" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "PartnerAppIpRange" }, "type": "object" }, "OAS.DataModel.Security.PartnerAppSamlEmailDomain": { "required": [ "id", "partnerAppId", "emailDomain" ], "properties": { "id": { "type": "integer", "format": "int32" }, "partnerAppId": { "type": "integer", "format": "int32" }, "emailDomain": { "type": "string" } }, "xml": { "name": "PartnerAppSamlEmailDomain" }, "type": "object" }, "OAS.DataModel.Security.PartnerAppAdvisor": { "properties": { "id": { "type": "integer", "format": "int32" }, "partnerAppId": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "serviceCredentials": { "type": "string", "maxLength": 8000, "minLength": 0 }, "acceptedTOS": { "type": "boolean" }, "acceptedTOSUserId": { "type": "string" }, "created": { "type": "string", "format": "date-time" } }, "xml": { "name": "PartnerAppAdvisor" }, "type": "object" }, "OAS.DataModel.Security.PartnerAppCustomUrl": { "required": [ "id", "urlType", "url", "indexId" ], "properties": { "id": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "partnerAppId": { "type": "integer", "format": "int32" }, "urlType": { "type": "string", "enum": [ "ResetPassword", "PartnerAppRedirect" ] }, "url": { "type": "string" }, "indexId": { "type": "integer", "format": "int32" } }, "xml": { "name": "PartnerAppCustomUrl" }, "type": "object" }, "OAS.DataModel.Portfolio.CustodianCommon": { "required": [ "id", "code", "name" ], "properties": { "id": { "type": "integer", "format": "int32" }, "code": { "type": "string", "maxLength": 10, "minLength": 0 }, "name": { "type": "string", "maxLength": 100, "minLength": 0 } }, "xml": { "name": "CustodianCommon" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.IntegrationSyncHistoryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "syncType": { "type": "string" }, "status": { "type": "string" }, "messages": { "type": "string" } }, "xml": { "name": "IntegrationSyncHistoryDto" }, "type": "object" }, "OAT.Integrations.TD.Dto.TDUserDto": { "properties": { "userId": { "type": "string" }, "password": { "type": "string" } }, "xml": { "name": "TDUserDto" }, "type": "object" }, "OAT.Integrations.TD.Dto.TDUsersInfoDto": { "properties": { "user": { "items": { "$ref": "#/definitions/OAT.Integrations.TD.Dto.TDUserInfoDto" }, "xml": { "name": "TDUserInfoDto", "wrapped": true }, "type": "array" }, "responseInfo": { "$ref": "#/definitions/OAT.Integrations.TD.Dto.TDResponseInfo" }, "errors": { "type": "string" } }, "xml": { "name": "TDUsersInfoDto" }, "type": "object" }, "OAT.Integrations.TD.Dto.TDUserInfoDto": { "properties": { "userId": { "type": "string" } }, "xml": { "name": "TDUserInfoDto" }, "type": "object" }, "OAT.Integrations.TD.Dto.TDResponseInfo": { "properties": { "responseDescription": { "type": "string" }, "totalSize": { "type": "integer", "format": "int32" }, "cutOffSize": { "type": "integer", "format": "int32" } }, "xml": { "name": "TDResponseInfo" }, "type": "object" }, "OAT.Integrations.TD.Dto.TDBalancesDto": { "properties": { "balance": { "items": { "$ref": "#/definitions/OAT.Integrations.TD.Dto.TDBalanceDto" }, "xml": { "name": "TDBalanceDto", "wrapped": true }, "type": "array" }, "responseInfo": { "$ref": "#/definitions/OAT.Integrations.TD.Dto.TDResponseInfo" }, "errors": { "$ref": "#/definitions/OAT.Integrations.TD.Dto.TDErrorDto" } }, "xml": { "name": "TDBalancesDto" }, "type": "object" }, "OAT.Integrations.TD.Dto.TDBalanceDto": { "properties": { "accountNumber": { "type": "string" }, "accountType": { "type": "string" }, "accountDescription": { "type": "string" }, "repCode": { "type": "string" }, "accountValue": { "type": "number", "format": "float" }, "moneyMarket": { "type": "number", "format": "float" }, "cashEquivalents": { "type": "number", "format": "float" }, "buyingPower": { "type": "number", "format": "float" }, "netBalance": { "type": "number", "format": "float" }, "optionBuyingPower": { "type": "number", "format": "float" } }, "xml": { "name": "TDBalanceDto" }, "type": "object" }, "OAT.Integrations.TD.Dto.TDErrorDto": { "properties": { "errorMessages": { "type": "string" } }, "xml": { "name": "TDErrorDto" }, "type": "object" }, "OAT.Integrations.TD.Dto.TDAccountsDto": { "properties": { "account": { "items": { "$ref": "#/definitions/OAT.Integrations.TD.Dto.TDAccountDto" }, "xml": { "name": "TDAccountDto", "wrapped": true }, "type": "array" }, "responseInfo": { "$ref": "#/definitions/OAT.Integrations.TD.Dto.TDResponseInfo" }, "errors": { "type": "string" } }, "xml": { "name": "TDAccountsDto" }, "type": "object" }, "OAT.Integrations.TD.Dto.TDAccountDto": { "properties": { "accountNumber": { "type": "string" }, "accountDescription": { "type": "string" }, "accountTitle": { "type": "string" }, "accountType": { "type": "string" }, "repCode": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "secondaryPhone": { "type": "string" }, "isSecondaryPhoneInternational": { "type": "boolean" }, "accountStatus": { "type": "string" }, "optionLevel": { "type": "string" }, "isAmerivestAccount": { "type": "boolean" }, "isMarginAccount": { "type": "boolean" }, "dateOpened": { "type": "string", "format": "date-time" }, "accountCategoryCode": { "type": "string" }, "dividendInstructions": { "type": "string" }, "isCashAccount": { "type": "boolean" }, "isIncomeAccount": { "type": "boolean" }, "isNonPurposeLoanAccount": { "type": "boolean" }, "isShortMarginAccount": { "type": "boolean" }, "isSpecSubscripAccount": { "type": "boolean" }, "isConvertibleBondAccount": { "type": "boolean" }, "isNonConvertibleBondAccount": { "type": "boolean" }, "isDvpOrRvpAccount": { "type": "boolean" }, "isTradingBlocked": { "type": "boolean" }, "isBlockAccount": { "type": "boolean" }, "isSelected": { "type": "boolean" } }, "xml": { "name": "TDAccountDto" }, "type": "object" }, "OAT.Integrations.TD.Dto.TDAccountsExtendedDto": { "properties": { "account": { "items": { "$ref": "#/definitions/OAT.Integrations.TD.Dto.TDAccountExtendedDto" }, "xml": { "name": "TDAccountExtendedDto", "wrapped": true }, "type": "array" }, "responseInfo": { "$ref": "#/definitions/OAT.Integrations.TD.Dto.TDResponseInfo" }, "errors": { "type": "string" } }, "xml": { "name": "TDAccountsExtendedDto" }, "type": "object" }, "OAT.Integrations.TD.Dto.TDAccountExtendedDto": { "properties": { "balance": { "$ref": "#/definitions/OAT.Integrations.TD.Dto.TDBalanceExtendedDto" }, "positions": { "$ref": "#/definitions/OAT.Integrations.TD.Dto.TDPositionsExtendedDto" }, "transactionsHistory": { "$ref": "#/definitions/OAT.Integrations.TD.Dto.TDTransactionsExtendedDto" }, "accountNumber": { "type": "string" }, "accountDescription": { "type": "string" }, "accountTitle": { "type": "string" }, "accountType": { "type": "string" }, "repCode": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "secondaryPhone": { "type": "string" }, "isSecondaryPhoneInternational": { "type": "boolean" }, "accountStatus": { "type": "string" }, "optionLevel": { "type": "string" }, "isAmerivestAccount": { "type": "boolean" }, "isMarginAccount": { "type": "boolean" }, "dateOpened": { "type": "string", "format": "date-time" }, "accountCategoryCode": { "type": "string" }, "dividendInstructions": { "type": "string" }, "isCashAccount": { "type": "boolean" }, "isIncomeAccount": { "type": "boolean" }, "isNonPurposeLoanAccount": { "type": "boolean" }, "isShortMarginAccount": { "type": "boolean" }, "isSpecSubscripAccount": { "type": "boolean" }, "isConvertibleBondAccount": { "type": "boolean" }, "isNonConvertibleBondAccount": { "type": "boolean" }, "isDvpOrRvpAccount": { "type": "boolean" }, "isTradingBlocked": { "type": "boolean" }, "isBlockAccount": { "type": "boolean" }, "isSelected": { "type": "boolean" } }, "xml": { "name": "TDAccountExtendedDto" }, "type": "object" }, "OAT.Integrations.TD.Dto.TDBalanceExtendedDto": { "properties": { "availableFunds": { "type": "number", "format": "float" }, "todaysNetChange": { "type": "number", "format": "float" }, "netChange": { "type": "number", "format": "float" }, "cashNetBalance": { "type": "number", "format": "float" }, "marginNetBalance": { "type": "number", "format": "float" }, "shortNetBalance": { "type": "number", "format": "float" }, "asOfDate": { "type": "string", "format": "date-time" }, "accountValueNetChange": { "type": "number", "format": "float" }, "accruedInterest": { "type": "number", "format": "float" }, "accruedInterestNetChange": { "type": "number", "format": "float" }, "availableFundsForTrading": { "type": "number", "format": "float" }, "bondsValue": { "type": "number", "format": "float" }, "cashEquivalentNetChange": { "type": "number", "format": "float" }, "cashBalanceNetChange": { "type": "number", "format": "float" }, "dayTradeBuyingPower": { "type": "number", "format": "float" }, "equityPercentage": { "type": "number", "format": "float" }, "equityPercentageNetChange": { "type": "number", "format": "float" }, "longMarginableValue": { "type": "number", "format": "float" }, "longMarginableValueNetChange": { "type": "number", "format": "float" }, "longPositions": { "type": "number", "format": "float" }, "longPositionsNetChange": { "type": "number", "format": "float" }, "maintenanceCalls": { "type": "number", "format": "float" }, "maintenanceCallsNetChange": { "type": "number", "format": "float" }, "maintenanceRequirement": { "type": "number", "format": "float" }, "maintenanceRequirementNetChange": { "type": "number", "format": "float" }, "marginEquity": { "type": "number", "format": "float" }, "marginEquityNetChange": { "type": "number", "format": "float" }, "marginBalanceNetChange": { "type": "number", "format": "float" }, "moneyMarketNetChange": { "type": "number", "format": "float" }, "mutualFundValue": { "type": "number", "format": "float" }, "mutualFundValueNetChange": { "type": "number", "format": "float" }, "nonMarginableFunds": { "type": "number", "format": "float" }, "optionsValue": { "type": "number", "format": "float" }, "optionsValueNetChange": { "type": "number", "format": "float" }, "pendingDeposits": { "type": "number", "format": "float" }, "pendingDepositsNetChange": { "type": "number", "format": "float" }, "shortMarginableValue": { "type": "number", "format": "float" }, "shortMarginableValueNetChange": { "type": "number", "format": "float" }, "marginBalance": { "type": "number", "format": "float" }, "shortBalance": { "type": "number", "format": "float" }, "shortBalanceNetChange": { "type": "number", "format": "float" }, "shortPositions": { "type": "number", "format": "float" }, "shortPositionsNetChange": { "type": "number", "format": "float" }, "stocksValue": { "type": "number", "format": "float" }, "stocksValueNetChange": { "type": "number", "format": "float" }, "totalPositionsValue": { "type": "number", "format": "float" }, "shortStockValue": { "type": "number", "format": "float" }, "shortStockValueNetChange": { "type": "number", "format": "float" }, "shortOptionValue": { "type": "number", "format": "float" }, "shortOptionValueNetChange": { "type": "number", "format": "float" }, "stockBuyingPower": { "type": "number", "format": "float" }, "bondValueNetChange": { "type": "number", "format": "float" }, "accountNumber": { "type": "string" }, "accountType": { "type": "string" }, "accountDescription": { "type": "string" }, "repCode": { "type": "string" }, "accountValue": { "type": "number", "format": "float" }, "moneyMarket": { "type": "number", "format": "float" }, "cashEquivalents": { "type": "number", "format": "float" }, "buyingPower": { "type": "number", "format": "float" }, "netBalance": { "type": "number", "format": "float" }, "optionBuyingPower": { "type": "number", "format": "float" } }, "xml": { "name": "TDBalanceExtendedDto" }, "type": "object" }, "OAT.Integrations.TD.Dto.TDPositionsExtendedDto": { "properties": { "position": { "items": { "$ref": "#/definitions/OAT.Integrations.TD.Dto.TDPositionExtendedDto" }, "xml": { "name": "TDPositionExtendedDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "TDPositionsExtendedDto" }, "type": "object" }, "OAT.Integrations.TD.Dto.TDTransactionsExtendedDto": { "properties": { "transaction": { "items": { "$ref": "#/definitions/OAT.Integrations.TD.Dto.TDTransactionDto" }, "xml": { "name": "TDTransactionDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "TDTransactionsExtendedDto" }, "type": "object" }, "OAT.Integrations.TD.Dto.TDPositionExtendedDto": { "properties": { "dayGainPercent": { "type": "number", "format": "float" }, "gainPercentage": { "type": "number", "format": "float" }, "dividendAmount": { "type": "number", "format": "float" }, "dividendYield": { "type": "number", "format": "float" }, "exDividendDate": { "type": "string", "format": "date-time" }, "isMarginable": { "type": "boolean" }, "shortSecurityDescription": { "type": "string" }, "maintenanceRequirement": { "type": "number", "format": "float" }, "repCode": { "type": "string" }, "assetType": { "type": "string" }, "symbol": { "type": "string" }, "cusip": { "type": "string" }, "securityDescription": { "type": "string" }, "asOfDate": { "type": "string" }, "quantity": { "type": "number", "format": "float" }, "marketValue": { "type": "number", "format": "float" }, "bid": { "type": "number", "format": "float" }, "ask": { "type": "number", "format": "float" }, "close": { "type": "number", "format": "float" }, "gain": { "type": "number", "format": "float" }, "change": { "type": "number", "format": "float" }, "lastPrice": { "type": "number", "format": "float" } }, "xml": { "name": "TDPositionExtendedDto" }, "type": "object" }, "OAT.Integrations.TD.Dto.TDTransactionDto": { "properties": { "accountNumber": { "type": "string" }, "repCode": { "type": "string" }, "transactionId": { "type": "string" }, "symbolOrCusip": { "type": "string" }, "symbol": { "type": "string" }, "symbolDescription": { "type": "string" }, "cusip": { "type": "string" }, "assetType": { "type": "string" }, "bondCouponRate": { "type": "number", "format": "float" }, "bondMaturityDate": { "type": "string", "format": "date-time" }, "asOfDate": { "type": "string", "format": "date-time" }, "processingDate": { "type": "string", "format": "date-time" }, "quantity": { "type": "number", "format": "float" }, "price": { "type": "number", "format": "float" }, "netTransactionAmt": { "type": "number", "format": "float" }, "withholdingAmt": { "type": "number", "format": "float" }, "debitCreditCode": { "type": "string" }, "creditDebitAmt": { "type": "number", "format": "float" }, "commissionAmt": { "type": "number", "format": "float" }, "settlementDate": { "type": "string", "format": "date-time" }, "transactionType": { "type": "string" }, "transactionTypeDescription": { "type": "string" }, "category": { "type": "string" }, "accountTypeCode": { "type": "string" }, "optionTypeCode": { "type": "string" }, "transactionDescription": { "type": "string" }, "buySellIndicator": { "type": "string" }, "optionTypeDescription": { "type": "string" } }, "xml": { "name": "TDTransactionDto" }, "type": "object" }, "OAT.Integrations.TD.Dto.TDPositionsDto": { "properties": { "position": { "items": { "$ref": "#/definitions/OAT.Integrations.TD.Dto.TDPositionDto" }, "xml": { "name": "TDPositionDto", "wrapped": true }, "type": "array" }, "responseInfo": { "$ref": "#/definitions/OAT.Integrations.TD.Dto.TDResponseInfo" }, "errors": { "type": "string" } }, "xml": { "name": "TDPositionsDto" }, "type": "object" }, "OAT.Integrations.TD.Dto.TDPositionDto": { "properties": { "accountNumber": { "type": "string" }, "value": { "type": "number", "format": "float" }, "price": { "type": "number", "format": "float" }, "todaysValueChange": { "type": "number", "format": "float" }, "todaysQuantityChange": { "type": "number", "format": "float" }, "coupon": { "type": "number", "format": "float" }, "nav": { "type": "number", "format": "float" }, "repCode": { "type": "string" }, "assetType": { "type": "string" }, "symbol": { "type": "string" }, "cusip": { "type": "string" }, "securityDescription": { "type": "string" }, "asOfDate": { "type": "string" }, "quantity": { "type": "number", "format": "float" }, "marketValue": { "type": "number", "format": "float" }, "bid": { "type": "number", "format": "float" }, "ask": { "type": "number", "format": "float" }, "close": { "type": "number", "format": "float" }, "gain": { "type": "number", "format": "float" }, "change": { "type": "number", "format": "float" }, "lastPrice": { "type": "number", "format": "float" } }, "xml": { "name": "TDPositionDto" }, "type": "object" }, "OAT.Integrations.TD.Dto.TDTransactionsDto": { "properties": { "transaction": { "items": { "$ref": "#/definitions/OAT.Integrations.TD.Dto.TDTransactionDto" }, "xml": { "name": "TDTransactionDto", "wrapped": true }, "type": "array" }, "responseInfo": { "$ref": "#/definitions/OAT.Integrations.TD.Dto.TDResponseInfo" }, "errors": { "type": "string" } }, "xml": { "name": "TDTransactionsDto" }, "type": "object" }, "OAT.Integrations.TD.Dto.TDAlertsReturnDto": { "properties": { "alerts": { "items": { "$ref": "#/definitions/OAT.Integrations.TD.Dto.TDAlertReturnDto" }, "xml": { "name": "TDAlertReturnDto", "wrapped": true }, "type": "array" }, "errorMsg": { "type": "string" } }, "xml": { "name": "TDAlertsReturnDto" }, "type": "object" }, "OAT.Integrations.TD.Dto.TDAlertReturnDto": { "properties": { "userID": { "type": "string" }, "account": { "type": "string" }, "repCode": { "type": "string" }, "createdOn": { "type": "string" }, "alertId": { "type": "string" }, "alertSubscriptionType": { "type": "string" }, "content": { "type": "object" }, "contentString": { "type": "string" } }, "xml": { "name": "TDAlertReturnDto" }, "type": "object" }, "OAS.WebApi.Domains.Integrations.TDAmeritradeController.AdvancedAlertsIntegrationConfig": { "properties": { "enabled": { "type": "boolean" } }, "xml": { "name": "AdvancedAlertsIntegrationConfig" }, "type": "object" }, "OAS.WebApi.Domains.Integrations.TRXIntegrationConfigDto": { "properties": { "orionUserId": { "type": "string" }, "orionPassword": { "type": "string" } }, "xml": { "name": "TRXIntegrationConfigDto" }, "type": "object" }, "OAS.WebApi.Domains.Integrations.TrxController.TrxHouseholdGroupDto": { "properties": { "householdId": { "type": "string" }, "householdDescription": { "type": "string" }, "items": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelToleranceDto" }, "xml": { "name": "ModelToleranceDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "TrxHouseholdGroupDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.ModelToleranceDto": { "properties": { "groupName": { "type": "string" }, "groupDescription": { "type": "string" }, "groupKey": { "type": "integer", "format": "int32" }, "groupEntity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "lowerTolerance": { "type": "number", "format": "double" }, "upperTolerance": { "type": "number", "format": "double" }, "targetPercent": { "type": "number", "format": "double" }, "targetValue": { "type": "number", "format": "double" }, "actualPercent": { "type": "number", "format": "double" }, "actualValue": { "type": "number", "format": "double" }, "actualShares": { "type": "number", "format": "double" }, "actualCash": { "type": "number", "format": "double" }, "excluded": { "type": "boolean" }, "postTradePercent": { "type": "number", "format": "double" }, "postTradeShares": { "type": "number", "format": "double" }, "postTradeCash": { "type": "number", "format": "double" }, "targetShares": { "type": "number", "format": "double" }, "postTradeValue": { "type": "number", "format": "double" }, "minCashBalance": { "type": "number", "format": "double" }, "minCashBalanceType": { "type": "string", "enum": [ "Dollars", "Percent" ] }, "inTolerance": { "readOnly": true, "type": "boolean" } }, "xml": { "name": "ModelToleranceDto" }, "type": "object" }, "OAT.Integrations.Vanilla.VanillaToken": { "properties": { "access_token": { "type": "string" }, "refresh_token": { "type": "string" }, "scope": { "type": "string" }, "token_type": { "type": "string" }, "expires_in": { "type": "integer", "format": "int32" }, "expires_datetime": { "type": "string", "format": "date-time" } }, "xml": { "name": "VanillaToken" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Vision.VisionSourceDestinationDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "acctCode": { "type": "string" }, "assetId": { "type": "integer", "format": "int32" }, "transTypeId": { "type": "integer", "format": "int32" }, "activityTypeId": { "type": "integer", "format": "int32" }, "sourceDestinationId": { "type": "integer", "format": "int32" }, "activityType": { "type": "string" } }, "xml": { "name": "VisionSourceDestinationDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.WealthAccess.IntegrationConfigDto": { "description": "DTO representing data stored in the ExternalId property of a firm's AppLinksDetails record for WealthAccess integration.", "properties": { "installed": { "description": "True if the integration is currently enabled for the firm, False otherwise.", "type": "boolean" }, "externalUserId": { "description": "The WealthAccess external user id.", "type": "string" }, "partnerAppId": { "description": "The unique ID of the partner app.", "type": "integer", "format": "int32" }, "productName": { "description": "The unique name of the partner app product.", "type": "string" } }, "xml": { "name": "IntegrationConfigDto" }, "type": "object" }, "OAS.DataModel.Integration.WealthAccess.IntegrationConfig": { "properties": { "externalUserId": { "type": "string" } }, "xml": { "name": "IntegrationConfig" }, "type": "object" }, "OAT.Integrations.WealthSite.Dto.WealthSiteRequestDataWithAccountsDto": { "properties": { "date": { "type": "string", "format": "date-time" }, "accountIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, "xml": { "name": "WealthSiteRequestDataWithAccountsDto" }, "type": "object" }, "OAT.Integrations.WealthSite.Dto.WealthSiteAllocationByManagerDto": { "properties": { "categoryId": { "type": "integer", "format": "int32" }, "categoryName": { "type": "string" }, "name": { "type": "string" }, "totalValue": { "type": "number", "format": "float" }, "pct": { "type": "number", "format": "float" }, "color": { "type": "string" }, "reportName": { "type": "string" } }, "xml": { "name": "WealthSiteAllocationByManagerDto" }, "type": "object" }, "OAT.Integrations.WealthSite.Dto.WealthSiteRequestDataDto": { "properties": { "date": { "type": "string", "format": "date-time" } }, "xml": { "name": "WealthSiteRequestDataDto" }, "type": "object" }, "OAT.Integrations.WealthSite.Dto.WealthSiteAllocationByPropertyTypeDto": { "properties": { "categoryId": { "type": "integer", "format": "int32" }, "categoryName": { "type": "string" }, "name": { "type": "string" }, "totalValue": { "type": "number", "format": "float" }, "pct": { "type": "number", "format": "float" }, "color": { "type": "string" }, "reportName": { "type": "string" } }, "xml": { "name": "WealthSiteAllocationByPropertyTypeDto" }, "type": "object" }, "OAT.Integrations.WealthSite.Dto.WealthSiteAllocationByRegionDto": { "properties": { "categoryId": { "type": "integer", "format": "int32" }, "categoryName": { "type": "string" }, "name": { "type": "string" }, "totalValue": { "type": "number", "format": "float" }, "pct": { "type": "number", "format": "float" }, "color": { "type": "string" }, "reportName": { "type": "string" } }, "xml": { "name": "WealthSiteAllocationByRegionDto" }, "type": "object" }, "OAT.Integrations.WealthSite.Dto.WealthSiteAllocationByRiskDto": { "properties": { "categoryId": { "type": "integer", "format": "int32" }, "categoryName": { "type": "string" }, "name": { "type": "string" }, "totalValue": { "type": "number", "format": "float" }, "pct": { "type": "number", "format": "float" }, "color": { "type": "string" }, "reportName": { "type": "string" } }, "xml": { "name": "WealthSiteAllocationByRiskDto" }, "type": "object" }, "OAT.Integrations.WealthSite.Dto.WealthSiteAllocationByYearDto": { "properties": { "categoryId": { "type": "integer", "format": "int32" }, "categoryName": { "type": "string" }, "name": { "type": "string" }, "totalValue": { "type": "number", "format": "float" }, "pct": { "type": "number", "format": "float" }, "color": { "type": "string" }, "reportName": { "type": "string" } }, "xml": { "name": "WealthSiteAllocationByYearDto" }, "type": "object" }, "OAT.Integrations.WealthSite.Dto.WealthSiteAllocationSummaryDto": { "properties": { "categoryId": { "type": "integer", "format": "int32" }, "categoryName": { "type": "string" }, "commitmentDate": { "type": "string", "format": "date-time" }, "investmentType": { "type": "string" }, "managerName": { "type": "string" }, "mval": { "type": "number", "format": "float" }, "propertyTypeName": { "type": "string" }, "regionName": { "type": "string" }, "remainingCommitment": { "type": "number", "format": "float" }, "secName": { "type": "string" } }, "xml": { "name": "WealthSiteAllocationSummaryDto" }, "type": "object" }, "OAT.Integrations.WealthSite.Dto.WealthSitePrivateAssetSummaryDto": { "properties": { "reportObject": { "type": "integer", "format": "int32" }, "date": { "type": "string", "format": "date-time" }, "totalValue": { "type": "number", "format": "float" }, "paidIn": { "type": "number", "format": "float" }, "transType": { "type": "string" }, "transAmount": { "type": "number", "format": "float" }, "rn": { "type": "integer", "format": "int32" }, "level": { "type": "string" }, "groupName": { "type": "string" }, "name": { "type": "string" }, "totalCommitment": { "type": "number", "format": "float" }, "inception": { "type": "string", "format": "date-time" }, "unreconciled": { "type": "integer", "format": "int32" }, "capitalDrawn": { "type": "number", "format": "float" }, "estimatedValuation": { "type": "number", "format": "float" }, "totalDistribution": { "type": "number", "format": "float" }, "recallable": { "type": "number", "format": "float" }, "irr": { "type": "number", "format": "float" }, "a_IRR": { "type": "number", "format": "float" }, "pctDrawn": { "type": "number", "format": "float" }, "remainingCommitment": { "type": "number", "format": "float" }, "realizedMultiple": { "type": "number", "format": "float" }, "tvpi": { "type": "number", "format": "float" }, "interval": { "type": "integer", "format": "int32" } }, "xml": { "name": "WealthSitePrivateAssetSummaryDto" }, "type": "object" }, "OAT.Integrations.WealthSite.Dto.WealthSitePrivateInvestmentPerformanceDto": { "properties": { "category": { "type": "string" }, "commitmentAmount": { "type": "number", "format": "float" }, "remainingCommitment": { "type": "number", "format": "float" }, "capitalCalls": { "type": "number", "format": "float" }, "distributions": { "type": "number", "format": "float" }, "mval": { "type": "number", "format": "float" }, "fund": { "type": "boolean" }, "commitmentDate": { "type": "string", "format": "date-time" }, "lastOfficial": { "type": "string", "format": "date-time" }, "multiple": { "type": "number", "format": "float" }, "irR2": { "type": "number", "format": "float" }, "comment": { "type": "string" }, "portfolioMultiple": { "type": "number", "format": "float" }, "portfolioIRR": { "type": "number", "format": "float" }, "upDownArrow": { "type": "integer", "format": "int32" }, "completeIRR": { "type": "number", "format": "float" }, "distributionsToCommitment": { "type": "number", "format": "float" }, "dpi": { "type": "number", "format": "float" }, "irR_NonAnnualized": { "type": "number", "format": "float" }, "object": { "type": "string" }, "sort1": { "type": "integer", "format": "int32" }, "secName": { "type": "string" }, "investmentPeriod": { "type": "string" } }, "xml": { "name": "WealthSitePrivateInvestmentPerformanceDto" }, "type": "object" }, "OAS.WebApi.Domains.Integrations.CoveredCallOptionsDto": { "properties": { "underlyingSymbol": { "type": "string" }, "expirationDates": { "items": { "type": "integer", "format": "int64" }, "type": "array" }, "strikes": { "items": { "type": "number", "format": "double" }, "type": "array" }, "hasMiniOptions": { "type": "boolean" }, "quote": { "$ref": "#/definitions/OAT.Integrations.YahooFinance.Quote" }, "options": { "items": { "$ref": "#/definitions/OAT.Integrations.YahooFinance.Options" }, "xml": { "name": "Options", "wrapped": true }, "type": "array" }, "convertedDates": { "items": { "$ref": "#/definitions/OAS.WebApi.Domains.Integrations.ExpirationDatesDto" }, "xml": { "name": "ExpirationDatesDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "CoveredCallOptionsDto" }, "type": "object" }, "OAT.Integrations.YahooFinance.Quote": { "properties": { "quoteType": { "type": "string" }, "quoteSourceName": { "type": "string" }, "currency": { "type": "string" }, "longName": { "type": "string" }, "market": { "type": "string" }, "marketState": { "type": "string" }, "exchange": { "type": "string" }, "sharesOutstanding": { "type": "number", "format": "double" }, "bookValue": { "type": "number", "format": "double" }, "fiftyDayAverage": { "type": "number", "format": "double" }, "fiftyDayAverageChange": { "type": "number", "format": "double" }, "fiftyDayAverageChangePercent": { "type": "number", "format": "double" }, "twoHundredDayAverage": { "type": "number", "format": "double" }, "twoHundredDayAverageChange": { "type": "number", "format": "double" }, "twoHundredDayAverageChangePercent": { "type": "number", "format": "double" }, "marketCap": { "type": "number", "format": "double" }, "forwardPE": { "type": "number", "format": "double" }, "priceToBook": { "type": "number", "format": "double" }, "sourceInterval": { "type": "integer", "format": "int32" }, "exchangeTimezoneName": { "type": "string" }, "exchangeTimezoneShortName": { "type": "string" }, "gmtOffSetMilliseconds": { "type": "integer", "format": "int32" }, "postMarketChangePercent": { "type": "number", "format": "double" }, "postMarketTime": { "type": "integer", "format": "int32" }, "postMarketPrice": { "type": "number", "format": "double" }, "postMarketChange": { "type": "number", "format": "double" }, "regularMarketChangePercent": { "type": "number", "format": "double" }, "regularMarketPreviousClose": { "type": "number", "format": "double" }, "bid": { "type": "number", "format": "double" }, "ask": { "type": "number", "format": "double" }, "bidSize": { "type": "integer", "format": "int32" }, "askSize": { "type": "integer", "format": "int32" }, "messageBoardId": { "type": "string" }, "fullExchangeName": { "type": "string" }, "averageDailyVolume3Month": { "type": "integer", "format": "int32" }, "averageDailyVolume10Day": { "type": "integer", "format": "int32" }, "fiftyTwoWeekLowChange": { "type": "number", "format": "double" }, "fiftyTwoWeekLowChangePercent": { "type": "number", "format": "double" }, "fiftyTwoWeekHighChange": { "type": "number", "format": "double" }, "fiftyTwoWeekHighChangePercent": { "type": "number", "format": "double" }, "fiftyTwoWeekLow": { "type": "number", "format": "double" }, "fiftyTwoWeekHigh": { "type": "number", "format": "double" }, "dividendDate": { "type": "integer", "format": "int32" }, "earningsTimestamp": { "type": "integer", "format": "int32" }, "earningsTimestampStart": { "type": "integer", "format": "int32" }, "earningsTimestampEnd": { "type": "integer", "format": "int32" }, "trailingAnnualDividendRate": { "type": "number", "format": "double" }, "trailingPE": { "type": "number", "format": "double" }, "epsTrailingTwelveMonths": { "type": "number", "format": "double" }, "epsForward": { "type": "number", "format": "double" }, "shortName": { "type": "string" }, "regularMarketPrice": { "type": "number", "format": "double" }, "regularMarketTime": { "type": "integer", "format": "int32" }, "regularMarketChange": { "type": "number", "format": "double" }, "regularMarketOpen": { "type": "number", "format": "double" }, "regularMarketDayHigh": { "type": "number", "format": "double" }, "regularMarketDayLow": { "type": "number", "format": "double" }, "regularMarketVolume": { "type": "number", "format": "double" }, "symbol": { "type": "string" }, "expireDate": { "type": "integer", "format": "int64" } }, "xml": { "name": "Quote" }, "type": "object" }, "OAT.Integrations.YahooFinance.Options": { "properties": { "expirationDate": { "type": "integer", "format": "int64" }, "hasMiniOptions": { "type": "boolean" }, "calls": { "items": { "$ref": "#/definitions/OAT.Integrations.YahooFinance.Call" }, "xml": { "name": "Call", "wrapped": true }, "type": "array" }, "puts": { "items": { "$ref": "#/definitions/OAT.Integrations.YahooFinance.Put" }, "xml": { "name": "Put", "wrapped": true }, "type": "array" }, "straddles": { "items": { "$ref": "#/definitions/OAT.Integrations.YahooFinance.Straddles" }, "xml": { "name": "Straddles", "wrapped": true }, "type": "array" } }, "xml": { "name": "Options" }, "type": "object" }, "OAS.WebApi.Domains.Integrations.ExpirationDatesDto": { "properties": { "value": { "type": "integer", "format": "int64" }, "displayValue": { "type": "string", "format": "date-time" } }, "xml": { "name": "ExpirationDatesDto" }, "type": "object" }, "OAT.Integrations.YahooFinance.Call": { "properties": { "contractSymbol": { "type": "string" }, "strike": { "type": "number", "format": "double" }, "currency": { "type": "string" }, "lastPrice": { "type": "number", "format": "double" }, "change": { "type": "number", "format": "double" }, "percentChange": { "type": "number", "format": "double" }, "volume": { "type": "integer", "format": "int32" }, "openInterest": { "type": "number", "format": "double" }, "bid": { "type": "number", "format": "double" }, "ask": { "type": "number", "format": "double" }, "contractSize": { "type": "string" }, "expiration": { "type": "integer", "format": "int64" }, "lastTradeDate": { "type": "integer", "format": "int64" }, "impliedVolatility": { "type": "number", "format": "double" }, "inTheMoney": { "type": "boolean" } }, "xml": { "name": "Call" }, "type": "object" }, "OAT.Integrations.YahooFinance.Put": { "properties": { "contractSymbol": { "type": "string" }, "strike": { "type": "number", "format": "double" }, "currency": { "type": "string" }, "lastPrice": { "type": "number", "format": "double" }, "change": { "type": "number", "format": "double" }, "percentChange": { "type": "number", "format": "double" }, "volume": { "type": "integer", "format": "int32" }, "openInterest": { "type": "number", "format": "double" }, "bid": { "type": "number", "format": "double" }, "ask": { "type": "number", "format": "double" }, "contractSize": { "type": "string" }, "expiration": { "type": "integer", "format": "int64" }, "lastTradeDate": { "type": "integer", "format": "int64" }, "impliedVolatility": { "type": "number", "format": "double" }, "inTheMoney": { "type": "boolean" } }, "xml": { "name": "Put" }, "type": "object" }, "OAT.Integrations.YahooFinance.Straddles": { "properties": { "strike": { "type": "number", "format": "double" }, "call": { "$ref": "#/definitions/OAT.Integrations.YahooFinance.Call" }, "put": { "$ref": "#/definitions/OAT.Integrations.YahooFinance.Put" } }, "xml": { "name": "Straddles" }, "type": "object" }, "OAS.WebApi.DTO.MarketProperties.BullBearDateDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "isBear": { "type": "boolean" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "BullBearDateDto" }, "type": "object" }, "OAS.WebApi.DTO.Mobile.PortfolioGroupValuesDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "grouping": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "asOfDate": { "readOnly": true, "type": "string" }, "value": { "type": "number", "format": "double" }, "percent": { "type": "number", "format": "double" }, "color": { "type": "string" } }, "xml": { "name": "PortfolioGroupValuesDto" }, "type": "object" }, "OAS.WebApi.DTO.Mobile.RepresentativeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "repNo": { "type": "string" }, "fullName": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "phoneNumber": { "type": "string" }, "email": { "type": "string" }, "company": { "type": "string" }, "mobilePhoneNumber": { "type": "string" }, "faxNumber": { "type": "string" }, "photo": { "type": "string", "format": "byte" } }, "xml": { "name": "RepresentativeDto" }, "type": "object" }, "OAS.WebApi.DTO.Mobile.AccountsMenuSettingsDto": { "properties": { "asOfDate": { "type": "string", "format": "date-time" }, "includeBondAccrual": { "type": "boolean" }, "clientPerformanceInclude": { "type": "string", "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, "includeUnmanaged": { "type": "boolean" } }, "xml": { "name": "AccountsMenuSettingsDto" }, "type": "object" }, "OAS.WebApi.DTO.Mobile.AccountsMenuReturnDto": { "properties": { "managed": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Mobile.ManagedAccountsMenuDto" }, "xml": { "name": "ManagedAccountsMenuDto", "wrapped": true }, "type": "array" }, "unmanaged": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Mobile.UnmanagedAccountsMenuDto" }, "xml": { "name": "UnmanagedAccountsMenuDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "AccountsMenuReturnDto" }, "type": "object" }, "OAS.WebApi.DTO.Mobile.ManagedAccountsMenuDto": { "properties": { "accountType": { "type": "string" }, "custodian": { "type": "string" }, "custodialAccountNumber": { "type": "string" }, "registrationId": { "type": "integer", "format": "int32" }, "unmanagedSetting": { "type": "string" }, "isManaged": { "type": "boolean" }, "accountId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "value": { "type": "number", "format": "double" }, "maskedAccountNumber": { "type": "string" }, "managementStyle": { "type": "string" }, "modelName": { "type": "string" }, "subAdvisor": { "type": "string" }, "riskBudget": { "type": "integer", "format": "int32" } }, "xml": { "name": "ManagedAccountsMenuDto" }, "type": "object" }, "OAS.WebApi.DTO.Mobile.UnmanagedAccountsMenuDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "value": { "type": "number", "format": "double" }, "maskedAccountNumber": { "type": "string" }, "managementStyle": { "type": "string" }, "modelName": { "type": "string" }, "subAdvisor": { "type": "string" }, "riskBudget": { "type": "integer", "format": "int32" } }, "xml": { "name": "UnmanagedAccountsMenuDto" }, "type": "object" }, "OAS.WebApi.DTO.Mobile.PushNotificationDto": { "properties": { "appId": { "type": "string" }, "osType": { "type": "string", "enum": [ "iOS", "Android" ] }, "token": { "type": "string" } }, "xml": { "name": "PushNotificationDto" }, "type": "object" }, "OAS.WebApi.DTO.Confirm.OrionStoredCompareBatchDto": { "description": "Class to instruct the Orion Stored Cost Basis Compare process how and what to calculate.", "properties": { "assetIds": { "description": "List of Asset IDs to get for the compare", "items": { "type": "integer", "format": "int32" }, "type": "array" }, "calculateDate": { "description": "Beginning date for unrealized calculations. Realized will use the date 31 days prior to catch wash sales.", "type": "string", "format": "date-time" }, "writeToDatabase": { "description": "Flag to determine whether to update the database with the new calculations or just return and discard the new calculations.", "type": "boolean" }, "useNewDataStructure": { "description": "Flag to determine whether to call the new cost basis calculation methods (will be ignored until new calculations are developed).", "type": "boolean" }, "returnDifferencesOnly": { "description": "Flag to determine whether to return all cost basis data or only that which doesn't match with the new calculations.", "type": "boolean" } }, "xml": { "name": "OrionStoredCompareBatchDto" }, "type": "object" }, "OAS.DataProcess.OrionStored.OrionStoredCostBasisCompareResult": { "properties": { "result": { "readOnly": true, "type": "boolean" }, "data": { "$ref": "#/definitions/OAS.DataProcess.OrionStored.OrionStoredCostBasisCompareData" }, "errors": { "items": { "$ref": "#/definitions/OAS.DataProcess.OrionStored.OrionStoredCostBasisCompareError" }, "xml": { "name": "OrionStoredCostBasisCompareError", "wrapped": true }, "type": "array" } }, "xml": { "name": "OrionStoredCostBasisCompareResult" }, "type": "object" }, "OAS.DataProcess.OrionStored.OrionStoredCostBasisCompareData": { "properties": { "originalData": { "items": { "$ref": "#/definitions/OAS.DataProcess.OrionStored.OrionStoredCostBasisAssetData" }, "xml": { "name": "OrionStoredCostBasisAssetData", "wrapped": true }, "type": "array" }, "newData": { "items": { "$ref": "#/definitions/OAS.DataProcess.OrionStored.OrionStoredCostBasisAssetData" }, "xml": { "name": "OrionStoredCostBasisAssetData", "wrapped": true }, "type": "array" } }, "xml": { "name": "OrionStoredCostBasisCompareData" }, "type": "object" }, "OAS.DataProcess.OrionStored.OrionStoredCostBasisCompareError": { "properties": { "assetId": { "type": "integer", "format": "int32" }, "message": { "type": "string" } }, "xml": { "name": "OrionStoredCostBasisCompareError" }, "type": "object" }, "OAS.DataProcess.OrionStored.OrionStoredCostBasisAssetData": { "properties": { "assetId": { "type": "integer", "format": "int32" }, "realizedData": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.CostBasis.OrionRealized" }, "xml": { "name": "OrionRealized", "wrapped": true }, "type": "array" }, "unrealizedData": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.CostBasis.OrionUnrealized" }, "xml": { "name": "OrionUnrealized", "wrapped": true }, "type": "array" } }, "xml": { "name": "OrionStoredCostBasisAssetData" }, "type": "object" }, "OAS.DataModel.Portfolio.CostBasis.OrionRealized": { "required": [ "id", "assetId", "createdDate", "createdBy", "editedDate", "editedBy" ], "properties": { "id": { "type": "integer", "format": "int32" }, "assetId": { "type": "integer", "format": "int32" }, "acquiredDate": { "type": "string", "format": "date-time" }, "sellDate": { "type": "string", "format": "date-time" }, "holdPeriodDate": { "type": "string", "format": "date-time" }, "costAmt": { "type": "number", "format": "double" }, "amortizationAmt": { "type": "number", "format": "double" }, "noUnits": { "type": "number", "format": "double" }, "method": { "type": "string", "maxLength": 50, "minLength": 0 }, "proceedAmt": { "type": "number", "format": "double" }, "washSaleImpacted": { "type": "boolean" }, "source": { "type": "integer", "format": "int32" }, "custodianCommonCode": { "type": "string", "maxLength": 10, "minLength": 0 }, "effectiveDate": { "type": "string", "format": "date-time" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "isShort": { "type": "boolean" }, "transactionId": { "type": "integer", "format": "int32" }, "isReturnOfCapital": { "type": "boolean" }, "isLongTerm": { "type": "boolean" }, "isInherited": { "type": "boolean" }, "isWashSale": { "type": "boolean" }, "isUnknown": { "type": "boolean" }, "transTypeOfBuyId": { "type": "integer", "format": "int32" }, "navOfBuy": { "type": "number", "format": "double" }, "asset": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Asset" }, "errors": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.OrionRealizedTaxError" }, "xml": { "name": "OrionRealizedTaxError", "wrapped": true }, "type": "array" }, "errorSummary": { "$ref": "#/definitions/OAS.DataModel.Confirm.OrionRealizedTaxErrorSummary" } }, "xml": { "name": "OrionRealized" }, "type": "object" }, "OAS.DataModel.Portfolio.CostBasis.OrionUnrealized": { "required": [ "id", "assetId", "asOfDate", "longTermCost", "shortTermCost", "longTermUnits", "shortTermUnits", "acquiredDate", "origCostPerShare" ], "properties": { "id": { "type": "integer", "format": "int64" }, "assetId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "longTermCost": { "type": "number", "format": "double" }, "shortTermCost": { "type": "number", "format": "double" }, "longTermUnits": { "type": "number", "format": "double" }, "shortTermUnits": { "type": "number", "format": "double" }, "acquiredDate": { "type": "string", "format": "date-time" }, "amortizationAmt": { "type": "number", "format": "double" }, "origCostPerShare": { "type": "number", "format": "double" }, "isShort": { "type": "boolean" }, "holdPeriodDate": { "type": "string", "format": "date-time" }, "isLongTerm": { "type": "boolean" }, "isInherited": { "type": "boolean" }, "isUnknown": { "type": "boolean" }, "transTypeOfBuyId": { "type": "integer", "format": "int32" }, "navOfBuy": { "type": "number", "format": "double" }, "asset": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Asset" }, "errors": { "items": { "$ref": "#/definitions/OAS.DataModel.Confirm.OrionUnrealizedTaxError" }, "xml": { "name": "OrionUnrealizedTaxError", "wrapped": true }, "type": "array" }, "errorSummary": { "$ref": "#/definitions/OAS.DataModel.Confirm.OrionUnrealizedTaxErrorSummary" } }, "xml": { "name": "OrionUnrealized" }, "type": "object" }, "OAS.DataModel.Confirm.OrionRealizedTaxError": { "required": [ "orionRealizedId", "id", "auditType", "errorMessage", "resolutionMessage", "createdDate", "createdBy" ], "properties": { "orionRealizedId": { "type": "integer", "format": "int32" }, "orionRealized": { "$ref": "#/definitions/OAS.DataModel.Portfolio.CostBasis.OrionRealized" }, "id": { "type": "integer", "format": "int32" }, "auditType": { "type": "string", "enum": [ "CustodialRealizedSharesDoNotMatch", "CustodialRealizedMissing", "CustodialUnrealizedMissing", "CustodialRealizedUnknownAcquiredDate", "CustodialUnrealizedUnknownAcquiredDate", "CustodialRealizedUnknownCostBasis", "CustodialUnrealizedUnknownCostBasis", "OrionUnknownCostBasis", "MoneyMarketProducts", "OrionMissingCostBasis" ] }, "assetId": { "type": "integer", "format": "int32" }, "errorMessage": { "type": "string", "maxLength": 255, "minLength": 0 }, "resolutionMessage": { "type": "string", "maxLength": 255, "minLength": 0 }, "expectedUnits": { "type": "number", "format": "double" }, "costUnits": { "type": "number", "format": "double" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "reviewed": { "type": "boolean" } }, "xml": { "name": "OrionRealizedTaxError" }, "type": "object" }, "OAS.DataModel.Confirm.OrionRealizedTaxErrorSummary": { "required": [ "parentId", "taxErrorIds" ], "properties": { "orionRealized": { "$ref": "#/definitions/OAS.DataModel.Portfolio.CostBasis.OrionRealized" }, "parentId": { "type": "integer", "format": "int32" }, "taxErrorIds": { "type": "string" } }, "xml": { "name": "OrionRealizedTaxErrorSummary" }, "type": "object" }, "OAS.DataModel.Confirm.OrionUnrealizedTaxError": { "required": [ "orionUnrealizedId", "id", "auditType", "errorMessage", "resolutionMessage", "createdDate", "createdBy" ], "properties": { "orionUnrealizedId": { "type": "integer", "format": "int64" }, "orionUnrealized": { "$ref": "#/definitions/OAS.DataModel.Portfolio.CostBasis.OrionUnrealized" }, "id": { "type": "integer", "format": "int32" }, "auditType": { "type": "string", "enum": [ "CustodialRealizedSharesDoNotMatch", "CustodialRealizedMissing", "CustodialUnrealizedMissing", "CustodialRealizedUnknownAcquiredDate", "CustodialUnrealizedUnknownAcquiredDate", "CustodialRealizedUnknownCostBasis", "CustodialUnrealizedUnknownCostBasis", "OrionUnknownCostBasis", "MoneyMarketProducts", "OrionMissingCostBasis" ] }, "assetId": { "type": "integer", "format": "int32" }, "errorMessage": { "type": "string", "maxLength": 255, "minLength": 0 }, "resolutionMessage": { "type": "string", "maxLength": 255, "minLength": 0 }, "expectedUnits": { "type": "number", "format": "double" }, "costUnits": { "type": "number", "format": "double" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string", "maxLength": 100, "minLength": 0 }, "reviewed": { "type": "boolean" } }, "xml": { "name": "OrionUnrealizedTaxError" }, "type": "object" }, "OAS.DataModel.Confirm.OrionUnrealizedTaxErrorSummary": { "required": [ "parentId", "taxErrorIds" ], "properties": { "orionUnrealized": { "$ref": "#/definitions/OAS.DataModel.Portfolio.CostBasis.OrionUnrealized" }, "parentId": { "type": "integer", "format": "int64" }, "taxErrorIds": { "type": "string" } }, "xml": { "name": "OrionUnrealizedTaxErrorSummary" }, "type": "object" }, "OAS.WebApi.DTO.Performance.AttributionAssignmentDto": { "properties": { "entityId": { "type": "integer", "format": "int32" }, "entityName": { "type": "string" }, "attributionAssetCategoryUserDataId": { "type": "integer", "format": "int32" }, "attributionAssetCategoryId": { "type": "integer", "format": "int32" }, "attributionAssetClassId": { "type": "integer", "format": "int32" }, "attributionAssetClassUserDataId": { "type": "integer", "format": "int32" } }, "xml": { "name": "AttributionAssignmentDto" }, "type": "object" }, "OAS.WebApi.DTO.Performance.AttributionDetailDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "groupingSelection": { "type": "string", "enum": [ "AssetClass", "AssetCategory" ] }, "auditedBy": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "AttributionDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Performance.AttributionDetailFullDto": { "properties": { "timeframes": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.AttributionDetailTimeframeDto" }, "xml": { "name": "AttributionDetailTimeframeDto", "wrapped": true }, "type": "array" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "groupingSelection": { "type": "string", "enum": [ "AssetClass", "AssetCategory" ] }, "auditedBy": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "AttributionDetailFullDto" }, "type": "object" }, "OAS.WebApi.DTO.Performance.AttributionDetailTimeframeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "allocations": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.AttributionDetailAllocationDto" }, "xml": { "name": "AttributionDetailAllocationDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "AttributionDetailTimeframeDto" }, "type": "object" }, "OAS.WebApi.DTO.Performance.AttributionDetailAllocationDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" }, "entityType": { "type": "string", "enum": [ "AssetClass", "AssetCategory" ] }, "entityName": { "type": "string" }, "weight": { "type": "number", "format": "double" }, "benchmark": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BenchmarkDto" } }, "xml": { "name": "AttributionDetailAllocationDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.BenchmarkDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "key": { "readOnly": true, "type": "string" }, "name": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "BenchmarkDto" }, "type": "object" }, "OAS.WebApi.DTO.Performance.PerformanceBatchDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "batchName": { "type": "string" }, "runForEntity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedBy": { "type": "string" }, "hangfireJobId": { "type": "string" } }, "xml": { "name": "PerformanceBatchDto" }, "type": "object" }, "OAS.Caching.IDistributedSemaphoreInfo": { "properties": { "name": { "readOnly": true, "type": "string" }, "limit": { "readOnly": true, "type": "integer", "format": "int32" }, "maxLockTime": { "readOnly": true, "type": "string" }, "locksGiven": { "readOnly": true, "type": "integer", "format": "int32" }, "locks": { "items": { "type": "string" }, "readOnly": true, "type": "array" } }, "xml": { "name": "IDistributedSemaphoreInfo" }, "type": "object" }, "OAS.WebApi.DTO.Performance.PerformanceBatchEntityDto": { "properties": { "runForEntity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "entityName": { "type": "string" }, "generationStatus": { "type": "string", "enum": [ "NotGenerated", "Errored", "Generated", "PendingGeneration", "DoNotGenerate" ] }, "errorText": { "type": "string" } }, "xml": { "name": "PerformanceBatchEntityDto" }, "type": "object" }, "OAS.WebApi.DTO.Performance.PerformanceBatchEntityDetailDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "performanceBatchId": { "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" }, "entityName": { "type": "string" }, "groupId": { "type": "integer", "format": "int32" }, "groupEntityId": { "type": "integer", "format": "int32" }, "groupEntityName": { "type": "string" }, "groupEntityEnum": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "benchmarkId": { "type": "integer", "format": "int32" }, "benchmarkName": { "type": "string" }, "timeframe": { "type": "string" }, "startDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "endDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "beginningMarketValue": { "type": "number", "format": "double" }, "endingMarketValue": { "type": "number", "format": "double" }, "performance": { "type": "number", "format": "double" }, "entityPath": { "type": "string" } }, "xml": { "name": "PerformanceBatchEntityDetailDto" }, "type": "object" }, "OAT.Utilities.Date.IDate": { "properties": { "date": { "readOnly": true, "type": "string", "format": "date-time" }, "year": { "readOnly": true, "type": "integer", "format": "int32" }, "month": { "readOnly": true, "type": "integer", "format": "int32" }, "day": { "readOnly": true, "type": "integer", "format": "int32" } }, "xml": { "name": "IDate" }, "type": "object" }, "OAS.WebApi.DTO.Performance.PerformanceBatchEntityDetailPivotDto": { "properties": { "performanceBatchId": { "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" }, "entityName": { "type": "string" }, "groupId": { "type": "integer", "format": "int32" }, "groupEntityId": { "type": "integer", "format": "int32" }, "groupEntityName": { "type": "string" }, "groupEntityEnum": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "benchmarkId": { "type": "integer", "format": "int32" }, "benchmarkName": { "readOnly": true, "type": "string" }, "additionalColumns": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Interface.AdditionalColumnDefinition" }, "readOnly": true, "xml": { "name": "AdditionalColumnDefinition", "wrapped": true }, "type": "array" }, "ids": { "items": { "type": "integer", "format": "int32" }, "readOnly": true, "type": "array" }, "entityPath": { "readOnly": true, "type": "string" } }, "xml": { "name": "PerformanceBatchEntityDetailPivotDto" }, "type": "object" }, "System.ValueTupleOfOAS.WebApi.DTO.Performance.PerformanceBatchEntityDetailPivotDataAndOAS.WebApi.DTO.Performance.PerformanceBatchEntityDetailPivotData": { "properties": { "item1": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.PerformanceBatchEntityDetailPivotData" }, "item2": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.PerformanceBatchEntityDetailPivotData" } }, "xml": { "name": "ValueTuple`2" }, "type": "object" }, "OAS.WebApi.DTO.Performance.PerformanceBatchEntityDetailPivotData": { "properties": { "performanceBatchEntityDetailId": { "type": "integer", "format": "int32" }, "timeframe": { "type": "string" }, "beginningMarketValue": { "type": "number", "format": "double" }, "endingMarketValue": { "type": "number", "format": "double" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "performance": { "type": "number", "format": "double" }, "benchmarkName": { "type": "string" }, "entityPath": { "type": "string" } }, "xml": { "name": "PerformanceBatchEntityDetailPivotData" }, "type": "object" }, "OAS.WebApi.DTO.Performance.PerformanceBatchVerboseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "batchName": { "type": "string" }, "general": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.PerformanceBatchVerboseGeneralDto" }, "options": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.PerformanceBatchVerboseOptionsDto" } }, "xml": { "name": "PerformanceBatchVerboseDto" }, "type": "object" }, "OAS.WebApi.DTO.Performance.PerformanceBatchVerboseGeneralDto": { "properties": { "runForEntity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "showBenchmarks": { "type": "boolean" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedBy": { "type": "string" } }, "xml": { "name": "PerformanceBatchVerboseGeneralDto" }, "type": "object" }, "OAS.WebApi.DTO.Performance.PerformanceBatchVerboseOptionsDto": { "properties": { "performanceOptions": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VerboseCalculationPerformanceOptionDto" }, "afterTaxActivityOptionId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "afterTaxActivityOptionName": { "type": "string" }, "dynamicGroupingId": { "type": "integer", "format": "int32" }, "entitySelectionMethod": { "type": "string", "enum": [ "Manual", "DynamicGroup", "CustomReport", "All", "Active", "ActiveWithValue", "BillInstance" ] }, "accountInclusion": { "type": "string", "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, "entityIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "unmanagedInclusionOverride": { "type": "string", "enum": [ "Unmanaged", "Performance", "ActivitySummary", "Allocation", "PortfolioDetail", "TaxDetail" ] }, "dateRanges": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VerboseCalculationDateRangeDto" }, "xml": { "name": "VerboseCalculationDateRangeDto", "wrapped": true }, "type": "array" }, "filters": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.PerformanceBatchVerboseFilterDto" }, "xml": { "name": "PerformanceBatchVerboseFilterDto", "wrapped": true }, "type": "array" }, "groupings": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.PerformanceBatchVerboseGroupingDto" }, "xml": { "name": "PerformanceBatchVerboseGroupingDto", "wrapped": true }, "type": "array" }, "readOnlyOptions": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.PerformanceBatchVerboseReadOnlyOptionsDto" } }, "xml": { "name": "PerformanceBatchVerboseOptionsDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.VerboseCalculationPerformanceOptionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "calculationMethod": { "type": "string", "enum": [ "TWR", "Simple", "IRR" ] }, "includeAccruedInterest": { "type": "boolean" }, "calcGrossOfFees": { "type": "boolean" }, "calcFirstDayPerformance": { "type": "boolean" }, "calcIntraDayPerformance": { "type": "boolean" }, "annualize": { "type": "boolean" }, "annualizeIncludeDaysWithoutValue": { "type": "boolean" }, "flipSignForShort": { "type": "boolean" }, "suppressMixedRanges": { "type": "boolean" }, "suppressMixedAssetLevelGroups": { "type": "boolean" }, "includeAIPLedger": { "type": "boolean" }, "calcAfterTax": { "type": "boolean" }, "intradayCalculationMethod": { "type": "string", "enum": [ "Standard", "Enhanced", "MarginEnhanced" ] } }, "xml": { "name": "VerboseCalculationPerformanceOptionDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.VerboseCalculationDateRangeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "displayName": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "dataMustExistOnRangeStartDate": { "type": "boolean" }, "dataMustExistOnRangeEndDate": { "type": "boolean" }, "allowStartDateAdjustment": { "type": "boolean" }, "startDateMethod": { "type": "string", "enum": [ "Inception", "HoldingPeriod", "AIPLedger" ] } }, "xml": { "name": "VerboseCalculationDateRangeDto" }, "type": "object" }, "OAS.WebApi.DTO.Performance.PerformanceBatchVerboseFilterDto": { "properties": { "filterBy": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "ids": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, "xml": { "name": "PerformanceBatchVerboseFilterDto" }, "type": "object" }, "OAS.WebApi.DTO.Performance.PerformanceBatchVerboseGroupingDto": { "properties": { "grouping": { "type": "string", "enum": [ "Self", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "FundFamily", "Platform", "Custodian", "AggregateModel", "DynamicGrouping", "AssetClass", "AssetLevelStrategy", "AssetCategory", "RiskCategory", "AccountType", "RegistrationTaxType", "ProductType", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "ProductVintageYear", "ProductSubType", "AssetCategoryParent", "PortfolioGroup", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "MaturityPeriod", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "MorningstarGeography", "BillEntityType", "ProductSubHolding", "Country", "Currency", "CustomGrouping", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "Prospect", "Transaction", "Comparison", "CostBasisLot", "ModelInclusion", "ContextChanges", "ActivityOptions", "DateRanges", "Time", "Bill", "Beneficiary", "Trustee", "Systematic", "BillTier", "BillAdjustment", "FeeSchedules", "BillCashflow", "ModelVsActual", "BillAssetLevel", "HouseholdMember", "CustomIndexing", "ProspectAccount", "CustomIndexingScenario", "ProspectAssetClass", "ProspectAssetCategory", "CustomIndexingPreference", "ProspectMandate", "ProspectComparisonAssetClass", "ProspectComparisonAssetCategory", "ProspectComparisonHolding", "ProspectHolding", "ProspectModelAgg", "ProspectAccountStressTestsGrouped", "ProspectAccountStressTestScenario", "ProspectComparisonStressTestsGrouped", "ProspectComparisonStressTestScenario", "ProspectStressTestsGrouped", "ProspectStressTestScenario", "ProspectAccountCorrelation", "ProspectComparisonAccountCorrelation", "ProspectCorrelation", "ProspectOrionPlanningCurrentGoal", "ProspectOrionPlanningProposedGoal", "ProspectOrionPlanningCurrentGoalResults", "ProspectOrionPlanningProposedGoalResults", "ProspectOrionPlanningCurrentGoalStepsResults", "ProspectOrionPlanningProposedGoalStepsResults", "ProspectHoldingSectorResults", "ProspectHoldingGeographyResults", "ProspectAccountHoldingSectorResults", "ProspectAccountHoldingGeographyResults", "ProspectComparisonAccountHoldingSectorResults", "ProspectComparisonAccountHoldingGeographyResults", "ProspectOrionPlanningNetWorth", "ProspectSelfDirectedResults", "ProspectSelfDirectedAssetClass", "ProspectSelfDirectedAssetCategory", "ProspectHouseholdMembers", "ProspectStrategist", "ProspectWeightedAssetClass", "ProspectAccountWeightedAssetClass", "BillingRelatedAccounts", "ProspectAccountBlendedFactSheet", "CustomIndexingBuys", "CustomIndexingSells", "ProspectBlendedAssetClasses", "ProspectBlendedAssetCategories", "ProspectOrionPlanningCurrentNetWorthAssetClasses", "ProspectOrionPlanningProposedNetWorthAssetClasses", "ProspectOrionPlanningNetWorthAsset", "ProspectOrionPlanningCurrentNetWorthAssetCategories", "ProspectOrionPlanningProposedNetWorthAssetCategories", "ProspectOrionPlanningCurrentAssetCategories", "ProspectOrionPlanningProposedAssetCategories", "ProspectOrionPlanningCurrentAssetClasses", "ProspectOrionPlanningProposedAssetClasses", "ProspectComparisonHouseholdManualAccounts", "AdHocGrouping" ] }, "groupings": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.PerformanceBatchVerboseGroupingDto" }, "xml": { "name": "PerformanceBatchVerboseGroupingDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "PerformanceBatchVerboseGroupingDto" }, "type": "object" }, "OAS.WebApi.DTO.Performance.PerformanceBatchVerboseReadOnlyOptionsDto": { "properties": { "localPriceCutOverDate": { "type": "string", "format": "date-time" }, "dividendAccrualStartDate": { "type": "string", "format": "date-time" }, "allowDividendAccrual": { "type": "boolean" }, "dailyInterestAccrual": { "$ref": "#/definitions/OAS.DataModel.Settings.DailyInterestAccrualEntityOptionValue" }, "feeAccrual": { "$ref": "#/definitions/OAS.DataModel.Settings.FeeAccrualEntityOptionValue" }, "forceAssetGroupingIntraday": { "type": "boolean" } }, "xml": { "name": "PerformanceBatchVerboseReadOnlyOptionsDto" }, "type": "object" }, "OAS.DataModel.Settings.DailyInterestAccrualEntityOptionValue": { "required": [ "enabled", "dailyReturnThreshold", "maxDays" ], "properties": { "enabled": { "type": "boolean" }, "startDate": { "type": "string", "format": "date-time" }, "dailyReturnThreshold": { "type": "number", "format": "double" }, "maxDays": { "type": "integer", "format": "int32" } }, "xml": { "name": "DailyInterestAccrualEntityOptionValue" }, "type": "object" }, "OAS.DataModel.Settings.FeeAccrualEntityOptionValue": { "required": [ "enabled", "impactThreshold", "maxDays" ], "properties": { "enabled": { "type": "boolean" }, "startDate": { "type": "string", "format": "date-time" }, "impactThreshold": { "type": "number", "format": "double" }, "maxDays": { "type": "integer", "format": "int32" } }, "xml": { "name": "FeeAccrualEntityOptionValue" }, "type": "object" }, "OAS.DataAccess.Domains.Reporting.Envision.CalculationGroupingOption": { "properties": { "options": { "items": { "type": "string", "enum": [ "ReportCategory", "DateRange", "Performance", "Comparison", "Activity", "Income", "Trading", "Size", "Statistical", "Billing", "CostBasis", "Calculation", "Prompt", "Sma", "MaturityPeriod", "LimitMethod", "WeightedBenchmarkGrouping", "TaxInceptionType", "CostPerShareMethod", "MaskString" ] }, "xml": { "name": "PlaceholderOptionType", "wrapped": true }, "type": "array" }, "additionalOptions": { "items": { "type": "string", "enum": [ "ReportCategory", "DateRange", "Performance", "Comparison", "Activity", "Income", "Trading", "Size", "Statistical", "Billing", "CostBasis", "Calculation", "Prompt", "Sma", "MaturityPeriod", "LimitMethod", "WeightedBenchmarkGrouping", "TaxInceptionType", "CostPerShareMethod", "MaskString" ] }, "xml": { "name": "PlaceholderOptionType", "wrapped": true }, "type": "array" }, "optionLists": { "items": { "type": "string", "enum": [ "ReportCategory", "DateRange", "Performance", "Comparison", "Activity", "Income", "Trading", "Size", "Statistical", "Billing", "CostBasis", "Calculation", "Prompt", "Sma", "MaturityPeriod", "LimitMethod", "WeightedBenchmarkGrouping", "TaxInceptionType", "CostPerShareMethod", "MaskString" ] }, "xml": { "name": "PlaceholderOptionType", "wrapped": true }, "type": "array" }, "allowedEntityType": { "items": { "type": "string", "enum": [ "AssetBased", "Prospect", "SecurityClassification" ] }, "xml": { "name": "PlaceholderEntityType", "wrapped": true }, "type": "array" }, "grouping": { "readOnly": true, "type": "string", "enum": [ "Self", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "FundFamily", "Platform", "Custodian", "AggregateModel", "DynamicGrouping", "AssetClass", "AssetLevelStrategy", "AssetCategory", "RiskCategory", "AccountType", "RegistrationTaxType", "ProductType", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "ProductVintageYear", "ProductSubType", "AssetCategoryParent", "PortfolioGroup", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "MaturityPeriod", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "MorningstarGeography", "BillEntityType", "ProductSubHolding", "Country", "Currency", "CustomGrouping", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "Prospect", "Transaction", "Comparison", "CostBasisLot", "ModelInclusion", "ContextChanges", "ActivityOptions", "DateRanges", "Time", "Bill", "Beneficiary", "Trustee", "Systematic", "BillTier", "BillAdjustment", "FeeSchedules", "BillCashflow", "ModelVsActual", "BillAssetLevel", "HouseholdMember", "CustomIndexing", "ProspectAccount", "CustomIndexingScenario", "ProspectAssetClass", "ProspectAssetCategory", "CustomIndexingPreference", "ProspectMandate", "ProspectComparisonAssetClass", "ProspectComparisonAssetCategory", "ProspectComparisonHolding", "ProspectHolding", "ProspectModelAgg", "ProspectAccountStressTestsGrouped", "ProspectAccountStressTestScenario", "ProspectComparisonStressTestsGrouped", "ProspectComparisonStressTestScenario", "ProspectStressTestsGrouped", "ProspectStressTestScenario", "ProspectAccountCorrelation", "ProspectComparisonAccountCorrelation", "ProspectCorrelation", "ProspectOrionPlanningCurrentGoal", "ProspectOrionPlanningProposedGoal", "ProspectOrionPlanningCurrentGoalResults", "ProspectOrionPlanningProposedGoalResults", "ProspectOrionPlanningCurrentGoalStepsResults", "ProspectOrionPlanningProposedGoalStepsResults", "ProspectHoldingSectorResults", "ProspectHoldingGeographyResults", "ProspectAccountHoldingSectorResults", "ProspectAccountHoldingGeographyResults", "ProspectComparisonAccountHoldingSectorResults", "ProspectComparisonAccountHoldingGeographyResults", "ProspectOrionPlanningNetWorth", "ProspectSelfDirectedResults", "ProspectSelfDirectedAssetClass", "ProspectSelfDirectedAssetCategory", "ProspectHouseholdMembers", "ProspectStrategist", "ProspectWeightedAssetClass", "ProspectAccountWeightedAssetClass", "BillingRelatedAccounts", "ProspectAccountBlendedFactSheet", "CustomIndexingBuys", "CustomIndexingSells", "ProspectBlendedAssetClasses", "ProspectBlendedAssetCategories", "ProspectOrionPlanningCurrentNetWorthAssetClasses", "ProspectOrionPlanningProposedNetWorthAssetClasses", "ProspectOrionPlanningNetWorthAsset", "ProspectOrionPlanningCurrentNetWorthAssetCategories", "ProspectOrionPlanningProposedNetWorthAssetCategories", "ProspectOrionPlanningCurrentAssetCategories", "ProspectOrionPlanningProposedAssetCategories", "ProspectOrionPlanningCurrentAssetClasses", "ProspectOrionPlanningProposedAssetClasses", "ProspectComparisonHouseholdManualAccounts", "AdHocGrouping" ] }, "value": { "readOnly": true, "type": "integer", "format": "int32" }, "name": { "type": "string" }, "category": { "type": "string", "enum": [ "Account", "Activity", "Alternatives", "Asset", "Benchmark", "Billing", "CostBasis", "CustomIndexing", "DateTime", "Firm", "Household", "Product", "Prospect", "Registration", "TargetAllocation", "Trading", "Other", "Blended" ] }, "isAssetBased": { "readOnly": true, "type": "boolean" } }, "xml": { "name": "CalculationGroupingOption" }, "type": "object" }, "OAS.WebApi.DTO.Performance.ValidatePerformanceCompareDetailDto": { "properties": { "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" }, "warningMessage": { "type": "string" }, "performanceCompareId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "timeframe": { "type": "string" }, "startValue": { "type": "number", "format": "double" }, "valueChange": { "type": "number", "format": "double" }, "endingValue": { "type": "number", "format": "double" }, "positiveCashflowAmount": { "type": "number", "format": "double" }, "negativeCashflowAmount": { "type": "number", "format": "double" }, "cashflowAmount": { "type": "number", "format": "double" }, "endingDividendAccrualAmount": { "type": "number", "format": "double" }, "endingBondAccrualAmount": { "type": "number", "format": "double" }, "grossPerformance": { "type": "number", "format": "double" }, "netPerformance": { "type": "number", "format": "double" } }, "xml": { "name": "ValidatePerformanceCompareDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Performance.PerformanceCompareDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "calcMethod": { "type": "string", "enum": [ "TWR", "Simple", "IRR" ] }, "auditedBy": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "isLockedDown": { "type": "boolean" }, "haveTimeframes": { "type": "boolean" } }, "xml": { "name": "PerformanceCompareDto" }, "type": "object" }, "OAS.WebApi.DTO.Performance.PerformanceCompareFullDto": { "properties": { "details": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.PerformanceCompareDetailDto" }, "xml": { "name": "PerformanceCompareDetailDto", "wrapped": true }, "type": "array" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "calcMethod": { "type": "string", "enum": [ "TWR", "Simple", "IRR" ] }, "auditedBy": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "isLockedDown": { "type": "boolean" }, "haveTimeframes": { "type": "boolean" } }, "xml": { "name": "PerformanceCompareFullDto" }, "type": "object" }, "OAS.WebApi.DTO.Performance.PerformanceCompareDetailDto": { "properties": { "performanceCompareId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "timeframe": { "type": "string" }, "startValue": { "type": "number", "format": "double" }, "valueChange": { "type": "number", "format": "double" }, "endingValue": { "type": "number", "format": "double" }, "positiveCashflowAmount": { "type": "number", "format": "double" }, "negativeCashflowAmount": { "type": "number", "format": "double" }, "cashflowAmount": { "type": "number", "format": "double" }, "endingDividendAccrualAmount": { "type": "number", "format": "double" }, "endingBondAccrualAmount": { "type": "number", "format": "double" }, "grossPerformance": { "type": "number", "format": "double" }, "netPerformance": { "type": "number", "format": "double" } }, "xml": { "name": "PerformanceCompareDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Performance.PerformanceCompareDetailFullDto": { "properties": { "systemStartValue": { "type": "number", "format": "double" }, "systemValueChange": { "type": "number", "format": "double" }, "systemEndingValue": { "type": "number", "format": "double" }, "systemPositiveCashflowAmount": { "type": "number", "format": "double" }, "systemNegativeCashflowAmount": { "type": "number", "format": "double" }, "systemCashflowAmount": { "type": "number", "format": "double" }, "systemEndingDividendAccrualAmount": { "type": "number", "format": "double" }, "systemEndingBondAccrualAmount": { "type": "number", "format": "double" }, "systemGrossPerformance": { "type": "number", "format": "double" }, "systemNetPerformance": { "type": "number", "format": "double" }, "calculationStatus": { "type": "string", "enum": [ "NotCalculated", "Errored", "Calculated", "PendingCalculation", "WillNotBeCalculated" ] }, "calculationDate": { "type": "string", "format": "date-time" }, "errorText": { "type": "string" }, "actionStatus": { "type": "string", "enum": [ "NotComplete", "Complete", "AdvisorResearch", "OrionResearch", "NoAction", "Addressed" ] }, "noteCount": { "type": "integer", "format": "int32" }, "compareStartValue": { "readOnly": true, "type": "number", "format": "double" }, "compareEndingValue": { "readOnly": true, "type": "number", "format": "double" }, "compareGrossPerformance": { "readOnly": true, "type": "number", "format": "double" }, "compareNetPerformance": { "readOnly": true, "type": "number", "format": "double" }, "cashflowPercentStart": { "readOnly": true, "type": "number", "format": "double" }, "cashflowPercentEnd": { "readOnly": true, "type": "number", "format": "double" }, "performanceCompareId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "timeframe": { "type": "string" }, "startValue": { "type": "number", "format": "double" }, "valueChange": { "type": "number", "format": "double" }, "endingValue": { "type": "number", "format": "double" }, "positiveCashflowAmount": { "type": "number", "format": "double" }, "negativeCashflowAmount": { "type": "number", "format": "double" }, "cashflowAmount": { "type": "number", "format": "double" }, "endingDividendAccrualAmount": { "type": "number", "format": "double" }, "endingBondAccrualAmount": { "type": "number", "format": "double" }, "grossPerformance": { "type": "number", "format": "double" }, "netPerformance": { "type": "number", "format": "double" } }, "xml": { "name": "PerformanceCompareDetailFullDto" }, "type": "object" }, "OAS.WebApi.DTO.Performance.PerformanceCompareDetailPivotDto": { "properties": { "performanceCompareId": { "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "additionalColumns": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Interface.AdditionalColumnDefinition" }, "readOnly": true, "xml": { "name": "AdditionalColumnDefinition", "wrapped": true }, "type": "array" }, "actionStatus": { "readOnly": true, "type": "string", "enum": [ "NotComplete", "Complete", "AdvisorResearch", "OrionResearch", "NoAction", "Addressed" ] }, "ids": { "items": { "type": "integer", "format": "int32" }, "readOnly": true, "type": "array" }, "noteCount": { "readOnly": true, "type": "integer", "format": "int32" } }, "xml": { "name": "PerformanceCompareDetailPivotDto" }, "type": "object" }, "OAS.WebApi.DTO.Performance.PerformanceCompareNoteDto": { "properties": { "performanceCompareId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "isAdvisorVisible": { "type": "boolean" }, "note": { "type": "string" } }, "xml": { "name": "PerformanceCompareNoteDto" }, "type": "object" }, "OAS.DataProcess.Performance.Overview.PerformanceWithDateRangeInfoDto": { "properties": { "performance": { "items": { "$ref": "#/definitions/OAS.DataProcess.Performance.Overview.PerformanceDto" }, "xml": { "name": "PerformanceDto", "wrapped": true }, "type": "array" }, "dateRanges": { "items": { "$ref": "#/definitions/OAS.DataProcess.Performance.Overview.PerformanceDateRangeDto" }, "xml": { "name": "PerformanceDateRangeDto", "wrapped": true }, "type": "array" }, "status": { "$ref": "#/definitions/OAS.DataProcess.Performance.Overview.PerformanceStatusDto" }, "asOfDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" } }, "xml": { "name": "PerformanceWithDateRangeInfoDto" }, "type": "object" }, "OAS.DataProcess.Performance.Overview.PerformanceDto": { "properties": { "entityId": { "type": "integer", "format": "int32" }, "entityEnum": { "type": "integer", "format": "int32" }, "parentId": { "type": "integer", "format": "int32" }, "groupName": { "type": "string" }, "marketValue": { "type": "number", "format": "double" }, "day": { "type": "number", "format": "double" }, "mtd": { "type": "number", "format": "double" }, "qtd": { "type": "number", "format": "double" }, "ytd": { "type": "number", "format": "double" }, "oneYear": { "type": "number", "format": "double" }, "threeYear": { "type": "number", "format": "double" }, "fiveYear": { "type": "number", "format": "double" }, "tenYear": { "type": "number", "format": "double" }, "inception": { "type": "number", "format": "double" } }, "xml": { "name": "PerformanceDto" }, "type": "object" }, "OAS.DataProcess.Performance.Overview.PerformanceDateRangeDto": { "properties": { "dateRangeName": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "PerformanceDateRangeDto" }, "type": "object" }, "OAS.DataProcess.Performance.Overview.PerformanceStatusDto": { "properties": { "status": { "type": "string" }, "lastUpdated": { "type": "string", "format": "date-time" } }, "xml": { "name": "PerformanceStatusDto" }, "type": "object" }, "OAS.DataProcess.Performance.Overview.OverviewPerformanceRequestParameters": { "properties": { "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "grouping": { "type": "string", "enum": [ "Undefined", "Representative", "Client", "Registration", "Account", "Asset", "AssetClass", "ProductType", "Platform", "RiskCategory", "Product", "IndexBlend", "AssetCategory", "AssetLevelStrategy", "AggregateModel", "AccountType", "PortfolioGroup" ] }, "annualizePerformance": { "type": "boolean" }, "includeBenchmarks": { "type": "boolean" } }, "xml": { "name": "OverviewPerformanceRequestParameters" }, "type": "object" }, "OAS.WebApi.DTO.Performance.StoredPerformance.StoredPerformanceImportVerboseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "importName": { "type": "string" }, "notes": { "type": "string" }, "importOptions": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.StoredPerformance.StoredPerformanceImportVerboseOptionsDto" }, "fileStatus": { "type": "string", "enum": [ "FileNotLoaded", "FileLoading", "FileLoaded", "Error" ] }, "hangfireJobId": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedBy": { "type": "string" } }, "xml": { "name": "StoredPerformanceImportVerboseDto" }, "type": "object" }, "OAS.WebApi.DTO.Performance.StoredPerformance.StoredPerformanceImportVerboseOptionsDto": { "properties": { "s3FileName": { "type": "string" }, "columnMappings": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Performance.StoredPerformance.StoredPerformanceColumnMapping" }, "xml": { "name": "StoredPerformanceColumnMapping", "wrapped": true }, "type": "array" }, "addDayToStartDate": { "type": "boolean" } }, "xml": { "name": "StoredPerformanceImportVerboseOptionsDto" }, "type": "object" }, "OAS.WebApi.DTO.Performance.StoredPerformance.StoredPerformanceColumnMapping": { "properties": { "columnName": { "type": "string" }, "columnType": { "type": "string", "enum": [ "AccountNumber", "StartDate", "EndDate", "StartValue", "EndValue", "Contributions", "Distributions", "Cashflows", "FeeAmount", "GrossPerformance", "NetPerformance", "AccountId" ] } }, "xml": { "name": "StoredPerformanceColumnMapping" }, "type": "object" }, "OAS.WebApi.DTO.Performance.StoredPerformance.StoredPerformanceImportFileDto": { "properties": { "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" }, "delimiter": { "type": "string" } }, "xml": { "name": "StoredPerformanceImportFileDto" }, "type": "object" }, "OAS.DataModel.Performance.StoredPerformanceImportEntity": { "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int32" }, "storedPerformanceImportId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string", "maxLength": 50, "minLength": 0 }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "generationStatus": { "type": "string", "enum": [ "NotGenerated", "Errored", "Generated", "PendingGeneration", "DoNotGenerate" ] }, "notes": { "type": "string", "maxLength": 1000, "minLength": 0 }, "errorMessage": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "StoredPerformanceImportEntity" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AccountCancellationSubjectsDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "AccountCancellationSubjectsDto" }, "type": "object" }, "OAS.DataModel.Portfolio.AccountCancellationSubjects": { "required": [ "id", "cancellationSubject" ], "properties": { "id": { "type": "integer", "format": "int32" }, "cancellationSubject": { "type": "string", "maxLength": 255, "minLength": 0 } }, "xml": { "name": "AccountCancellationSubjects" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AccountCustodialInfoChangeDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "changeStatus": { "type": "string" }, "fieldName": { "type": "string" }, "fieldLevel": { "type": "string" }, "custodialInfo": { "type": "string" }, "householdInfo": { "type": "string" }, "householdId": { "type": "integer", "format": "int32" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "effectiveDate": { "type": "string", "format": "date-time" }, "accountCode": { "type": "string" }, "householdName": { "type": "string" }, "regName": { "type": "string" }, "repName": { "type": "string" }, "repCode": { "type": "string" }, "custodian": { "type": "string" }, "fundFamily": { "type": "string" } }, "xml": { "name": "AccountCustodialInfoChangeDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SimpleAccountWithValue": { "properties": { "value": { "type": "number", "format": "double" }, "number": { "type": "string" }, "managementStyle": { "type": "string" }, "isActive": { "type": "boolean" }, "clientId": { "type": "integer", "format": "int32" }, "custodian": { "type": "string" }, "registrationId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "SimpleAccountWithValue" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AssetDto": { "properties": { "costBasis": { "type": "number", "format": "double" }, "name": { "type": "string" }, "accountNumber": { "type": "string" }, "ticker": { "type": "string" }, "currentShares": { "type": "number", "format": "double" }, "currentValue": { "type": "number", "format": "double" }, "currentPrice": { "type": "number", "format": "double" }, "isManaged": { "type": "boolean" }, "assetClass": { "type": "string" }, "productCategory": { "type": "string" }, "productCategoryAbbreviation": { "type": "string" }, "isCustodialCash": { "type": "boolean" }, "secondaryAccountNumber": { "type": "string" }, "cusip": { "type": "string" }, "productId": { "type": "integer", "format": "int32" }, "assetLevelStrategyId": { "type": "integer", "format": "int32" }, "assetLevelStrategy": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "isStrategyOverride": { "type": "boolean" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "accountId": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "downloadSymbol": { "type": "integer", "format": "int32" }, "accountType": { "type": "string" }, "fundFamily": { "type": "string" }, "custodian": { "type": "string" }, "asOfDate": { "type": "string", "format": "date-time" }, "registrationName": { "type": "string" }, "managementStyle": { "type": "string" }, "sleeveType": { "type": "string", "enum": [ "Normal sleeve", "Custodial account", "Contribution sleeve", "Distribution sleeve", "Unmanaged sleeve" ] }, "productType": { "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, "productSubType": { "type": "string" }, "isGlobalExcluded": { "type": "boolean" }, "isFeeExcluded": { "type": "boolean" }, "excludeAmountType": { "type": "string", "enum": [ "Percent", "Dollars", "Shares" ] }, "excludeAmount": { "type": "number", "format": "double" }, "excludePercentOf": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "excludeFromMargin": { "type": "boolean" }, "isRebalance": { "type": "boolean" }, "isAdvisorOnly": { "type": "boolean" }, "isAdvReportable": { "type": "boolean" }, "is13FReportable": { "type": "boolean" }, "mscsFundAccountNumber": { "type": "string" }, "lastReconDate": { "type": "string", "format": "date-time" }, "isOrionVision": { "type": "boolean" }, "assetPercentOfAccount": { "type": "number", "format": "double" }, "householdName": { "type": "string" }, "riskCategory": { "type": "string" }, "modelName": { "type": "string" }, "registrationType": { "type": "string" }, "accountStatusId": { "type": "integer", "format": "int32" }, "isin": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "isDataSharingEntity": { "type": "boolean" } }, "xml": { "name": "AssetDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SimpleAssetWithValue": { "properties": { "assetClass": { "type": "string" }, "accountNumber": { "type": "string" }, "isCustodialCash": { "type": "boolean" }, "isTradeExcluded": { "type": "boolean" }, "shares": { "type": "number", "format": "double" }, "price": { "type": "number", "format": "double" }, "value": { "type": "number", "format": "double" }, "name": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "ticker": { "type": "string" }, "productId": { "type": "integer", "format": "int32" } }, "xml": { "name": "SimpleAssetWithValue" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RestoreAccountsDto": { "properties": { "sessionId": { "type": "string" }, "pkDownloadNameFile": { "type": "integer", "format": "int32" }, "nameNotConfirmed": { "type": "integer", "format": "int32" }, "pkDownloadTranFile": { "type": "integer", "format": "int32" }, "tranNotConfirmed": { "type": "integer", "format": "int32" }, "pkDownloadPosFile": { "type": "integer", "format": "int32" }, "PosNotConfirmed": { "type": "integer", "format": "int32" }, "pkDownloadStartingValueTranFile": { "type": "integer", "format": "int32" }, "startingValueTranNotConfirmed": { "type": "integer", "format": "int32" }, "pkRemainingPosFile": { "type": "integer", "format": "int32" }, "remainingPosNotConfirmed": { "type": "integer", "format": "int32" } }, "xml": { "name": "RestoreAccountsDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AccountAuditDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "fundFamilyId": { "type": "integer", "format": "int32" }, "shareClassId": { "type": "integer", "format": "int32" }, "platformId": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "isSweepAcct": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "provider": { "type": "string" }, "createdBy": { "type": "string" }, "cancelDate": { "type": "string", "format": "date-time" }, "cancelValue": { "type": "number", "format": "double" }, "isTradingBlocked": { "type": "boolean" }, "tradingInstructions": { "type": "string" }, "outsideId": { "type": "string" }, "groupNumber": { "type": "string" }, "subAdvisorId": { "type": "integer", "format": "int32" }, "importKey": { "type": "string" }, "accountStartDate": { "type": "string", "format": "date-time" }, "accountStartValue": { "type": "number", "format": "double" }, "planId": { "type": "integer", "format": "int32" }, "accountStatusId": { "type": "integer", "format": "int32" }, "accountHistoryId": { "type": "integer", "format": "int32" }, "sweepAssetId": { "type": "integer", "format": "int32" }, "initialPurchaseDate": { "type": "string", "format": "date-time" }, "isManaged": { "type": "boolean" }, "isOps": { "type": "boolean" }, "registrationName": { "type": "string" }, "fundFamilyName": { "type": "string" }, "shareClassName": { "type": "string" }, "custodianName": { "type": "string" }, "managementStyleName": { "type": "string" }, "subAdvivisorName": { "type": "string" }, "changeType": { "type": "string" } }, "xml": { "name": "AccountAuditDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AumOverTimeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "grouping": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "value": { "type": "number", "format": "double" } }, "xml": { "name": "AumOverTimeDto" }, "type": "object" }, "OAS.DataModel.Reporting.Activity.AumOverTimeSimple": { "properties": { "id": { "type": "integer", "format": "int32" }, "grouping": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string" }, "value": { "type": "number", "format": "double" } }, "xml": { "name": "AumOverTimeSimple" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AumOverTimeWithNetAmountInvestedDto": { "properties": { "aumOverTime": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AumOverTimeDto" }, "xml": { "name": "AumOverTimeDto", "wrapped": true }, "type": "array" }, "netAmountInvested": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AumOverTimeDto" }, "xml": { "name": "AumOverTimeDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "AumOverTimeWithNetAmountInvestedDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Performance.PerformancePortfolio": { "properties": { "pkGroup": { "type": "integer", "format": "int32" }, "fkParentGroup": { "type": "integer", "format": "int32" }, "fkBucket": { "type": "integer", "format": "int32" }, "fkEntity": { "type": "integer", "format": "int32" }, "grouping": { "type": "string", "enum": [ "Undefined", "Representative", "Client", "Registration", "Account", "Asset", "AssetClass", "ProductType", "Platform", "RiskCategory", "Product", "IndexBlend", "AssetCategory", "AssetLevelStrategy", "AggregateModel", "AccountType", "PortfolioGroup" ] }, "fkGroupEntity": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "inceptionDate": { "type": "string", "format": "date-time" }, "calcFirstDayPerformance": { "type": "boolean" }, "calcGrossOfFees": { "type": "string", "enum": [ "NetOfFees", "GrossOfFees", "Both" ] }, "includeAccruedInt": { "type": "boolean" }, "portfolios": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Performance.PerformancePortfolio" }, "xml": { "name": "PerformancePortfolio", "wrapped": true }, "type": "array" }, "summaries": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Performance.PerformancePortfolioSummary" }, "xml": { "name": "PerformancePortfolioSummary", "wrapped": true }, "type": "array" }, "details": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Performance.PerformancePortfolioDetail" }, "xml": { "name": "PerformancePortfolioDetail", "wrapped": true }, "type": "array" }, "benchmarks": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Performance.PerformanceBenchmark" }, "xml": { "name": "PerformanceBenchmark", "wrapped": true }, "type": "array" }, "assetGroupAssignments": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Performance.PerformanceAssetGroupAssignment" }, "xml": { "name": "PerformanceAssetGroupAssignment", "wrapped": true }, "type": "array" }, "statistics": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Performance.PerformanceStatistic" }, "xml": { "name": "PerformanceStatistic", "wrapped": true }, "type": "array" } }, "xml": { "name": "PerformancePortfolio" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Performance.PerformancePortfolioSummary": { "properties": { "pkGroup": { "type": "integer", "format": "int32" }, "calcGrossOfFees": { "type": "boolean" }, "pkDateRange": { "type": "integer", "format": "int32" }, "dateRangeName": { "type": "string" }, "performance": { "type": "number", "format": "double" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "error": { "type": "integer", "format": "int32" }, "annualize": { "type": "boolean" }, "overflow": { "type": "boolean" }, "daysInPeriod": { "type": "integer", "format": "int32" } }, "xml": { "name": "PerformancePortfolioSummary" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Performance.PerformancePortfolioDetail": { "properties": { "pkGroup": { "type": "integer", "format": "int32" }, "calcGrossOfFees": { "type": "boolean" }, "asOfDate": { "type": "string", "format": "date-time" }, "factor": { "type": "number", "format": "double" } }, "xml": { "name": "PerformancePortfolioDetail" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Performance.PerformanceBenchmark": { "properties": { "pkGroup": { "type": "integer", "format": "int32" }, "fkKey": { "type": "integer", "format": "int32" }, "bmType": { "type": "string" }, "name": { "type": "string" }, "inceptionDate": { "type": "string", "format": "date-time" }, "rebalanceFrequency": { "type": "string", "enum": [ "Daily", "Monthly", "Quarterly", "Semiannually", "Annually", "BuyAndHold", "Default" ] }, "rebalanceBasedOn": { "type": "string", "enum": [ "CalendarPeriodEnd", "RollingPeriod" ] }, "sortOrder": { "type": "integer", "format": "int32" }, "color": { "type": "string" }, "summaries": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Performance.PerformanceBenchmarkSummary" }, "xml": { "name": "PerformanceBenchmarkSummary", "wrapped": true }, "type": "array" }, "details": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Performance.PerformanceBenchmarkDetail" }, "xml": { "name": "PerformanceBenchmarkDetail", "wrapped": true }, "type": "array" }, "statistics": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Performance.PerformanceStatistic" }, "xml": { "name": "PerformanceStatistic", "wrapped": true }, "type": "array" } }, "xml": { "name": "PerformanceBenchmark" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Performance.PerformanceAssetGroupAssignment": { "properties": { "pkGroup": { "type": "integer", "format": "int32" }, "fkAsset": { "type": "integer", "format": "int32" }, "weight": { "type": "number", "format": "double" }, "performance": { "type": "boolean" }, "activitySummary": { "type": "boolean" }, "allocation": { "type": "boolean" }, "portfolioDetail": { "type": "boolean" }, "taxDetail": { "type": "boolean" } }, "xml": { "name": "PerformanceAssetGroupAssignment" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Performance.PerformanceStatistic": { "properties": { "pkDateRange": { "type": "integer", "format": "int32" }, "pkGroup": { "type": "integer", "format": "int32" }, "calcGrossOfFees": { "type": "boolean" }, "fkKey": { "type": "integer", "format": "int32" }, "bmType": { "type": "string" }, "fkStatistic": { "type": "integer", "format": "int32" }, "value": { "type": "number", "format": "double" } }, "xml": { "name": "PerformanceStatistic" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Performance.PerformanceBenchmarkSummary": { "properties": { "pkGroup": { "type": "integer", "format": "int32" }, "fkKey": { "type": "integer", "format": "int32" }, "bmType": { "type": "string" }, "pkDateRange": { "type": "integer", "format": "int32" }, "dateRangeName": { "type": "string" }, "performance": { "type": "number", "format": "double" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "error": { "type": "integer", "format": "int32" }, "annualize": { "type": "boolean" }, "overflow": { "type": "boolean" }, "daysInPeriod": { "type": "integer", "format": "int32" } }, "xml": { "name": "PerformanceBenchmarkSummary" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Performance.PerformanceBenchmarkDetail": { "properties": { "pkGroup": { "type": "integer", "format": "int32" }, "fkKey": { "type": "integer", "format": "int32" }, "bmType": { "type": "string" }, "asOfDate": { "type": "string", "format": "date-time" }, "factor": { "type": "number", "format": "double" } }, "xml": { "name": "PerformanceBenchmarkDetail" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.PerformancePortfolioSummaryDto": { "properties": { "groupId": { "type": "integer", "format": "int32" }, "fkGroupEntity": { "type": "integer", "format": "int32" }, "grouping": { "type": "string", "enum": [ "Undefined", "Representative", "Client", "Registration", "Account", "Asset", "AssetClass", "ProductType", "Platform", "RiskCategory", "Product", "IndexBlend", "AssetCategory", "AssetLevelStrategy", "AggregateModel", "AccountType", "PortfolioGroup" ] }, "groupName": { "type": "string" }, "dateRangeName": { "type": "string" }, "performance": { "type": "number", "format": "double" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "error": { "type": "integer", "format": "int32" }, "annualize": { "type": "boolean" }, "overflow": { "type": "boolean" } }, "xml": { "name": "PerformancePortfolioSummaryDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Reporting.PerformancePortfolioDetailDto": { "properties": { "groupId": { "type": "integer", "format": "int32" }, "groupName": { "type": "string" }, "asOfDate": { "type": "string", "format": "date-time" }, "factor": { "type": "number", "format": "double" } }, "xml": { "name": "PerformancePortfolioDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.RunReport.InceptionDateDto": { "properties": { "inceptionDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "InceptionDateDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AccountChangeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "oldEntityName": { "type": "string" }, "newEntityName": { "type": "string" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "isDeleted": { "type": "boolean" } }, "xml": { "name": "AccountChangeDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AccountChangeNewDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "changes": { "additionalProperties": { "type": "object" }, "type": "object" }, "original": { "additionalProperties": { "type": "object" }, "type": "object" }, "changeDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "AccountChangeNewDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.NumerousAccountChangeNewDto": { "properties": { "accountIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "changes": { "additionalProperties": { "type": "object" }, "type": "object" }, "changeDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "NumerousAccountChangeNewDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AccountFileDto": { "properties": { "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" }, "openWith": { "type": "string" }, "blobDesc": { "type": "string" }, "category": { "type": "string" }, "blobType": { "type": "string", "enum": [ "RPT_1099", "QuarterlyStatements", "YearEndStatements", "CrmDocuments", "Payable", "InsightPresentations", "PortfolioViewDashboards" ] } }, "xml": { "name": "AccountFileDto" }, "type": "object" }, "OAS.WebApi.Code.Projection.ProjectionManipulatorOfOAS.WebApi.DTO.Portfolio.AccountDto": { "properties": { "type": { "readOnly": true, "type": "string" }, "hasImpact": { "readOnly": true, "type": "boolean" }, "top": { "readOnly": true, "type": "integer", "format": "int32" }, "skip": { "readOnly": true, "type": "integer", "format": "int32" }, "requestedProperties": { "description": "The properties the user specifically asked for", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" }, "requiredProperties": { "description": "The properties that are required to fulfill the requested properties", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProjectionManipulator`1" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AccountBaseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "number": { "type": "string" }, "modelName": { "type": "string" }, "subAdvisor": { "type": "string" }, "accountType": { "type": "string" }, "isDataSharingEntity": { "type": "boolean" } }, "xml": { "name": "AccountBaseDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.TradingTransactionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "assetId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "ticker": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "registrationId": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "registrationCode": { "type": "string" }, "householdId": { "type": "integer", "format": "int32" }, "fundFamilyName": { "type": "string" }, "custodianName": { "type": "string" }, "status": { "type": "string", "enum": [ "Complete", "Pending", "Rejected", "Reversed", "Inactive", "PendingCorpAction", "FutureAip" ] }, "transDate": { "type": "string", "format": "date-time" }, "transactionDescription": { "type": "string" }, "transAmount": { "type": "number", "format": "double" }, "navPrice": { "type": "number", "format": "double" }, "noUnits": { "type": "number", "format": "double" }, "notes": { "type": "string" }, "orderId": { "type": "string" }, "blockId": { "type": "integer", "format": "int32" }, "orderCreatedBy": { "type": "string" }, "avgPrice": { "type": "number", "format": "double" }, "executionTime": { "type": "string", "format": "date-time" }, "transTypeId": { "type": "integer", "format": "int32" }, "contributionCodeId": { "type": "integer", "format": "int32" }, "distributionCodeId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "registrationSleeveStrategyName": { "type": "string" }, "tradeOrderId": { "type": "integer", "format": "int32" } }, "xml": { "name": "TradingTransactionDto" }, "type": "object" }, "OAS.DataProcess.Performance.OrionCustomIndexing.Models.OrionCustomIndexingClientInformation": { "properties": { "result": { "$ref": "#/definitions/OAS.DataProcess.Reporting.Calculate.CalculatedGroup" }, "accountId": { "type": "integer", "format": "int32" }, "lastUpdated": { "type": "string", "format": "date-time" }, "asOfDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "OrionCustomIndexingClientInformation" }, "type": "object" }, "OAS.DataProcess.Reporting.Calculate.CalculatedGroup": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "id": { "type": "string" }, "groupId": { "type": "integer", "format": "int32" }, "grouping": { "type": "string", "enum": [ "Self", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "FundFamily", "Platform", "Custodian", "AggregateModel", "DynamicGrouping", "AssetClass", "AssetLevelStrategy", "AssetCategory", "RiskCategory", "AccountType", "RegistrationTaxType", "ProductType", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "ProductVintageYear", "ProductSubType", "AssetCategoryParent", "PortfolioGroup", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "MaturityPeriod", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "MorningstarGeography", "BillEntityType", "ProductSubHolding", "Country", "Currency", "CustomGrouping", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "Prospect", "Transaction", "Comparison", "CostBasisLot", "ModelInclusion", "ContextChanges", "ActivityOptions", "DateRanges", "Time", "Bill", "Beneficiary", "Trustee", "Systematic", "BillTier", "BillAdjustment", "FeeSchedules", "BillCashflow", "ModelVsActual", "BillAssetLevel", "HouseholdMember", "CustomIndexing", "ProspectAccount", "CustomIndexingScenario", "ProspectAssetClass", "ProspectAssetCategory", "CustomIndexingPreference", "ProspectMandate", "ProspectComparisonAssetClass", "ProspectComparisonAssetCategory", "ProspectComparisonHolding", "ProspectHolding", "ProspectModelAgg", "ProspectAccountStressTestsGrouped", "ProspectAccountStressTestScenario", "ProspectComparisonStressTestsGrouped", "ProspectComparisonStressTestScenario", "ProspectStressTestsGrouped", "ProspectStressTestScenario", "ProspectAccountCorrelation", "ProspectComparisonAccountCorrelation", "ProspectCorrelation", "ProspectOrionPlanningCurrentGoal", "ProspectOrionPlanningProposedGoal", "ProspectOrionPlanningCurrentGoalResults", "ProspectOrionPlanningProposedGoalResults", "ProspectOrionPlanningCurrentGoalStepsResults", "ProspectOrionPlanningProposedGoalStepsResults", "ProspectHoldingSectorResults", "ProspectHoldingGeographyResults", "ProspectAccountHoldingSectorResults", "ProspectAccountHoldingGeographyResults", "ProspectComparisonAccountHoldingSectorResults", "ProspectComparisonAccountHoldingGeographyResults", "ProspectOrionPlanningNetWorth", "ProspectSelfDirectedResults", "ProspectSelfDirectedAssetClass", "ProspectSelfDirectedAssetCategory", "ProspectHouseholdMembers", "ProspectStrategist", "ProspectWeightedAssetClass", "ProspectAccountWeightedAssetClass", "BillingRelatedAccounts", "ProspectAccountBlendedFactSheet", "CustomIndexingBuys", "CustomIndexingSells", "ProspectBlendedAssetClasses", "ProspectBlendedAssetCategories", "ProspectOrionPlanningCurrentNetWorthAssetClasses", "ProspectOrionPlanningProposedNetWorthAssetClasses", "ProspectOrionPlanningNetWorthAsset", "ProspectOrionPlanningCurrentNetWorthAssetCategories", "ProspectOrionPlanningProposedNetWorthAssetCategories", "ProspectOrionPlanningCurrentAssetCategories", "ProspectOrionPlanningProposedAssetCategories", "ProspectOrionPlanningCurrentAssetClasses", "ProspectOrionPlanningProposedAssetClasses", "ProspectComparisonHouseholdManualAccounts", "AdHocGrouping" ] }, "groupEntityId": { "type": "integer", "format": "int32" }, "groupEntityIdPath": { "type": "string" }, "name": { "type": "string" }, "inceptionDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "calculations": { "items": { "$ref": "#/definitions/OAS.DataAccess.Domains.Reporting.DataEngine.IGotCalculated" }, "xml": { "name": "IGotCalculated", "wrapped": true }, "type": "array" } }, "xml": { "name": "CalculatedGroup" }, "type": "object" }, "OAS.DataAccess.Domains.Reporting.DataEngine.IGotCalculated": { "properties": { "id": { "type": "string" }, "type": { "readOnly": true, "type": "string" } }, "xml": { "name": "IGotCalculated" }, "type": "object" }, "OAS.DataProcess.Performance.OrionCustomIndexing.OrionCustomIndexingClientInformationRequest": { "properties": { "asOfDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "accountIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "contextChange": { "$ref": "#/definitions/OAS.DataModel.Reporting.Engine.ContextChange" } }, "xml": { "name": "OrionCustomIndexingClientInformationRequest" }, "type": "object" }, "OAS.DataModel.Reporting.Engine.ContextChange": { "properties": { "activityOption": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IMakeActivityOption" }, "billingOption": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IMakeBillingOption" }, "calculationOption": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculation.IMakeCalculationOption" }, "comparisonOption": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IMakeComparisonOption" }, "costBasisOption": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IMakeCostBasisOption" }, "dateRange": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IMakeDateRange" }, "incomeOption": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IMakeIncomeOption" }, "maturityPeriodOption": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IMakeMaturityPeriodOption" }, "performanceOption": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IMakePerformanceOption" }, "projectedIncomeOption": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IMakeProjectedIncomeOption" }, "statisticalOption": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IMakeStatisticalOption" }, "taxOption": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IMakeTaxOption" }, "tradingOption": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IMakeTradingOption" }, "transactionOption": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IMakeTransactionOption" }, "attributionOption": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IMakeAttributionOption" }, "activityOptionId": { "type": "integer", "format": "int32" }, "billingOptionId": { "type": "integer", "format": "int32" }, "calculationOptionId": { "type": "integer", "format": "int32" }, "comparisonOptionId": { "type": "integer", "format": "int32" }, "costBasisOptionId": { "type": "integer", "format": "int32" }, "dateRangeId": { "type": "integer", "format": "int32" }, "incomeOptionId": { "type": "integer", "format": "int32" }, "maturityPeriodOptionId": { "type": "integer", "format": "int32" }, "performanceOptionId": { "type": "integer", "format": "int32" }, "projectedIncomeOptionId": { "type": "integer", "format": "int32" }, "promptOptionId": { "type": "integer", "format": "int32" }, "reportCategoryId": { "type": "integer", "format": "int32" }, "statisticalOptionId": { "type": "integer", "format": "int32" }, "taxOptionId": { "type": "integer", "format": "int32" }, "tradingOptionId": { "type": "integer", "format": "int32" }, "transactionOptionId": { "type": "integer", "format": "int32" }, "attributionId": { "type": "integer", "format": "int32" }, "returnStyle": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IReturnStyle" }, "percentFormat": { "type": "string" }, "dollarFormat": { "type": "string" }, "decimalFormat": { "type": "string" }, "numericFormat": { "type": "string" }, "quickDate": { "type": "string", "enum": [ "Day", "WTD", "MTD", "QTD", "YTD", "OneYear", "TwoYear", "ThreeYear", "FourYear", "FiveYear", "SixYear", "SevenYear", "EightYear", "NineYear", "TenYear", "PreviousOneYear", "PreviousTwoYear", "PreviousThreeYear", "PreviousFourYear", "PreviousFiveYear", "PreviousSixYear", "PreviousSevenYear", "PreviousEightYear", "PreviousNineYear", "PreviousTenYear", "Inception", "HoldingPeriod", "AIPLedger" ] }, "globalsSynced": { "type": "boolean" }, "useSmaSetting": { "type": "boolean" } }, "xml": { "name": "ContextChange" }, "type": "object" }, "OAS.DataModel.Reporting.Interfaces.IMakeActivityOption": { "properties": { "type": { "readOnly": true, "type": "string" } }, "xml": { "name": "IMakeActivityOption" }, "type": "object" }, "OAS.DataModel.Reporting.Interfaces.IMakeBillingOption": { "properties": { "type": { "readOnly": true, "type": "string" } }, "xml": { "name": "IMakeBillingOption" }, "type": "object" }, "OAS.DataModel.Reporting.Calculation.IMakeCalculationOption": { "properties": { "type": { "readOnly": true, "type": "string" } }, "xml": { "name": "IMakeCalculationOption" }, "type": "object" }, "OAS.DataModel.Reporting.Interfaces.IMakeComparisonOption": { "properties": { "type": { "readOnly": true, "type": "string" } }, "xml": { "name": "IMakeComparisonOption" }, "type": "object" }, "OAS.DataModel.Reporting.Interfaces.IMakeCostBasisOption": { "properties": { "type": { "readOnly": true, "type": "string" } }, "xml": { "name": "IMakeCostBasisOption" }, "type": "object" }, "OAS.DataModel.Reporting.Interfaces.IMakeDateRange": { "properties": { "type": { "readOnly": true, "type": "string" } }, "xml": { "name": "IMakeDateRange" }, "type": "object" }, "OAS.DataModel.Reporting.Interfaces.IMakeIncomeOption": { "properties": { "type": { "readOnly": true, "type": "string" } }, "xml": { "name": "IMakeIncomeOption" }, "type": "object" }, "OAS.DataModel.Reporting.Interfaces.IMakeMaturityPeriodOption": { "properties": { "type": { "readOnly": true, "type": "string" } }, "xml": { "name": "IMakeMaturityPeriodOption" }, "type": "object" }, "OAS.DataModel.Reporting.Interfaces.IMakePerformanceOption": { "properties": { "type": { "readOnly": true, "type": "string" } }, "xml": { "name": "IMakePerformanceOption" }, "type": "object" }, "OAS.DataModel.Reporting.Interfaces.IMakeProjectedIncomeOption": { "properties": { "type": { "readOnly": true, "type": "string" } }, "xml": { "name": "IMakeProjectedIncomeOption" }, "type": "object" }, "OAS.DataModel.Reporting.Interfaces.IMakeStatisticalOption": { "properties": { "type": { "readOnly": true, "type": "string" } }, "xml": { "name": "IMakeStatisticalOption" }, "type": "object" }, "OAS.DataModel.Reporting.Interfaces.IMakeTaxOption": { "properties": { "type": { "readOnly": true, "type": "string" } }, "xml": { "name": "IMakeTaxOption" }, "type": "object" }, "OAS.DataModel.Reporting.Interfaces.IMakeTradingOption": { "properties": { "type": { "readOnly": true, "type": "string" } }, "xml": { "name": "IMakeTradingOption" }, "type": "object" }, "OAS.DataModel.Reporting.Interfaces.IMakeTransactionOption": { "properties": { "type": { "readOnly": true, "type": "string" } }, "xml": { "name": "IMakeTransactionOption" }, "type": "object" }, "OAS.DataModel.Reporting.Interfaces.IMakeAttributionOption": { "properties": { "type": { "readOnly": true, "type": "string" } }, "xml": { "name": "IMakeAttributionOption" }, "type": "object" }, "OAS.DataModel.Reporting.Interfaces.IReturnStyle": { "properties": { "frequency": { "readOnly": true, "type": "string", "enum": [ "Summary", "Annually", "Quarterly", "Monthly", "Weekly", "Daily", "Automatic" ] }, "basedOn": { "readOnly": true, "type": "string", "enum": [ "Calendar", "RollingForward", "RollingBackward" ] }, "breakBehavior": { "readOnly": true, "type": "string", "enum": [ "AllowPartialPeriods", "PartialPeriodsWithBreakPoints", "FullPeriodsOnly" ] }, "cumulative": { "readOnly": true, "type": "boolean" }, "cumulativeBasedOn": { "readOnly": true, "type": "string", "enum": [ "ForwardFromStartDate", "BackwardFromEndDate" ] }, "context": { "readOnly": true, "type": "string", "enum": [ "Self", "Parent" ] } }, "xml": { "name": "IReturnStyle" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.BankingAccountDto": { "properties": { "acctCode": { "type": "string" }, "nameOnAccount": { "type": "string" }, "accountType": { "type": "string" }, "bankName": { "type": "string" }, "bankAccountType": { "type": "string" }, "bankAccountLastFour": { "type": "string" }, "advMvMny": { "type": "string" }, "transferType": { "type": "string" } }, "xml": { "name": "BankingAccountDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RmdDto": { "properties": { "acctCode": { "type": "string" }, "registrationName": { "type": "string" }, "registrationType": { "type": "string" }, "priorEoyValue": { "type": "number", "format": "double" }, "endOfPreviousYearAccountValueIsCalculated": { "type": "boolean" }, "ytdDistribution": { "type": "number", "format": "double" }, "rmdAmount": { "type": "number", "format": "double" }, "rmdRemaining": { "type": "number", "format": "double" } }, "xml": { "name": "RmdDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.BeneficiaryAccountDto": { "properties": { "accountNumber": { "type": "string" }, "registrationName": { "type": "string" }, "registrationType": { "type": "string" }, "beneficiaryDetailDtos": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BeneficiaryDetailDto" }, "xml": { "name": "BeneficiaryDetailDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "BeneficiaryAccountDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.BeneficiaryDetailDto": { "properties": { "beneficiaryType": { "type": "string" }, "beneficiaryName": { "type": "string" }, "relationship": { "type": "string" }, "percent": { "type": "number", "format": "double" } }, "xml": { "name": "BeneficiaryDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SystematicAccountDto": { "properties": { "accountNumber": { "type": "string" }, "registrationName": { "type": "string" }, "registrationType": { "type": "string" }, "systematicFrequency": { "type": "string", "enum": [ "Monthly", "Quarterly", "Semiannually", "Annually" ] }, "systematicType": { "type": "string", "enum": [ "None", "Withdrawal", "Rmd", "Purchase", "Dca" ] }, "amount": { "type": "number", "format": "double" }, "nextDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "SystematicAccountDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.TaxLotExportDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "aquiredDate": { "type": "string" }, "isCash": { "type": "boolean" }, "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "symbol": { "type": "string" }, "totalCost": { "type": "number", "format": "double" }, "units": { "type": "number", "format": "double" }, "costBasisPerUnit": { "type": "number", "format": "double" }, "cusip": { "type": "string" } }, "xml": { "name": "TaxLotExportDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RmdDashboardBaseDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "representativeId": { "type": "integer", "format": "int32" }, "representativeName": { "type": "string" }, "clientId": { "type": "integer", "format": "int32" }, "clientName": { "type": "string" }, "registrationId": { "type": "integer", "format": "int32" }, "registrationLastName": { "type": "string" }, "registrationName": { "type": "string" }, "registrationSsn": { "type": "string" }, "registrationDeceasedSsn": { "type": "string" }, "accountType": { "type": "string" }, "number": { "type": "string" }, "rmdAmount": { "type": "number", "format": "double" }, "rmdOriginalAmount": { "type": "number", "format": "double" }, "endOfPreviousYearAccountValue": { "type": "number", "format": "double" }, "calculatedEndOfPreviousYearAccountValue": { "type": "number", "format": "double" }, "endOfPreviousYearAccountValueIsCalculated": { "type": "boolean" }, "investorAge": { "type": "number", "format": "double" }, "investorAgeText": { "readOnly": true, "type": "string" }, "dateOfBirth": { "type": "string" }, "dateOfDeath": { "type": "string", "format": "date-time" }, "distributionAmountYtd": { "type": "number", "format": "double" }, "rmdRemaining": { "readOnly": true, "type": "number", "format": "double" }, "rmdRemainingGroup": { "readOnly": true, "type": "number", "format": "double" }, "rmdRemainingGroupApplied": { "readOnly": true, "type": "number", "format": "double" }, "isActive": { "type": "boolean" }, "rmdSatisfiedOverview": { "readOnly": true, "type": "string" }, "rmdRuleApplied": { "readOnly": true, "type": "string" }, "rmdSatisfied": { "type": "boolean" }, "manualRmdSatisfied": { "type": "boolean" }, "primaryBeneficiaryName": { "type": "string" }, "primaryBeneficiaryAge": { "type": "number", "format": "double" }, "primaryBeneficiaryAgeText": { "readOnly": true, "type": "string" }, "primaryBeneficiaryRelation": { "type": "string" }, "irsTable": { "type": "string" }, "factor": { "type": "number", "format": "double" }, "spouseIsPrimaryBeneAndMoreThan10YrsDiff": { "readOnly": true, "type": "boolean" }, "sweepCash": { "type": "number", "format": "double" }, "accountNotes": { "type": "string" }, "custodialCash": { "type": "number", "format": "double" }, "rmdNotes": { "type": "string" }, "custodianName": { "type": "string" }, "clientAddressLine1": { "type": "string" }, "clientAddressLine2": { "type": "string" }, "clientAddressLine3": { "type": "string" }, "clientCity": { "type": "string" }, "clientState": { "type": "string" }, "clientZip": { "type": "string" }, "regRmdSatisfied": { "type": "boolean" }, "outsideId": { "type": "string" }, "additionalColumns": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Interface.AdditionalColumnDefinition" }, "readOnly": true, "xml": { "name": "AdditionalColumnDefinition", "wrapped": true }, "type": "array" } }, "xml": { "name": "RmdDashboardBaseDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RmdDashboardFullDto": { "properties": { "yearOverrides": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RmdDashboardYearOverridesDto" }, "xml": { "name": "RmdDashboardYearOverridesDto", "wrapped": true }, "type": "array" }, "accountId": { "type": "integer", "format": "int32" }, "representativeId": { "type": "integer", "format": "int32" }, "representativeName": { "type": "string" }, "clientId": { "type": "integer", "format": "int32" }, "clientName": { "type": "string" }, "registrationId": { "type": "integer", "format": "int32" }, "registrationLastName": { "type": "string" }, "registrationName": { "type": "string" }, "registrationSsn": { "type": "string" }, "registrationDeceasedSsn": { "type": "string" }, "accountType": { "type": "string" }, "number": { "type": "string" }, "rmdAmount": { "type": "number", "format": "double" }, "rmdOriginalAmount": { "type": "number", "format": "double" }, "endOfPreviousYearAccountValue": { "type": "number", "format": "double" }, "calculatedEndOfPreviousYearAccountValue": { "type": "number", "format": "double" }, "endOfPreviousYearAccountValueIsCalculated": { "type": "boolean" }, "investorAge": { "type": "number", "format": "double" }, "investorAgeText": { "readOnly": true, "type": "string" }, "dateOfBirth": { "type": "string" }, "dateOfDeath": { "type": "string", "format": "date-time" }, "distributionAmountYtd": { "type": "number", "format": "double" }, "rmdRemaining": { "readOnly": true, "type": "number", "format": "double" }, "rmdRemainingGroup": { "readOnly": true, "type": "number", "format": "double" }, "rmdRemainingGroupApplied": { "readOnly": true, "type": "number", "format": "double" }, "isActive": { "type": "boolean" }, "rmdSatisfiedOverview": { "readOnly": true, "type": "string" }, "rmdRuleApplied": { "readOnly": true, "type": "string" }, "rmdSatisfied": { "type": "boolean" }, "manualRmdSatisfied": { "type": "boolean" }, "primaryBeneficiaryName": { "type": "string" }, "primaryBeneficiaryAge": { "type": "number", "format": "double" }, "primaryBeneficiaryAgeText": { "readOnly": true, "type": "string" }, "primaryBeneficiaryRelation": { "type": "string" }, "irsTable": { "type": "string" }, "factor": { "type": "number", "format": "double" }, "spouseIsPrimaryBeneAndMoreThan10YrsDiff": { "readOnly": true, "type": "boolean" }, "sweepCash": { "type": "number", "format": "double" }, "accountNotes": { "type": "string" }, "custodialCash": { "type": "number", "format": "double" }, "rmdNotes": { "type": "string" }, "custodianName": { "type": "string" }, "clientAddressLine1": { "type": "string" }, "clientAddressLine2": { "type": "string" }, "clientAddressLine3": { "type": "string" }, "clientCity": { "type": "string" }, "clientState": { "type": "string" }, "clientZip": { "type": "string" }, "regRmdSatisfied": { "type": "boolean" }, "outsideId": { "type": "string" }, "additionalColumns": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Interface.AdditionalColumnDefinition" }, "readOnly": true, "xml": { "name": "AdditionalColumnDefinition", "wrapped": true }, "type": "array" } }, "xml": { "name": "RmdDashboardFullDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RmdDashboardYearOverridesDto": { "properties": { "year": { "type": "integer", "format": "int32" }, "value": { "type": "number", "format": "double" }, "isSatisfied": { "type": "boolean" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "overrideRmdAmount": { "type": "number", "format": "double" } }, "xml": { "name": "RmdDashboardYearOverridesDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RmdMailMergeFileImportDto": { "properties": { "fileId": { "type": "integer", "format": "int32" }, "accountIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, "xml": { "name": "RmdMailMergeFileImportDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RmdSystematicReclacDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "systematicAccountId": { "type": "integer", "format": "int32" }, "systematicAmount": { "type": "number", "format": "double" }, "errorMessage": { "type": "string" }, "isError": { "type": "boolean" } }, "xml": { "name": "RmdSystematicReclacDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AccountVerboseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "number": { "type": "string" }, "isDataSharingEntity": { "type": "boolean" }, "isAstroEnabled": { "type": "boolean" }, "billing": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountBillingDto" }, "portfolio": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountPortfolioDto" }, "modelingInfo": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountModelingInfoDto" }, "notes": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.NoteDto" }, "xml": { "name": "NoteDto", "wrapped": true }, "type": "array" }, "documents": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DocumentDto" }, "xml": { "name": "DocumentDto", "wrapped": true }, "type": "array" }, "compliance": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ComplianceDto" }, "systematics": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SystematicDto" }, "xml": { "name": "SystematicDto", "wrapped": true }, "type": "array" }, "accountManagers": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountManagerDto" }, "xml": { "name": "AccountManagerDto", "wrapped": true }, "type": "array" }, "recurringAdjustments": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BillRecurrentAdjustmentDto" }, "xml": { "name": "BillRecurrentAdjustmentDto", "wrapped": true }, "type": "array" }, "generalAccounts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.GeneralAccountDto" }, "xml": { "name": "GeneralAccountDto", "wrapped": true }, "type": "array" }, "referralSchedules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.AccountReferralDto" }, "xml": { "name": "AccountReferralDto", "wrapped": true }, "type": "array" }, "billAccountSchedules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BillAccountScheduleDto" }, "xml": { "name": "BillAccountScheduleDto", "wrapped": true }, "type": "array" }, "userDefinedFields": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" }, "targetAllocations": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TargetAllocationDto" }, "xml": { "name": "TargetAllocationDto", "wrapped": true }, "type": "array" }, "productEquivalents": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductEquivalentDto" }, "xml": { "name": "ProductEquivalentDto", "wrapped": true }, "type": "array" }, "sma": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountSmaDto" }, "bondTrade": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.AccountBondTradeDto" }, "compositeExclusions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.CompositeAccountExcludeDto" }, "xml": { "name": "CompositeAccountExcludeDto", "wrapped": true }, "type": "array" }, "futureCashflows": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountFutureCashflowDto" }, "xml": { "name": "AccountFutureCashflowDto", "wrapped": true }, "type": "array" }, "growthRates": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountGrowthRateDto" }, "xml": { "name": "AccountGrowthRateDto", "wrapped": true }, "type": "array" }, "goals": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountGoalDto" }, "xml": { "name": "AccountGoalDto", "wrapped": true }, "type": "array" }, "suitability": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountSuitabilityDto" }, "permissibleAggregateModels": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.SimpleAggregateModel" }, "xml": { "name": "SimpleAggregateModel", "wrapped": true }, "type": "array" }, "astroTaxSchedules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.AstroAccountTaxSchedulesDto" }, "xml": { "name": "AstroAccountTaxSchedulesDto", "wrapped": true }, "type": "array" }, "astroAccount": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.AstroAccountDto" }, "taxRates": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountTaxRateDto" }, "xml": { "name": "AccountTaxRateDto", "wrapped": true }, "type": "array" }, "additionalClients": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientAdditionalAccountDto" }, "xml": { "name": "ClientAdditionalAccountDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "AccountVerboseDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.NewPortfolioAccountDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "accountStatusIcon": { "readOnly": true, "type": "string" }, "accountStatus": { "type": "string" }, "isActive": { "type": "boolean" }, "name": { "type": "string" }, "accountType": { "type": "string" }, "fundFamily": { "type": "string" }, "accountNumber": { "type": "string" }, "currentValue": { "type": "number", "format": "double" }, "managementStyle": { "type": "string" }, "modelName": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "missingInformation": { "readOnly": true, "type": "string" }, "custodian": { "type": "string" }, "statusState": { "type": "string", "enum": [ "Complete", "Pending", "Rejected", "SentToCustodian" ] }, "accountStartDate": { "type": "string", "format": "date-time" }, "accountStartValue": { "type": "number", "format": "double" }, "isManaged": { "type": "boolean" }, "isSweepAccount": { "type": "boolean" }, "importKey": { "type": "string" }, "outsideId": { "type": "string" }, "managementStyleId": { "type": "integer", "format": "int32" }, "fundFamilyId": { "type": "integer", "format": "int32" }, "accountHistoryId": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "shareClass": { "type": "string" }, "shareClassId": { "type": "integer", "format": "int32" }, "subAdvisor": { "type": "string" }, "subAdvisorId": { "type": "integer", "format": "int32" }, "provider": { "type": "string" }, "plan": { "type": "integer", "format": "int32" }, "linkedAccount": { "type": "integer", "format": "int32" }, "modelGroupNumber": { "type": "string" }, "isOriginalSMCAccount": { "type": "boolean" }, "isTradingBlocked": { "type": "boolean" }, "tradingInstructions": { "type": "string" }, "downloadSource": { "type": "integer", "format": "int32" }, "businessLine": { "type": "integer", "format": "int32" }, "homePhone": { "type": "string" }, "mobilePhone": { "type": "string" }, "businessPhone": { "type": "string" }, "createdBy": { "type": "string" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "accountStatusId": { "type": "integer", "format": "int32" }, "feeScheduleId": { "type": "integer", "format": "int32" }, "masterPayoutScheduleId": { "type": "integer", "format": "int32" }, "payMethod": { "type": "string" }, "masterPayoutSchedule": { "type": "string" }, "feeSchedule": { "type": "string" }, "billFrequency": { "type": "string", "enum": [ "Undefined", "Monthly", "Quarterly", "Triannual", "Semiannually", "Annually", "AtMaturity" ] }, "cycleMonth": { "type": "integer", "format": "int32" }, "valuationMethod": { "type": "string", "enum": [ "PeriodEndingValue", "AvgDailyBalance", "AvgMonthlyBalance" ] }, "billStartDate": { "type": "string", "format": "date-time" }, "acceptsList": { "type": "boolean" }, "addressLine1": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "birthDate": { "type": "string" }, "email": { "type": "string" }, "ssn": { "type": "string" }, "representativeName": { "type": "string" }, "riskBudget": { "type": "integer", "format": "int32" }, "lastName": { "type": "string" }, "wholesaler": { "type": "string" }, "isSleeveAccount": { "type": "boolean" }, "custodialRepCode": { "type": "string" }, "signatureStatus": { "type": "string" }, "quikIntegration": { "$ref": "#/definitions/OAS.DataModel.Integrations.QuikIntegration" }, "additionalColumns": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Interface.AdditionalColumnDefinition" }, "xml": { "name": "AdditionalColumnDefinition", "wrapped": true }, "type": "array" } }, "xml": { "name": "NewPortfolioAccountDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.NewAccountDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "client": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientVerboseDto" }, "registration": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationVerboseDto" }, "account": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountVerboseDto" } }, "xml": { "name": "NewAccountDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ClientVerboseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "globalId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "isDataSharingEntity": { "type": "boolean" }, "billing": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientBillingDto" }, "recurringAdjustments": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BillRecurrentAdjustmentDto" }, "xml": { "name": "BillRecurrentAdjustmentDto", "wrapped": true }, "type": "array" }, "feePayingAccounts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BillFeePayingAccountDto" }, "xml": { "name": "BillFeePayingAccountDto", "wrapped": true }, "type": "array" }, "tieredFeeAccounts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.TieredFeeAccountDto" }, "xml": { "name": "TieredFeeAccountDto", "wrapped": true }, "type": "array" }, "householdBills": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.HouseholdBillDto" }, "xml": { "name": "HouseholdBillDto", "wrapped": true }, "type": "array" }, "financialPlanningFee": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillFinancialPlanningFeeDto" }, "portfolio": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientPortfolioDto" }, "householdMembers": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.HouseholdMemberDto" }, "xml": { "name": "HouseholdMemberDto", "wrapped": true }, "type": "array" }, "notes": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.NoteDto" }, "xml": { "name": "NoteDto", "wrapped": true }, "type": "array" }, "documents": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DocumentDto" }, "xml": { "name": "DocumentDto", "wrapped": true }, "type": "array" }, "additionalAccounts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AdditionalAccountDto" }, "xml": { "name": "AdditionalAccountDto", "wrapped": true }, "type": "array" }, "suitability": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientSuitabilityDto" }, "userDefinedFields": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" }, "targetAllocations": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TargetAllocationDto" }, "xml": { "name": "TargetAllocationDto", "wrapped": true }, "type": "array" }, "creditCard": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientCreditCardSimpleDto" }, "assetExclusions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientAssetExclusionDto" }, "xml": { "name": "ClientAssetExclusionDto", "wrapped": true }, "type": "array" }, "portfolioGroups": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientPortfolioGroupDto" }, "xml": { "name": "ClientPortfolioGroupDto", "wrapped": true }, "type": "array" }, "appLinks": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientAppLinkDto" }, "xml": { "name": "ClientAppLinkDto", "wrapped": true }, "type": "array" }, "additionalRepresentatives": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AdditionalRepresentativeDto" }, "xml": { "name": "AdditionalRepresentativeDto", "wrapped": true }, "type": "array" }, "clientRepAdditional": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientRepAdditionalDto" } }, "xml": { "name": "ClientVerboseDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RegistrationVerboseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "globalId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "portfolio": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationPortfolioDto" }, "contact": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationContactDto" }, "notes": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.NoteDto" }, "xml": { "name": "NoteDto", "wrapped": true }, "type": "array" }, "feePayingAccounts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BillFeePayingAccountDto" }, "xml": { "name": "BillFeePayingAccountDto", "wrapped": true }, "type": "array" }, "beneficiaries": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationBeneficiaryDto" }, "xml": { "name": "RegistrationBeneficiaryDto", "wrapped": true }, "type": "array" }, "custodianBeneficiary": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationCustodianBeneficiaryDto" }, "xml": { "name": "RegistrationCustodianBeneficiaryDto", "wrapped": true }, "type": "array" }, "accounts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountDto" }, "xml": { "name": "AccountDto", "wrapped": true }, "type": "array" }, "decedent": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationDecedentDto" }, "suitability": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationSuitabilityDto" }, "userDefinedFields": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" }, "additionalRepresentatives": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AdditionalRepresentativeDto" }, "xml": { "name": "AdditionalRepresentativeDto", "wrapped": true }, "type": "array" }, "additionalRepresentativesPercent": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AdditionalRepresentativePercentDto" }, "xml": { "name": "AdditionalRepresentativePercentDto", "wrapped": true }, "type": "array" }, "registrationRepAdditionals": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationRepAdditionalDto" }, "xml": { "name": "RegistrationRepAdditionalDto", "wrapped": true }, "type": "array" }, "targetAllocations": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TargetAllocationDto" }, "xml": { "name": "TargetAllocationDto", "wrapped": true }, "type": "array" }, "isDataSharingEntity": { "type": "boolean" } }, "xml": { "name": "RegistrationVerboseDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RegistrationPortfolioDto": { "properties": { "name": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "prefix": { "type": "string" }, "suffix": { "type": "string" }, "typeCode": { "type": "string" }, "isBIRA": { "type": "boolean" }, "accountType": { "type": "string" }, "isActive": { "type": "boolean" }, "clientId": { "type": "integer", "format": "int32" }, "typeId": { "type": "integer", "format": "int32" }, "company": { "type": "string" }, "isUsResident": { "type": "boolean" }, "jobTitle": { "type": "string" }, "ssN_TaxID": { "type": "string" }, "deceasedSSN_TaxID": { "type": "string" }, "dob": { "type": "string", "format": "date-time" }, "gender": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "dateOfDeath": { "type": "string", "format": "date-time" }, "targetSpendRate": { "type": "number", "format": "double" }, "targetDollarAmount": { "type": "number", "format": "double" }, "targetDate": { "type": "string", "format": "date-time" }, "isEligibleDesignatedBeneficiary": { "type": "boolean" }, "isEDBTenYearOverride": { "type": "boolean" }, "isNonPersonBeneficiary": { "type": "boolean" }, "isSoleBeneficiary": { "type": "boolean" }, "isNonInitialInheritorBira": { "type": "boolean" }, "initialOwnerDateOfDeath": { "type": "string", "format": "date-time" } }, "xml": { "name": "RegistrationPortfolioDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RegistrationContactDto": { "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "address3": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "homePhone": { "type": "string" }, "homePhoneExt": { "type": "string" }, "fax": { "type": "string" }, "faxExt": { "type": "string" }, "pager": { "type": "string" }, "pagerExt": { "type": "string" }, "mobilePhone": { "type": "string" }, "businessPhone": { "type": "string" }, "businessPhoneExt": { "type": "string" }, "otherPhone": { "type": "string" }, "otherPhoneExt": { "type": "string" }, "workPhone": { "type": "string" }, "workPhoneExt": { "type": "string" }, "email": { "type": "string" }, "webAddress": { "type": "string" } }, "xml": { "name": "RegistrationContactDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RegistrationBeneficiaryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "dob": { "type": "string", "format": "date-time" }, "type": { "type": "string" }, "relation": { "type": "string" }, "relationDisplay": { "type": "string" }, "percentage": { "type": "number", "format": "double" }, "address": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "ssn": { "type": "string" }, "reason": { "type": "string" }, "perStirpes": { "type": "boolean" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "RegistrationBeneficiaryDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RegistrationCustodianBeneficiaryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "accountHolderId": { "type": "string" }, "accountHolderType": { "type": "string" }, "role": { "type": "string" }, "isPrimaryContact": { "type": "boolean" }, "beneficiaryRelationship": { "type": "string" }, "beneficiaryAssetPercentage": { "type": "integer", "format": "int32" }, "title": { "type": "string" }, "firstName": { "type": "string" }, "middleName": { "type": "string" }, "lastName": { "type": "string" }, "suffix": { "type": "string" }, "nickName": { "type": "string" }, "organizationName": { "type": "string" }, "dateOfBirth": { "type": "string", "format": "date-time" }, "formattedTaxpayerId": { "type": "string" }, "taxpayerIdType": { "type": "string" }, "emailAddress": { "type": "string" }, "homePhone": { "type": "string" }, "mobilePhone": { "type": "string" }, "businessPhone": { "type": "string" }, "employmentStatus": { "type": "string" }, "employerName": { "type": "string" }, "citizenship1": { "type": "string" }, "citizenship2": { "type": "string" }, "fkCustodianCommon": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "RegistrationCustodianBeneficiaryDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RegistrationDecedentDto": { "properties": { "name": { "type": "string" }, "dateOfBirth": { "type": "string", "format": "date-time" }, "relationToBeneficiary": { "type": "string" } }, "xml": { "name": "RegistrationDecedentDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RegistrationSuitabilityDto": { "properties": { "netWorthIncludingResidence": { "type": "number", "format": "double" }, "netWorthExcludingResidence": { "type": "number", "format": "double" }, "liquidNetWorth": { "type": "number", "format": "double" }, "investmentKnowledge": { "type": "string" }, "riskExposure": { "type": "string" }, "investmentExperience": { "type": "string" }, "returnObjective": { "type": "string" }, "investmentObjective": { "type": "string" }, "timeHorizon": { "type": "string" }, "stockPercent": { "type": "string" }, "riskTolerance": { "type": "integer", "format": "int32" }, "netWorth": { "type": "number", "format": "double" }, "netIncome": { "type": "number", "format": "double" }, "riskBudget": { "type": "integer", "format": "int32" }, "isLifestyleOption": { "type": "boolean" }, "reviewCompleted": { "type": "boolean" }, "reviewCompletedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "RegistrationSuitabilityDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AdditionalRepresentativePercentDto": { "properties": { "repId": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "repTitleId": { "type": "integer", "format": "int32" }, "repTitle": { "type": "string" }, "percentage": { "type": "number", "format": "double" }, "simpleRep": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "AdditionalRepresentativePercentDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RegistrationRepAdditionalDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "clientRepAdditionalId": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "representativeId": { "type": "integer", "format": "int32" }, "payoutRate": { "type": "number", "format": "double" }, "notes": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" }, "representative": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleRepresentative" }, "clientRepAdditional": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientRepAdditionalDto" } }, "xml": { "name": "RegistrationRepAdditionalDto" }, "type": "object" }, "OAS.WebApi.DTO.Simple.ListCountDto": { "description": "Count result for list endpoints that support OData $filter (e.g. GET /api/v1/Portfolio/Clients/Count).", "properties": { "count": { "description": "Number of entities matching URI filters and optional OData $filter.", "type": "integer", "format": "int32" }, "oDataFilter": { "description": "OData $filter from the request query string (URL-decoded), or null if none.\r\nCallers should send PascalCase EDM property names; MCP normalizes before proxying where applicable.", "type": "string" } }, "xml": { "name": "ListCountDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.AccountDoNotTradeAndSmaDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "modelingInfo": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountModelingInfoSimpleDto" }, "sma": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountSmaDto" } }, "xml": { "name": "AccountDoNotTradeAndSmaDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AccountModelingInfoSimpleDto": { "properties": { "isTradingBlocked": { "type": "boolean" } }, "xml": { "name": "AccountModelingInfoSimpleDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.AccountDoNotTradeDto": { "properties": { "id": { "description": "Id for Account", "type": "integer", "format": "int32" }, "modelingInfo": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountModelingInfoSimpleDto", "description": "Simple object for passing isTradeBlocked" } }, "xml": { "name": "AccountDoNotTradeDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RegistrationCustomIndexDto": { "properties": { "registrationId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "isSleeved": { "type": "boolean" }, "accounts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountCustomIndexInfoDto" }, "xml": { "name": "AccountCustomIndexInfoDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "RegistrationCustomIndexDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AccountCustomIndexInfoDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "accountValue": { "type": "number", "format": "double" }, "modelAggName": { "type": "string" }, "isSleeved": { "type": "boolean" }, "isTaxLotAccount": { "type": "boolean" } }, "xml": { "name": "AccountCustomIndexInfoDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AccountForConvertAccountDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "fundName": { "type": "string" }, "acctCode": { "type": "string" } }, "xml": { "name": "AccountForConvertAccountDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ConvertAccountDto": { "properties": { "fromAccountId": { "type": "integer", "format": "int32" }, "copyAssets": { "type": "boolean" }, "copyTrans": { "type": "boolean" }, "copyBillingInst": { "type": "boolean" }, "copySwp": { "type": "boolean" }, "convertDate": { "type": "string", "format": "date-time" }, "overwriteAcctNum": { "type": "integer", "format": "int32" }, "newAcctCode": { "type": "string" }, "oldAcctActive": { "type": "boolean" }, "toAccountId": { "type": "integer", "format": "int32" }, "mgmtStyleId": { "type": "integer", "format": "int32" }, "subAdvisorId": { "type": "integer", "format": "int32" }, "feeSchedId": { "type": "integer", "format": "int32" }, "paySchedId": { "type": "integer", "format": "int32" }, "shareClassId": { "type": "integer", "format": "int32" }, "fundFamilyId": { "type": "integer", "format": "int32" }, "modelId": { "type": "integer", "format": "int32" }, "planId": { "type": "integer", "format": "int32" }, "groupNum": { "type": "string" } }, "xml": { "name": "ConvertAccountDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.UndoCancelDto": { "properties": { "result": { "type": "string" } }, "xml": { "name": "UndoCancelDto" }, "type": "object" }, "OAS.DataModel.Portfolio.AccountMerge": { "properties": { "oldAccountId": { "type": "integer", "format": "int32" }, "newAccountId": { "type": "integer", "format": "int32" } }, "xml": { "name": "AccountMerge" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SimpleAccountStatusDto": { "properties": { "description": { "type": "string" }, "isVisible": { "type": "boolean" }, "includeInBusinessMetrics": { "type": "boolean" }, "isDownloading": { "type": "boolean" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "SimpleAccountStatusDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AssetLevelStrategyDto": { "properties": { "color": { "type": "string" }, "sortOrder": { "type": "integer", "format": "int32" }, "assignmentDefinitions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetLevelStrategyAssignmentDefinition" }, "xml": { "name": "AssetLevelStrategyAssignmentDefinition", "wrapped": true }, "type": "array" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "AssetLevelStrategyDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AssetLevelStrategyAssignmentDefinition": { "properties": { "assetClassId": { "type": "integer", "format": "int32" }, "assetClass": { "type": "string" }, "managementStyleId": { "type": "integer", "format": "int32" }, "managementStyle": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "AssetLevelStrategyAssignmentDefinition" }, "type": "object" }, "OAS.WebApi.DTO.Trading.RealtimePriceDto": { "properties": { "date": { "type": "string", "format": "date-time" }, "last": { "type": "number", "format": "double" }, "isRealTimeQuote": { "type": "boolean" }, "isDelayedQuote": { "type": "boolean" }, "changeFromLastClose": { "type": "number", "format": "double" }, "changeFromLastMarketClose": { "type": "number", "format": "double" }, "changeFromMarketClose": { "type": "number", "format": "double" }, "changeFromMarketOpen": { "type": "number", "format": "double" }, "changeFromPrev": { "type": "number", "format": "double" }, "lastClosePrice": { "type": "number", "format": "double" }, "lastMarketClosePrice": { "type": "number", "format": "double" }, "marketClosePrice": { "type": "number", "format": "double" }, "marketOpenPrice": { "type": "number", "format": "double" }, "percentChangeFromLastClose": { "type": "number", "format": "double" }, "percentChangeFromLastMarketClose": { "type": "number", "format": "double" }, "percentChangeFromMarketClose": { "type": "number", "format": "double" }, "percentChangeFromMarketOpen": { "type": "number", "format": "double" }, "percentChangeFromOpen": { "type": "number", "format": "double" }, "percentChangeFromPrev": { "type": "number", "format": "double" }, "ask": { "type": "number", "format": "double" }, "askQuantity": { "type": "number", "format": "double" }, "bid": { "type": "number", "format": "double" }, "bidQuantity": { "type": "number", "format": "double" }, "changeFromOpen": { "type": "number", "format": "double" }, "changeFromPrevious": { "type": "number", "format": "double" }, "cusip": { "type": "string" }, "delay": { "type": "number", "format": "double" }, "high": { "type": "number", "format": "double" }, "low": { "type": "number", "format": "double" }, "name": { "type": "string" }, "outcome": { "type": "string" }, "percentageChangeFromOpen": { "type": "number", "format": "double" }, "percentageChangeFromPrevious": { "type": "number", "format": "double" }, "quantity": { "type": "number", "format": "double" }, "volume": { "type": "number", "format": "double" }, "open": { "type": "number", "format": "double" }, "priceSource": { "type": "string" }, "symbol": { "type": "string" } }, "xml": { "name": "RealtimePriceDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.BuyOptionSharesDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "currentShares": { "type": "number", "format": "double" }, "currentContracts": { "type": "integer", "format": "int32" }, "possibleContracts": { "type": "integer", "format": "int32" } }, "xml": { "name": "BuyOptionSharesDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.SellOptionSharesDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "currentShares": { "type": "number", "format": "double" }, "currentValue": { "type": "number", "format": "double" }, "currentPrice": { "type": "number", "format": "double" }, "strikePrice": { "type": "number", "format": "double" }, "currentContracts": { "type": "integer", "format": "int32" }, "possibleContracts": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "expirationDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "SellOptionSharesDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AssetVerboseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "isDataSharingEntity": { "type": "boolean" }, "portfolio": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetPortfolioDto" }, "billing": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetBillingDto" }, "stepUps": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.StepUpDto" }, "xml": { "name": "StepUpDto", "wrapped": true }, "type": "array" }, "bifurcates": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BifurcateDto" }, "xml": { "name": "BifurcateDto", "wrapped": true }, "type": "array" }, "costBasisHistories": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasisHistoryDto" }, "xml": { "name": "CostBasisHistoryDto", "wrapped": true }, "type": "array" }, "costBasisLots": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.UnrealizedAssetCostDto" }, "xml": { "name": "UnrealizedAssetCostDto", "wrapped": true }, "type": "array" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" }, "userDefinedFields": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" }, "userDefinedTimeFields": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionTimeDto" }, "xml": { "name": "EntityOptionTimeDto", "wrapped": true }, "type": "array" }, "assetValuations": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.AssetValuationDto" }, "xml": { "name": "AssetValuationDto", "wrapped": true }, "type": "array" }, "commitments": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.CommitmentLedgerDto" }, "xml": { "name": "CommitmentLedgerDto", "wrapped": true }, "type": "array" }, "alternativeSchedules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Confirm.Alternative.AlternativeScheduleDto" }, "xml": { "name": "AlternativeScheduleDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "AssetVerboseDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AssetCopyHistoricalDataDto": { "properties": { "assetIdToEdit": { "type": "integer", "format": "int32" }, "assetIdToCopy": { "type": "integer", "format": "int32" }, "percentage": { "type": "number", "format": "double" } }, "xml": { "name": "AssetCopyHistoricalDataDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AssetBaseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "isDataSharingEntity": { "type": "boolean" } }, "xml": { "name": "AssetBaseDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AssetAlternativeDto": { "properties": { "value": { "type": "number", "format": "double" }, "accountNumber": { "type": "string" }, "ticker": { "type": "string" }, "currentShares": { "type": "number", "format": "double" }, "currentPrice": { "type": "number", "format": "double" }, "isManaged": { "type": "boolean" }, "assetClass": { "type": "string" }, "productCategory": { "type": "string" }, "productCategoryAbbreviation": { "type": "string" }, "isCustodialCash": { "type": "boolean" }, "secondaryAccountNumber": { "type": "string" }, "cusip": { "type": "string" }, "assetLevelStrategyId": { "type": "integer", "format": "int32" }, "assetLevelStrategy": { "type": "string" }, "status": { "type": "integer", "format": "int32" }, "isStrategyOverride": { "type": "boolean" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "registrationId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "downloadSymbol": { "type": "integer", "format": "int32" }, "accountType": { "type": "string" }, "fundFamily": { "type": "string" }, "custodian": { "type": "string" }, "asOfDate": { "type": "string", "format": "date-time" }, "managementStyle": { "type": "string" }, "productType": { "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, "productSubType": { "type": "string" }, "isGlobalExcluded": { "type": "boolean" }, "isFeeExcluded": { "type": "boolean" }, "excludeAmountType": { "type": "string", "enum": [ "Percent", "Dollars", "Shares" ] }, "excludeAmount": { "type": "number", "format": "double" }, "excludePercentOf": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "excludeFromMargin": { "type": "boolean" }, "isRebalance": { "type": "boolean" }, "isAdvisorOnly": { "type": "boolean" }, "isAdvReportable": { "type": "boolean" }, "is13FReportable": { "type": "boolean" }, "mscsFundAccountNumber": { "type": "string" }, "lastReconDate": { "type": "string", "format": "date-time" }, "isOrionVision": { "type": "boolean" }, "assetPercentOfAccount": { "type": "number", "format": "double" }, "name": { "type": "string" }, "registrationName": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "currentValue": { "type": "number", "format": "double" }, "valuation": { "type": "number", "format": "double" }, "committedCapital": { "type": "number", "format": "double" }, "committedCapitalDate": { "type": "string", "format": "date-time" }, "contributedCapital": { "type": "number", "format": "double" }, "distribution": { "type": "number", "format": "double" }, "unfundedCommitmentAdjustment": { "type": "number", "format": "double" }, "unfundedCommitmentAmount": { "type": "number", "format": "double" }, "costBasis": { "type": "number", "format": "double" }, "productId": { "type": "integer", "format": "int32" }, "recallableDistribution": { "type": "number", "format": "double" }, "distributionCapitalGains": { "type": "number", "format": "double" }, "distributionReturnOfCapital": { "type": "number", "format": "double" }, "distributionInvestmentIncome": { "type": "number", "format": "double" }, "distributionNonInvestmentIncome": { "type": "number", "format": "double" }, "upcomingCapitalCallDate": { "type": "string", "format": "date-time" }, "upcomingCapitalCallAmount": { "type": "number", "format": "double" }, "upcomingCapitalCallType": { "type": "string", "enum": [ "Dollars", "Percent" ] }, "upcomingDistributionDate": { "type": "string", "format": "date-time" }, "upcomingDistributionAmount": { "type": "number", "format": "double" }, "upcomingDistributionType": { "type": "string", "enum": [ "Dollars", "Percent" ] }, "managerName": { "type": "string" }, "lastValuationDate": { "type": "string", "format": "date-time" }, "accountSweepAssetProductName": { "type": "string" }, "accountSweepAssetValueAsOf": { "type": "number", "format": "double" }, "repId": { "type": "integer", "format": "int32" }, "repName": { "type": "string" }, "lastValuationIsEstimate": { "type": "boolean" }, "id": { "type": "integer", "format": "int32" }, "isDataSharingEntity": { "type": "boolean" } }, "xml": { "name": "AssetAlternativeDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SimpleAsset2WithValueDto": { "properties": { "shares": { "type": "number", "format": "double" }, "price": { "type": "number", "format": "double" }, "value": { "type": "number", "format": "double" }, "productId": { "type": "integer", "format": "int32" }, "ticker": { "type": "string" }, "assetClass": { "type": "string" }, "isCustodialCash": { "type": "boolean" }, "accountId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "id": { "type": "integer", "format": "int32" } }, "xml": { "name": "SimpleAsset2WithValueDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AssetPriceDto": { "properties": { "productId": { "type": "integer", "format": "int32" }, "requestedPriceDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "priceSourceName": { "type": "string" }, "priceDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "navPrice": { "type": "number", "format": "double" }, "cachedPrice": { "type": "number", "format": "double" }, "adjustedPrice": { "type": "number", "format": "double" } }, "xml": { "name": "AssetPriceDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SimpleAssetDto": { "properties": { "assetClass": { "type": "string" }, "accountNumber": { "type": "string" }, "ticker": { "type": "string" }, "isCustodialCash": { "type": "boolean" }, "isTradeExcluded": { "type": "boolean" }, "name": { "type": "string" }, "id": { "type": "integer", "format": "int32" } }, "xml": { "name": "SimpleAssetDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SimpleBenchmarkDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "key": { "readOnly": true, "type": "string" }, "name": { "type": "string" }, "dynamicBenchmarkType": { "type": "string", "enum": [ "None", "AssetClass", "AssetCategory", "ManagementStyle", "AggregateModel", "RiskCategory" ] } }, "xml": { "name": "SimpleBenchmarkDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.BondRatingDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "code": { "type": "string" }, "ratingNumber": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "source": { "type": "string" } }, "xml": { "name": "BondRatingDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.BrokerDealerVerboseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "portfolio": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BrokerDealerPortfolioDto" }, "notes": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.NoteDto" }, "xml": { "name": "NoteDto", "wrapped": true }, "type": "array" }, "documents": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DocumentDto" }, "xml": { "name": "DocumentDto", "wrapped": true }, "type": "array" }, "additionalContacts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BrokerDealerAdditionalContactDto" }, "xml": { "name": "BrokerDealerAdditionalContactDto", "wrapped": true }, "type": "array" }, "brokerDealerRevenueShares": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BrokerDealerRevenueShareDto" }, "xml": { "name": "BrokerDealerRevenueShareDto", "wrapped": true }, "type": "array" }, "brokerDealerRevenueShareAccountTypeExclusions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BrokerDealerRevenueShareAccountTypeExclusionDto" }, "xml": { "name": "BrokerDealerRevenueShareAccountTypeExclusionDto", "wrapped": true }, "type": "array" }, "brokerDealerRevenueShareRepresentativeExclusions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BrokerDealerRevenueShareRepresentativeExclusionDto" }, "xml": { "name": "BrokerDealerRevenueShareRepresentativeExclusionDto", "wrapped": true }, "type": "array" }, "brokerDealerRevenueShareBusinessLineExclusions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BrokerDealerRevenueShareBusinessLineExclusionDto" }, "xml": { "name": "BrokerDealerRevenueShareBusinessLineExclusionDto", "wrapped": true }, "type": "array" }, "reportImage": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BrokerDealerReportImageDto" }, "userDefinedFields": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "BrokerDealerVerboseDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.BrokerDealerPortfolioDto": { "properties": { "actgLedgerNum": { "type": "string" }, "advOneAgreeDate": { "type": "string", "format": "date-time" }, "advOneRestrictions": { "type": "string" }, "advYear": { "type": "integer", "format": "int32" }, "agentID": { "type": "string" }, "agreeDate": { "type": "string", "format": "date-time" }, "agreeRestrictions": { "type": "string" }, "albridgeID": { "type": "integer", "format": "int32" }, "bdRepRestrict": { "type": "string" }, "bdStatus": { "type": "string", "enum": [ "NoIssues", "Limited", "Pending", "Prospect", "Rejected", "Inactive" ] }, "billPayoutScheduleId": { "type": "integer", "format": "int32" }, "clsSendAdvTo": { "type": "string" }, "registrationName": { "type": "string" }, "crdNumber": { "type": "string" }, "clearingFirm": { "type": "string", "enum": [ "SelfClearing", "Pershing", "NationalFinancial", "Unknown", "TDAmeritrade", "Schwab", "TrustCompanyOfAmerica", "Foliofn", "Fidelity", "RBCCapitalMarkets", "SouthwestSecuritiesInc" ] }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "dazlid": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "frequency": { "type": "integer", "format": "int32" }, "howIsAdvRegistered": { "type": "string", "enum": [ "Unknown", "SECRegistered", "StateRegistered", "Unregistered", "Other" ] }, "id": { "type": "integer", "format": "int32" }, "impDate": { "type": "string", "format": "date-time" }, "importKey": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "isActive": { "type": "boolean" }, "isAdvOnFile": { "type": "boolean" }, "isAdvOneAgree": { "type": "boolean" }, "isMktingMaterialSent": { "type": "boolean" }, "isProductionReported": { "type": "boolean" }, "isSendingQuestionaire": { "type": "boolean" }, "marketingNotes": { "type": "string" }, "mktMaterialEmail": { "type": "string" }, "mktMaterialFax": { "type": "string" }, "mktMaterialSendTo": { "type": "string" }, "natConference": { "type": "string" }, "oldBDCode": { "type": "string" }, "oldBD_ID": { "type": "integer", "format": "int32" }, "overideCode": { "type": "string" }, "overidePerc": { "type": "number", "format": "double" }, "payeeId": { "type": "integer", "format": "int32" }, "city": { "type": "string" }, "state": { "type": "string" }, "email": { "type": "string" }, "salutation": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "address3": { "type": "string" }, "zip": { "type": "string" }, "homePhone": { "type": "string" }, "homePhoneExt": { "type": "string" }, "fax": { "type": "string" }, "faxExt": { "type": "string" }, "pager": { "type": "string" }, "pagerExt": { "type": "string" }, "mobilePhone": { "type": "string" }, "businessPhone": { "type": "string" }, "businessPhoneExt": { "type": "string" }, "otherPhone": { "type": "string" }, "otherPhoneExt": { "type": "string" }, "reportName": { "type": "string" }, "company": { "type": "string" }, "jobTitle": { "type": "string" }, "ssN_TaxID": { "type": "string" }, "gender": { "type": "string" }, "webAddress": { "type": "string" }, "name": { "type": "string" }, "lName": { "type": "string" }, "riaId": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "isValueEditLockedDown": { "type": "boolean" } }, "xml": { "name": "BrokerDealerPortfolioDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.BrokerDealerAdditionalContactDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "salutation": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "name": { "readOnly": true, "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "address3": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "homePhone": { "type": "string" }, "homePhoneExt": { "type": "string" }, "fax": { "type": "string" }, "faxExt": { "type": "string" }, "pager": { "type": "string" }, "pagerExt": { "type": "string" }, "mobilePhone": { "type": "string" }, "businessPhone": { "type": "string" }, "businessPhoneExt": { "type": "string" }, "otherPhone": { "type": "string" }, "otherPhoneExt": { "type": "string" }, "email": { "type": "string" }, "ssN_TaxID": { "type": "string" }, "gender": { "type": "string" }, "dob": { "type": "string", "format": "date-time" }, "webAddress": { "type": "string" }, "entityType": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "parentId": { "type": "integer", "format": "int32" } }, "xml": { "name": "BrokerDealerAdditionalContactDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.BrokerDealerRevenueShareDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "brokerDealerId": { "type": "integer", "format": "int32" }, "billScheduleId": { "type": "integer", "format": "int32" }, "payoutRate": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "BrokerDealerRevenueShareDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.BrokerDealerRevenueShareAccountTypeExclusionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "brokerDealerId": { "type": "integer", "format": "int32" }, "accountTypeId": { "type": "integer", "format": "int32" }, "accountType": { "type": "string" } }, "xml": { "name": "BrokerDealerRevenueShareAccountTypeExclusionDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.BrokerDealerRevenueShareRepresentativeExclusionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "brokerDealerId": { "type": "integer", "format": "int32" }, "repId": { "type": "integer", "format": "int32" }, "repName": { "type": "string" } }, "xml": { "name": "BrokerDealerRevenueShareRepresentativeExclusionDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.BrokerDealerRevenueShareBusinessLineExclusionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "brokerDealerId": { "type": "integer", "format": "int32" }, "businessLineId": { "type": "integer", "format": "int32" }, "businessLine": { "type": "string" } }, "xml": { "name": "BrokerDealerRevenueShareBusinessLineExclusionDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.BrokerDealerReportImageDto": { "properties": { "brokerDealerId": { "type": "integer", "format": "int32" }, "image": { "type": "string", "format": "byte" }, "height": { "type": "number", "format": "double" }, "width": { "type": "number", "format": "double" }, "barColor": { "type": "string", "maxLength": 50, "minLength": 0 } }, "xml": { "name": "BrokerDealerReportImageDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.BrokerDealerDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "isActive": { "type": "boolean" }, "status": { "type": "string", "enum": [ "NoIssues", "Limited", "Pending", "Prospect", "Rejected", "Inactive" ] }, "crdNumber": { "type": "string" }, "clearingFirm": { "type": "string", "enum": [ "SelfClearing", "Pershing", "NationalFinancial", "Unknown", "TDAmeritrade", "Schwab", "TrustCompanyOfAmerica", "Foliofn", "Fidelity", "RBCCapitalMarkets", "SouthwestSecuritiesInc" ] }, "ledgerNumber": { "type": "string" }, "albridgeId": { "type": "integer", "format": "int32" }, "value": { "type": "number", "format": "double" }, "dazlId": { "type": "string" }, "agreementDate": { "type": "string", "format": "date-time" }, "agreementRestriction": { "type": "string" }, "advisorOneDate": { "type": "string", "format": "date-time" }, "advisorOneAgree": { "type": "boolean" }, "advisorOneRestriction": { "type": "string" }, "restriction": { "type": "string" }, "repCount": { "type": "integer", "format": "int32" }, "agentId": { "type": "string" }, "bdCode": { "type": "string" }, "advOnFile": { "type": "boolean" }, "advYear": { "type": "integer", "format": "int32" }, "clsSendAdvTo": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "frequency": { "type": "integer", "format": "int32" }, "howAdvRegistered": { "type": "string", "enum": [ "Unknown", "SECRegistered", "StateRegistered", "Unregistered", "Other" ] }, "marketingNotes": { "type": "string" }, "mktgMaterialEmail": { "type": "string" }, "mktgMaterialFax": { "type": "string" }, "mktgMaterialSendTo": { "type": "string" }, "nationalConference": { "type": "string" }, "overrideCode": { "type": "string" }, "overridePercent": { "type": "number", "format": "double" }, "productReported": { "type": "boolean" }, "regionalConference": { "type": "string" }, "repListReceiveDate": { "type": "string", "format": "date-time" }, "reportsEmail": { "type": "string" }, "reportsFax": { "type": "string" }, "reportsSendTo": { "type": "string" }, "sendingQuestionare": { "type": "boolean" }, "transmissionFormat": { "type": "integer", "format": "int32" }, "transmissionMethod": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "globalId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "BrokerDealerDto" }, "type": "object" }, "OAS.WebApi.DTO.Simple.SimpleValueDto": { "properties": { "value": { "type": "number", "format": "double" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "SimpleValueDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.BrokerDealerFileDto": { "properties": { "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" }, "openWith": { "type": "string" }, "blobDesc": { "type": "string" }, "category": { "type": "string" }, "blobType": { "type": "string", "enum": [ "CrmDocuments", "Payable" ] } }, "xml": { "name": "BrokerDealerFileDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.BusinessLineDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "employeeCount": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "company": { "type": "string" }, "webAddress": { "type": "string" }, "jobTitle": { "type": "string" }, "email": { "type": "string" }, "salutation": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "address3": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "homePhone": { "type": "string" }, "homePhoneExt": { "type": "string" }, "fax": { "type": "string" }, "faxExt": { "type": "string" }, "pager": { "type": "string" }, "pagerExt": { "type": "string" }, "mobilePhone": { "type": "string" }, "businessPhone": { "type": "string" }, "businessPhoneExt": { "type": "string" }, "otherPhone": { "type": "string" }, "otherPhoneExt": { "type": "string" }, "ssN_TaxID": { "type": "string" }, "gender": { "type": "string" }, "dob": { "type": "string", "format": "date-time" } }, "xml": { "name": "BusinessLineDto" }, "type": "object" }, "OAS.DataModel.Portfolio.SimpleClientCategory": { "properties": { "abbreviation": { "type": "string" }, "isDefault": { "type": "boolean" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "SimpleClientCategory" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ClientChangeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "changes": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientChangeSetDto" }, "xml": { "name": "ClientChangeSetDto", "wrapped": true }, "type": "array" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedBy": { "type": "string" } }, "xml": { "name": "ClientChangeDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ClientChangeSetDto": { "properties": { "entityType": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Rep", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Beneficiary", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QPEDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "Banking", "RMD", "Systematic", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "AdditionalRep", "DownloadSource", "DownloadRecord", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "oldEntityId": { "type": "integer", "format": "int32" }, "newEntityId": { "type": "integer", "format": "int32" }, "oldEntityName": { "type": "string" }, "newEntityName": { "type": "string" }, "oldRepTitleId": { "type": "integer", "format": "int32" }, "newRepTitleId": { "type": "integer", "format": "int32" }, "oldRepTitleName": { "type": "string" }, "newRepTitleName": { "type": "string" }, "oldEntityNumber": { "type": "string" }, "newEntityNumber": { "type": "string" }, "actionType": { "type": "string", "enum": [ "None", "Inserted", "Updated", "Deleted" ] }, "isDeleted": { "type": "boolean" }, "isPartOfSet": { "type": "boolean" }, "isUncommitted": { "type": "boolean" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "ClientChangeSetDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ClientBlobBaseDto": { "properties": { "isViewable": { "type": "boolean" }, "isViewableAdvisor": { "type": "boolean" }, "isViewableRepresentative": { "type": "boolean" }, "folder": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "id": { "type": "integer", "format": "int32" }, "openWith": { "type": "string" }, "fileName": { "type": "string" }, "blobDesc": { "type": "string" }, "blobText": { "type": "string" }, "category": { "type": "string" }, "isZip": { "type": "boolean" } }, "xml": { "name": "ClientBlobBaseDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.AppLinkDetailForClientDto": { "properties": { "clientId": { "type": "integer", "format": "int32" }, "integrationInfo": { "type": "string" } }, "xml": { "name": "AppLinkDetailForClientDto" }, "type": "object" }, "JsonPatch.JsonPatchDocumentOfOAS.WebApi.DTO.Portfolio.ClientVerboseDto": { "properties": { "operations": { "items": { "$ref": "#/definitions/JsonPatch.JsonPatchOperation" }, "readOnly": true, "xml": { "name": "JsonPatchOperation", "wrapped": true }, "type": "array" }, "hasOperations": { "readOnly": true, "type": "boolean" } }, "xml": { "name": "JsonPatchDocument`1" }, "type": "object" }, "JsonPatch.JsonPatchOperation": { "properties": { "operation": { "type": "string", "enum": [ "add", "remove", "replace", "move" ] }, "fromPath": { "type": "string" }, "parsedFromPath": { "items": { "$ref": "#/definitions/JsonPatch.Paths.Components.PathComponent" }, "xml": { "name": "PathComponent", "wrapped": true }, "type": "array" }, "path": { "type": "string" }, "parsedPath": { "items": { "$ref": "#/definitions/JsonPatch.Paths.Components.PathComponent" }, "xml": { "name": "PathComponent", "wrapped": true }, "type": "array" }, "value": { "type": "object" } }, "xml": { "name": "JsonPatchOperation" }, "type": "object" }, "JsonPatch.Paths.Components.PathComponent": { "properties": { "name": { "type": "string" }, "componentType": { "type": "string" }, "isCollection": { "readOnly": true, "type": "boolean" } }, "xml": { "name": "PathComponent" }, "type": "object" }, "OAS.WebApi.Code.Projection.ProjectionManipulatorOfOAS.WebApi.DTO.Portfolio.ClientDto": { "properties": { "type": { "readOnly": true, "type": "string" }, "hasImpact": { "readOnly": true, "type": "boolean" }, "top": { "readOnly": true, "type": "integer", "format": "int32" }, "skip": { "readOnly": true, "type": "integer", "format": "int32" }, "requestedProperties": { "description": "The properties the user specifically asked for", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" }, "requiredProperties": { "description": "The properties that are required to fulfill the requested properties", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProjectionManipulator`1" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ClientBaseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "isDataSharingEntity": { "type": "boolean" } }, "xml": { "name": "ClientBaseDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ClientDto": { "properties": { "aum": { "type": "number", "format": "double" }, "isActive": { "type": "boolean" }, "representativeName": { "type": "string" }, "representativeNumber": { "type": "string" }, "representativeId": { "type": "integer", "format": "int32" }, "brokerDealerName": { "type": "string" }, "categoryId": { "type": "integer", "format": "int32" }, "statementDeliveryMethodId": { "type": "integer", "format": "int32" }, "category": { "type": "string" }, "statementDeliveryMethod": { "type": "string" }, "videoStatementDeliveryMethod": { "type": "string", "enum": [ "Unassigned", "NoVideoStatement", "WebsiteOnly", "Email" ] }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "startDate": { "type": "string", "format": "date-time" }, "importKey": { "type": "string" }, "lastStatementSent": { "type": "string", "format": "date-time" }, "lastStatementSentTo": { "type": "string" }, "additionalAccounts": { "type": "integer", "format": "int32" }, "cashBalance": { "type": "number", "format": "double" }, "missingInformation": { "readOnly": true, "type": "string" }, "lastName": { "type": "string" }, "firstName": { "type": "string" }, "homePhone": { "type": "string" }, "email": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "salutation": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "address3": { "type": "string" }, "zip": { "type": "string" }, "fax": { "type": "string" }, "faxExt": { "type": "string" }, "pager": { "type": "string" }, "pagerExt": { "type": "string" }, "mobilePhone": { "type": "string" }, "businessPhone": { "type": "string" }, "businessPhoneExt": { "type": "string" }, "otherPhone": { "type": "string" }, "otherPhoneExt": { "type": "string" }, "reportName": { "type": "string" }, "company": { "type": "string" }, "jobTitle": { "type": "string" }, "ssN_TaxID": { "type": "string" }, "personalId": { "type": "integer", "format": "int32" }, "gender": { "type": "string" }, "probabilityOfSuccess": { "type": "number", "format": "double" }, "additionalColumns": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Interface.AdditionalColumnDefinition" }, "xml": { "name": "AdditionalColumnDefinition", "wrapped": true }, "type": "array" }, "dob": { "type": "string", "format": "date-time" }, "webAddress": { "type": "string" }, "homePhoneExt": { "type": "string" }, "country": { "type": "string" }, "riskScore": { "type": "number", "format": "double" }, "ccNum": { "type": "string" }, "ccType": { "type": "string" }, "ccToken": { "type": "string" }, "ccIsValid": { "type": "boolean" }, "currentRiskScore": { "type": "integer", "format": "int32" }, "targetRiskScore": { "type": "integer", "format": "int32" }, "portfolioRiskScore": { "type": "integer", "format": "int32" }, "riskScoreAsOfDate": { "type": "string", "format": "date-time" }, "riskScoreProvider": { "description": "The source of {OAS.WebApi.DTO.Portfolio.ClientDto.TargetRiskScore}, {OAS.WebApi.DTO.Portfolio.ClientDto.CurrentRiskScore}, {OAS.WebApi.DTO.Portfolio.ClientDto.RiskScoreAsOfDate}, and {OAS.WebApi.DTO.Portfolio.ClientDto.PortfolioRiskScore}", "type": "string" }, "advClientCategoryId": { "type": "integer", "format": "int32" }, "advClientCategory": { "type": "string" }, "isRTQLocked": { "type": "boolean" }, "globalId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "isDataSharingEntity": { "type": "boolean" } }, "xml": { "name": "ClientDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SimpleRegistrationsWithSimpleAccountsDto": { "properties": { "accounts": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleAccount" }, "xml": { "name": "SimpleAccount", "wrapped": true }, "type": "array" }, "isActive": { "type": "boolean" }, "clientId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "SimpleRegistrationsWithSimpleAccountsDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ClientPortfolioTreeDto": { "properties": { "inceptionDate": { "type": "string", "format": "date-time" }, "value": { "type": "number", "format": "double" }, "registrations": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationPortfolioTreeDto" }, "xml": { "name": "RegistrationPortfolioTreeDto", "wrapped": true }, "type": "array" }, "portfolioGroupsForTreeView": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PortfolioGroupForPortfolioTreeDto" }, "xml": { "name": "PortfolioGroupForPortfolioTreeDto", "wrapped": true }, "type": "array" }, "representative": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleRepresentative" }, "portfolioGroups": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PortfolioGroupPortfolioTreeDto" }, "xml": { "name": "PortfolioGroupPortfolioTreeDto", "wrapped": true }, "type": "array" }, "message": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "entityName": { "type": "string" }, "isActive": { "type": "boolean" }, "repCode": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "ClientPortfolioTreeDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RegistrationPortfolioTreeDto": { "properties": { "inceptionDate": { "type": "string", "format": "date-time" }, "value": { "type": "number", "format": "double" }, "accounts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountPortfolioTreeDto" }, "xml": { "name": "AccountPortfolioTreeDto", "wrapped": true }, "type": "array" }, "isActive": { "type": "boolean" }, "clientId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "RegistrationPortfolioTreeDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.PortfolioGroupForPortfolioTreeDto": { "properties": { "registrations": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationPortfolioTreeDto" }, "xml": { "name": "RegistrationPortfolioTreeDto", "wrapped": true }, "type": "array" }, "inceptionDate": { "type": "string", "format": "date-time" }, "value": { "type": "number", "format": "double" }, "clientId": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "PortfolioGroupForPortfolioTreeDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.PortfolioGroupPortfolioTreeDto": { "properties": { "inceptionDate": { "type": "string", "format": "date-time" }, "value": { "type": "number", "format": "double" }, "clientId": { "type": "integer", "format": "int32" }, "accounts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountPortfolioTreeDto" }, "xml": { "name": "AccountPortfolioTreeDto", "wrapped": true }, "type": "array" }, "isActive": { "type": "boolean" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "PortfolioGroupPortfolioTreeDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AccountPortfolioTreeDto": { "properties": { "inceptionDate": { "type": "string", "format": "date-time" }, "value": { "type": "number", "format": "double" }, "registrationId": { "type": "integer", "format": "int32" }, "lastPositionDate": { "type": "string", "format": "date-time" }, "inBalance": { "type": "boolean" }, "lastReconciledEffectiveDate": { "type": "string", "format": "date-time" }, "number": { "type": "string" }, "managementStyle": { "type": "string" }, "isActive": { "type": "boolean" }, "clientId": { "type": "integer", "format": "int32" }, "custodian": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "AccountPortfolioTreeDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.CancelAccountsActionDto": { "properties": { "clientId": { "type": "integer", "format": "int32" }, "cancelType": { "type": "string", "enum": [ "Full", "Partial" ] }, "accountIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "asOfDate": { "type": "string", "format": "date-time" }, "journalSubject": { "type": "string" }, "journalNote": { "type": "string" }, "zeroAssets": { "type": "boolean" }, "excludeDownloads": { "type": "boolean" }, "createFinalBill": { "type": "boolean" } }, "xml": { "name": "CancelAccountsActionDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ClientUnderlyingCountsDto": { "properties": { "registrations": { "type": "integer", "format": "int32" }, "accounts": { "type": "integer", "format": "int32" }, "assets": { "type": "integer", "format": "int32" }, "transactions": { "type": "integer", "format": "int32" } }, "xml": { "name": "ClientUnderlyingCountsDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RmdDashboardDto": { "properties": { "accountStatusIcon": { "readOnly": true, "type": "string" }, "accountStatus": { "readOnly": true, "type": "string" }, "registrationStatusIcon": { "readOnly": true, "type": "string" }, "registrationStatus": { "readOnly": true, "type": "string" }, "isAutoRmd": { "readOnly": true, "type": "boolean" }, "notes": { "readOnly": true, "type": "string" }, "amounts": { "readOnly": true, "type": "number", "format": "double" }, "annualizedAmounts": { "readOnly": true, "type": "number", "format": "double" }, "frequency": { "readOnly": true, "type": "string" }, "taxWitheld": { "readOnly": true, "type": "string" }, "stateTaxWitheld": { "readOnly": true, "type": "string" }, "recalc": { "readOnly": true, "type": "boolean" }, "banksOfRecord": { "readOnly": true, "type": "string" }, "bankAccountNumbers": { "readOnly": true, "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "representativeId": { "type": "integer", "format": "int32" }, "representativeName": { "type": "string" }, "clientId": { "type": "integer", "format": "int32" }, "clientName": { "type": "string" }, "registrationId": { "type": "integer", "format": "int32" }, "registrationLastName": { "type": "string" }, "registrationName": { "type": "string" }, "registrationSsn": { "type": "string" }, "registrationDeceasedSsn": { "type": "string" }, "accountType": { "type": "string" }, "number": { "type": "string" }, "rmdAmount": { "type": "number", "format": "double" }, "rmdOriginalAmount": { "type": "number", "format": "double" }, "endOfPreviousYearAccountValue": { "type": "number", "format": "double" }, "calculatedEndOfPreviousYearAccountValue": { "type": "number", "format": "double" }, "endOfPreviousYearAccountValueIsCalculated": { "type": "boolean" }, "investorAge": { "type": "number", "format": "double" }, "investorAgeText": { "readOnly": true, "type": "string" }, "dateOfBirth": { "type": "string" }, "dateOfDeath": { "type": "string", "format": "date-time" }, "distributionAmountYtd": { "type": "number", "format": "double" }, "rmdRemaining": { "readOnly": true, "type": "number", "format": "double" }, "rmdRemainingGroup": { "readOnly": true, "type": "number", "format": "double" }, "rmdRemainingGroupApplied": { "readOnly": true, "type": "number", "format": "double" }, "isActive": { "type": "boolean" }, "rmdSatisfiedOverview": { "readOnly": true, "type": "string" }, "rmdRuleApplied": { "readOnly": true, "type": "string" }, "rmdSatisfied": { "type": "boolean" }, "manualRmdSatisfied": { "type": "boolean" }, "primaryBeneficiaryName": { "type": "string" }, "primaryBeneficiaryAge": { "type": "number", "format": "double" }, "primaryBeneficiaryAgeText": { "readOnly": true, "type": "string" }, "primaryBeneficiaryRelation": { "type": "string" }, "irsTable": { "type": "string" }, "factor": { "type": "number", "format": "double" }, "spouseIsPrimaryBeneAndMoreThan10YrsDiff": { "readOnly": true, "type": "boolean" }, "sweepCash": { "type": "number", "format": "double" }, "accountNotes": { "type": "string" }, "custodialCash": { "type": "number", "format": "double" }, "rmdNotes": { "type": "string" }, "custodianName": { "type": "string" }, "clientAddressLine1": { "type": "string" }, "clientAddressLine2": { "type": "string" }, "clientAddressLine3": { "type": "string" }, "clientCity": { "type": "string" }, "clientState": { "type": "string" }, "clientZip": { "type": "string" }, "regRmdSatisfied": { "type": "boolean" }, "outsideId": { "type": "string" }, "additionalColumns": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Interface.AdditionalColumnDefinition" }, "readOnly": true, "xml": { "name": "AdditionalColumnDefinition", "wrapped": true }, "type": "array" } }, "xml": { "name": "RmdDashboardDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.SimpleBillDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "calcDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "SimpleBillDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ClientFileDto": { "properties": { "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" }, "openWith": { "type": "string" }, "blobDesc": { "type": "string" }, "category": { "type": "string" }, "blobType": { "type": "string", "enum": [ "RPT_1099", "QuarterlyStatements", "YearEndStatements", "CrmDocuments", "CustodialStatements", "Form_5498", "FeeLetters", "QualifiedTradeConfirms", "InsightPresentations", "PortfolioViewDashboards" ] } }, "xml": { "name": "ClientFileDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.BlendedModelManagementClientDto": { "properties": { "aum": { "type": "number", "format": "double" }, "hasRiskScore": { "readOnly": true, "type": "boolean" }, "modelRiskTarget": { "readOnly": true, "type": "boolean" }, "riskAlert": { "readOnly": true, "type": "boolean" }, "registrations": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlendedModelManagementRegistrationDetailsDto" }, "xml": { "name": "BlendedModelManagementRegistrationDetailsDto", "wrapped": true }, "type": "array" }, "aggregatedRiskScore": { "type": "number", "format": "double" }, "disableRiskAlerts": { "type": "boolean" }, "needsUpdate": { "readOnly": true, "type": "boolean" }, "needsUpdateRegIds": { "items": { "type": "integer", "format": "int32" }, "readOnly": true, "type": "array" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "isDataSharingEntity": { "type": "boolean" } }, "xml": { "name": "BlendedModelManagementClientDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.BlendedModelManagementRegistrationDetailsDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "regType": { "type": "string" }, "aum": { "readOnly": true, "type": "number", "format": "double" }, "strategyName": { "type": "string" }, "riskScore": { "type": "number", "format": "double" }, "isActive": { "type": "boolean" }, "riskAlert": { "readOnly": true, "type": "boolean" }, "lowerLimit": { "type": "number", "format": "double" }, "upperLimit": { "type": "number", "format": "double" }, "aggregatedRiskScore": { "type": "number", "format": "double" }, "accounts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BlendedModelManagementAccountDetailsDto" }, "xml": { "name": "BlendedModelManagementAccountDetailsDto", "wrapped": true }, "type": "array" }, "needsUpdate": { "type": "boolean" } }, "xml": { "name": "BlendedModelManagementRegistrationDetailsDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.BlendedModelManagementAccountDetailsDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "modelName": { "type": "string" }, "allocation": { "type": "number", "format": "double" }, "aum": { "type": "number", "format": "double" }, "mandate": { "type": "string" }, "modelRiskScore": { "type": "number", "format": "double" } }, "xml": { "name": "BlendedModelManagementAccountDetailsDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.PortfolioGroupDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "groupValue": { "type": "number", "format": "double" }, "clientName": { "type": "string" }, "clientId": { "type": "integer", "format": "int32" }, "portfolioType": { "type": "string", "enum": [ "Composite", "Reporting", "Trading" ] }, "isReporting": { "readOnly": true, "type": "boolean" }, "isTrading": { "readOnly": true, "type": "boolean" }, "isComposites": { "readOnly": true, "type": "boolean" }, "eclipsePortfolioId": { "type": "integer", "format": "int32" }, "representativeId": { "type": "integer", "format": "int32" }, "representativeName": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "effectiveDate": { "type": "string", "format": "date-time" }, "changes": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PortfolioGroupChangeSimpleDto" }, "xml": { "name": "PortfolioGroupChangeSimpleDto", "wrapped": true }, "type": "array" }, "userDefinedFields": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" }, "repId": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "modelAggId": { "type": "integer", "format": "int32" }, "platformId": { "type": "integer", "format": "int32" }, "planId": { "type": "integer", "format": "int32" }, "fundFamilyId": { "type": "integer", "format": "int32" }, "stockRange": { "type": "integer", "format": "int32" }, "riskTolerance": { "type": "integer", "format": "int32" }, "riskBudgetRange": { "type": "integer", "format": "int32" } }, "xml": { "name": "PortfolioGroupDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.PortfolioGroupChangeSimpleDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityName": { "type": "string" }, "effectiveDate": { "type": "string", "format": "date-time" }, "action": { "type": "string", "enum": [ "Add", "Update", "Delete" ] }, "monthsExclude": { "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" } }, "xml": { "name": "PortfolioGroupChangeSimpleDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.PortfolioGroupFullDto": { "properties": { "accounts": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "registrations": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "targetAllocations": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TargetAllocationDto" }, "xml": { "name": "TargetAllocationDto", "wrapped": true }, "type": "array" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "groupValue": { "type": "number", "format": "double" }, "clientName": { "type": "string" }, "clientId": { "type": "integer", "format": "int32" }, "portfolioType": { "type": "string", "enum": [ "Composite", "Reporting", "Trading" ] }, "isReporting": { "readOnly": true, "type": "boolean" }, "isTrading": { "readOnly": true, "type": "boolean" }, "isComposites": { "readOnly": true, "type": "boolean" }, "eclipsePortfolioId": { "type": "integer", "format": "int32" }, "representativeId": { "type": "integer", "format": "int32" }, "representativeName": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "effectiveDate": { "type": "string", "format": "date-time" }, "changes": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PortfolioGroupChangeSimpleDto" }, "xml": { "name": "PortfolioGroupChangeSimpleDto", "wrapped": true }, "type": "array" }, "userDefinedFields": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" }, "repId": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "modelAggId": { "type": "integer", "format": "int32" }, "platformId": { "type": "integer", "format": "int32" }, "planId": { "type": "integer", "format": "int32" }, "fundFamilyId": { "type": "integer", "format": "int32" }, "stockRange": { "type": "integer", "format": "int32" }, "riskTolerance": { "type": "integer", "format": "int32" }, "riskBudgetRange": { "type": "integer", "format": "int32" } }, "xml": { "name": "PortfolioGroupFullDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.BalanceSheet.ClientWithBalanceSheetsDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "assets": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BalanceSheet.BalanceSheetGroupDto" }, "liabilities": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BalanceSheet.BalanceSheetGroupDto" } }, "xml": { "name": "ClientWithBalanceSheetsDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.BalanceSheet.BalanceSheetGroupDto": { "properties": { "categories": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BalanceSheet.BalanceSheetCategoryDetailsDto" }, "xml": { "name": "BalanceSheetCategoryDetailsDto", "wrapped": true }, "type": "array" }, "value": { "readOnly": true, "type": "number", "format": "double" } }, "xml": { "name": "BalanceSheetGroupDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.BalanceSheet.BalanceSheetCategoryDetailsDto": { "properties": { "items": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BalanceSheet.BalanceSheetDto" }, "xml": { "name": "BalanceSheetDto", "wrapped": true }, "type": "array" }, "value": { "readOnly": true, "type": "number", "format": "double" }, "id": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "BalanceSheetCategoryDetailsDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.BalanceSheet.BalanceSheetDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "value": { "type": "number", "format": "double" }, "intuitId": { "type": "integer", "format": "int32" }, "intuitAccountId": { "type": "integer", "format": "int64" }, "byAllId": { "type": "integer", "format": "int64" }, "byAllAccountId": { "type": "integer", "format": "int64" }, "createdBy": { "type": "string" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "createdDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "BalanceSheetDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.PortfolioGroupChangeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "portfolioGroupId": { "type": "integer", "format": "int32" }, "portfolioGroupName": { "type": "string" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityName": { "type": "string" }, "effectiveDate": { "type": "string", "format": "date-time" }, "action": { "type": "string", "enum": [ "Add", "Update", "Delete" ] }, "monthsExclude": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "PortfolioGroupChangeDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.CorpActionNotificationDTO": { "properties": { "beginningOfDay": { "type": "boolean" }, "costBasisFactor": { "type": "number", "format": "double" }, "corporateActionId": { "type": "integer", "format": "int32" }, "corporateActionProcessingId": { "type": "integer", "format": "int32" }, "corporateActionStatus": { "type": "string" }, "corporateActionStatusId": { "type": "integer", "format": "int32" }, "corporateActionStatusDescription": { "type": "string" }, "effectiveDate": { "type": "string", "format": "date-time" }, "expectedClose": { "type": "string", "format": "date-time" }, "moreInfoURL": { "type": "string" }, "numberOfAccountHeld": { "type": "integer", "format": "int32" }, "price": { "type": "number", "format": "double" }, "processingType": { "type": "string" }, "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "ticker": { "type": "string" }, "roundingType": { "type": "string" } }, "xml": { "name": "CorpActionNotificationDTO" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.CorpActionNotificationAccountDTO": { "properties": { "productID": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "ticker": { "type": "string" }, "cusip": { "type": "string" }, "productType": { "type": "integer", "format": "int32" }, "accountID": { "type": "integer", "format": "int32" }, "assetID": { "type": "integer", "format": "int32" }, "acctCode": { "type": "string" }, "fundFamilyName": { "type": "string" }, "fundFamilyID": { "type": "integer", "format": "int32" }, "custodianName": { "type": "string" }, "preActionUnitBalance": { "type": "number", "format": "double" }, "currentUnitBalance": { "type": "number", "format": "double" }, "pendingCorpActionShares": { "type": "number", "format": "double" }, "corpActionStatus": { "type": "string" }, "assetStatus": { "type": "string" }, "houseHoldID": { "type": "integer", "format": "int32" }, "houseHoldName": { "type": "string" }, "registrationID": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "registrationType": { "type": "string" }, "repID": { "type": "integer", "format": "int32" }, "repName": { "type": "string" }, "currentValue": { "type": "number", "format": "double" }, "currentPrice": { "type": "number", "format": "double" }, "processingType": { "type": "string" }, "corpActionID": { "type": "integer", "format": "int32" }, "corpActionProcessingID": { "type": "integer", "format": "int32" } }, "xml": { "name": "CorpActionNotificationAccountDTO" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.CostBasis.OrionStoredCostBasisQueueDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "assetId": { "type": "integer", "format": "int32" }, "processingStatus": { "type": "string", "enum": [ "NotStarted", "Processing", "Skipped", "Failed", "Completed" ] }, "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "productType": { "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, "cusip": { "type": "string" }, "ticker": { "type": "string" }, "details": { "type": "string" }, "queueType": { "type": "string", "enum": [ "Standard", "Manual", "LongRunning" ] }, "orionLastUpdate": { "type": "string", "format": "date-time" }, "startedDate": { "type": "string", "format": "date-time" }, "completedDate": { "type": "string", "format": "date-time" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "clientId": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" } }, "xml": { "name": "OrionStoredCostBasisQueueDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.PorfolioCountsDto": { "properties": { "client": { "additionalProperties": { "type": "integer", "format": "int32" }, "type": "object" }, "registration": { "additionalProperties": { "type": "integer", "format": "int32" }, "type": "object" }, "account": { "additionalProperties": { "type": "integer", "format": "int32" }, "type": "object" } }, "xml": { "name": "PorfolioCountsDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.CostBasis.CustodianRealizedDto": { "properties": { "assetId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "acquiredDate": { "type": "string", "format": "date-time" }, "sellDate": { "type": "string", "format": "date-time" }, "holdPeriodDate": { "type": "string", "format": "date-time" }, "costAmt": { "type": "number", "format": "double" }, "amortizationAmt": { "type": "number", "format": "double" }, "noUnits": { "type": "number", "format": "double" }, "id": { "type": "integer", "format": "int32" }, "source": { "type": "integer", "format": "int32" }, "method": { "type": "string" }, "proceedAmt": { "type": "number", "format": "double" }, "washSaleImpacted": { "type": "boolean" }, "effectiveDate": { "type": "string", "format": "date-time" }, "custodianCommonCode": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "isLongTerm": { "type": "boolean" }, "isInherited": { "type": "boolean" }, "isWashSale": { "type": "boolean" }, "isUnknown": { "type": "boolean" }, "isVarious": { "type": "boolean" }, "clientId": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "productTicker": { "type": "string" }, "householdName": { "type": "string" }, "registrationType": { "type": "string" }, "isQualified": { "type": "boolean" }, "representative": { "type": "string" }, "representativeNumber": { "type": "string" }, "custodian": { "type": "string" }, "accountCreatedDate": { "type": "string", "format": "date-time" }, "costBasisMethod": { "type": "integer", "format": "int32" }, "custodianRecordId": { "type": "string" } }, "xml": { "name": "CustodianRealizedDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.CustodianVerboseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "portfolio": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CustodianPortfolioDto" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" }, "fixTradingSettings": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CustodianFixDto" }, "xml": { "name": "CustodianFixDto", "wrapped": true }, "type": "array" }, "algorithms": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CustodianAlgorithmDto" }, "xml": { "name": "CustodianAlgorithmDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "CustodianVerboseDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.CustodianPortfolioDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string" }, "code": { "type": "string" }, "sweepLevel": { "type": "string", "enum": [ "Invalid", "Registration", "Account" ] }, "isDirect": { "type": "boolean" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "custodialAccountNum": { "type": "string" }, "canSweepFeesToCustAcct": { "type": "boolean" }, "feeReqSrc": { "type": "string", "enum": [ "Invalid", "HighValueFund", "CashAccount", "ProRata" ] }, "isDefault": { "type": "boolean" }, "isCreateDistribution": { "type": "boolean" }, "custTaxID": { "type": "string" }, "masterAccountNumber": { "type": "string" }, "sweepProductClassId": { "type": "integer", "format": "int32" }, "isQpeTransExcluded": { "type": "boolean" }, "isUsingEquityBlockTrades": { "type": "boolean" }, "is2PartTrading": { "type": "boolean" }, "isUseB50Setup": { "type": "boolean" }, "canTransmitAfterHours": { "type": "boolean" }, "isSupermarket": { "type": "boolean" }, "isManual": { "type": "boolean" }, "allowManualOrderAllocate": { "type": "boolean" }, "manualOrderAllocationClOrdId": { "type": "string" }, "dtcNum": { "type": "string" }, "directTrading": { "type": "string", "enum": [ "None", "Tda" ] }, "communitiesDirectTrading": { "type": "string" }, "downloadsCostBasis": { "type": "boolean" }, "fixUploadTargetId": { "type": "integer", "format": "int32" }, "brokerCommission": { "type": "number", "format": "double" }, "aggregateSleeves": { "type": "boolean" }, "minCashBalance": { "type": "number", "format": "double" }, "replenishMinCash": { "type": "boolean" }, "shareTradeThreshold": { "type": "number", "format": "double" }, "email": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "salutation": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "address3": { "type": "string" }, "zip": { "type": "string" }, "fax": { "type": "string" }, "faxExt": { "type": "string" }, "mobilePhone": { "type": "string" }, "businessPhone": { "type": "string" }, "businessPhoneExt": { "type": "string" }, "otherPhone": { "type": "string" }, "otherPhoneExt": { "type": "string" }, "company": { "type": "string" }, "jobTitle": { "type": "string" }, "webAddress": { "type": "string" }, "custodianCommonIdList": { "type": "string" }, "custodianGlobalId": { "type": "integer", "format": "int32" }, "globalId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "CustodianPortfolioDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.CustodianFixDto": { "properties": { "custodianId": { "type": "integer", "format": "int32" }, "productType": { "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, "fixVersion": { "type": "string" }, "fixRouting": { "type": "string" }, "blockMethod": { "type": "string", "enum": [ "Default", "FixEft", "OneToOne" ] }, "fkTRInterface": { "type": "integer", "format": "int32" } }, "xml": { "name": "CustodianFixDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.CustodianAlgorithmDto": { "properties": { "custodianId": { "type": "integer", "format": "int32" }, "tag": { "type": "string" }, "algorithmCode": { "type": "string" } }, "xml": { "name": "CustodianAlgorithmDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.CustodianDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "code": { "type": "string" }, "sweepLevel": { "type": "string", "enum": [ "Invalid", "Registration", "Account" ] }, "isDirect": { "type": "boolean" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "custodialAccountNum": { "type": "string" }, "canSweepFeesToCustAcct": { "type": "boolean" }, "feeReqSrc": { "type": "string", "enum": [ "Invalid", "HighValueFund", "CashAccount", "ProRata" ] }, "isDefault": { "type": "boolean" }, "isCreateDistribution": { "type": "boolean" }, "custTaxID": { "type": "string" }, "masterAccountNumber": { "type": "string" }, "sweepProductClassId": { "type": "integer", "format": "int32" }, "isQpeTransExcluded": { "type": "boolean" }, "isUsingEquityBlockTrades": { "type": "boolean" }, "is2PartTrading": { "type": "boolean" }, "isUseB50Setup": { "type": "boolean" }, "canTransmitAfterHours": { "type": "boolean" }, "isSupermarket": { "type": "boolean" }, "isManual": { "type": "boolean" }, "allowManualOrderAllocate": { "type": "boolean" }, "manualOrderAllocationClOrdId": { "type": "string" }, "dtcNum": { "type": "string" }, "directTrading": { "type": "string", "enum": [ "None", "Tda" ] }, "communitiesDirectTrading": { "type": "string" }, "downloadsCostBasis": { "type": "boolean" }, "fixUploadTargetId": { "type": "integer", "format": "int32" }, "brokerCommission": { "type": "number", "format": "double" }, "aggregateSleeves": { "type": "boolean" }, "minCashBalance": { "type": "number", "format": "double" }, "replenishMinCash": { "type": "boolean" }, "shareTradeThreshold": { "type": "number", "format": "double" }, "custodianCommonIdList": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "entityName": { "type": "string" }, "email": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "salutation": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "address3": { "type": "string" }, "zip": { "type": "string" }, "fax": { "type": "string" }, "faxExt": { "type": "string" }, "mobilePhone": { "type": "string" }, "businessPhone": { "type": "string" }, "businessPhoneExt": { "type": "string" }, "otherPhone": { "type": "string" }, "otherPhoneExt": { "type": "string" }, "company": { "type": "string" }, "jobTitle": { "type": "string" }, "webAddress": { "type": "string" }, "custodianGlobalId": { "type": "integer", "format": "int32" }, "custodianFixTradeSettings": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CustodianFixDto" }, "xml": { "name": "CustodianFixDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "CustodianDto" }, "type": "object" }, "OAS.DataModel.Portfolio.SimpleCustodian": { "properties": { "trustType": { "type": "string", "enum": [ "None", "CTC", "EAS" ] }, "code": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "SimpleCustodian" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.CustodianCutOffError": { "properties": { "custodian": { "type": "string" }, "errorMessage": { "type": "string" } }, "xml": { "name": "CustodianCutOffError" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.CostBasis.CustodianUnrealizedVerboseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "portfolio": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.CustodianUnrealizedPortfolioDto" }, "additionalInformation": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasis.CustodianUnrealizedAdditionalInformationDto" } }, "xml": { "name": "CustodianUnrealizedVerboseDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.CostBasis.CustodianUnrealizedPortfolioDto": { "properties": { "assetId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "longTermCost": { "type": "number", "format": "double" }, "shortTermCost": { "type": "number", "format": "double" }, "longTermUnits": { "type": "number", "format": "double" }, "shortTermUnits": { "type": "number", "format": "double" }, "acquiredDate": { "type": "string", "format": "date-time" }, "amortizationAmt": { "type": "number", "format": "double" }, "holdPeriodDate": { "type": "string", "format": "date-time" }, "isLongTerm": { "type": "boolean" }, "isInherited": { "type": "boolean" }, "isUnknown": { "type": "boolean" }, "isVarious": { "type": "boolean" }, "source": { "type": "integer", "format": "int32" }, "custodianRecordID": { "type": "string" } }, "xml": { "name": "CustodianUnrealizedPortfolioDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.CostBasis.CustodianUnrealizedAdditionalInformationDto": { "properties": { "isLongTerm": { "type": "boolean" }, "inheritedDate": { "type": "string", "format": "date-time" }, "giftedDate": { "type": "string", "format": "date-time" }, "auditedBy": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "CustodianUnrealizedAdditionalInformationDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.CostBasis.CustodianUnrealizedDto": { "properties": { "assetId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "asOfDate": { "type": "string", "format": "date-time" }, "longTermCost": { "type": "number", "format": "double" }, "shortTermCost": { "type": "number", "format": "double" }, "source": { "type": "integer", "format": "int32" }, "longTermUnits": { "type": "number", "format": "double" }, "shortTermUnits": { "type": "number", "format": "double" }, "acquiredDate": { "type": "string", "format": "date-time" }, "amortizationAmt": { "type": "number", "format": "double" }, "id": { "type": "integer", "format": "int32" }, "holdPeriodDate": { "type": "string", "format": "date-time" }, "isLongTerm": { "type": "boolean" }, "isInherited": { "type": "boolean" }, "isUnknown": { "type": "boolean" }, "isVarious": { "type": "boolean" }, "clientId": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "productTicker": { "type": "string" }, "householdName": { "type": "string" }, "registrationType": { "type": "string" }, "isQualified": { "type": "boolean" }, "representative": { "type": "string" }, "representativeNumber": { "type": "string" }, "custodian": { "type": "string" }, "accountCreatedDate": { "type": "string", "format": "date-time" }, "custodianRecordID": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "costBasisMethod": { "type": "integer", "format": "int32" } }, "xml": { "name": "CustodianUnrealizedDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.NewHouseholdFileDto": { "required": [ "entity" ], "properties": { "entity": { "readOnly": true, "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" }, "openWith": { "type": "string" }, "blobDesc": { "type": "string" }, "category": { "type": "string" }, "blobType": { "type": "string", "enum": [ "CrmDocuments" ] } }, "xml": { "name": "NewHouseholdFileDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.FundFamilyWithErrorsDto": { "properties": { "status": { "type": "string" }, "errorMessage": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "isActive": { "type": "boolean" }, "isAnnuity": { "type": "boolean" }, "unitScale": { "type": "integer", "format": "int32" }, "priceScale": { "type": "integer", "format": "int32" }, "isShareClassSensitive": { "type": "boolean" }, "isAcctNumUnique": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "isCreateDistribution": { "type": "boolean" }, "sungardBrokerId": { "type": "integer", "format": "int32" }, "custComplexes": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CustComplexDto" }, "xml": { "name": "CustComplexDto", "wrapped": true }, "type": "array" }, "custodianTradeFileFormats": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CustodianTradeFileFormatDto" }, "xml": { "name": "CustodianTradeFileFormatDto", "wrapped": true }, "type": "array" }, "userDefinedFields": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.FundFamilyEntityOptionDto" }, "xml": { "name": "FundFamilyEntityOptionDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "FundFamilyWithErrorsDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.TradeFormatDto": { "properties": { "tradeFormatId": { "type": "integer", "format": "int32" }, "formatDisplayName": { "type": "string" }, "typeData": { "type": "string" }, "type": { "type": "string" } }, "xml": { "name": "TradeFormatDto" }, "type": "object" }, "OAS.WebApi.Domains.Portfolio.Gender": { "properties": { "abbreviation": { "type": "string" }, "name": { "type": "string" } }, "xml": { "name": "Gender" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.GoalDto": { "required": [ "name", "value", "startDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "value": { "type": "number", "format": "double" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "timeFrame": { "type": "string", "enum": [ "Monthly", "Quarterly", "Annually" ] } }, "xml": { "name": "GoalDto" }, "type": "object" }, "OAS.DataModel.Portfolio.GoalType": { "properties": { "id": { "readOnly": true, "type": "integer", "format": "int32" }, "goalName": { "type": "string" } }, "xml": { "name": "GoalType" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.IndexBlendDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "interval": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "assetClassId": { "type": "integer", "format": "int32" }, "assetClassName": { "type": "string" }, "color": { "type": "string" }, "dynamicType": { "type": "string", "enum": [ "None", "AssetClass", "AssetCategory", "ManagementStyle", "AggregateModel", "RiskCategory" ] } }, "xml": { "name": "IndexBlendDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.IndexBlendFullDto": { "properties": { "represenativesExcludedByDefault": { "type": "boolean" }, "timeFrames": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.IndexBlendTimeframeDto" }, "xml": { "name": "IndexBlendTimeframeDto", "wrapped": true }, "type": "array" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" }, "representatives": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleRepresentative" }, "xml": { "name": "SimpleRepresentative", "wrapped": true }, "type": "array" }, "dynamicDetails": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.IndexBlendDynamicDetailDto" }, "xml": { "name": "IndexBlendDynamicDetailDto", "wrapped": true }, "type": "array" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "interval": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "assetClassId": { "type": "integer", "format": "int32" }, "assetClassName": { "type": "string" }, "color": { "type": "string" }, "dynamicType": { "type": "string", "enum": [ "None", "AssetClass", "AssetCategory", "ManagementStyle", "AggregateModel", "RiskCategory" ] } }, "xml": { "name": "IndexBlendFullDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.IndexBlendTimeframeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "target": { "type": "number", "format": "double" }, "allocations": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.IndexBlendAllocationDto" }, "xml": { "name": "IndexBlendAllocationDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "IndexBlendTimeframeDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.IndexBlendDynamicDetailDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "product": { "$ref": "#/definitions/OAS.WebApi.DTO.Search.SearchProductDto" } }, "xml": { "name": "IndexBlendDynamicDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.IndexBlendAllocationDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "ticker": { "type": "string" }, "productName": { "type": "string" }, "weight": { "type": "number", "format": "double" } }, "xml": { "name": "IndexBlendAllocationDto" }, "type": "object" }, "OAS.WebApi.DTO.Search.SearchProductDto": { "properties": { "ticker": { "type": "string" }, "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "productType": { "type": "integer", "format": "int32" }, "productTypeName": { "type": "string" }, "price": { "type": "number", "format": "double" }, "shareClass": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ShareClass" }, "externalId": { "type": "integer", "format": "int32" }, "productRiskScore": { "type": "integer", "format": "int32" }, "productClass": { "type": "string" }, "productCategory": { "type": "string" }, "riskScore": { "type": "integer", "format": "int32" } }, "xml": { "name": "SearchProductDto" }, "type": "object" }, "OAS.DataModel.Portfolio.IndexBlendDetailDateRange": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "xml": { "name": "IndexBlendDetailDateRange" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.InvestmentObjectiveVerboseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "general": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.InvestmentObjectiveGeneralDto" }, "hypotheticalMonthlyPerformanceValues": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.InvestmentObjectiveHypotheticalMonthlyPerformanceValueDto" }, "xml": { "name": "InvestmentObjectiveHypotheticalMonthlyPerformanceValueDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "InvestmentObjectiveVerboseDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.InvestmentObjectiveGeneralDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "sequenceNumber": { "type": "integer", "format": "int32" } }, "xml": { "name": "InvestmentObjectiveGeneralDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.InvestmentObjectiveHypotheticalMonthlyPerformanceValueDto": { "properties": { "month": { "type": "integer", "format": "int32" }, "percentile5": { "type": "number", "format": "double" }, "percentile50": { "type": "number", "format": "double" }, "percentile95": { "type": "number", "format": "double" } }, "xml": { "name": "InvestmentObjectiveHypotheticalMonthlyPerformanceValueDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.InvestmentObjectiveDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "sequenceNumber": { "type": "integer", "format": "int32" }, "riskRangeLow": { "type": "integer", "format": "int32" }, "riskRangeHigh": { "type": "integer", "format": "int32" }, "driftRangeLow": { "type": "integer", "format": "int32" }, "driftRangeHigh": { "type": "integer", "format": "int32" }, "detail": { "type": "string" } }, "xml": { "name": "InvestmentObjectiveDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.LocaleDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "displayName": { "type": "string" }, "cultureCode": { "type": "string" }, "productId": { "type": "integer", "format": "int32" } }, "xml": { "name": "LocaleDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.MatrixB50Dto": { "properties": { "status": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "accountCode": { "type": "string" }, "subAdvisor": { "type": "string" }, "regName": { "type": "string" }, "fundFamily": { "type": "string" }, "productName": { "type": "string" }, "ticker": { "type": "string" }, "cusip": { "type": "string" }, "source": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "riaAccountId": { "type": "integer", "format": "int32" }, "notes": { "type": "string" }, "sharesClass": { "type": "string" }, "id": { "type": "integer", "format": "int32" } }, "xml": { "name": "MatrixB50Dto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.OfacCheckDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "readOnly": true, "type": "string", "enum": [ "NeedsReview", "NoMatch", "Match" ] }, "registrationId": { "type": "integer", "format": "int32" }, "householdName": { "type": "string" }, "householdAddress": { "type": "string" }, "ofacId": { "type": "integer", "format": "int32" }, "ofacName": { "type": "string" }, "ofacAddress": { "type": "string" }, "ofacAltName": { "type": "string" }, "dateChecked": { "type": "string", "format": "date-time" }, "notes": { "type": "string" } }, "xml": { "name": "OfacCheckDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.CostBasis.OrionRealizedDto": { "properties": { "assetId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "acquiredDate": { "type": "string", "format": "date-time" }, "sellDate": { "type": "string", "format": "date-time" }, "holdPeriodDate": { "type": "string", "format": "date-time" }, "costAmt": { "type": "number", "format": "double" }, "amortizationAmt": { "type": "number", "format": "double" }, "noUnits": { "type": "number", "format": "double" }, "source": { "type": "integer", "format": "int32" }, "method": { "type": "string" }, "proceedAmt": { "type": "number", "format": "double" }, "id": { "type": "integer", "format": "int32" }, "washSaleImpacted": { "type": "boolean" }, "custodianCommonCode": { "type": "string" }, "effectiveDate": { "type": "string", "format": "date-time" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "isShort": { "type": "boolean" }, "transactionId": { "type": "integer", "format": "int32" }, "isReturnOfCapital": { "type": "boolean" }, "isLongTerm": { "type": "boolean" }, "isInherited": { "type": "boolean" }, "isWashSale": { "type": "boolean" }, "isUnknown": { "type": "boolean" }, "transTypeOfBuyId": { "type": "integer", "format": "int32" }, "navOfBuy": { "type": "number", "format": "double" }, "clientId": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "productTicker": { "type": "string" }, "householdName": { "type": "string" }, "registrationType": { "type": "string" }, "isQualified": { "type": "boolean" }, "representative": { "type": "string" }, "representativeNumber": { "type": "string" } }, "xml": { "name": "OrionRealizedDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.CostBasis.OrionUnrealizedDto": { "properties": { "assetId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "productName": { "type": "string" }, "longTermCost": { "type": "number", "format": "double" }, "shortTermCost": { "type": "number", "format": "double" }, "longTermUnits": { "type": "number", "format": "double" }, "shortTermUnits": { "type": "number", "format": "double" }, "acquiredDate": { "type": "string", "format": "date-time" }, "amortizationAmt": { "type": "number", "format": "double" }, "id": { "type": "integer", "format": "int64" }, "holdPeriodDate": { "type": "string", "format": "date-time" }, "isShort": { "type": "boolean" }, "isLongTerm": { "type": "boolean" }, "isInherited": { "type": "boolean" }, "isUnknown": { "type": "boolean" }, "transTypeOfBuyId": { "type": "integer", "format": "int32" }, "navOfBuy": { "type": "number", "format": "double" }, "clientId": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "productTicker": { "type": "string" }, "householdName": { "type": "string" }, "registrationType": { "type": "string" }, "isQualified": { "type": "boolean" }, "representative": { "type": "string" }, "representativeNumber": { "type": "string" } }, "xml": { "name": "OrionUnrealizedDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ParentCategoryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "abbreviation": { "type": "string" }, "name": { "type": "string" }, "sortOrder": { "type": "integer", "format": "int32" }, "isEditable": { "type": "boolean" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "ParentCategoryDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.PlanAdministratorDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "adminNumber": { "type": "string" }, "contact": { "type": "string" }, "agreementSigned": { "type": "string", "format": "date-time" }, "importKey": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "entityName": { "type": "string" }, "email": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "salutation": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "address3": { "type": "string" }, "zip": { "type": "string" }, "fax": { "type": "string" }, "faxExt": { "type": "string" }, "mobilePhone": { "type": "string" }, "businessPhone": { "type": "string" }, "businessPhoneExt": { "type": "string" }, "otherPhone": { "type": "string" }, "otherPhoneExt": { "type": "string" }, "company": { "type": "string" }, "jobTitle": { "type": "string" }, "webAddress": { "type": "string" } }, "xml": { "name": "PlanAdministratorDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.PlanVerboseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "portfolio": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlanPortfolioDto" }, "personal": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlanPersonalDto" }, "sponsor": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlanSponsorDto" }, "participants": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ParticipantAccountDto" }, "xml": { "name": "ParticipantAccountDto", "wrapped": true }, "type": "array" }, "fees": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlanFeeDto" }, "xml": { "name": "PlanFeeDto", "wrapped": true }, "type": "array" }, "platforms": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlanPlatformDto" }, "xml": { "name": "PlanPlatformDto", "wrapped": true }, "type": "array" }, "representatives": { "items": { "$ref": "#/definitions/OAS.DataModel.Portfolio.SimpleRepresentative" }, "xml": { "name": "SimpleRepresentative", "wrapped": true }, "type": "array" }, "notes": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.NoteDto" }, "xml": { "name": "NoteDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "PlanVerboseDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.PlanPortfolioDto": { "properties": { "planName": { "type": "string" }, "status": { "type": "string" }, "value": { "type": "number", "format": "double" }, "isFundWindow": { "type": "boolean" }, "planNumber": { "type": "string" }, "trustee": { "type": "string" }, "planAdministratorId": { "type": "integer", "format": "int32" }, "notes": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "shareClassId": { "type": "integer", "format": "int32" }, "registrationTypeId": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "planCustodialAccountNumber": { "type": "string" } }, "xml": { "name": "PlanPortfolioDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.PlanPersonalDto": { "properties": { "city": { "type": "string" }, "state": { "type": "string" }, "email": { "type": "string" }, "salutation": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "address3": { "type": "string" }, "zip": { "type": "string" }, "homePhone": { "type": "string" }, "homePhoneExt": { "type": "string" }, "fax": { "type": "string" }, "faxExt": { "type": "string" }, "pager": { "type": "string" }, "pagerExt": { "type": "string" }, "mobilePhone": { "type": "string" }, "businessPhone": { "type": "string" }, "businessPhoneExt": { "type": "string" }, "otherPhone": { "type": "string" }, "otherPhoneExt": { "type": "string" }, "company": { "type": "string" }, "jobTitle": { "type": "string" }, "ssN_TaxID": { "type": "string" }, "gender": { "type": "string" }, "dob": { "type": "string", "format": "date-time" }, "webAddress": { "type": "string" } }, "xml": { "name": "PlanPersonalDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.PlanSponsorDto": { "properties": { "planSponsor": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "email": { "type": "string" }, "salutation": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "address3": { "type": "string" }, "zip": { "type": "string" }, "homePhone": { "type": "string" }, "homePhoneExt": { "type": "string" }, "fax": { "type": "string" }, "faxExt": { "type": "string" }, "pager": { "type": "string" }, "pagerExt": { "type": "string" }, "mobilePhone": { "type": "string" }, "businessPhone": { "type": "string" }, "businessPhoneExt": { "type": "string" }, "otherPhone": { "type": "string" }, "otherPhoneExt": { "type": "string" }, "company": { "type": "string" }, "jobTitle": { "type": "string" }, "ssN_TaxID": { "type": "string" }, "gender": { "type": "string" }, "dob": { "type": "string", "format": "date-time" }, "webAddress": { "type": "string" }, "syncAddress": { "type": "boolean" } }, "xml": { "name": "PlanSponsorDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ParticipantAccountDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "householdId": { "type": "integer", "format": "int32" }, "householdName": { "type": "string" }, "accountNumber": { "type": "string" }, "currValue": { "type": "number", "format": "double" }, "fundFamilyName": { "type": "string" }, "managementStyleName": { "type": "string" }, "houseHoldEmail": { "type": "string" }, "isActive": { "type": "boolean" }, "riskBudget": { "type": "integer", "format": "int32" }, "isLifestyleOption": { "type": "boolean" } }, "xml": { "name": "ParticipantAccountDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.PlanFeeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "party": { "type": "string" }, "feePercent": { "type": "number", "format": "double" } }, "xml": { "name": "PlanFeeDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.PlanPlatformDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "platformId": { "type": "integer", "format": "int32" }, "platformName": { "type": "string" }, "feePercent": { "type": "number", "format": "double" }, "feeScheduleId": { "type": "integer", "format": "int32" }, "feeScheduleName": { "type": "string" } }, "xml": { "name": "PlanPlatformDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.PlanParticipantAddDto": { "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "ssn": { "type": "string" }, "dateOfBirth": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" }, "platformId": { "type": "integer", "format": "int32" }, "businessLineId": { "type": "integer", "format": "int32" }, "isLifestyleOption": { "type": "boolean" }, "autoPopulate": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlanParticipantAutoPopulateDto" } }, "xml": { "name": "PlanParticipantAddDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.PlanParticipantAutoPopulateDto": { "properties": { "accountNumber": { "type": "string" }, "riskBudget": { "type": "integer", "format": "int32" }, "riskTolerance": { "type": "integer", "format": "int32" }, "returnObjective": { "type": "string" }, "investmentObjective": { "type": "string" }, "timeHorizon": { "type": "string" }, "stockPercent": { "type": "string" }, "modelId": { "type": "integer", "format": "int32" }, "modelName": { "type": "string" }, "platformId": { "type": "integer", "format": "int32" }, "managementStyleName": { "type": "string" } }, "xml": { "name": "PlanParticipantAutoPopulateDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.PlanParticipantValidationResultDto": { "properties": { "isValid": { "type": "boolean" }, "message": { "type": "string" }, "warningMessage": { "type": "string" }, "autoPopulate": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlanParticipantAutoPopulateDto" }, "fieldErrors": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PlanParticipantFieldErrorDto" }, "xml": { "name": "PlanParticipantFieldErrorDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "PlanParticipantValidationResultDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.PlanParticipantFieldErrorDto": { "properties": { "field": { "type": "string" }, "message": { "type": "string" } }, "xml": { "name": "PlanParticipantFieldErrorDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.PlanDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "status": { "type": "string" }, "value": { "type": "number", "format": "double" }, "representativeName": { "type": "string" }, "representativeId": { "type": "integer", "format": "int32" }, "planNumber": { "type": "string" }, "trustee": { "type": "string" }, "participantsCount": { "type": "integer", "format": "int32" }, "planAdministrator": { "type": "string" }, "custodianName": { "type": "string" }, "registrationType": { "type": "string" }, "shareClassId": { "type": "integer", "format": "int32" }, "wholesalerName": { "type": "string" }, "registrationTypeId": { "type": "integer", "format": "int32" }, "planAdministrationId": { "type": "integer", "format": "int32" }, "planAdministrationNumber": { "type": "string" }, "planSponsor": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "isCustodianNotified": { "type": "boolean" }, "isFundWindow": { "type": "boolean" }, "notes": { "type": "string" }, "syncAddress": { "type": "boolean" }, "planState": { "type": "string" }, "planCustodialAccountNumber": { "type": "string" } }, "xml": { "name": "PlanDto" }, "type": "object" }, "OAS.DataModel.Portfolio.SimplePlan": { "properties": { "registrationTypeId": { "type": "integer", "format": "int32" }, "registrationType": { "type": "string" }, "planNumber": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "SimplePlan" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.PlatformDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "isActive": { "type": "boolean" }, "abbreviation": { "type": "string" }, "description": { "type": "string" }, "rankOrder": { "type": "integer", "format": "int32" }, "isDefault": { "type": "boolean" }, "ipsId": { "type": "integer", "format": "int32" }, "color": { "type": "string" }, "platformTypeId": { "type": "integer", "format": "int32" }, "objective": { "type": "string" }, "isWrapFeeProgram": { "type": "boolean" }, "modelAggId": { "type": "integer", "format": "int32" }, "modelAggName": { "type": "string" } }, "xml": { "name": "PlatformDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.PlatformTypeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "type": "string" } }, "xml": { "name": "PlatformTypeDto" }, "type": "object" }, "OAS.DataProcess.Reporting.FirmJobs.IPortfolioGroupAssignmentAutomationOptions": { "properties": { "businessLineIds": { "items": { "type": "integer", "format": "int32" }, "readOnly": true, "type": "array" }, "createPortfolioGroupOnNonMatch": { "readOnly": true, "type": "boolean" }, "excludeByAccountNumberContains": { "items": { "type": "string" }, "readOnly": true, "type": "array" }, "matchByAccountName": { "readOnly": true, "type": "boolean" }, "matchByAccountNumberPrefix": { "additionalProperties": { "type": "string" }, "readOnly": true, "type": "object" }, "overwriteExistingPortfolioGroup": { "readOnly": true, "type": "boolean" } }, "xml": { "name": "IPortfolioGroupAssignmentAutomationOptions" }, "type": "object" }, "OAS.DataProcess.Reporting.FirmJobs.PortfolioGroupAssignmentAutomationOptions": { "properties": { "businessLineIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "matchByAccountNumberPrefix": { "additionalProperties": { "type": "string" }, "type": "object" }, "matchByAccountName": { "type": "boolean" }, "createPortfolioGroupOnNonMatch": { "type": "boolean" }, "overwriteExistingPortfolioGroup": { "type": "boolean" }, "excludeByAccountNumberContains": { "items": { "type": "string" }, "type": "array" } }, "xml": { "name": "PortfolioGroupAssignmentAutomationOptions" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SimplePortfolioGroupDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "clientId": { "type": "integer", "format": "int32" }, "portfolioType": { "type": "string", "enum": [ "Composite", "Reporting", "Trading" ] }, "clientName": { "type": "string" } }, "xml": { "name": "SimplePortfolioGroupDto" }, "type": "object" }, "OAS.DataModel.Portfolio.SimplePortfolioGroup": { "properties": { "clientId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "SimplePortfolioGroup" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RegistrationDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "accountType": { "type": "string" }, "isActive": { "type": "boolean" }, "lastName": { "type": "string" }, "firstName": { "type": "string" }, "currentValue": { "type": "number", "format": "double" }, "ssN_TaxID": { "type": "string" }, "deceasedSSN_TaxID": { "type": "string" }, "dob": { "type": "string", "format": "date-time" }, "clientId": { "type": "integer", "format": "int32" }, "typeCode": { "type": "string" }, "typeId": { "type": "integer", "format": "int32" }, "company": { "type": "string" }, "jobTitle": { "type": "string" }, "gender": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "riskBudget": { "type": "integer", "format": "int32" }, "representativeName": { "type": "string" }, "representativeNumber": { "type": "string" }, "missingInformation": { "readOnly": true, "type": "string" }, "returnObjective": { "type": "string" }, "investmentObjective": { "type": "string" }, "timeHorizon": { "type": "string" }, "stockPercent": { "type": "string" }, "bondPercent": { "readOnly": true, "type": "string" }, "sleeveStrategy": { "type": "string" }, "targetSpendRate": { "type": "number", "format": "double" }, "targetDollarAmount": { "type": "number", "format": "double" }, "targetDate": { "type": "string", "format": "date-time" }, "isRTQLocked": { "type": "boolean" }, "riskTolerance": { "type": "integer", "format": "int32" }, "riskExposure": { "type": "string" }, "isDataSharingEntity": { "type": "boolean" }, "additionalColumns": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Interface.AdditionalColumnDefinition" }, "xml": { "name": "AdditionalColumnDefinition", "wrapped": true }, "type": "array" }, "custodialAccountNumber": { "type": "string" }, "hasSleeve": { "type": "boolean" }, "dod": { "type": "string", "format": "date-time" }, "taxType": { "type": "string", "enum": [ "Taxable", "TaxDeferred", "TaxFree" ] }, "globalId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "RegistrationDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.TransactionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "transDate": { "type": "string", "format": "date-time" }, "transactionDescription": { "type": "string" }, "productName": { "type": "string" }, "ticker": { "type": "string" }, "transAmount": { "type": "number", "format": "double" }, "noUnits": { "type": "number", "format": "double" }, "navPrice": { "type": "number", "format": "double" }, "accountNumber": { "type": "string" }, "status": { "type": "string", "enum": [ "Complete", "Pending", "Rejected", "Reversed", "Inactive", "PendingCorpAction", "FutureAip" ] }, "fileTranCode": { "type": "string" }, "type": { "type": "string" }, "transTime": { "type": "string", "format": "date-time" }, "assetId": { "type": "integer", "format": "int32" }, "assetStatusId": { "type": "integer", "format": "int32" }, "cusip": { "type": "string" }, "notes": { "type": "string" }, "transTypeId": { "type": "integer", "format": "int32" }, "transactionSubTypeId": { "type": "integer", "format": "int32" }, "transactionSubTypeName": { "type": "string" }, "transactionSubTypeDescription": { "type": "string" }, "contributionCodeId": { "type": "integer", "format": "int32" }, "contributionCodeName": { "type": "string" }, "distributionCodeId": { "type": "integer", "format": "int32" }, "distributionCodeName": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "accountStatusId": { "type": "integer", "format": "int32" }, "managementStyle": { "type": "string" }, "payee": { "type": "integer", "format": "int32" }, "advisorNotes": { "type": "string" }, "state": { "type": "string" }, "settleDate": { "type": "string", "format": "date-time" }, "tradeReferenceNumber": { "type": "string" }, "transactionLinkCode": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "registrationId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "typeCode": { "type": "string" }, "brokerCode": { "type": "string" }, "accountType": { "type": "string" }, "fundFamily": { "type": "string" }, "custodian": { "type": "string" }, "count": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "unitBalance": { "type": "number", "format": "double" }, "productId": { "type": "integer", "format": "int32" }, "performanceFeeBreak": { "type": "boolean" }, "financialType": { "type": "string", "enum": [ "None", "Contribution", "Distribution", "Exchange", "DivReinvest", "MgmntFees", "DivCash", "MiscFees", "Journal", "Merges" ] } }, "xml": { "name": "TransactionDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ProductCategoryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "abbreviation": { "type": "string" }, "categoryName": { "type": "string" }, "color": { "type": "string" }, "parentCategory": { "type": "string" }, "sortOrder": { "type": "integer", "format": "int32" }, "value": { "type": "number", "format": "double" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "ProductCategoryDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ProductCategoryWeightedDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "representativeId": { "type": "integer", "format": "int32" }, "representativeName": { "type": "string" }, "productId": { "type": "integer", "format": "int32" }, "details": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductCategoryWeightedDetailDto" }, "xml": { "name": "ProductCategoryWeightedDetailDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProductCategoryWeightedDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ProductCategoryWeightedDetailDto": { "properties": { "productCategoryId": { "type": "integer", "format": "int32" }, "categoryName": { "type": "string" }, "weight": { "type": "number", "format": "double" } }, "xml": { "name": "ProductCategoryWeightedDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ProductClassAutoAssignOverrideDto": { "properties": { "productDescriptionProviderId": { "type": "integer", "format": "int32" }, "providerName": { "type": "string" }, "abbreviation": { "type": "string" }, "classDescription": { "type": "string" }, "hasMultipleDescriptions": { "type": "boolean" }, "productClassAutoAssignOverrideId": { "type": "integer", "format": "int32" }, "productClassId": { "type": "integer", "format": "int32" }, "providerAssigned": { "type": "boolean" } }, "xml": { "name": "ProductClassAutoAssignOverrideDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ProductClassAutoAssignOverrideKeyDto": { "properties": { "productDescriptionProviderId": { "type": "integer", "format": "int32" }, "abbreviation": { "type": "string" } }, "xml": { "name": "ProductClassAutoAssignOverrideKeyDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ProductClassVerboseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "portfolio": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassPortfolioDto" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProductClassVerboseDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ProductClassPortfolioDto": { "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "category": { "type": "string" }, "subCategory": { "type": "string" }, "isDefault": { "type": "boolean" }, "riskScore": { "type": "number", "format": "double" }, "color": { "type": "string" }, "classLevel": { "type": "integer", "format": "int32" }, "sortOrder1": { "type": "integer", "format": "int32" }, "sortOrder2": { "type": "integer", "format": "int32" }, "productCategoryId": { "type": "integer", "format": "int32" }, "externalId": { "type": "string" }, "importKey": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "productDescriptionProviderId": { "type": "integer", "format": "int32" }, "productDescriptionProviderName": { "type": "string" }, "rebalancePriority": { "type": "integer", "format": "int32" }, "rebalanceSellPriority": { "type": "integer", "format": "int32" }, "symbol": { "type": "string" } }, "xml": { "name": "ProductClassPortfolioDto" }, "type": "object" }, "OAS.Validation.IValidationError": { "properties": { "propertyName": { "readOnly": true, "type": "string" }, "errorMessage": { "readOnly": true, "type": "string" } }, "xml": { "name": "IValidationError" }, "type": "object" }, "OAS.DataModel.Portfolio.SimpleProductClass": { "properties": { "productClassId": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "category": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "SimpleProductClass" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ProductClassWeightedDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "representativeId": { "type": "integer", "format": "int32" }, "representativeName": { "type": "string" }, "productId": { "type": "integer", "format": "int32" }, "details": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductClassWeightedDetailDto" }, "xml": { "name": "ProductClassWeightedDetailDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProductClassWeightedDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ProductClassWeightedDetailDto": { "properties": { "productClassId": { "type": "integer", "format": "int32" }, "className": { "type": "string" }, "weight": { "type": "number", "format": "double" } }, "xml": { "name": "ProductClassWeightedDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ProductDescriptionAssignmentDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, "assignments": { "properties": { "assetClass": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" }, "riskCategory": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } }, "type": "object" } }, "xml": { "name": "ProductDescriptionAssignmentDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ProductExpenseRatioDto": { "properties": { "productId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "netExpenseRatio": { "type": "number", "format": "double" } }, "xml": { "name": "ProductExpenseRatioDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.PriceLocalDto": { "properties": { "productId": { "type": "integer", "format": "int32" }, "priceDate": { "type": "string", "format": "date-time" }, "navPrice": { "type": "number", "format": "double" }, "priceSource": { "type": "string", "enum": [ "NotSpecified", "ManuallyEntered", "OrionCopy", "ConversionData" ] }, "auditedBy": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "PriceLocalDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.PriceLocalKeyDto": { "properties": { "productId": { "type": "integer", "format": "int32" }, "priceDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "PriceLocalKeyDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ProductDescriptionWithMorningstarDataDto": { "properties": { "input": { "type": "string" }, "ticker": { "type": "string" }, "cusip": { "type": "string" }, "pkProduct": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "type": { "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, "productSubType": { "type": "string" }, "assetClassId": { "type": "integer", "format": "int32" }, "assetClassDescription": { "type": "string" }, "assetCategoryId": { "type": "integer", "format": "int32" }, "assetCategoryName": { "type": "string" }, "riskCategoryId": { "type": "integer", "format": "int32" }, "riskFullName": { "type": "string" }, "morningstarAllocationWeightings": { "items": { "type": "string" }, "type": "array" }, "morningstarSector": { "items": { "type": "string" }, "type": "array" }, "morningstarSectorWeightings": { "items": { "type": "string" }, "type": "array" }, "morningstarIndustry": { "items": { "type": "string" }, "type": "array" }, "morningstarIndustryGroup": { "items": { "type": "string" }, "type": "array" }, "morningstarStyleBox": { "items": { "type": "string" }, "type": "array" }, "morningstarStyleBoxWeightings": { "items": { "type": "string" }, "type": "array" }, "morningstarCountry": { "items": { "type": "string" }, "type": "array" }, "morningstarBusinessCountry": { "items": { "type": "string" }, "type": "array" }, "morningstarDomicileCountry": { "items": { "type": "string" }, "type": "array" }, "morningstarRegion1": { "items": { "type": "string" }, "type": "array" }, "morningstarRegion2": { "items": { "type": "string" }, "type": "array" } }, "xml": { "name": "ProductDescriptionWithMorningstarDataDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ProductsHoldingsData": { "properties": { "tickers": { "items": { "type": "string" }, "type": "array" }, "date": { "type": "string", "format": "date-time" } }, "xml": { "name": "ProductsHoldingsData" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ProductHoldingsDto": { "properties": { "input": { "type": "string" }, "ticker": { "type": "string" }, "cusip": { "type": "string" }, "pkProduct": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "type": { "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, "productSubType": { "type": "string" }, "date": { "type": "string" }, "holdings": { "items": { "type": "string" }, "type": "array" } }, "xml": { "name": "ProductHoldingsDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ProductEntityExclusionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "parentId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "ticker": { "type": "string" }, "exceptions": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, "xml": { "name": "ProductEntityExclusionDto" }, "type": "object" }, "OAS.WebApi.DTO.EnMasseDtoOfOAS.WebApi.DTO.Portfolio.ProductEntityExclusionDto": { "properties": { "create": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductEntityExclusionDto" }, "xml": { "name": "ProductEntityExclusionDto", "wrapped": true }, "type": "array" }, "update": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductEntityExclusionDto" }, "xml": { "name": "ProductEntityExclusionDto", "wrapped": true }, "type": "array" }, "delete": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductEntityExclusionDto" }, "xml": { "name": "ProductEntityExclusionDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "EnMasseDto`1" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ProductNameMappingDstDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "downloadPriceProductName": { "type": "string" }, "mappedProductName": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "ProductNameMappingDstDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.PorfolioProductCountsDto": { "properties": { "localProducts": { "additionalProperties": { "type": "integer", "format": "int32" }, "type": "object" }, "globalProducts": { "additionalProperties": { "type": "integer", "format": "int32" }, "type": "object" } }, "xml": { "name": "PorfolioProductCountsDto" }, "type": "object" }, "OAS.WebApi.Code.Projection.ProjectionManipulatorOfOAS.WebApi.DTO.Portfolio.LocalProductBaseDto": { "properties": { "type": { "readOnly": true, "type": "string" }, "hasImpact": { "readOnly": true, "type": "boolean" }, "top": { "readOnly": true, "type": "integer", "format": "int32" }, "skip": { "readOnly": true, "type": "integer", "format": "int32" }, "requestedProperties": { "description": "The properties the user specifically asked for", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" }, "requiredProperties": { "description": "The properties that are required to fulfill the requested properties", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProjectionManipulator`1" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.LocalProductBaseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "ticker": { "type": "string" }, "cusip": { "type": "string" }, "productType": { "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, "assetClassDescription": { "type": "string" }, "productSubTypeName": { "type": "string" }, "productCategoryName": { "type": "string" }, "currentOrionPrice": { "type": "number", "format": "double" }, "currentOrionPriceDate": { "type": "string", "format": "date-time" }, "aum": { "type": "number", "format": "double" }, "advAssetCategoryId": { "type": "integer", "format": "int32" }, "advAssetCategory": { "type": "string" }, "additionalColumns": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Interface.AdditionalColumnDefinition" }, "xml": { "name": "AdditionalColumnDefinition", "wrapped": true }, "type": "array" }, "isAdvisorProduct": { "type": "boolean" }, "advisorPrefix": { "type": "string" } }, "xml": { "name": "LocalProductBaseDto" }, "type": "object" }, "OAS.WebApi.Code.Projection.ProjectionManipulatorOfOAS.WebApi.DTO.Portfolio.LocalProductDto": { "properties": { "type": { "readOnly": true, "type": "string" }, "hasImpact": { "readOnly": true, "type": "boolean" }, "top": { "readOnly": true, "type": "integer", "format": "int32" }, "skip": { "readOnly": true, "type": "integer", "format": "int32" }, "requestedProperties": { "description": "The properties the user specifically asked for", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" }, "requiredProperties": { "description": "The properties that are required to fulfill the requested properties", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProjectionManipulator`1" }, "type": "object" }, "OAS.WebApi.Code.Projection.ProjectionManipulatorOfOAS.WebApi.DTO.Portfolio.LocalProductBondAuditDto": { "properties": { "type": { "readOnly": true, "type": "string" }, "hasImpact": { "readOnly": true, "type": "boolean" }, "top": { "readOnly": true, "type": "integer", "format": "int32" }, "skip": { "readOnly": true, "type": "integer", "format": "int32" }, "requestedProperties": { "description": "The properties the user specifically asked for", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" }, "requiredProperties": { "description": "The properties that are required to fulfill the requested properties", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProjectionManipulator`1" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.LocalProductMinimalDto": { "properties": { "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "productCategoryName": { "type": "string" }, "assetClassName": { "type": "string" }, "assetClassDescription": { "type": "string" }, "ticker": { "type": "string" } }, "xml": { "name": "LocalProductMinimalDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ProductBondCallDto": { "properties": { "productId": { "type": "integer", "format": "int32" }, "callDate": { "type": "string", "format": "date-time" }, "callPrice": { "type": "number", "format": "double" }, "productName": { "type": "string" }, "ticker": { "type": "string" }, "cusip": { "type": "string" } }, "xml": { "name": "ProductBondCallDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ProductBondCallKeyDto": { "properties": { "productId": { "type": "integer", "format": "int32" }, "callDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "ProductBondCallKeyDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.PropertyTypeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "PropertyTypeDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ProductPropertyTypeWeightedDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "representativeId": { "type": "integer", "format": "int32" }, "representativeName": { "type": "string" }, "productId": { "type": "integer", "format": "int32" }, "details": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductPropertyTypeWeightedDetailDto" }, "xml": { "name": "ProductPropertyTypeWeightedDetailDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProductPropertyTypeWeightedDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ProductPropertyTypeWeightedDetailDto": { "properties": { "productPropertyTypeWeightedId": { "type": "integer", "format": "int32" }, "propertyTypeId": { "type": "integer", "format": "int32" }, "propertyTypeName": { "type": "string" }, "weight": { "type": "number", "format": "double" } }, "xml": { "name": "ProductPropertyTypeWeightedDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.QpeNonManagedDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "clientId": { "type": "string" }, "asOfDt": { "type": "string", "format": "date-time" }, "ssN_TaxId": { "type": "string" }, "registrationNm": { "type": "string" }, "assetNm": { "type": "string" }, "acctNum": { "type": "string" }, "shares": { "type": "string" }, "price": { "type": "string" }, "startingVal": { "type": "string" }, "mktVal": { "type": "string" }, "fileNm": { "type": "string" }, "createdBy": { "type": "string" }, "createdDt": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDt": { "type": "string", "format": "date-time" }, "isError": { "type": "boolean" }, "errorText": { "type": "string" } }, "xml": { "name": "QpeNonManagedDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ProductRegionWeightedDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "representativeId": { "type": "integer", "format": "int32" }, "representativeName": { "type": "string" }, "productId": { "type": "integer", "format": "int32" }, "details": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductRegionWeightedDetailDto" }, "xml": { "name": "ProductRegionWeightedDetailDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProductRegionWeightedDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ProductRegionWeightedDetailDto": { "properties": { "productRegionWeightedId": { "type": "integer", "format": "int32" }, "regionId": { "type": "integer", "format": "int32" }, "regionName": { "type": "string" }, "weight": { "type": "number", "format": "double" } }, "xml": { "name": "ProductRegionWeightedDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RegionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "RegionDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RegistrationChangeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "changes": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationChangeSetDto" }, "xml": { "name": "RegistrationChangeSetDto", "wrapped": true }, "type": "array" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedBy": { "type": "string" } }, "xml": { "name": "RegistrationChangeDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RegistrationChangeSetDto": { "properties": { "entityType": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Rep", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Beneficiary", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QPEDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "Banking", "RMD", "Systematic", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "AdditionalRep", "DownloadSource", "DownloadRecord", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "entityName": { "type": "string" }, "entityNumber": { "type": "string" }, "oldBillRepPercentage": { "type": "number", "format": "double" }, "newBillRepPercentage": { "type": "number", "format": "double" }, "actionType": { "type": "string", "enum": [ "None", "Inserted", "Updated", "Deleted" ] }, "sourceType": { "type": "string", "enum": [ "Registration", "Client" ] }, "isDeleted": { "type": "boolean" }, "isPartOfSet": { "type": "boolean" }, "isUncommitted": { "type": "boolean" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "RegistrationChangeSetDto" }, "type": "object" }, "System.Web.Http.OData.Query.ODataQueryOptionsOfOAS.WebApi.DTO.Portfolio.RegistrationDto": { "properties": { "ifMatch": { "readOnly": true, "type": "object" }, "ifNoneMatch": { "readOnly": true, "type": "object" }, "context": { "$ref": "#/definitions/System.Web.Http.OData.ODataQueryContext", "readOnly": true }, "request": { "readOnly": true, "type": "object" }, "rawValues": { "$ref": "#/definitions/System.Web.Http.OData.Query.ODataRawQueryOptions", "readOnly": true }, "selectExpand": { "$ref": "#/definitions/System.Web.Http.OData.Query.SelectExpandQueryOption", "readOnly": true }, "filter": { "$ref": "#/definitions/System.Web.Http.OData.Query.FilterQueryOption", "readOnly": true }, "orderBy": { "$ref": "#/definitions/System.Web.Http.OData.Query.OrderByQueryOption", "readOnly": true }, "skip": { "$ref": "#/definitions/System.Web.Http.OData.Query.SkipQueryOption", "readOnly": true }, "top": { "$ref": "#/definitions/System.Web.Http.OData.Query.TopQueryOption", "readOnly": true }, "inlineCount": { "$ref": "#/definitions/System.Web.Http.OData.Query.InlineCountQueryOption", "readOnly": true }, "validator": { "$ref": "#/definitions/System.Web.Http.OData.Query.Validators.ODataQueryValidator" } }, "xml": { "name": "ODataQueryOptions`1" }, "type": "object" }, "System.Web.Http.OData.ODataQueryContext": { "properties": { "model": { "$ref": "#/definitions/Microsoft.Data.Edm.IEdmModel", "readOnly": true }, "elementType": { "$ref": "#/definitions/Microsoft.Data.Edm.IEdmType", "readOnly": true }, "elementClrType": { "readOnly": true, "type": "string" } }, "xml": { "name": "ODataQueryContext" }, "type": "object" }, "System.Web.Http.OData.Query.ODataRawQueryOptions": { "properties": { "filter": { "readOnly": true, "type": "string" }, "orderBy": { "readOnly": true, "type": "string" }, "top": { "readOnly": true, "type": "string" }, "skip": { "readOnly": true, "type": "string" }, "select": { "readOnly": true, "type": "string" }, "expand": { "readOnly": true, "type": "string" }, "inlineCount": { "readOnly": true, "type": "string" }, "format": { "readOnly": true, "type": "string" }, "skipToken": { "readOnly": true, "type": "string" } }, "xml": { "name": "ODataRawQueryOptions" }, "type": "object" }, "System.Web.Http.OData.Query.SelectExpandQueryOption": { "properties": { "context": { "$ref": "#/definitions/System.Web.Http.OData.ODataQueryContext", "readOnly": true }, "rawSelect": { "readOnly": true, "type": "string" }, "rawExpand": { "readOnly": true, "type": "string" }, "validator": { "$ref": "#/definitions/System.Web.Http.OData.Query.Validators.SelectExpandQueryValidator" }, "selectExpandClause": { "$ref": "#/definitions/Microsoft.Data.OData.Query.SemanticAst.SelectExpandClause", "readOnly": true } }, "xml": { "name": "SelectExpandQueryOption" }, "type": "object" }, "System.Web.Http.OData.Query.FilterQueryOption": { "properties": { "context": { "$ref": "#/definitions/System.Web.Http.OData.ODataQueryContext", "readOnly": true }, "validator": { "$ref": "#/definitions/System.Web.Http.OData.Query.Validators.FilterQueryValidator" }, "filterClause": { "$ref": "#/definitions/Microsoft.Data.OData.Query.SemanticAst.FilterClause", "readOnly": true }, "rawValue": { "readOnly": true, "type": "string" } }, "xml": { "name": "FilterQueryOption" }, "type": "object" }, "System.Web.Http.OData.Query.OrderByQueryOption": { "properties": { "context": { "$ref": "#/definitions/System.Web.Http.OData.ODataQueryContext", "readOnly": true }, "orderByNodes": { "items": { "$ref": "#/definitions/System.Web.Http.OData.Query.OrderByNode" }, "readOnly": true, "xml": { "name": "OrderByNode", "wrapped": true }, "type": "array" }, "rawValue": { "readOnly": true, "type": "string" }, "validator": { "$ref": "#/definitions/System.Web.Http.OData.Query.Validators.OrderByQueryValidator" }, "orderByClause": { "$ref": "#/definitions/Microsoft.Data.OData.Query.SemanticAst.OrderByClause", "readOnly": true } }, "xml": { "name": "OrderByQueryOption" }, "type": "object" }, "System.Web.Http.OData.Query.SkipQueryOption": { "properties": { "context": { "$ref": "#/definitions/System.Web.Http.OData.ODataQueryContext", "readOnly": true }, "rawValue": { "readOnly": true, "type": "string" }, "value": { "readOnly": true, "type": "integer", "format": "int32" }, "validator": { "$ref": "#/definitions/System.Web.Http.OData.Query.Validators.SkipQueryValidator" } }, "xml": { "name": "SkipQueryOption" }, "type": "object" }, "System.Web.Http.OData.Query.TopQueryOption": { "properties": { "context": { "$ref": "#/definitions/System.Web.Http.OData.ODataQueryContext", "readOnly": true }, "rawValue": { "readOnly": true, "type": "string" }, "value": { "readOnly": true, "type": "integer", "format": "int32" }, "validator": { "$ref": "#/definitions/System.Web.Http.OData.Query.Validators.TopQueryValidator" } }, "xml": { "name": "TopQueryOption" }, "type": "object" }, "System.Web.Http.OData.Query.InlineCountQueryOption": { "properties": { "context": { "$ref": "#/definitions/System.Web.Http.OData.ODataQueryContext", "readOnly": true }, "rawValue": { "readOnly": true, "type": "string" }, "value": { "readOnly": true, "type": "string", "enum": [ "None", "AllPages" ] } }, "xml": { "name": "InlineCountQueryOption" }, "type": "object" }, "System.Web.Http.OData.Query.Validators.ODataQueryValidator": { "properties": {}, "xml": { "name": "ODataQueryValidator" }, "type": "object" }, "Microsoft.Data.Edm.IEdmModel": { "properties": { "schemaElements": { "items": { "$ref": "#/definitions/Microsoft.Data.Edm.IEdmSchemaElement" }, "readOnly": true, "xml": { "name": "IEdmSchemaElement", "wrapped": true }, "type": "array" }, "vocabularyAnnotations": { "items": { "$ref": "#/definitions/Microsoft.Data.Edm.Annotations.IEdmVocabularyAnnotation" }, "readOnly": true, "xml": { "name": "IEdmVocabularyAnnotation", "wrapped": true }, "type": "array" }, "referencedModels": { "items": { "$ref": "#/definitions/Microsoft.Data.Edm.IEdmModel" }, "readOnly": true, "xml": { "name": "IEdmModel", "wrapped": true }, "type": "array" }, "directValueAnnotationsManager": { "$ref": "#/definitions/Microsoft.Data.Edm.Annotations.IEdmDirectValueAnnotationsManager", "readOnly": true } }, "xml": { "name": "IEdmModel" }, "type": "object" }, "Microsoft.Data.Edm.IEdmType": { "properties": { "typeKind": { "readOnly": true, "type": "string", "enum": [ "None", "Primitive", "Entity", "Complex", "Row", "Collection", "EntityReference", "Enum" ] } }, "xml": { "name": "IEdmType" }, "type": "object" }, "System.Web.Http.OData.Query.Validators.SelectExpandQueryValidator": { "properties": {}, "xml": { "name": "SelectExpandQueryValidator" }, "type": "object" }, "Microsoft.Data.OData.Query.SemanticAst.SelectExpandClause": { "properties": { "selectedItems": { "items": { "$ref": "#/definitions/Microsoft.Data.OData.Query.SemanticAst.SelectItem" }, "readOnly": true, "xml": { "name": "SelectItem", "wrapped": true }, "type": "array" }, "allSelected": { "readOnly": true, "type": "boolean" } }, "xml": { "name": "SelectExpandClause" }, "type": "object" }, "System.Web.Http.OData.Query.Validators.FilterQueryValidator": { "properties": {}, "xml": { "name": "FilterQueryValidator" }, "type": "object" }, "Microsoft.Data.OData.Query.SemanticAst.FilterClause": { "properties": { "expression": { "$ref": "#/definitions/Microsoft.Data.OData.Query.SemanticAst.SingleValueNode", "readOnly": true }, "rangeVariable": { "$ref": "#/definitions/Microsoft.Data.OData.Query.SemanticAst.RangeVariable", "readOnly": true }, "itemType": { "$ref": "#/definitions/Microsoft.Data.Edm.IEdmTypeReference", "readOnly": true } }, "xml": { "name": "FilterClause" }, "type": "object" }, "System.Web.Http.OData.Query.OrderByNode": { "properties": { "direction": { "readOnly": true, "type": "string", "enum": [ "Ascending", "Descending" ] } }, "xml": { "name": "OrderByNode" }, "type": "object" }, "System.Web.Http.OData.Query.Validators.OrderByQueryValidator": { "properties": {}, "xml": { "name": "OrderByQueryValidator" }, "type": "object" }, "Microsoft.Data.OData.Query.SemanticAst.OrderByClause": { "properties": { "thenBy": { "$ref": "#/definitions/Microsoft.Data.OData.Query.SemanticAst.OrderByClause", "readOnly": true }, "expression": { "$ref": "#/definitions/Microsoft.Data.OData.Query.SemanticAst.SingleValueNode", "readOnly": true }, "direction": { "readOnly": true, "type": "string", "enum": [ "Ascending", "Descending" ] }, "rangeVariable": { "$ref": "#/definitions/Microsoft.Data.OData.Query.SemanticAst.RangeVariable", "readOnly": true }, "itemType": { "$ref": "#/definitions/Microsoft.Data.Edm.IEdmTypeReference", "readOnly": true } }, "xml": { "name": "OrderByClause" }, "type": "object" }, "System.Web.Http.OData.Query.Validators.SkipQueryValidator": { "properties": {}, "xml": { "name": "SkipQueryValidator" }, "type": "object" }, "System.Web.Http.OData.Query.Validators.TopQueryValidator": { "properties": {}, "xml": { "name": "TopQueryValidator" }, "type": "object" }, "Microsoft.Data.Edm.IEdmSchemaElement": { "properties": { "schemaElementKind": { "readOnly": true, "type": "string", "enum": [ "None", "TypeDefinition", "Function", "ValueTerm", "EntityContainer" ] }, "namespace": { "readOnly": true, "type": "string" }, "name": { "readOnly": true, "type": "string" } }, "xml": { "name": "IEdmSchemaElement" }, "type": "object" }, "Microsoft.Data.Edm.Annotations.IEdmVocabularyAnnotation": { "properties": { "qualifier": { "readOnly": true, "type": "string" }, "term": { "$ref": "#/definitions/Microsoft.Data.Edm.IEdmTerm", "readOnly": true }, "target": { "$ref": "#/definitions/Microsoft.Data.Edm.IEdmVocabularyAnnotatable", "readOnly": true } }, "xml": { "name": "IEdmVocabularyAnnotation" }, "type": "object" }, "Microsoft.Data.Edm.Annotations.IEdmDirectValueAnnotationsManager": { "properties": {}, "xml": { "name": "IEdmDirectValueAnnotationsManager" }, "type": "object" }, "Microsoft.Data.OData.Query.SemanticAst.SelectItem": { "properties": {}, "xml": { "name": "SelectItem" }, "type": "object" }, "Microsoft.Data.OData.Query.SemanticAst.SingleValueNode": { "properties": { "typeReference": { "$ref": "#/definitions/Microsoft.Data.Edm.IEdmTypeReference", "readOnly": true }, "kind": { "readOnly": true, "type": "string", "enum": [ "None", "Constant", "Convert", "NonentityRangeVariableReference", "BinaryOperator", "UnaryOperator", "SingleValuePropertyAccess", "CollectionPropertyAccess", "SingleValueFunctionCall", "Any", "CollectionNavigationNode", "SingleNavigationNode", "SingleValueOpenPropertyAccess", "SingleEntityCast", "All", "EntityCollectionCast", "EntityRangeVariableReference", "SingleEntityFunctionCall", "CollectionFunctionCall", "EntityCollectionFunctionCall", "NamedFunctionParameter" ] } }, "xml": { "name": "SingleValueNode" }, "type": "object" }, "Microsoft.Data.OData.Query.SemanticAst.RangeVariable": { "properties": { "name": { "readOnly": true, "type": "string" }, "typeReference": { "$ref": "#/definitions/Microsoft.Data.Edm.IEdmTypeReference", "readOnly": true }, "kind": { "readOnly": true, "type": "integer", "format": "int32" } }, "xml": { "name": "RangeVariable" }, "type": "object" }, "Microsoft.Data.Edm.IEdmTypeReference": { "properties": { "isNullable": { "readOnly": true, "type": "boolean" }, "definition": { "$ref": "#/definitions/Microsoft.Data.Edm.IEdmType", "readOnly": true } }, "xml": { "name": "IEdmTypeReference" }, "type": "object" }, "Microsoft.Data.Edm.IEdmTerm": { "properties": { "termKind": { "readOnly": true, "type": "string", "enum": [ "None", "Type", "Value" ] }, "schemaElementKind": { "readOnly": true, "type": "string", "enum": [ "None", "TypeDefinition", "Function", "ValueTerm", "EntityContainer" ] }, "namespace": { "readOnly": true, "type": "string" }, "name": { "readOnly": true, "type": "string" } }, "xml": { "name": "IEdmTerm" }, "type": "object" }, "Microsoft.Data.Edm.IEdmVocabularyAnnotatable": { "properties": {}, "xml": { "name": "IEdmVocabularyAnnotatable" }, "type": "object" }, "OAS.WebApi.Code.Projection.ProjectionManipulatorOfOAS.WebApi.DTO.Portfolio.RegistrationDto": { "properties": { "type": { "readOnly": true, "type": "string" }, "hasImpact": { "readOnly": true, "type": "boolean" }, "top": { "readOnly": true, "type": "integer", "format": "int32" }, "skip": { "readOnly": true, "type": "integer", "format": "int32" }, "requestedProperties": { "description": "The properties the user specifically asked for", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" }, "requiredProperties": { "description": "The properties that are required to fulfill the requested properties", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProjectionManipulator`1" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.MoveRegistrationDto": { "properties": { "registrationIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, "xml": { "name": "MoveRegistrationDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.LinkedAccountsDto": { "description": "DTO for unlinked accounts that can be linked to another account", "properties": { "id": { "description": "Account ID", "type": "integer", "format": "int32" }, "name": { "description": "Account Name", "type": "string" }, "number": { "description": "Account Number", "type": "string" }, "accountType": { "description": "Account Type", "type": "string" }, "custodian": { "description": "Custodian", "type": "string" }, "managementStyle": { "description": "Management Style", "type": "string" }, "fundFamily": { "description": "Fund Family", "type": "string" }, "shareClass": { "description": "Share Class", "type": "string" }, "isActive": { "description": "Whether the account is active", "type": "boolean" }, "registrationId": { "description": "Registration ID", "type": "integer", "format": "int32" } }, "xml": { "name": "LinkedAccountsDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ClientPayoutOptionDto": { "properties": { "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "clientRepAdditionals": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientRepAdditionalDetailDto" }, "xml": { "name": "ClientRepAdditionalDetailDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ClientPayoutOptionDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RegistrationTypeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "sRegCode": { "type": "string" }, "sRegDesc": { "type": "string" }, "taxType": { "type": "string", "enum": [ "Taxable", "TaxDeferred", "TaxFree" ] }, "isQual": { "type": "boolean" }, "isIRA": { "type": "boolean" }, "is403b": { "type": "boolean" }, "isBIRA": { "type": "boolean" }, "includeInRMD": { "type": "boolean" }, "excludeFromRMDAggregation": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "planType": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "isMultipleOwners": { "type": "boolean" }, "externalCode": { "type": "string" }, "socialCode": { "type": "string" }, "commonCode": { "type": "string" }, "category": { "type": "string", "enum": [ "Organization", "Minor", "Individual", "Trust", "MultipleApplicants" ] }, "proposalCode": { "type": "string" }, "benTypes": { "type": "string" }, "isERISA": { "type": "boolean" }, "globalId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "RegistrationTypeDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ReportGroup.ReportGroupClientDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "email": { "type": "string" }, "state": { "type": "string" }, "numAccounts": { "type": "integer", "format": "int32" }, "value": { "type": "number", "format": "double" }, "reportName": { "type": "string" }, "isActualHH": { "type": "boolean" }, "deliveryMethod": { "type": "string" } }, "xml": { "name": "ReportGroupClientDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ReportGroup.ReportGroupClientFullDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "representativeId": { "type": "integer", "format": "int32" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "address3": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "value": { "type": "number", "format": "double" }, "reportName": { "type": "string" }, "isActualHH": { "type": "boolean" }, "deliveryMethodId": { "type": "integer", "format": "int32" }, "additionalAccounts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAccountWithValueWeighted" }, "xml": { "name": "SimpleAccountWithValueWeighted", "wrapped": true }, "type": "array" } }, "xml": { "name": "ReportGroupClientFullDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SimpleAccountWithValueWeighted": { "properties": { "weight": { "type": "number", "format": "double" }, "value": { "type": "number", "format": "double" }, "number": { "type": "string" }, "managementStyle": { "type": "string" }, "isActive": { "type": "boolean" }, "clientId": { "type": "integer", "format": "int32" }, "custodian": { "type": "string" }, "registrationId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "SimpleAccountWithValueWeighted" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RepresentativeChangeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "representativeId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "changes": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RepresentativeChangeSetDto" }, "xml": { "name": "RepresentativeChangeSetDto", "wrapped": true }, "type": "array" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedBy": { "type": "string" } }, "xml": { "name": "RepresentativeChangeDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RepresentativeChangeSetDto": { "properties": { "entityType": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Rep", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Beneficiary", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QPEDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "Banking", "RMD", "Systematic", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "AdditionalRep", "DownloadSource", "DownloadRecord", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "oldEntityId": { "type": "integer", "format": "int32" }, "newEntityId": { "type": "integer", "format": "int32" }, "oldEntityName": { "type": "string" }, "newEntityName": { "type": "string" }, "actionType": { "type": "string", "enum": [ "None", "Inserted", "Updated", "Deleted" ] }, "isDeleted": { "type": "boolean" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "RepresentativeChangeSetDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RepresentativeVerboseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "portfolio": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RepresentativePortfolioDto" }, "notes": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.NoteDto" }, "xml": { "name": "NoteDto", "wrapped": true }, "type": "array" }, "documents": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DocumentDto" }, "xml": { "name": "DocumentDto", "wrapped": true }, "type": "array" }, "billRepresentativePlatforms": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillRepresentativePlatformDto" }, "xml": { "name": "BillRepresentativePlatformDto", "wrapped": true }, "type": "array" }, "repBrokerDealers": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RepBrokerDealerDto" }, "xml": { "name": "RepBrokerDealerDto", "wrapped": true }, "type": "array" }, "reportImage": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RepresentativeReportImageDto" }, "userDefinedFields": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "RepresentativeVerboseDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RepresentativePortfolioDto": { "properties": { "brokerDealerId": { "type": "integer", "format": "int32" }, "wholesalerId": { "type": "integer", "format": "int32" }, "payeeId": { "type": "integer", "format": "int32" }, "payoutOverride": { "type": "number", "format": "double" }, "riaId": { "type": "integer", "format": "int32" }, "wholesaler401KId": { "type": "integer", "format": "int32" }, "planAdministratorId": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "createdDate": { "type": "string", "format": "date-time" }, "copyToRep": { "type": "boolean" }, "isRIA": { "type": "boolean" }, "riaName": { "type": "string" }, "royalTCode": { "type": "string" }, "hasADV": { "type": "boolean" }, "hasU4": { "type": "boolean" }, "isActive": { "type": "boolean" }, "isDstDwnld": { "type": "boolean" }, "branchID": { "type": "string" }, "oldRep_ID": { "type": "integer", "format": "int32" }, "number": { "type": "string" }, "impDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "firstTransactionDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "repStatus": { "type": "string", "enum": [ "ActiveNoIssues", "HoldForCompliance", "ActiveNoNewClients", "InActive", "Pending", "Limited", "Prospect", "Rejected" ] }, "firmName": { "type": "string" }, "actgLedgerNum": { "type": "string" }, "isDefault": { "type": "boolean" }, "importKey": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "raAmount": { "type": "number", "format": "double" }, "raDate": { "type": "string", "format": "date-time" }, "isRAActive": { "type": "boolean" }, "repRestrict": { "type": "string" }, "custodianPortalId": { "type": "string" }, "name": { "type": "string" }, "salutation": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "address3": { "type": "string" }, "zip": { "type": "string" }, "homePhone": { "type": "string" }, "homePhoneExt": { "type": "string" }, "fax": { "type": "string" }, "faxExt": { "type": "string" }, "pager": { "type": "string" }, "pagerExt": { "type": "string" }, "mobilePhone": { "type": "string" }, "businessPhone": { "type": "string" }, "businessPhoneExt": { "type": "string" }, "otherPhone": { "type": "string" }, "otherPhoneExt": { "type": "string" }, "reportName": { "type": "string" }, "company": { "type": "string" }, "jobTitle": { "type": "string" }, "ssN_TaxID": { "type": "string" }, "gender": { "type": "string" }, "dob": { "type": "string", "format": "date-time" }, "webAddress": { "type": "string" }, "lastName": { "type": "string" }, "firstName": { "type": "string" }, "prefix": { "type": "string" }, "suffix": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "city": { "type": "string" }, "state": { "type": "string" }, "email": { "type": "string" }, "repNasds": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RepNasdDto" }, "xml": { "name": "RepNasdDto", "wrapped": true }, "type": "array" }, "repOnHolds": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RepOnHoldDto" }, "xml": { "name": "RepOnHoldDto", "wrapped": true }, "type": "array" }, "repStates": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RepStateDto" }, "xml": { "name": "RepStateDto", "wrapped": true }, "type": "array" }, "payoutDashNotCompliance": { "type": "boolean" }, "repCRDNumber": { "type": "string" } }, "xml": { "name": "RepresentativePortfolioDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillRepresentativePlatformDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "billFeeScheduleId": { "type": "integer", "format": "int32" }, "platformId": { "type": "integer", "format": "int32" }, "billMasterPayoutScheduleId": { "type": "integer", "format": "int32" } }, "xml": { "name": "BillRepresentativePlatformDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RepBrokerDealerDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "representativeId": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "brokerDealerId": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "isSystemGenerated": { "type": "boolean" }, "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" } }, "xml": { "name": "RepBrokerDealerDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RepresentativeReportImageDto": { "properties": { "representativeId": { "type": "integer", "format": "int32" }, "image": { "type": "string", "format": "byte" }, "height": { "type": "number", "format": "double" }, "width": { "type": "number", "format": "double" }, "barColor": { "type": "string", "maxLength": 50, "minLength": 0 } }, "xml": { "name": "RepresentativeReportImageDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RepNasdDto": { "properties": { "nasdId": { "type": "integer", "format": "int32" }, "representativeId": { "type": "integer", "format": "int32" }, "number": { "type": "string" } }, "xml": { "name": "RepNasdDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RepOnHoldDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "entityEnum": { "type": "integer", "format": "int32" }, "holdDate": { "type": "string", "format": "date-time" }, "holdStatus": { "type": "string" } }, "xml": { "name": "RepOnHoldDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RepStateDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "stateId": { "type": "integer", "format": "int32" }, "stateName": { "type": "string" } }, "xml": { "name": "RepStateDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RepresentativeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "repNo": { "type": "string" }, "fullName": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "phoneNumber": { "type": "string" }, "email": { "type": "string" }, "company": { "type": "string" }, "mobilePhoneNumber": { "type": "string" }, "faxNumber": { "type": "string" }, "brokerDealer": { "type": "string" }, "businessPhoneNumber": { "type": "string" }, "households": { "type": "integer", "format": "int32" }, "value": { "type": "number", "format": "double" }, "isActive": { "type": "boolean" }, "accountingLedgerNo": { "type": "string" }, "branch": { "type": "string" }, "copyToRep": { "type": "boolean" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "default": { "type": "boolean" }, "destinationDownload": { "type": "boolean" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "firmName": { "type": "string" }, "hasADV": { "type": "boolean" }, "hasU4": { "type": "boolean" }, "importKey": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "payee": { "type": "integer", "format": "int32" }, "planAdministrator": { "type": "integer", "format": "int32" }, "raActive": { "type": "boolean" }, "raAmount": { "type": "number", "format": "double" }, "raDate": { "type": "string", "format": "date-time" }, "repRestriction": { "type": "string" }, "riaId": { "type": "integer", "format": "int32" }, "riaName": { "type": "string" }, "royalTCode": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "ActiveNoIssues", "HoldForCompliance", "ActiveNoNewClients", "InActive", "Pending", "Limited", "Prospect", "Rejected" ] }, "wholeSaler": { "type": "string" }, "custodianId": { "type": "integer", "format": "int32" }, "brokerDealerId": { "type": "integer", "format": "int32" }, "custodianPortalId": { "type": "string" }, "repCRDNumber": { "type": "string" }, "globalId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "RepresentativeDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RepresentativeFileDto": { "properties": { "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" }, "openWith": { "type": "string" }, "blobDesc": { "type": "string" }, "category": { "type": "string" }, "blobType": { "type": "string", "enum": [ "QuarterlyStatements", "CrmDocuments", "Payable" ] } }, "xml": { "name": "RepresentativeFileDto" }, "type": "object" }, "OAS.DataModel.Portfolio.ReturnObjective": { "required": [ "id", "description" ], "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string", "maxLength": 25, "minLength": 0 }, "seqNo": { "type": "integer", "format": "int32" } }, "xml": { "name": "ReturnObjective" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RiaDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "isActive": { "type": "boolean" }, "description": { "type": "string" }, "fiscalStartDate": { "type": "string" }, "fiscalEndDate": { "type": "string" }, "payeeId": { "type": "integer", "format": "int32" }, "billingStyle": { "type": "integer", "format": "int32" }, "isSolicitor": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "importKey": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "entityName": { "type": "string" }, "email": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "salutation": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "address3": { "type": "string" }, "zip": { "type": "string" }, "fax": { "type": "string" }, "faxExt": { "type": "string" }, "mobilePhone": { "type": "string" }, "businessPhone": { "type": "string" }, "businessPhoneExt": { "type": "string" }, "otherPhone": { "type": "string" }, "otherPhoneExt": { "type": "string" }, "company": { "type": "string" }, "jobTitle": { "type": "string" }, "webAddress": { "type": "string" }, "globalId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "RiaDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RiskCategoryVerboseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "portfolio": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RiskCategoryPortfolioDto" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "RiskCategoryVerboseDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RiskCategoryPortfolioDto": { "properties": { "abbreviation": { "type": "string" }, "fullName": { "type": "string" }, "color": { "type": "string" }, "symbol": { "type": "string" }, "rank": { "type": "integer", "format": "int32" }, "productDescriptionProviderId": { "type": "integer", "format": "int32" }, "productDescriptionProviderName": { "type": "string" }, "value": { "type": "number", "format": "double" }, "isCategoryExcluded": { "type": "boolean" } }, "xml": { "name": "RiskCategoryPortfolioDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RiskCategoryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "abbreviation": { "type": "string" }, "fullName": { "type": "string" }, "color": { "type": "string" }, "symbol": { "type": "string" }, "rank": { "type": "integer", "format": "int32" }, "productDescriptionProviderId": { "type": "integer", "format": "int32" }, "productDescriptionProvider": { "type": "string" }, "value": { "type": "number", "format": "double" }, "isCategoryExcluded": { "type": "boolean" } }, "xml": { "name": "RiskCategoryDto" }, "type": "object" }, "OAS.DataModel.Portfolio.SimpleRiskCategory": { "properties": { "RiskCategoryId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "riskAbbrev": { "type": "string" }, "riskFullName": { "type": "string" }, "name": { "type": "string" } }, "xml": { "name": "SimpleRiskCategory" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RiskCategoryAutoAssignOverrideDto": { "properties": { "productDescriptionProviderId": { "type": "integer", "format": "int32" }, "providerName": { "type": "string" }, "abbreviation": { "type": "string" }, "riskDescription": { "type": "string" }, "hasMultipleDescriptions": { "type": "boolean" }, "riskCategoryAutoAssignOverrideId": { "type": "integer", "format": "int32" }, "riskCategoryId": { "type": "integer", "format": "int32" }, "providerAssigned": { "type": "boolean" } }, "xml": { "name": "RiskCategoryAutoAssignOverrideDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RiskCategoryAutoAssignOverrideKeyDto": { "properties": { "productDescriptionProviderId": { "type": "integer", "format": "int32" }, "abbreviation": { "type": "string" } }, "xml": { "name": "RiskCategoryAutoAssignOverrideKeyDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SecurityClassification.DerivationGlobalDto": { "required": [ "securityClassificationMethodId", "baseSecurityClassId" ], "properties": { "securityClassificationMethodId": { "type": "integer", "format": "int32" }, "securityClassificationMethod": { "type": "string" }, "baseSecurityClassId": { "type": "integer", "format": "int32" }, "baseSecurityClass": { "type": "string" }, "baseSecurityClassCode": { "type": "string" }, "baseClassificationMethod": { "type": "string" }, "baseClassificationMethodId": { "type": "integer", "format": "int32" }, "derivedSecurityClassId": { "type": "integer", "format": "int32" }, "derivedSecurityClass": { "type": "string" }, "derivedSecurityClassCode": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedBy": { "type": "string" } }, "xml": { "name": "DerivationGlobalDto" }, "type": "object" }, "OAS.WebApi.Code.Projection.ProjectionManipulatorOfOAS.WebApi.DTO.Portfolio.SecurityClassification.DerivationGlobalDto": { "properties": { "type": { "readOnly": true, "type": "string" }, "hasImpact": { "readOnly": true, "type": "boolean" }, "top": { "readOnly": true, "type": "integer", "format": "int32" }, "skip": { "readOnly": true, "type": "integer", "format": "int32" }, "requestedProperties": { "description": "The properties the user specifically asked for", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" }, "requiredProperties": { "description": "The properties that are required to fulfill the requested properties", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProjectionManipulator`1" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SecurityClassification.DerivationLocalDto": { "required": [ "securityClassificationMethodId", "baseSecurityClassId", "derivedSecurityClassId" ], "properties": { "securityClassificationMethodId": { "type": "integer", "format": "int32" }, "securityClassificationMethod": { "type": "string" }, "baseSecurityClassId": { "type": "integer", "format": "int32" }, "baseSecurityClass": { "type": "string" }, "baseSecurityClassCode": { "type": "string" }, "baseClassificationMethod": { "type": "string" }, "baseClassificationMethodId": { "type": "integer", "format": "int32" }, "derivedSecurityClassId": { "type": "integer", "format": "int32" }, "derivedSecurityClass": { "type": "string" }, "derivedSecurityClassCode": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedBy": { "type": "string" } }, "xml": { "name": "DerivationLocalDto" }, "type": "object" }, "OAS.WebApi.Code.Projection.ProjectionManipulatorOfOAS.WebApi.DTO.Portfolio.SecurityClassification.DerivationLocalDto": { "properties": { "type": { "readOnly": true, "type": "string" }, "hasImpact": { "readOnly": true, "type": "boolean" }, "top": { "readOnly": true, "type": "integer", "format": "int32" }, "skip": { "readOnly": true, "type": "integer", "format": "int32" }, "requestedProperties": { "description": "The properties the user specifically asked for", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" }, "requiredProperties": { "description": "The properties that are required to fulfill the requested properties", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProjectionManipulator`1" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodRuleDataSetDto": { "properties": { "fieldEnum": { "type": "integer", "format": "int32" }, "fieldName": { "type": "string" }, "fieldTypeEnum": { "type": "integer", "format": "int32" }, "fieldType": { "readOnly": true, "type": "string" }, "dataSourceJSON": { "type": "string" }, "isWeighted": { "type": "boolean" }, "placeholder": { "type": "string", "enum": [ "Years", "Decimal" ] } }, "xml": { "name": "MethodRuleDataSetDto" }, "type": "object" }, "OAS.WebApi.Code.Projection.ProjectionManipulatorOfOAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassGlobalDto": { "properties": { "type": { "readOnly": true, "type": "string" }, "hasImpact": { "readOnly": true, "type": "boolean" }, "top": { "readOnly": true, "type": "integer", "format": "int32" }, "skip": { "readOnly": true, "type": "integer", "format": "int32" }, "requestedProperties": { "description": "The properties the user specifically asked for", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" }, "requiredProperties": { "description": "The properties that are required to fulfill the requested properties", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProjectionManipulator`1" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassGlobalDto": { "required": [ "securityClassificationMethodId", "securityClass", "securityClassCode" ], "properties": { "id": { "type": "integer", "format": "int32" }, "securityClassificationMethodId": { "type": "integer", "format": "int32" }, "securityClassificationMethod": { "type": "string" }, "securityClass": { "type": "string", "maxLength": 1000, "minLength": 0 }, "securityClassCode": { "type": "string", "maxLength": 1000, "minLength": 0 }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedBy": { "type": "string" }, "securityClassificationMethodType": { "type": "string", "enum": [ "Rules / Assigned", "Inherited", "Global", "Global Inherited", "Compounding", "GICS", "Product Description", "Product Description Weighted", "Product Exchange", "Global Weighted" ] } }, "xml": { "name": "SecurityClassGlobalDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassAssociationCountsDto": { "properties": { "methodCount": { "type": "integer", "format": "int32" }, "methodRuleCount": { "type": "integer", "format": "int32" }, "assignedSecurityClassesCount": { "type": "integer", "format": "int32" }, "securityClassificationProductCount": { "type": "integer", "format": "int32" } }, "xml": { "name": "SecurityClassAssociationCountsDto" }, "type": "object" }, "OAS.WebApi.Code.Projection.ProjectionManipulatorOfOAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassLocalDto": { "properties": { "type": { "readOnly": true, "type": "string" }, "hasImpact": { "readOnly": true, "type": "boolean" }, "top": { "readOnly": true, "type": "integer", "format": "int32" }, "skip": { "readOnly": true, "type": "integer", "format": "int32" }, "requestedProperties": { "description": "The properties the user specifically asked for", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" }, "requiredProperties": { "description": "The properties that are required to fulfill the requested properties", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProjectionManipulator`1" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassLocalDto": { "required": [ "securityClassificationMethodId", "securityClass", "securityClassCode" ], "properties": { "id": { "type": "integer", "format": "int32" }, "securityClassificationMethodId": { "type": "integer", "format": "int32" }, "securityClassificationMethod": { "type": "string" }, "securityClass": { "type": "string", "maxLength": 1000, "minLength": 0 }, "securityClassCode": { "type": "string", "maxLength": 1000, "minLength": 0 }, "securityClassGlobalId": { "type": "integer", "format": "int32" }, "securityClassificationMethodGlobalId": { "type": "integer", "format": "int32" }, "securityClassificationMethodGlobal": { "type": "string" }, "excludeFromFeesAndPayouts": { "type": "boolean" }, "color": { "type": "string" }, "sortOrder": { "type": "integer", "format": "int32" }, "riskScore": { "type": "number", "format": "double" }, "productDescriptionProviderId": { "type": "integer", "format": "int32" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedBy": { "type": "string" }, "securityClassificationMethodType": { "type": "string", "enum": [ "Rules / Assigned", "Inherited", "Global", "Global Inherited", "Compounding", "GICS", "Product Description", "Product Description Weighted", "Product Exchange", "Global Weighted" ] } }, "xml": { "name": "SecurityClassLocalDto" }, "type": "object" }, "OAS.WebApi.Code.Projection.ProjectionManipulatorOfOAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassificationProductOverrideLocalDto": { "properties": { "type": { "readOnly": true, "type": "string" }, "hasImpact": { "readOnly": true, "type": "boolean" }, "top": { "readOnly": true, "type": "integer", "format": "int32" }, "skip": { "readOnly": true, "type": "integer", "format": "int32" }, "requestedProperties": { "description": "The properties the user specifically asked for", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" }, "requiredProperties": { "description": "The properties that are required to fulfill the requested properties", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProjectionManipulator`1" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassificationProductOverrideLocalDto": { "required": [ "securityClassId", "securityClassificationMethodId", "entityEnum", "entityId", "productId" ], "properties": { "securityClassId": { "type": "integer", "format": "int32" }, "securityClass": { "type": "string" }, "securityClassificationMethodId": { "type": "integer", "format": "int32" }, "securityClassificationMethod": { "type": "string" }, "entityEnum": { "type": "string", "pattern": "^(Undefined|Payee|BrokerDealer|Wholesaler|Representative|Client|Registration|Account|Asset|Product|Transaction|Distribution|FundFamily|Personal|PayoutSchedule|FeeSchedule|Platform|RIA|Custodian|Journal|SWP|Other|NASD|CashFunding|Bill|BillInstance|BillMasterPayout|Model|NewAccountClient|NewAccountReg|DownloadExclusion|Price|UserDefinedFields|NewAcctUserDef|ManagersMessage|IndexEntry|OneTimeDistribution|WebLogin|Plan401k|CRMEmailList|EntityOption|RegistrationType|ProductType|ProductSubType|OrionRealizedLot|OrionUnrealizedLot|CustodianRealizedLot|CustodianUnrealizedLot|TaxType|ProductPropertyType|RegistrationTaxType|BillEntity|BillEntityType|SecurityClassification1|SecurityClassification2|SecurityClassification3|SecurityClassification4|SecurityClassification5|SecurityClassification6|SecurityClassification7|SecurityClassification8|SecurityClassification9|SecurityClassification10|SecurityClassification11|SecurityClassification12|SecurityClassification13|SecurityClassification14|SecurityClassification15|SecurityClassification16|SecurityClassification17|SecurityClassification18|SecurityClassification19|SecurityClassification20|SecurityClassification21|SecurityClassification22|SecurityClassification23|SecurityClassification24|SecurityClassification25)$", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "entityName": { "type": "string" }, "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "ticker": { "type": "string" }, "cusip": { "type": "string" }, "productType": { "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, "productSubTypeName": { "type": "string" }, "classificationWeight": { "type": "number", "format": "double" }, "auditedByDisplay": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "isRemoved": { "type": "boolean" } }, "xml": { "name": "SecurityClassificationProductOverrideLocalDto" }, "type": "object" }, "OAS.WebApi.Code.Projection.ProjectionManipulatorOfOAS.WebApi.DTO.Portfolio.SecurityClassification.MethodAlClientGlobalDto": { "properties": { "type": { "readOnly": true, "type": "string" }, "hasImpact": { "readOnly": true, "type": "boolean" }, "top": { "readOnly": true, "type": "integer", "format": "int32" }, "skip": { "readOnly": true, "type": "integer", "format": "int32" }, "requestedProperties": { "description": "The properties the user specifically asked for", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" }, "requiredProperties": { "description": "The properties that are required to fulfill the requested properties", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProjectionManipulator`1" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodAlClientGlobalDto": { "required": [ "securityClassificationMethodId", "alClientId" ], "properties": { "securityClassificationMethod": { "type": "string" }, "securityClassificationMethodId": { "type": "integer", "format": "int32" }, "productDescriptionProvider": { "type": "string" }, "baseSecurityClassificationMethod": { "type": "string" }, "baseSecurityClassificationMethodId": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "clientName": { "type": "string" }, "dbName": { "type": "string" }, "advisorNumber": { "type": "integer", "format": "int32" }, "dbIsActive": { "type": "boolean" }, "dbActiveDate": { "type": "string", "format": "date-time" }, "dbInActiveDate": { "type": "string", "format": "date-time" }, "masterGroup": { "type": "string" }, "isDemo": { "type": "boolean" }, "firmType": { "type": "string", "enum": [ "None", "Foundations", "Essentials", "Advantage", "OrionTradingOnly", "OrionRiskOnly", "OrionComplianceOnly", "OrionPlanningOnly", "OasLegacy" ] }, "auditedByDisplay": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "MethodAlClientGlobalDto" }, "type": "object" }, "OAS.WebApi.Code.Projection.ProjectionManipulatorOfOAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassificationProductGlobalDto": { "properties": { "type": { "readOnly": true, "type": "string" }, "hasImpact": { "readOnly": true, "type": "boolean" }, "top": { "readOnly": true, "type": "integer", "format": "int32" }, "skip": { "readOnly": true, "type": "integer", "format": "int32" }, "requestedProperties": { "description": "The properties the user specifically asked for", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" }, "requiredProperties": { "description": "The properties that are required to fulfill the requested properties", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProjectionManipulator`1" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassificationProductGlobalDto": { "required": [ "securityClassId", "securityClassificationMethodId", "productId" ], "properties": { "securityClassId": { "type": "integer", "format": "int32" }, "securityClassificationMethodId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "ticker": { "type": "string" }, "cusip": { "type": "string" }, "productType": { "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, "productSubTypeName": { "type": "string" }, "classificationWeight": { "type": "number", "format": "double" }, "isRemoved": { "type": "boolean" }, "assignmentType": { "type": "boolean" } }, "xml": { "name": "SecurityClassificationProductGlobalDto" }, "type": "object" }, "OAS.WebApi.Code.Projection.ProjectionManipulatorOfOAS.WebApi.DTO.Portfolio.SecurityClassification.MethodLocalDto": { "properties": { "type": { "readOnly": true, "type": "string" }, "hasImpact": { "readOnly": true, "type": "boolean" }, "top": { "readOnly": true, "type": "integer", "format": "int32" }, "skip": { "readOnly": true, "type": "integer", "format": "int32" }, "requestedProperties": { "description": "The properties the user specifically asked for", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" }, "requiredProperties": { "description": "The properties that are required to fulfill the requested properties", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProjectionManipulator`1" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodLocalDto": { "required": [ "classificationMethod", "classificationMethodDescription", "securityClassificationType", "isTradingEnabled" ], "properties": { "id": { "type": "integer", "format": "int32" }, "auditedBy": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "classificationMethod": { "type": "string" }, "classificationMethodDescription": { "type": "string" }, "classificationMethodGlobalId": { "type": "integer", "format": "int32" }, "classificationMethodGlobal": { "type": "string" }, "isActive": { "type": "boolean" }, "lastCalculated": { "type": "string", "format": "date-time" }, "securityClassDefault": { "type": "string" }, "securityClassDefaultId": { "type": "integer", "format": "int32" }, "securityClassificationMethodBase": { "type": "string" }, "securityClassificationMethodBaseId": { "type": "integer", "format": "int32" }, "securityClassificationType": { "type": "string", "enum": [ "Rules / Assigned", "Inherited", "Global", "Global Inherited", "Compounding", "GICS", "Product Description", "Product Description Weighted", "Product Exchange", "Global Weighted" ] }, "entityEnum": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "isTradingEnabled": { "type": "boolean" }, "isBillingEnabled": { "type": "boolean" }, "recalculationSchedule": { "type": "string", "enum": [ "On Demand", "Daily", "Weekly", "Monthly" ] }, "recalculationHour": { "type": "integer", "format": "int32" }, "isCopyingFromGlobal": { "type": "boolean" }, "useParentProductAssignment": { "type": "boolean" }, "lastUpdated": { "type": "string", "format": "date-time" } }, "xml": { "name": "MethodLocalDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodLocalAssociationCountsDto": { "properties": { "securityClasssesCount": { "type": "integer", "format": "int32" }, "securityClassificationRulesCount": { "type": "integer", "format": "int32" }, "securityClassificationProductsCount": { "type": "integer", "format": "int32" } }, "xml": { "name": "MethodLocalAssociationCountsDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SecurityClassification.MigrateSecurityClassificationRequestDto": { "properties": { "codes": { "items": { "type": "string" }, "type": "array" } }, "xml": { "name": "MigrateSecurityClassificationRequestDto" }, "type": "object" }, "OAS.WebApi.Code.Projection.ProjectionManipulatorOfOAS.WebApi.DTO.Portfolio.SecurityClassification.MethodRuleLocalDto": { "properties": { "type": { "readOnly": true, "type": "string" }, "hasImpact": { "readOnly": true, "type": "boolean" }, "top": { "readOnly": true, "type": "integer", "format": "int32" }, "skip": { "readOnly": true, "type": "integer", "format": "int32" }, "requestedProperties": { "description": "The properties the user specifically asked for", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" }, "requiredProperties": { "description": "The properties that are required to fulfill the requested properties", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProjectionManipulator`1" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodRuleLocalDto": { "required": [ "classificationMethodId", "ruleConfiguration" ], "properties": { "classificationMethodId": { "type": "integer", "format": "int32" }, "classificationMethod": { "type": "string" }, "runOrder": { "type": "integer", "format": "int32" }, "ruleConfiguration": { "type": "string" }, "securityClassId": { "type": "integer", "format": "int32" }, "securityClassCode": { "type": "string" }, "securityClass": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedBy": { "type": "string" }, "securityClassificationMethodForRuleId": { "type": "integer", "format": "int32" }, "securityClassificationMethodRuleType": { "type": "string", "enum": [ "Security Class", "Classification Method" ] } }, "xml": { "name": "MethodRuleLocalDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SecurityClassification.ClassificationMethodLocalVerboseDto": { "properties": { "methodLocal": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodLocalDto" }, "derivationsLocal": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.DerivationLocalDto" }, "xml": { "name": "DerivationLocalDto", "wrapped": true }, "type": "array" }, "securityClassesLocal": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassLocalDto" }, "xml": { "name": "SecurityClassLocalDto", "wrapped": true }, "type": "array" }, "methodRulesLocal": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodRuleLocalDto" }, "xml": { "name": "MethodRuleLocalDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ClassificationMethodLocalVerboseDto" }, "type": "object" }, "OAS.WebApi.Code.Projection.ProjectionManipulatorOfOAS.WebApi.DTO.Portfolio.SecurityClassification.MethodRuleGlobalDto": { "properties": { "type": { "readOnly": true, "type": "string" }, "hasImpact": { "readOnly": true, "type": "boolean" }, "top": { "readOnly": true, "type": "integer", "format": "int32" }, "skip": { "readOnly": true, "type": "integer", "format": "int32" }, "requestedProperties": { "description": "The properties the user specifically asked for", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" }, "requiredProperties": { "description": "The properties that are required to fulfill the requested properties", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProjectionManipulator`1" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodRuleGlobalDto": { "required": [ "classificationMethodId", "ruleConfiguration" ], "properties": { "classificationMethodId": { "type": "integer", "format": "int32" }, "classificationMethod": { "type": "string" }, "runOrder": { "type": "integer", "format": "int32" }, "ruleConfiguration": { "type": "string" }, "securityClassId": { "type": "integer", "format": "int32" }, "securityClassCode": { "type": "string" }, "securityClass": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedBy": { "type": "string" }, "securityClassificationMethodForRuleId": { "type": "integer", "format": "int32" }, "securityClassificationMethodRuleType": { "type": "string", "enum": [ "Security Class", "Classification Method" ] } }, "xml": { "name": "MethodRuleGlobalDto" }, "type": "object" }, "OAS.WebApi.Code.Projection.ProjectionManipulatorOfOAS.WebApi.DTO.Portfolio.SecurityClassification.MethodGlobalDto": { "properties": { "type": { "readOnly": true, "type": "string" }, "hasImpact": { "readOnly": true, "type": "boolean" }, "top": { "readOnly": true, "type": "integer", "format": "int32" }, "skip": { "readOnly": true, "type": "integer", "format": "int32" }, "requestedProperties": { "description": "The properties the user specifically asked for", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" }, "requiredProperties": { "description": "The properties that are required to fulfill the requested properties", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProjectionManipulator`1" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodGlobalDto": { "required": [ "classificationMethod", "classificationMethodDescription", "isRestricted", "securityClassificationType" ], "properties": { "id": { "type": "integer", "format": "int32" }, "auditedBy": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "classificationMethod": { "type": "string" }, "classificationMethodDescription": { "type": "string" }, "isActive": { "type": "boolean" }, "isRestricted": { "type": "boolean" }, "lastCalculated": { "type": "string", "format": "date-time" }, "securityClassDefault": { "type": "string" }, "securityClassDefaultId": { "type": "integer", "format": "int32" }, "securityClassificationMethodBase": { "type": "string" }, "securityClassificationMethodBaseId": { "type": "integer", "format": "int32" }, "securityClassificationType": { "type": "string", "pattern": "^(RulesAssigned|Inherited|Global|GlobalInherited|Compounding|GICS|ProductDescription|ProductDescriptionWeighted|ProductExchange)$", "enum": [ "Rules / Assigned", "Inherited", "Global", "Global Inherited", "Compounding", "GICS", "Product Description", "Product Description Weighted", "Product Exchange", "Global Weighted" ] }, "recalculationSchedule": { "type": "string", "enum": [ "On Demand", "Daily", "Weekly", "Monthly" ] }, "recalculationHour": { "type": "integer", "format": "int32" }, "productDescriptionProviderId": { "type": "integer", "format": "int32" }, "productExchangeEnum": { "type": "string", "enum": [ "Stock Status", "Company Name", "Company Status", "Status Type", "Is MLP", "Is BDC", "Country", "Business Country", "Domicile Country", "Place Of Incorporation", "Is REIT", "Is Limited Partnership", "Is Limited Liability Company", "Stock Type", "Is Shell", "Is SPAC" ] } }, "xml": { "name": "MethodGlobalDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SecurityClassification.ClassificationMethodGlobalVerboseDto": { "properties": { "methodGlobal": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodGlobalDto" }, "securityClassesGlobal": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassGlobalDto" }, "xml": { "name": "SecurityClassGlobalDto", "wrapped": true }, "type": "array" }, "derivationsGlobal": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.DerivationGlobalDto" }, "xml": { "name": "DerivationGlobalDto", "wrapped": true }, "type": "array" }, "methodRulesGlobal": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SecurityClassification.MethodRuleGlobalDto" }, "xml": { "name": "MethodRuleGlobalDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ClassificationMethodGlobalVerboseDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassificationGlobalAssignmentRequestDto": { "properties": { "requestId": { "description": "Gets or sets the unique identifier for the request. Required when more than one request is made.", "type": "integer", "format": "int32" }, "securityClassificationMethodId": { "description": "Gets or sets the identifier for the security classification method.", "type": "integer", "format": "int32" }, "productIds": { "description": "Gets or sets the list of product identifiers associated with the request.", "items": { "type": "integer", "format": "int32" }, "type": "array" } }, "xml": { "name": "SecurityClassificationGlobalAssignmentRequestDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassificationGlobalAssignmentResponseDto": { "properties": { "requestId": { "description": "Gets or sets the ID of the request.", "type": "integer", "format": "int32" }, "securityClassificationMethodId": { "description": "Gets or sets the ID of the security classification method.", "type": "integer", "format": "int32" }, "productId": { "description": "Gets or sets the ID of the product.", "type": "integer", "format": "int32" }, "securityClassId": { "description": "Gets or sets the ID of the security class.", "type": "integer", "format": "int32" }, "weighting": { "description": "Gets or sets the weighting value.", "type": "number", "format": "double" }, "securityClass": { "description": "Gets or sets the name of the security class.", "type": "string" }, "securityClassCode": { "description": "Gets or sets the code of the security class.", "type": "string" } }, "xml": { "name": "SecurityClassificationGlobalAssignmentResponseDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassificationGlobalAssignmentBySymbolResponseDto": { "properties": { "symbol": { "description": "Gets or sets the original symbol sent in request payload.", "type": "string" }, "securityClassificationMethodId": { "description": "Gets or sets the ID of the security classification method.", "type": "integer", "format": "int32" }, "productId": { "description": "Gets or sets the ID of the product.", "type": "integer", "format": "int32" }, "securityClassId": { "description": "Gets or sets the ID of the security class.", "type": "integer", "format": "int32" }, "weighting": { "description": "Gets or sets the weighting value.", "type": "number", "format": "double" }, "securityClass": { "description": "Gets or sets the name of the security class.", "type": "string" }, "securityClassCode": { "description": "Gets or sets the code of the security class.", "type": "string" } }, "xml": { "name": "SecurityClassificationGlobalAssignmentBySymbolResponseDto" }, "type": "object" }, "OAS.WebApi.Code.Projection.ProjectionManipulatorOfOAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassificationProductLocalDto": { "properties": { "type": { "readOnly": true, "type": "string" }, "hasImpact": { "readOnly": true, "type": "boolean" }, "top": { "readOnly": true, "type": "integer", "format": "int32" }, "skip": { "readOnly": true, "type": "integer", "format": "int32" }, "requestedProperties": { "description": "The properties the user specifically asked for", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" }, "requiredProperties": { "description": "The properties that are required to fulfill the requested properties", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProjectionManipulator`1" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassificationProductLocalDto": { "required": [ "securityClassId", "securityClassificationMethodId", "productId" ], "properties": { "securityClassId": { "type": "integer", "format": "int32" }, "securityClass": { "type": "string" }, "securityClassCode": { "type": "string" }, "securityClassificationMethodId": { "type": "integer", "format": "int32" }, "securityClassificationMethod": { "type": "string" }, "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "ticker": { "type": "string" }, "cusip": { "type": "string" }, "productType": { "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, "productSubTypeName": { "type": "string" }, "classificationWeight": { "type": "number", "format": "double" }, "assignmentType": { "type": "boolean" }, "isRemoved": { "type": "boolean" }, "isImplicit": { "type": "boolean" }, "downloadSymbols": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DownloadSymbolSimpleDto" }, "xml": { "name": "DownloadSymbolSimpleDto", "wrapped": true }, "type": "array" }, "canReadCusip": { "type": "boolean" } }, "xml": { "name": "SecurityClassificationProductLocalDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassificationAssignmentRequestDto": { "properties": { "requestId": { "description": "Gets or sets the unique identifier for the request. Required when more than one request is made. Optional for single requests.", "type": "integer", "format": "int32" }, "securityClassificationMethodId": { "description": "Gets or sets the identifier for the security classification method.", "type": "integer", "format": "int32" }, "reportGroupingEntityEnum": { "description": "Gets or sets the report grouping entity enumeration value.", "type": "integer", "format": "int32" }, "productIds": { "description": "Gets or sets the list of product identifiers associated with the request.", "items": { "type": "integer", "format": "int32" }, "type": "array" }, "entityEnumOverride": { "description": "Gets or sets the entity enumeration override value.", "type": "integer", "format": "int32" }, "entityEnumOverrideIds": { "description": "Gets or sets the list of entity enumeration override identifiers.", "items": { "type": "integer", "format": "int32" }, "type": "array" } }, "xml": { "name": "SecurityClassificationAssignmentRequestDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SecurityClassification.SecurityClassificationAssignmentResponseDto": { "properties": { "requestId": { "description": "Gets or sets the ID of the request.", "type": "integer", "format": "int32" }, "securityClassificationMethodId": { "description": "Gets or sets the ID of the security classification method.", "type": "integer", "format": "int32" }, "reportGroupingEntityEnum": { "description": "Gets or sets the report grouping entity enumeration value.", "type": "integer", "format": "int32" }, "productId": { "description": "Gets or sets the ID of the product.", "type": "integer", "format": "int32" }, "securityClassId": { "description": "Gets or sets the ID of the security class.", "type": "integer", "format": "int32" }, "weighting": { "description": "Gets or sets the weighting value.", "type": "number", "format": "double" }, "overrideEntityEnum": { "description": "Gets or sets the override entity enumeration value.", "type": "integer", "format": "int32" }, "overrideEntityId": { "description": "Gets or sets the ID of the override entity.", "type": "integer", "format": "int32" }, "securityClass": { "description": "Gets or sets the name of the security class.", "type": "string" }, "securityClassCode": { "description": "Gets or sets the code of the security class.", "type": "string" } }, "xml": { "name": "SecurityClassificationAssignmentResponseDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ShareClassDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "class": { "type": "string" }, "description": { "type": "string" } }, "xml": { "name": "ShareClassDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.Sleeve.AssetSleeveDto": { "properties": { "assetId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "productId": { "type": "integer", "format": "int32" }, "ticker": { "type": "string" }, "currentQuantity": { "type": "number", "format": "double" }, "transferQuantity": { "type": "number", "format": "double" }, "remainingQuantity": { "type": "number", "format": "double" }, "modelFromAccountId": { "type": "integer", "format": "int32" }, "modelFromAccountName": { "type": "string" }, "modelFromAggId": { "type": "integer", "format": "int32" }, "modelToAccountId": { "type": "integer", "format": "int32" }, "modelToAccountName": { "type": "string" }, "modelToAggId": { "type": "integer", "format": "int32" }, "journalDate": { "type": "string", "format": "date-time" }, "lastTransactionDate": { "type": "string", "format": "date-time" }, "useNonBilledJournals": { "type": "boolean" }, "assetClass": { "type": "string" }, "riskCategory": { "type": "string" }, "registrationId": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "sleeveType": { "type": "string", "enum": [ "Normal sleeve", "Custodial account", "Contribution sleeve", "Distribution sleeve", "Unmanaged sleeve" ] }, "transType": { "type": "string" }, "currentValue": { "type": "number", "format": "double" }, "eclipseEnabled": { "type": "boolean" } }, "xml": { "name": "AssetSleeveDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.Sleeve.SleeveProductModelDto": { "properties": { "sleeveModels": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.Sleeve.SleeveModelDto" }, "readOnly": true, "xml": { "name": "SleeveModelDto", "wrapped": true }, "type": "array" }, "sleeveModelsByRegistrationId": { "additionalProperties": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.Sleeve.SleeveProductAvailableModel" }, "xml": { "name": "SleeveProductAvailableModel", "wrapped": true }, "type": "array" }, "readOnly": true, "type": "object" }, "sleeveModelsByProductId": { "additionalProperties": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.Sleeve.SleeveProductAvailableModel" }, "xml": { "name": "SleeveProductAvailableModel", "wrapped": true }, "type": "array" }, "readOnly": true, "type": "object" } }, "xml": { "name": "SleeveProductModelDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.Sleeve.SleeveModelDto": { "properties": { "assetId": { "readOnly": true, "type": "integer", "format": "int32" }, "accountId": { "readOnly": true, "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "registrationId": { "readOnly": true, "type": "integer", "format": "int32" }, "modelAggId": { "readOnly": true, "type": "integer", "format": "int32" }, "modelName": { "readOnly": true, "type": "string" }, "sleeveType": { "readOnly": true, "type": "string", "enum": [ "Normal sleeve", "Custodial account", "Contribution sleeve", "Distribution sleeve", "Unmanaged sleeve" ] }, "displayModelName": { "readOnly": true, "type": "string" } }, "xml": { "name": "SleeveModelDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.Sleeve.SleeveProductAvailableModel": { "properties": { "modelAggId": { "readOnly": true, "type": "integer", "format": "int32" }, "modelName": { "readOnly": true, "type": "string" }, "sleeveType": { "readOnly": true, "type": "string", "enum": [ "Normal sleeve", "Custodial account", "Contribution sleeve", "Distribution sleeve", "Unmanaged sleeve" ] }, "displayModelName": { "readOnly": true, "type": "string" }, "accountId": { "readOnly": true, "type": "integer", "format": "int32" } }, "xml": { "name": "SleeveProductAvailableModel" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.Sleeve.SleeveTransferBatchDto": { "properties": { "id": { "type": "integer", "format": "int64" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "registrationsImpacted": { "type": "integer", "format": "int32" }, "assetsImpacted": { "type": "integer", "format": "int32" }, "transactionsCreated": { "type": "integer", "format": "int32" } }, "xml": { "name": "SleeveTransferBatchDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.Sleeve.SleeveTransferBatchTransactionDto": { "properties": { "registrationId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "assetId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "modelName": { "type": "string" }, "transactionDate": { "type": "string", "format": "date-time" }, "transType": { "type": "string" }, "transferQuantity": { "type": "number", "format": "double" }, "registrationName": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "householdName": { "type": "string" }, "householdId": { "type": "integer", "format": "int32" }, "transactionId": { "type": "integer", "format": "int32" }, "modelId": { "type": "integer", "format": "int32" } }, "xml": { "name": "SleeveTransferBatchTransactionDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.StateDto": { "properties": { "abbreviation": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "StateDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SubAdvisor.SubAdvisorVerboseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "portfolio": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SubAdvisor.SubAdvisorPortfolioDto" }, "notes": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.NoteDto" }, "xml": { "name": "NoteDto", "wrapped": true }, "type": "array" }, "logo": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SubAdvisor.SubAdvisorLogoDto" }, "documents": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DocumentDto" }, "xml": { "name": "DocumentDto", "wrapped": true }, "type": "array" }, "entities": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SubAdvisor.SubAdvisorEntityDto" }, "xml": { "name": "SubAdvisorEntityDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "SubAdvisorVerboseDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SubAdvisor.SubAdvisorPortfolioDto": { "properties": { "blockAccountNumber": { "type": "string" }, "saCode": { "type": "string" }, "description": { "type": "string" }, "payeeId": { "type": "integer", "format": "int32" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "name": { "type": "string" }, "isActive": { "type": "boolean" }, "company": { "type": "string" }, "jobTitle": { "type": "string" }, "ssN_TaxID": { "type": "string" }, "dob": { "type": "string", "format": "date-time" }, "gender": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "addressLine3": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "salutation": { "type": "string" }, "homePhone": { "type": "string" }, "homePhoneExt": { "type": "string" }, "mobilePhone": { "type": "string" }, "businessPhone": { "type": "string" }, "businessPhoneExt": { "type": "string" }, "otherPhone": { "type": "string" }, "otherPhoneExt": { "type": "string" }, "fax": { "type": "string" }, "faxExt": { "type": "string" }, "pager": { "type": "string" }, "pagerExt": { "type": "string" }, "email": { "type": "string" }, "webAddress": { "type": "string" }, "getTargetAllocEmail": { "type": "boolean" }, "targetAllocEmails": { "type": "string" }, "eclipseFirmId": { "type": "integer", "format": "int32" }, "isOciSyncEnable": { "type": "boolean" } }, "xml": { "name": "SubAdvisorPortfolioDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SubAdvisor.SubAdvisorLogoDto": { "properties": { "image": { "type": "string", "format": "byte" } }, "xml": { "name": "SubAdvisorLogoDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SubAdvisor.SubAdvisorEntityDto": { "properties": { "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" } }, "xml": { "name": "SubAdvisorEntityDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SubAdvisorDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "email": { "type": "string" }, "isActive": { "type": "boolean" }, "subAdvisorCode": { "type": "string" }, "payeeName": { "type": "string" } }, "xml": { "name": "SubAdvisorDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SubAdvisorFileDto": { "properties": { "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" }, "openWith": { "type": "string" }, "blobDesc": { "type": "string" }, "category": { "type": "string" }, "blobType": { "type": "string", "enum": [ "CrmDocuments" ] } }, "xml": { "name": "SubAdvisorFileDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AssetTaxLotDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "aquiredDate": { "type": "string" }, "isCash": { "type": "boolean" }, "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "symbol": { "type": "string" }, "totalCost": { "type": "number", "format": "double" }, "units": { "type": "number", "format": "double" }, "costBasisPerUnit": { "type": "number", "format": "double" }, "cusip": { "type": "string" }, "taxTransType": { "type": "string", "enum": [ "Sell", "Buy", "WashSale", "NotUsed", "MoneyMarket", "StepUp", "Spinoff" ] }, "transactionId": { "type": "integer", "format": "int32" }, "transDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "AssetTaxLotDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AssetTranLotDto": { "properties": { "pkTransaction": { "type": "integer", "format": "int32" }, "transDate": { "type": "string", "format": "date-time" }, "noUnits": { "type": "number", "format": "double" }, "transAmount": { "type": "number", "format": "double" }, "unitCost": { "type": "number", "format": "double" }, "description": { "type": "string" }, "unitsRemaining": { "type": "number", "format": "double" }, "unitsSold": { "type": "number", "format": "double" } }, "xml": { "name": "AssetTranLotDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.TranTaxLotDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "transactionId": { "type": "integer", "format": "int32" }, "tranBuyId": { "type": "integer", "format": "int32" }, "noUnits": { "type": "number", "format": "double" }, "description": { "type": "string" }, "taxLotType": { "type": "string", "enum": [ "None", "SpecificId", "LinkedHistory", "Normal", "Unrealized", "StepUp", "Spinoff" ] } }, "xml": { "name": "TranTaxLotDto" }, "type": "object" }, "OAS.DataModel.Portfolio.TimeHorizon": { "required": [ "id", "description", "seqNo" ], "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string", "maxLength": 25, "minLength": 0 }, "seqNo": { "type": "integer", "format": "int32" } }, "xml": { "name": "TimeHorizon" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.TransactionVerboseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "isDataSharingEntity": { "type": "boolean" }, "portfolio": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionPortfolioDto" }, "billing": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionBillingDto" }, "costBasis": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasisDto" }, "xml": { "name": "CostBasisDto", "wrapped": true }, "type": "array" }, "additionalInformation": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PortfolioTransactionAdditionalInformationDto" }, "alternative": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionVerboseAlternativeDto" }, "userDefinedFields": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" }, "transactionFee": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionFeeDto" }, "xml": { "name": "TransactionFeeDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "TransactionVerboseDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.TransactionPortfolioDto": { "properties": { "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "ticker": { "type": "string" }, "transDate": { "type": "string", "format": "date-time" }, "transTime": { "type": "string", "format": "date-time" }, "transAmount": { "type": "number", "format": "double" }, "navPrice": { "type": "number", "format": "double" }, "noUnits": { "type": "number", "format": "double" }, "assetId": { "type": "integer", "format": "int32" }, "status": { "type": "string", "enum": [ "Complete", "Pending", "Rejected", "Reversed", "Inactive", "PendingCorpAction", "FutureAip" ] }, "transactionDescription": { "type": "string" }, "notes": { "type": "string" }, "transTypeId": { "type": "integer", "format": "int32" }, "transactionSubTypeId": { "type": "integer", "format": "int32" }, "transactionSubTypeName": { "type": "string" }, "contributionCodeId": { "type": "integer", "format": "int32" }, "distributionCodeId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "managementStyle": { "type": "string" }, "payee": { "type": "integer", "format": "int32" }, "advisorNotes": { "type": "string" }, "state": { "type": "string" }, "settleDate": { "type": "string", "format": "date-time" }, "tradeReferenceNumber": { "type": "string" }, "transactionLinkCode": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "registrationId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "typeCode": { "type": "string" }, "typeSource": { "type": "string" }, "signField": { "type": "string" }, "eclipseOrderId": { "type": "integer", "format": "int32" }, "performanceFeeBreak": { "type": "boolean" }, "financialType": { "type": "string", "enum": [ "None", "Contribution", "Distribution", "Exchange", "DivReinvest", "MgmntFees", "DivCash", "MiscFees", "Journal", "Merges" ] }, "fileTranCode": { "type": "string" } }, "xml": { "name": "TransactionPortfolioDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.TransactionBillingDto": { "properties": { "isNMReady": { "type": "boolean" }, "isBilled": { "type": "boolean" }, "isAdvanceBilled": { "type": "boolean" }, "isCashFlow": { "type": "boolean" }, "billedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "TransactionBillingDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.CostBasisDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "costDate": { "type": "string", "format": "date-time" }, "holdingPeriodDate": { "type": "string", "format": "date-time" }, "costUnits": { "type": "number", "format": "double" }, "costPrice": { "type": "number", "format": "double" }, "costTotal": { "type": "number", "format": "double" }, "costNotes": { "type": "string" }, "transTypeId": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "CostBasisDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.PortfolioTransactionAdditionalInformationDto": { "properties": { "yieldToMaturity": { "type": "number", "format": "double" }, "isOID": { "type": "boolean" }, "tradeRequestId": { "type": "integer", "format": "int32" }, "commIndicator": { "type": "integer", "format": "int32" }, "orderType": { "type": "integer", "format": "int32" }, "marketCode": { "type": "integer", "format": "int32" }, "blotterCode": { "type": "integer", "format": "int32" }, "distIndicator": { "type": "integer", "format": "int32" }, "revenueType": { "type": "integer", "format": "int32" }, "spreadStraddle": { "type": "integer", "format": "int32" }, "brokerCode": { "type": "string" }, "includeAsRmdDistribution": { "type": "boolean" }, "includeAsRmdDistributionIsSystemMaintained": { "type": "boolean" }, "divExDate": { "type": "string", "format": "date-time" }, "oidInterest": { "type": "number", "format": "double" } }, "xml": { "name": "PortfolioTransactionAdditionalInformationDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.TransactionVerboseAlternativeDto": { "properties": { "impactsCommitment": { "type": "boolean" }, "impactsCapitalBalance": { "type": "boolean" }, "originalCost": { "type": "number", "format": "double" }, "originalCostDate": { "type": "string", "format": "date-time" }, "equityFundingType": { "type": "string" }, "equityFundingTypeId": { "type": "integer", "format": "int32" }, "equityActivityType": { "type": "string" }, "equityActivityTypeId": { "type": "integer", "format": "int32" }, "productTransactionId": { "type": "integer", "format": "int32" }, "cashDate": { "type": "string", "format": "date-time" }, "isParent": { "type": "boolean" } }, "xml": { "name": "TransactionVerboseAlternativeDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.TransactionFeeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "transactionFeeTypeId": { "type": "integer", "format": "int32" }, "feeAmount": { "type": "number", "format": "double" }, "fileFeeDescription": { "type": "string" }, "feeType": { "type": "string" } }, "xml": { "name": "TransactionFeeDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.TransactionBaseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "transDate": { "type": "string", "format": "date-time" }, "transactionDescription": { "type": "string" }, "productName": { "type": "string" }, "ticker": { "type": "string" }, "transAmount": { "type": "number", "format": "double" }, "noUnits": { "type": "number", "format": "double" }, "navPrice": { "type": "number", "format": "double" }, "accountNumber": { "type": "string" }, "status": { "type": "string", "enum": [ "Complete", "Pending", "Rejected", "Reversed", "Inactive", "PendingCorpAction", "FutureAip" ] }, "fileTranCode": { "type": "string" }, "type": { "type": "string" }, "transTime": { "type": "string", "format": "date-time" }, "assetId": { "type": "integer", "format": "int32" }, "assetStatusId": { "type": "integer", "format": "int32" }, "cusip": { "type": "string" }, "notes": { "type": "string" }, "transTypeId": { "type": "integer", "format": "int32" }, "transactionSubTypeId": { "type": "integer", "format": "int32" }, "transactionSubTypeName": { "type": "string" }, "transactionSubTypeDescription": { "type": "string" }, "contributionCodeId": { "type": "integer", "format": "int32" }, "contributionCodeName": { "type": "string" }, "distributionCodeId": { "type": "integer", "format": "int32" }, "distributionCodeName": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "accountStatusId": { "type": "integer", "format": "int32" }, "managementStyle": { "type": "string" }, "payee": { "type": "integer", "format": "int32" }, "advisorNotes": { "type": "string" }, "state": { "type": "string" }, "settleDate": { "type": "string", "format": "date-time" }, "tradeReferenceNumber": { "type": "string" }, "transactionLinkCode": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "registrationId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "typeCode": { "type": "string" }, "brokerCode": { "type": "string" }, "accountType": { "type": "string" }, "fundFamily": { "type": "string" }, "custodian": { "type": "string" }, "count": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "unitBalance": { "type": "number", "format": "double" }, "productId": { "type": "integer", "format": "int32" }, "performanceFeeBreak": { "type": "boolean" }, "financialType": { "type": "string", "enum": [ "None", "Contribution", "Distribution", "Exchange", "DivReinvest", "MgmntFees", "DivCash", "MiscFees", "Journal", "Merges" ] } }, "xml": { "name": "TransactionBaseDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.TransactionAlternativeDto": { "properties": { "impactsCommitment": { "type": "boolean" }, "impactsCapitalBalance": { "type": "boolean" }, "originalCost": { "type": "number", "format": "double" }, "originalCostDate": { "type": "string", "format": "date-time" }, "equityFundingType": { "type": "string" }, "equityFundingTypeId": { "type": "integer", "format": "int32" }, "equityActivityType": { "type": "string" }, "equityActivityTypeId": { "type": "integer", "format": "int32" }, "costBasis": { "type": "number", "format": "double" }, "productTransactionId": { "type": "integer", "format": "int32" }, "cashDate": { "type": "string", "format": "date-time" }, "id": { "type": "integer", "format": "int32" }, "transDate": { "type": "string", "format": "date-time" }, "transactionDescription": { "type": "string" }, "productName": { "type": "string" }, "ticker": { "type": "string" }, "transAmount": { "type": "number", "format": "double" }, "noUnits": { "type": "number", "format": "double" }, "navPrice": { "type": "number", "format": "double" }, "accountNumber": { "type": "string" }, "status": { "type": "string", "enum": [ "Complete", "Pending", "Rejected", "Reversed", "Inactive", "PendingCorpAction", "FutureAip" ] }, "fileTranCode": { "type": "string" }, "type": { "type": "string" }, "transTime": { "type": "string", "format": "date-time" }, "assetId": { "type": "integer", "format": "int32" }, "assetStatusId": { "type": "integer", "format": "int32" }, "cusip": { "type": "string" }, "notes": { "type": "string" }, "transTypeId": { "type": "integer", "format": "int32" }, "transactionSubTypeId": { "type": "integer", "format": "int32" }, "transactionSubTypeName": { "type": "string" }, "transactionSubTypeDescription": { "type": "string" }, "contributionCodeId": { "type": "integer", "format": "int32" }, "contributionCodeName": { "type": "string" }, "distributionCodeId": { "type": "integer", "format": "int32" }, "distributionCodeName": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "accountStatusId": { "type": "integer", "format": "int32" }, "managementStyle": { "type": "string" }, "payee": { "type": "integer", "format": "int32" }, "advisorNotes": { "type": "string" }, "state": { "type": "string" }, "settleDate": { "type": "string", "format": "date-time" }, "tradeReferenceNumber": { "type": "string" }, "transactionLinkCode": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "registrationId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "typeCode": { "type": "string" }, "brokerCode": { "type": "string" }, "accountType": { "type": "string" }, "fundFamily": { "type": "string" }, "custodian": { "type": "string" }, "count": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "unitBalance": { "type": "number", "format": "double" }, "productId": { "type": "integer", "format": "int32" }, "performanceFeeBreak": { "type": "boolean" }, "financialType": { "type": "string", "enum": [ "None", "Contribution", "Distribution", "Exchange", "DivReinvest", "MgmntFees", "DivCash", "MiscFees", "Journal", "Merges" ] } }, "xml": { "name": "TransactionAlternativeDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.TransactionSimpleDto": { "properties": { "transDate": { "type": "string", "format": "date-time" }, "productName": { "type": "string" }, "ticker": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "TransactionSimpleDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ValidateClientFPFDto": { "required": [ "id", "cycleMonth" ], "properties": { "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" }, "warningMessage": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "payMethod": { "type": "string", "maxLength": 25, "minLength": 0 }, "feeSchedule": { "type": "string", "maxLength": 50, "minLength": 0 }, "frequency": { "type": "string", "maxLength": 50, "minLength": 0 }, "payoutSchedule": { "type": "string", "maxLength": 50, "minLength": 0 }, "cycleMonth": { "type": "integer", "format": "int32" }, "style": { "type": "string", "maxLength": 50, "minLength": 0 }, "startDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "ValidateClientFPFDto" }, "type": "object" }, "OAS.DataModel.Portfolio.ClientFPF": { "required": [ "id", "cycleMonth" ], "properties": { "id": { "type": "integer", "format": "int32" }, "payMethod": { "type": "string", "maxLength": 25, "minLength": 0 }, "feeSchedule": { "type": "string", "maxLength": 50, "minLength": 0 }, "frequency": { "type": "string", "maxLength": 50, "minLength": 0 }, "payoutSchedule": { "type": "string", "maxLength": 50, "minLength": 0 }, "cycleMonth": { "type": "integer", "format": "int32" }, "style": { "type": "string", "maxLength": 50, "minLength": 0 }, "startDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "ClientFPF" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ProductCategoryWeightedValidationDto": { "properties": { "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" }, "warningMessage": { "type": "string" }, "recordId": { "type": "string" }, "productName": { "type": "string" }, "productId": { "type": "integer", "format": "int32" }, "productCategoryId": { "type": "integer", "format": "int32" }, "categoryName": { "type": "string" }, "weight": { "type": "number", "format": "double" } }, "xml": { "name": "ProductCategoryWeightedValidationDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.TransactionVerboseValidationDto": { "properties": { "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" }, "warningMessage": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "isDataSharingEntity": { "type": "boolean" }, "portfolio": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionPortfolioDto" }, "billing": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionBillingDto" }, "costBasis": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.CostBasisDto" }, "xml": { "name": "CostBasisDto", "wrapped": true }, "type": "array" }, "additionalInformation": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.PortfolioTransactionAdditionalInformationDto" }, "alternative": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionVerboseAlternativeDto" }, "userDefinedFields": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" }, "transactionFee": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TransactionFeeDto" }, "xml": { "name": "TransactionFeeDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "TransactionVerboseValidationDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ValidateAccountSloaDto": { "properties": { "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" }, "warningMessage": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "sloaDate": { "type": "string", "format": "date-time" }, "thirdParty": { "type": "string" }, "isAffiliated": { "type": "boolean" }, "distributionType": { "type": "string", "enum": [ "Wire", "Journal", "EFT", "Check", "Other" ] }, "isActive": { "type": "boolean" }, "notes": { "type": "string" } }, "xml": { "name": "ValidateAccountSloaDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ProductsPricesLocalValidationDto": { "properties": { "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" }, "warningMessage": { "type": "string" }, "ticker": { "type": "string" }, "recordId": { "type": "string" }, "productId": { "type": "integer", "format": "int32" }, "priceDate": { "type": "string", "format": "date-time" }, "navPrice": { "type": "number", "format": "double" }, "priceSource": { "type": "string", "enum": [ "NotSpecified", "ManuallyEntered", "OrionCopy", "ConversionData" ] }, "auditedBy": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "ProductsPricesLocalValidationDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.TargetAllocationAccountValidationDto": { "properties": { "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" }, "warningMessage": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "number": { "type": "string" }, "isDataSharingEntity": { "type": "boolean" }, "isAstroEnabled": { "type": "boolean" }, "billing": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountBillingDto" }, "portfolio": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountPortfolioDto" }, "modelingInfo": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountModelingInfoDto" }, "notes": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.NoteDto" }, "xml": { "name": "NoteDto", "wrapped": true }, "type": "array" }, "documents": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DocumentDto" }, "xml": { "name": "DocumentDto", "wrapped": true }, "type": "array" }, "compliance": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ComplianceDto" }, "systematics": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SystematicDto" }, "xml": { "name": "SystematicDto", "wrapped": true }, "type": "array" }, "accountManagers": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountManagerDto" }, "xml": { "name": "AccountManagerDto", "wrapped": true }, "type": "array" }, "recurringAdjustments": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BillRecurrentAdjustmentDto" }, "xml": { "name": "BillRecurrentAdjustmentDto", "wrapped": true }, "type": "array" }, "generalAccounts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.GeneralAccountDto" }, "xml": { "name": "GeneralAccountDto", "wrapped": true }, "type": "array" }, "referralSchedules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.AccountReferralDto" }, "xml": { "name": "AccountReferralDto", "wrapped": true }, "type": "array" }, "billAccountSchedules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BillAccountScheduleDto" }, "xml": { "name": "BillAccountScheduleDto", "wrapped": true }, "type": "array" }, "userDefinedFields": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" }, "targetAllocations": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TargetAllocationDto" }, "xml": { "name": "TargetAllocationDto", "wrapped": true }, "type": "array" }, "productEquivalents": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ProductEquivalentDto" }, "xml": { "name": "ProductEquivalentDto", "wrapped": true }, "type": "array" }, "sma": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountSmaDto" }, "bondTrade": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.AccountBondTradeDto" }, "compositeExclusions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.CompositeAccountExcludeDto" }, "xml": { "name": "CompositeAccountExcludeDto", "wrapped": true }, "type": "array" }, "futureCashflows": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountFutureCashflowDto" }, "xml": { "name": "AccountFutureCashflowDto", "wrapped": true }, "type": "array" }, "growthRates": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountGrowthRateDto" }, "xml": { "name": "AccountGrowthRateDto", "wrapped": true }, "type": "array" }, "goals": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountGoalDto" }, "xml": { "name": "AccountGoalDto", "wrapped": true }, "type": "array" }, "suitability": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountSuitabilityDto" }, "permissibleAggregateModels": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.SimpleAggregateModel" }, "xml": { "name": "SimpleAggregateModel", "wrapped": true }, "type": "array" }, "astroTaxSchedules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.AstroAccountTaxSchedulesDto" }, "xml": { "name": "AstroAccountTaxSchedulesDto", "wrapped": true }, "type": "array" }, "astroAccount": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.AstroAccountDto" }, "taxRates": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountTaxRateDto" }, "xml": { "name": "AccountTaxRateDto", "wrapped": true }, "type": "array" }, "additionalClients": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientAdditionalAccountDto" }, "xml": { "name": "ClientAdditionalAccountDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "TargetAllocationAccountValidationDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.TargetAllocationClientValidationDto": { "properties": { "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" }, "warningMessage": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "globalId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "isDataSharingEntity": { "type": "boolean" }, "billing": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientBillingDto" }, "recurringAdjustments": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BillRecurrentAdjustmentDto" }, "xml": { "name": "BillRecurrentAdjustmentDto", "wrapped": true }, "type": "array" }, "feePayingAccounts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BillFeePayingAccountDto" }, "xml": { "name": "BillFeePayingAccountDto", "wrapped": true }, "type": "array" }, "tieredFeeAccounts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.TieredFeeAccountDto" }, "xml": { "name": "TieredFeeAccountDto", "wrapped": true }, "type": "array" }, "householdBills": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.HouseholdBillDto" }, "xml": { "name": "HouseholdBillDto", "wrapped": true }, "type": "array" }, "financialPlanningFee": { "$ref": "#/definitions/OAS.WebApi.DTO.Billing.BillFinancialPlanningFeeDto" }, "portfolio": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientPortfolioDto" }, "householdMembers": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.HouseholdMemberDto" }, "xml": { "name": "HouseholdMemberDto", "wrapped": true }, "type": "array" }, "notes": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.NoteDto" }, "xml": { "name": "NoteDto", "wrapped": true }, "type": "array" }, "documents": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DocumentDto" }, "xml": { "name": "DocumentDto", "wrapped": true }, "type": "array" }, "additionalAccounts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AdditionalAccountDto" }, "xml": { "name": "AdditionalAccountDto", "wrapped": true }, "type": "array" }, "suitability": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientSuitabilityDto" }, "userDefinedFields": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" }, "entityOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" }, "targetAllocations": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.TargetAllocationDto" }, "xml": { "name": "TargetAllocationDto", "wrapped": true }, "type": "array" }, "creditCard": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientCreditCardSimpleDto" }, "assetExclusions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientAssetExclusionDto" }, "xml": { "name": "ClientAssetExclusionDto", "wrapped": true }, "type": "array" }, "portfolioGroups": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientPortfolioGroupDto" }, "xml": { "name": "ClientPortfolioGroupDto", "wrapped": true }, "type": "array" }, "appLinks": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientAppLinkDto" }, "xml": { "name": "ClientAppLinkDto", "wrapped": true }, "type": "array" }, "additionalRepresentatives": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AdditionalRepresentativeDto" }, "xml": { "name": "AdditionalRepresentativeDto", "wrapped": true }, "type": "array" }, "clientRepAdditional": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientRepAdditionalDto" } }, "xml": { "name": "TargetAllocationClientValidationDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.NewAccountValidationDto": { "properties": { "importType": { "type": "string", "enum": [ "Standard", "Simple" ] }, "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "client": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ClientVerboseDto" }, "registration": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationVerboseDto" }, "account": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountVerboseDto" } }, "xml": { "name": "NewAccountValidationDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.AccountMergeValidationDto": { "properties": { "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" }, "warningMessage": { "type": "string" }, "oldAccountId": { "type": "integer", "format": "int32" }, "newAccountId": { "type": "integer", "format": "int32" } }, "xml": { "name": "AccountMergeValidationDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ValidateImport.ValidatePortfolioRmdUpdateDto": { "properties": { "registrationId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "year": { "type": "integer", "format": "int32" }, "yearEndValue": { "type": "number", "format": "double" }, "rmdIsSatisfied": { "type": "boolean" }, "overrideRmdAmount": { "type": "number", "format": "double" }, "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" } }, "xml": { "name": "ValidatePortfolioRmdUpdateDto" }, "type": "object" }, "OAS.WebApi.DTO.Integrations.Astro.ValidateImport.ValidateTaxScheduleDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "year": { "type": "integer", "format": "int32" }, "q1Percent": { "type": "number", "format": "double" }, "q2Percent": { "type": "number", "format": "double" }, "q3Percent": { "type": "number", "format": "double" }, "q4Percent": { "type": "number", "format": "double" }, "annualCapGain": { "type": "number", "format": "double" }, "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" }, "warningMessage": { "type": "string" } }, "xml": { "name": "ValidateTaxScheduleDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ValidateImport.MclWizardInstanceDto": { "properties": { "mclWizardInstanceId": { "type": "integer", "format": "int32" }, "importName": { "type": "string" }, "mclGrouping": { "type": "string", "enum": [ "HHGroupingCode", "HouseholdSSN", "Address1", "ConsolidatedHHGroupingCode" ] }, "currentStep": { "type": "string", "enum": [ "Household", "Representative", "RegistrationType", "Custodian", "FundFamily", "Registration", "Summary" ] }, "completed": { "type": "boolean" }, "recordCount": { "type": "integer", "format": "int32" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "MclWizardInstanceDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ValidateImport.MasterClientListValidatorDto": { "properties": { "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" }, "importName": { "type": "string" }, "grouping": { "type": "string", "enum": [ "HHGroupingCode", "HouseholdSSN", "Address1", "ConsolidatedHHGroupingCode" ] } }, "xml": { "name": "MasterClientListValidatorDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ValidateImport.MasterClientListInitialDto": { "properties": { "mclWizardInstanceId": { "type": "integer", "format": "int32" }, "errors": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ValidateImport.WizardImportErrorsDto" }, "xml": { "name": "WizardImportErrorsDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "MasterClientListInitialDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ValidateImport.WizardImportErrorsDto": { "properties": { "errorMessage": { "type": "string", "enum": [ "MissingHouseholdGroupingCode", "MissingHouseholdSSN", "MissingAddress1", "MissingHouseholdLastName", "MissingRepresentativeName", "MissingRegistrationLastName", "MissingRegistrationType", "MissingCustodian", "MissingAccountNumber", "MissingFundName", "UnrecognizedOpenClosed", "InvalidHouseholdDob", "InvalidRegistrationDob", "InvalidClientId", "AccountNumberExists", "AccountNumberDuplicate", "InvalidHouseholdSSN", "InvalidRegistrationSSN", "LengthErrorOutsideId" ] }, "errorCount": { "type": "integer", "format": "int32" }, "errorNotes": { "items": { "type": "string" }, "type": "array" } }, "xml": { "name": "WizardImportErrorsDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ValidateImport.MclWizardGroupErrorDto": { "properties": { "group": { "type": "string" }, "mclWizardDetailIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "errors": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ValidateImport.MclWizardGroupErrorDetailDto" }, "xml": { "name": "MclWizardGroupErrorDetailDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "MclWizardGroupErrorDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ValidateImport.MclWizardGroupErrorDetailDto": { "properties": { "displayName": { "type": "string" }, "property": { "type": "string" }, "choice": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ValidateImport.MclWizardGroupChoiceDto" }, "choices": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.ValidateImport.MclWizardGroupChoiceDto" }, "xml": { "name": "MclWizardGroupChoiceDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "MclWizardGroupErrorDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ValidateImport.MclWizardGroupChoiceDto": { "properties": { "value": { "type": "string" }, "isValid": { "type": "boolean" }, "count": { "type": "integer", "format": "int32" } }, "xml": { "name": "MclWizardGroupChoiceDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ValidateImport.MclWizardGeneralErrorDto": { "properties": { "displayName": { "type": "string" }, "property": { "type": "string" }, "mclWizardDetailIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "updateId": { "type": "integer", "format": "int32" }, "valueName": { "type": "string" }, "error": { "type": "string" }, "count": { "type": "integer", "format": "int32" } }, "xml": { "name": "MclWizardGeneralErrorDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ValidateImport.MclWizardValueErrorDto": { "properties": { "property": { "type": "string" }, "mclWizardDetailIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "value": { "type": "string" }, "error": { "type": "string" }, "count": { "type": "integer", "format": "int32" } }, "xml": { "name": "MclWizardValueErrorDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ValidateImport.ValidateImportMCLWizardSummaryDto": { "properties": { "statusIcon": { "type": "string" }, "mclWizardDetailID": { "type": "integer", "format": "int32" }, "hhGroupingCode": { "type": "string" }, "clientId": { "type": "integer", "format": "int32" }, "householdSSN": { "type": "string" }, "householdFirstName": { "type": "string" }, "householdLastName": { "type": "string" }, "householdName": { "type": "string" }, "representativeName": { "type": "string" }, "householdDOB": { "type": "string", "format": "date-time" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "email": { "type": "string" }, "homePhone": { "type": "string" }, "businessPhone": { "type": "string" }, "registrationSSN": { "type": "string" }, "registrationDOB": { "type": "string", "format": "date-time" }, "registrationFirstName": { "type": "string" }, "registrationLastName": { "type": "string" }, "registrationName": { "type": "string" }, "registrationType": { "type": "string" }, "custodian": { "type": "string" }, "accountNumber": { "type": "string" }, "fundFamilyName": { "type": "string" }, "openClosed": { "type": "string" }, "outsideId": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "accountID": { "type": "integer", "format": "int32" }, "registrationID": { "type": "integer", "format": "int32" } }, "xml": { "name": "ValidateImportMCLWizardSummaryDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ValidateImport.ValidatePortfolioParticipantDto": { "properties": { "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" }, "warningMessage": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "householdId": { "type": "integer", "format": "int32" }, "householdName": { "type": "string" }, "accountNumber": { "type": "string" }, "currValue": { "type": "number", "format": "double" }, "fundFamilyName": { "type": "string" }, "managementStyleName": { "type": "string" }, "houseHoldEmail": { "type": "string" }, "isActive": { "type": "boolean" }, "riskBudget": { "type": "integer", "format": "int32" }, "isLifestyleOption": { "type": "boolean" } }, "xml": { "name": "ValidatePortfolioParticipantDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.StoredPerformanceValidationDto": { "properties": { "id": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "periodStart": { "type": "string", "format": "date-time" }, "periodEnd": { "type": "string", "format": "date-time" }, "startValue": { "type": "number", "format": "double" }, "grossOfFees": { "type": "number", "format": "double" }, "netOfFees": { "type": "number", "format": "double" }, "cashFlow": { "type": "number", "format": "double" }, "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" }, "warningMessage": { "type": "string" } }, "xml": { "name": "StoredPerformanceValidationDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ProductClassWeightedValidationDto": { "properties": { "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" }, "warningMessage": { "type": "string" }, "recordId": { "type": "string" }, "productName": { "type": "string" }, "productId": { "type": "integer", "format": "int32" }, "productClassId": { "type": "integer", "format": "int32" }, "className": { "type": "string" }, "weight": { "type": "number", "format": "double" } }, "xml": { "name": "ProductClassWeightedValidationDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.WholesalerVerboseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "portfolio": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.WholesalerPortfolioDto" }, "notes": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.NoteDto" }, "xml": { "name": "NoteDto", "wrapped": true }, "type": "array" }, "documents": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.DocumentDto" }, "xml": { "name": "DocumentDto", "wrapped": true }, "type": "array" }, "userDefinedFields": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "WholesalerVerboseDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.WholesalerPortfolioDto": { "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "name": { "type": "string" }, "isActive": { "type": "boolean" }, "company": { "type": "string" }, "jobTitle": { "type": "string" }, "ssN_TaxID": { "type": "string" }, "dob": { "type": "string", "format": "date-time" }, "gender": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "addressLine3": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "salutation": { "type": "string" }, "homePhone": { "type": "string" }, "homePhoneExt": { "type": "string" }, "mobilePhone": { "type": "string" }, "businessPhone": { "type": "string" }, "businessPhoneExt": { "type": "string" }, "otherPhone": { "type": "string" }, "otherPhoneExt": { "type": "string" }, "fax": { "type": "string" }, "faxExt": { "type": "string" }, "pager": { "type": "string" }, "pagerExt": { "type": "string" }, "email": { "type": "string" }, "webAddress": { "type": "string" }, "wholesalerStates": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.WholesalerStateDto" }, "xml": { "name": "WholesalerStateDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "WholesalerPortfolioDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.WholesalerStateDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "stateId": { "type": "integer", "format": "int32" }, "stateName": { "type": "string" } }, "xml": { "name": "WholesalerStateDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.WholesalerDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "value": { "type": "number", "format": "double" }, "repCount": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "isActive": { "type": "boolean" } }, "xml": { "name": "WholesalerDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.WholesalerFileDto": { "properties": { "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" }, "openWith": { "type": "string" }, "blobDesc": { "type": "string" }, "category": { "type": "string" }, "blobType": { "type": "string", "enum": [ "CrmDocuments" ] } }, "xml": { "name": "WholesalerFileDto" }, "type": "object" }, "OAS.WebApi.DTO.PortfolioDataSync.DataSharingNotificationDto": { "properties": { "dataSharingSourceId": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "isAlertSource": { "type": "boolean" }, "isAlertDestination": { "type": "boolean" }, "isAlertMapping": { "type": "boolean" }, "isEmailAlert": { "type": "boolean" }, "isNotificationCenterAlert": { "type": "boolean" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "DataSharingNotificationDto" }, "type": "object" }, "OAS.WebApi.DTO.PortfolioDataSync.DataSharingSourceDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "alClientSourceId": { "type": "integer", "format": "int32" }, "alClientDestinationId": { "type": "integer", "format": "int32" }, "alClientSourceName": { "type": "string" }, "alClientDestinationName": { "type": "string" }, "sourceDescription": { "type": "string" }, "isActive": { "type": "boolean" }, "dataSharingSourceUID": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "firstErroredMapping": { "type": "string", "format": "date-time" }, "firstErroredDestination": { "type": "string", "format": "date-time" }, "firstErroredSource": { "type": "string", "format": "date-time" }, "lastProcessedSource": { "type": "string", "format": "date-time" }, "lastProcessedDestination": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "DataSharingSourceDto" }, "type": "object" }, "OAS.WebApi.DTO.PortfolioDataSync.DataSharingEntitySelectionDto": { "properties": { "dataSharingSourceId": { "type": "integer", "format": "int32" }, "entityEnum": { "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" }, "doesEntityExist": { "type": "boolean" }, "entityDescription": { "type": "string" }, "isInclude": { "type": "boolean" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "DataSharingEntitySelectionDto" }, "type": "object" }, "OAS.WebApi.DTO.PortfolioDataSync.DataSharingEntityMapDto": { "properties": { "dataSharingSourceId": { "type": "integer", "format": "int32" }, "entityEnum": { "type": "integer", "format": "int32" }, "entitySource": { "type": "integer", "format": "int32" }, "entityDescriptionSource": { "type": "string" }, "entityInfoSourceJSON": { "type": "string" }, "entityDestination": { "type": "integer", "format": "int32" }, "entityDescriptionDestination": { "type": "string" } }, "xml": { "name": "DataSharingEntityMapDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.CreateProductRequestDto": { "properties": { "ticker": { "type": "string" }, "name": { "type": "string" } }, "xml": { "name": "CreateProductRequestDto" }, "type": "object" }, "OAS.DataModel.Authentication.DatabaseInfo": { "properties": { "clientName": { "type": "string" }, "image": { "type": "string" }, "webOptions": { "additionalProperties": { "type": "string" }, "type": "object" }, "createLoginOptions": { "$ref": "#/definitions/OAS.DataModel.Authentication.CreateLoginOptions" } }, "xml": { "name": "DatabaseInfo" }, "type": "object" }, "OAS.DataModel.Authentication.CreateLoginOptions": { "properties": { "client": { "type": "string", "enum": [ "None", "SSNAndAcctNo", "SSNAndDOB" ] }, "representative": { "type": "string", "enum": [ "None", "SSNAndRepNo" ] } }, "xml": { "name": "CreateLoginOptions" }, "type": "object" }, "OAS.DataModel.Security.PartnerAppInfo": { "properties": { "id": { "type": "integer", "format": "int32" }, "partnerName": { "type": "string" }, "productName": { "type": "string" }, "productDescription": { "type": "string" }, "enabled": { "type": "boolean" }, "supportName": { "type": "string" }, "supportPhone": { "type": "string" }, "supportEmail": { "type": "string" }, "homePageURL": { "type": "string" }, "hasProductLogo": { "readOnly": true, "type": "boolean" }, "termsOfService": { "type": "string" }, "partnerAppType": { "type": "integer", "format": "int32" }, "productShortDescription": { "type": "string" } }, "xml": { "name": "PartnerAppInfo" }, "type": "object" }, "OAS.WebApi.DTO.Security.NewClientOrRepUserDto": { "properties": { "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "userName": { "type": "string" }, "ssn": { "type": "string" }, "birthDate": { "type": "string", "format": "date-time" }, "accountNumber": { "type": "string" }, "repNumber": { "type": "string" }, "securityQuestion": { "readOnly": true, "type": "string" }, "securityAnswer": { "readOnly": true, "type": "string" }, "captchaResponse": { "type": "string" }, "creatingEntity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "creatingEntityId": { "type": "integer", "format": "int32" } }, "xml": { "name": "NewClientOrRepUserDto" }, "type": "object" }, "OAS.WebApi.DTO.Authorization.RecaptchaResponseDto": { "properties": { "success": { "type": "boolean" }, "error-codes": { "items": { "type": "string" }, "type": "array" }, "clientId": { "type": "integer", "format": "int32" } }, "xml": { "name": "RecaptchaResponseDto" }, "type": "object" }, "OAS.DataProcess.QueryStudio.NaturalLanguage.AwsQueryTagChatMessage": { "properties": { "prompt": { "type": "string" }, "firmId": { "readOnly": true, "type": "integer", "format": "int32" }, "conversationHistories": { "items": { "$ref": "#/definitions/OAS.DataProcess.QueryStudio.NaturalLanguage.AIChatMessage" }, "xml": { "name": "AIChatMessage", "wrapped": true }, "type": "array" } }, "xml": { "name": "AwsQueryTagChatMessage" }, "type": "object" }, "OAS.DataProcess.QueryStudio.NaturalLanguage.AIChatMessage": { "properties": { "role": { "type": "string" }, "text": { "type": "string" } }, "xml": { "name": "AIChatMessage" }, "type": "object" }, "OAS.WebApi.DTO.QueryStudio.QueryDto": { "properties": { "id": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "legacyQueryId": { "type": "integer", "format": "int32" }, "queryTags": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.QueryStudio.QueryTagDto" }, "xml": { "name": "QueryTagDto", "wrapped": true }, "type": "array" }, "filters": { "$ref": "#/definitions/OAS.WebApi.DTO.QueryStudio.FilterGroupDto" }, "parameters": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.QueryStudio.QueryParameterDto" }, "xml": { "name": "QueryParameterDto", "wrapped": true }, "type": "array" }, "sorting": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.QueryStudio.QuerySortDto" }, "xml": { "name": "QuerySortDto", "wrapped": true }, "type": "array" }, "scopeSettings": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Calculate.ScopeSettingsDto" }, "auditedBy": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "queryId": { "type": "integer", "format": "int32" }, "canRun": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "canEdit": { "type": "boolean" } }, "xml": { "name": "QueryDto" }, "type": "object" }, "OAS.WebApi.DTO.QueryStudio.QueryTagDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" }, "tagDataType": { "type": "integer", "format": "int32" }, "sourceName": { "type": "string" }, "sourceType": { "type": "integer", "format": "int32" }, "keywords": { "type": "string" }, "category": { "type": "string" }, "isActive": { "type": "boolean" }, "isNullable": { "type": "boolean" }, "options": { "$ref": "#/definitions/OAS.WebApi.DTO.QueryStudio.QueryTagOptionsDto" }, "sourceParameters": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.QueryStudio.SourceParameterDto" }, "xml": { "name": "SourceParameterDto", "wrapped": true }, "type": "array" }, "guid": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "auditedBy": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "entityEnum": { "type": "integer", "format": "int32" }, "isDefaultTagForEntityEnum": { "type": "boolean" }, "selectExpression": { "type": "string" }, "isScope": { "readOnly": true, "type": "boolean" } }, "xml": { "name": "QueryTagDto" }, "type": "object" }, "OAS.WebApi.DTO.QueryStudio.FilterGroupDto": { "properties": { "logicalOperator": { "type": "string" }, "children": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.QueryStudio.FilterNodeDto" }, "xml": { "name": "FilterNodeDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "FilterGroupDto" }, "type": "object" }, "OAS.WebApi.DTO.QueryStudio.QueryParameterDto": { "properties": { "name": { "type": "string" }, "dataType": { "type": "string" }, "value": { "type": "object" } }, "xml": { "name": "QueryParameterDto" }, "type": "object" }, "OAS.WebApi.DTO.QueryStudio.QuerySortDto": { "properties": { "queryTagGuid": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "isAscending": { "type": "boolean" } }, "xml": { "name": "QuerySortDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Calculate.ScopeSettingsDto": { "properties": { "workloadContext": { "description": "The value used here will be stamped onto the report engine's datadog traces. If not provided a value will be dirived from the calculations being requested.", "type": "string" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "prospectId": { "type": "string" }, "asOfDate": { "type": "string", "format": "date-time" }, "clientPerformanceInclude": { "type": "string", "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, "unmanagedInclusionOverride": { "type": "string", "enum": [ "Unmanaged", "Performance", "ActivitySummary", "Allocation", "PortfolioDetail", "TaxDetail" ] }, "accountManagementOverrides": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.AccountManagementOverride" }, "xml": { "name": "AccountManagementOverride", "wrapped": true }, "type": "array" }, "flags": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Calculate.ScopeFeatureFlagsDto" }, "calculations": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Calculate.CalculateBase" }, "xml": { "name": "CalculateBase", "wrapped": true }, "type": "array" }, "useSmaSettings": { "type": "boolean" } }, "xml": { "name": "ScopeSettingsDto" }, "type": "object" }, "OAS.WebApi.DTO.QueryStudio.QueryTagOptionsDto": { "properties": { "columnName": { "type": "string" }, "dateFormat": { "type": "string" }, "decimalPlaces": { "type": "integer", "format": "int32" }, "formatAsCurrency": { "type": "boolean" }, "useNegativeParenthesis": { "type": "boolean" }, "useThousandsSeparator": { "type": "boolean" }, "scope": { "additionalProperties": { "type": "object" }, "type": "object" }, "sourceParameters": { "additionalProperties": { "type": "object" }, "type": "object" } }, "xml": { "name": "QueryTagOptionsDto" }, "type": "object" }, "OAS.WebApi.DTO.QueryStudio.SourceParameterDto": { "properties": { "name": { "type": "string" }, "displayName": { "type": "string" }, "dataType": { "type": "integer", "format": "int32" }, "parameterOrder": { "type": "integer", "format": "int32" }, "defaultValue": { "type": "string" } }, "xml": { "name": "SourceParameterDto" }, "type": "object" }, "OAS.WebApi.DTO.QueryStudio.FilterNodeDto": { "properties": { "columnId": { "type": "integer", "format": "int32" }, "operator": { "type": "string", "enum": [ "Equals", "DoesNotEqual", "Contains", "DoesNotContain", "StartsWith", "EndsWith", "IsEmpty", "IsNotEmpty", "GreaterThan", "GreaterThanOrEqualTo", "LessThan", "LessThanOrEqualTo", "Between", "In", "NotIn" ] }, "values": { "items": { "type": "object" }, "type": "array" }, "logicalOperator": { "type": "string" }, "children": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.QueryStudio.FilterNodeDto" }, "xml": { "name": "FilterNodeDto", "wrapped": true }, "type": "array" }, "isGroup": { "readOnly": true, "type": "boolean" } }, "xml": { "name": "FilterNodeDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Calculate.ScopeFeatureFlagsDto": { "properties": { "dynamicBenchmarkProcessType": { "type": "string", "enum": [ "Cloud", "LocalService" ] }, "forceAssetGroupingIntraDayPerformance": { "type": "boolean" }, "activityProcessType": { "type": "string", "enum": [ "Cloud", "LocalService" ] }, "costBasisProcessType": { "type": "string", "enum": [ "Old", "Cloud", "LocalService" ] }, "morningstarLevel2Assignment": { "type": "boolean" }, "localPriceCutOverDate": { "type": "string", "format": "date-time" }, "noScope": { "type": "boolean" }, "ensureAssetsUpdated": { "type": "boolean" }, "storeReportDataCompressed": { "type": "boolean" }, "showEInModelNames": { "type": "boolean" }, "performanceProcessType": { "type": "string", "enum": [ "Cloud", "LocalService" ] }, "forceNonSummaryPerformanceToUseTwr": { "type": "boolean" }, "forceNetOfFeesPerformance": { "type": "boolean" }, "costBasisStoredSource": { "type": "string", "enum": [ "Orion", "Custodian" ] }, "tradingWithParentGrouping": { "type": "boolean" }, "useGlobalSettingsUniqueIds": { "type": "boolean" }, "showEquations": { "type": "boolean" }, "isReportCompare": { "type": "boolean" }, "useBenchmarksInAccountChangeHistory": { "type": "boolean" }, "benchmarkAssignmentOverride": { "type": "string" }, "useAsOfDateForAdvizr": { "type": "boolean" }, "accountNumbersToShow": { "type": "integer", "format": "int32" }, "useBatchSettingsBulkCopy": { "type": "boolean" }, "showExcludedFromRebalance": { "type": "boolean" }, "useInMemoryForModelVsActual": { "type": "boolean" }, "useNewLineChartRenderer": { "type": "boolean" }, "useNewScatterPlotChartRenderer": { "type": "boolean" }, "useInMemoryIncomeCalculation": { "type": "boolean" }, "useModelAllocationHistory": { "type": "boolean" }, "useDisclaimerShadowDom": { "type": "boolean" } }, "xml": { "name": "ScopeFeatureFlagsDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Calculate.CalculateBase": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "id": { "type": "string" }, "contextChange": { "$ref": "#/definitions/OAS.DataModel.Reporting.Engine.ContextChange" } }, "xml": { "name": "CalculateBase" }, "type": "object" }, "OAS.DataProcess.QueryStudio.AccessRules.QueryAccessRuleDto": { "properties": { "id": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "queryId": { "type": "integer", "format": "int32" }, "representativeAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportRepresentativeAccessRuleDto" }, "xml": { "name": "ReportRepresentativeAccessRuleDto", "wrapped": true }, "type": "array" }, "databaseAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportDatabaseAccessRuleDto" }, "xml": { "name": "ReportDatabaseAccessRuleDto", "wrapped": true }, "type": "array" }, "loginAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportLoginAccessRuleDto" }, "xml": { "name": "ReportLoginAccessRuleDto", "wrapped": true }, "type": "array" }, "databaseGroupAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportDatabaseGroupAccessRuleDto" }, "xml": { "name": "ReportDatabaseGroupAccessRuleDto", "wrapped": true }, "type": "array" }, "userAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportUserAccessRuleDto" }, "xml": { "name": "ReportUserAccessRuleDto", "wrapped": true }, "type": "array" }, "roleAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportRoleAccessRuleDto" }, "xml": { "name": "ReportRoleAccessRuleDto", "wrapped": true }, "type": "array" }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" } }, "xml": { "name": "QueryAccessRuleDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ReportRepresentativeAccessRuleDto": { "properties": { "representativeId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "canRun": { "type": "boolean" } }, "xml": { "name": "ReportRepresentativeAccessRuleDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ReportDatabaseAccessRuleDto": { "properties": { "alClientId": { "type": "integer", "format": "int32" }, "loginEntityId": { "type": "string", "enum": [ "BrokerDealer", "Wholesaler", "Representative", "Client", "RIA", "Administrator", "SubAdvisor", "ThirdPartyAdministrator", "Custodian", "PlanSponsor", "ThirdParty", "ServiceAccount", "Participant", "RepAccountManager", "Payee", "RIATable", "Cotenant" ] }, "name": { "type": "string" }, "canRun": { "type": "boolean" }, "canEdit": { "type": "boolean" } }, "xml": { "name": "ReportDatabaseAccessRuleDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ReportLoginAccessRuleDto": { "properties": { "loginEntityId": { "type": "string", "enum": [ "BrokerDealer", "Wholesaler", "Representative", "Client", "RIA", "Administrator", "SubAdvisor", "ThirdPartyAdministrator", "Custodian", "PlanSponsor", "ThirdParty", "ServiceAccount", "Participant", "RepAccountManager", "Payee", "RIATable", "Cotenant" ] }, "canRun": { "type": "boolean" } }, "xml": { "name": "ReportLoginAccessRuleDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ReportDatabaseGroupAccessRuleDto": { "properties": { "databaseGroupId": { "type": "integer", "format": "int32" }, "loginEntityId": { "type": "string", "enum": [ "BrokerDealer", "Wholesaler", "Representative", "Client", "RIA", "Administrator", "SubAdvisor", "ThirdPartyAdministrator", "Custodian", "PlanSponsor", "ThirdParty", "ServiceAccount", "Participant", "RepAccountManager", "Payee", "RIATable", "Cotenant" ] }, "name": { "type": "string" }, "canRun": { "type": "boolean" }, "canEdit": { "type": "boolean" } }, "xml": { "name": "ReportDatabaseGroupAccessRuleDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ReportUserAccessRuleDto": { "properties": { "userId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "canRun": { "type": "boolean" }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" } }, "xml": { "name": "ReportUserAccessRuleDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ReportRoleAccessRuleDto": { "properties": { "roleId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "canRun": { "type": "boolean" }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" } }, "xml": { "name": "ReportRoleAccessRuleDto" }, "type": "object" }, "OAS.DataProcess.QueryStudio.QueryGenerate.QueryStudioQueryExportOptions": { "properties": { "limit": { "type": "integer", "format": "int32" }, "exportType": { "type": "string", "enum": [ "DataTable", "Xlsx", "Xls", "Csv", "Psv", "Json" ] }, "destination": { "type": "string", "enum": [ "DirectDownload", "CloudStorage", "ReportInbox", "FileTransfer" ] }, "parameters": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.QueryStudio.QueryParameterDto" }, "xml": { "name": "QueryParameterDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "QueryStudioQueryExportOptions" }, "type": "object" }, "OAS.DataModel.QueryStudio.QueryTagSource": { "properties": { "id": { "type": "integer", "format": "int32" }, "sourceName": { "type": "string" }, "sourceType": { "type": "string", "enum": [ "Table", "RB3", "TVF", "CustomField", "EntityOption" ] }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "entityEnum": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "queryTags": { "items": { "$ref": "#/definitions/OAS.DataModel.QueryStudio.QueryTag" }, "xml": { "name": "QueryTag", "wrapped": true }, "type": "array" }, "parameters": { "items": { "$ref": "#/definitions/OAS.DataModel.QueryStudio.QueryStudioSourceParameter" }, "xml": { "name": "QueryStudioSourceParameter", "wrapped": true }, "type": "array" } }, "xml": { "name": "QueryTagSource" }, "type": "object" }, "OAS.DataModel.QueryStudio.QueryTag": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" }, "tagDataType": { "type": "string", "enum": [ "Int", "Float", "Bit", "DateTime", "Varchar", "Money", "Decimal", "Object", "Date", "TimeUTC" ] }, "queryTagSourceId": { "type": "integer", "format": "int32" }, "keywords": { "type": "string" }, "category": { "type": "string" }, "isActive": { "type": "boolean" }, "isNullable": { "type": "boolean" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "isDefaultTagForEntityEnum": { "type": "boolean" }, "selectExpression": { "type": "string" }, "queryTagSource": { "$ref": "#/definitions/OAS.DataModel.QueryStudio.QueryTagSource" } }, "xml": { "name": "QueryTag" }, "type": "object" }, "OAS.DataModel.QueryStudio.QueryStudioSourceParameter": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "displayName": { "type": "string" }, "dataType": { "type": "string", "enum": [ "Int", "Float", "Bit", "DateTime", "Varchar", "Money", "Decimal", "Object", "Date", "TimeUTC" ] }, "parameterOrder": { "type": "integer", "format": "int32" }, "defaultValue": { "type": "string" } }, "xml": { "name": "QueryStudioSourceParameter" }, "type": "object" }, "OAS.WebApi.DTO.QueryStudio.QueryTagSourceDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "sourceName": { "type": "string" }, "sourceType": { "type": "string", "enum": [ "Table", "RB3", "TVF", "CustomField", "EntityOption" ] }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "entityEnum": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityEnumId": { "type": "integer", "format": "int32" } }, "xml": { "name": "QueryTagSourceDto" }, "type": "object" }, "OAS.DataModel.QueryStudio.RelatedColumn": { "properties": { "id": { "type": "integer", "format": "int32" }, "columnName": { "type": "string" }, "sourceName": { "type": "string" }, "relatedColumnName": { "type": "string" }, "relatedSourceName": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "RelatedColumn" }, "type": "object" }, "OAS.DataProcess.QueryStudio.QueryTags.TableColumn": { "properties": { "id": { "type": "integer", "format": "int32" }, "dataType": { "type": "string" }, "isNullable": { "type": "boolean" }, "columnName": { "type": "string" }, "tableName": { "type": "string" } }, "xml": { "name": "TableColumn" }, "type": "object" }, "OAS.DataProcess.Trading.RepExpTrading.CompareTool.DTO.CompareToolModelDeviationRequestDto": { "properties": { "accountSleeves": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.AccountSleeveMinimalDto" }, "xml": { "name": "AccountSleeveMinimalDto", "wrapped": true }, "type": "array" }, "rebalanceData": { "items": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.CompareTool.DTO.Rebalance.Response.RebalanceResponseDto" }, "xml": { "name": "RebalanceResponseDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "CompareToolModelDeviationRequestDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.AccountSleeveMinimalDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "targetAllocation": { "type": "number", "format": "double" }, "currentAllocation": { "type": "number", "format": "double" }, "currentValue": { "type": "number", "format": "double" }, "contributionAllocation": { "type": "number", "format": "double" }, "distributionAllocation": { "type": "number", "format": "double" }, "toleranceLower": { "type": "number", "format": "double" }, "toleranceUpper": { "type": "number", "format": "double" }, "modelAgg": { "type": "string" }, "modelAggId": { "type": "integer", "format": "int32" }, "modelAggType": { "type": "string", "enum": [ "Normal", "CustomIndex", "SelfDirected" ] }, "modelAggMinimumInvestmentAmount": { "type": "number", "format": "double" }, "subAdvisor": { "type": "string" }, "subAdvisorId": { "type": "integer", "format": "int32" }, "doNotTrade": { "type": "boolean" }, "modelAggExcludeRebalanceSleeve": { "description": "Whether the sleeve's model aggregate is excluded from portfolio rebalance.\r\nRead-only signal used to force and lock {OAS.WebApi.DTO.Trading.AccountSleeveMinimalDto.DoNotTrade}; the stored value\r\nremains on the account sleeve.", "type": "boolean" }, "sleeveStrategyDetailId": { "type": "integer", "format": "int32" }, "sleeveStrategy": { "type": "string" }, "sleeveStrategyId": { "type": "integer", "format": "int32" }, "sleeveStrategyToleranceLower": { "type": "number", "format": "double" }, "sleeveStrategyToleranceUpper": { "type": "number", "format": "double" }, "riskScore": { "type": "number", "format": "double" }, "modelAllocations": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelItemFullDto" }, "xml": { "name": "ModelItemFullDto", "wrapped": true }, "type": "array" }, "assets": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetDto" }, "xml": { "name": "AssetDto", "wrapped": true }, "type": "array" }, "defaultSleeve": { "type": "boolean" }, "name": { "type": "string" }, "sleeveType": { "type": "string", "enum": [ "Normal sleeve", "Custodial account", "Contribution sleeve", "Distribution sleeve", "Unmanaged sleeve" ] }, "guid": { "type": "string" }, "autoRebalanceSelfDirected": { "type": "boolean" }, "deductFeesFromProductId": { "type": "integer", "format": "int32" }, "managementStyle": { "type": "string" }, "managementStyleId": { "type": "integer", "format": "int32" }, "deleted": { "type": "boolean" }, "isCustomized": { "type": "boolean" } }, "xml": { "name": "AccountSleeveMinimalDto" }, "type": "object" }, "OAS.DataProcess.Trading.RepExpTrading.CompareTool.DTO.Rebalance.Response.RebalanceResponseDto": { "properties": { "trades": { "items": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.CompareTool.DTO.Rebalance.Response.Trade" }, "xml": { "name": "Trade", "wrapped": true }, "type": "array" }, "modelTargetAnalytics": { "items": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.CompareTool.DTO.Rebalance.Response.ModelTargetAnalytics" }, "xml": { "name": "ModelTargetAnalytics", "wrapped": true }, "type": "array" }, "unassignedPositions": { "items": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.CompareTool.DTO.Rebalance.Response.UnassignedPosition" }, "xml": { "name": "UnassignedPosition", "wrapped": true }, "type": "array" }, "updatedRebalanceType": { "type": "string", "enum": [ "PartialLocationOptimization", "FullLocationOptimization", "StandardRebalance", "FocusedRebalance", "RaiseCash", "SpendCash", "CashNeed", "Analytics", "FullRebalance", "FullSleeveRebalance", "SellRebalance", "SellRebalanceOversell", "SellFullRebalance", "ProRata", "SellRebalanceTaxSensitive", "SellRebalanceBestTolerance", "Current" ] }, "sessionData": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.RebalancerSessionDataDto" }, "accountAnalyticsValues": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.AccountAnalyticsValueDto" }, "xml": { "name": "AccountAnalyticsValueDto", "wrapped": true }, "type": "array" }, "portfolioAnalyticsValues": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.PortfolioAnalyticsValueDto" } }, "xml": { "name": "RebalanceResponseDto" }, "type": "object" }, "OAS.DataProcess.Trading.RepExpTrading.CompareTool.DTO.Rebalance.Response.Trade": { "properties": { "ocSecurityId": { "type": "integer", "format": "int32" }, "securityName": { "type": "string" }, "category": { "type": "string" }, "assetClass": { "type": "string" }, "securitySymbol": { "type": "string" }, "securityId": { "type": "integer", "format": "int32" }, "portfolioId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "orionConnectAccountId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "custodianId": { "type": "integer", "format": "int32" }, "modelId": { "type": "integer", "format": "int32" }, "positionId": { "type": "integer", "format": "int32" }, "advisorId": { "type": "integer", "format": "int32" }, "shares": { "type": "number", "format": "double" }, "orderPercent": { "type": "number", "format": "double" }, "pricePerUnit": { "type": "number", "format": "double" }, "tradeAmount": { "type": "number", "format": "double" }, "action": { "type": "string" }, "accountType": { "type": "string" }, "securityType": { "type": "string" }, "moneyMarketTrade": { "type": "boolean" }, "isAutoAllocate": { "type": "boolean" }, "isMacTrade": { "type": "boolean" }, "isSMATrade": { "type": "boolean" }, "isEnabled": { "type": "boolean" }, "isDiscardedTrade": { "type": "boolean" }, "isCloseAsset": { "type": "boolean" }, "isTransactionFeeIncluded": { "type": "boolean" }, "isContainingPartialShares": { "type": "boolean" }, "cashValuePostTrade": { "type": "number", "format": "double" }, "tradePercentageOfAccount": { "type": "number", "format": "double" }, "reinvestDividends": { "type": "boolean" }, "reinvestCapitalGains": { "type": "boolean" }, "reinvestLongTermGains": { "type": "boolean" }, "reinvestShortTermGains": { "type": "boolean" }, "transactionFee": { "type": "number", "format": "double" }, "redemptionFee": { "type": "number", "format": "double" }, "tradingInstruction": { "type": "string" }, "minTradeAmount": { "type": "number", "format": "double" }, "gainLoss": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.GainLossDto" }, "sellTradeLots": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.SellTradeLotsDto" }, "xml": { "name": "SellTradeLotsDto", "wrapped": true }, "type": "array" }, "isSmaTradeable": { "type": "string" }, "rebalanceLevel": { "type": "string" }, "vspInfo": { "type": "boolean" }, "vspDate": { "type": "string", "format": "date-time" }, "vspPrice": { "type": "number", "format": "double" }, "sellSharesThreshold": { "type": "number", "format": "double" }, "tradeTypeId": { "type": "integer", "format": "int32" }, "tradeType": { "type": "string" }, "washUnits": { "type": "number", "format": "double" }, "washAmount": { "type": "number", "format": "double" }, "daysUntilLongTerm": { "type": "integer", "format": "int32" }, "tradeOrderMessages": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.TradeOrderMessageDto" }, "xml": { "name": "TradeOrderMessageDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "Trade" }, "type": "object" }, "OAS.DataProcess.Trading.RepExpTrading.CompareTool.DTO.Rebalance.Response.ModelTargetAnalytics": { "properties": { "ocSecurityId": { "type": "integer", "format": "int32" }, "securityId": { "type": "integer", "format": "int32" }, "securityName": { "type": "string" }, "category": { "type": "string" }, "assetClass": { "type": "string" }, "equivalenceAnalytics": { "items": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.CompareTool.DTO.Rebalance.Response.EquivalenceAnalytics" }, "xml": { "name": "EquivalenceAnalytics", "wrapped": true }, "type": "array" }, "nodeId": { "type": "integer", "format": "int32" }, "nodeName": { "type": "string" }, "securitySymbol": { "type": "string" }, "nodeIdType": { "type": "string" }, "portfolioId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "parentModelDetailId": { "type": "integer", "format": "int32" }, "isSMANode": { "type": "boolean" }, "isMacSecurity": { "type": "boolean" }, "isDoNotBuySellDueToMacRules": { "type": "boolean" }, "effectiveTargetPercentage": { "type": "number", "format": "double" }, "effectiveTargetAmount": { "type": "number", "format": "double" }, "lowerModelTolerancePercent": { "type": "number", "format": "double" }, "lowerModelToleranceAmount": { "type": "number", "format": "double" }, "upperModelTolerancePercent": { "type": "number", "format": "double" }, "upperModelToleranceAmount": { "type": "number", "format": "double" }, "aggregatedPostAmount": { "type": "number", "format": "double" }, "aggregatedPostPer": { "type": "number", "format": "double" }, "aggregatedCurrentAmount": { "type": "number", "format": "double" }, "aggregatedCurrentPer": { "type": "number", "format": "double" }, "postAmount": { "type": "number", "format": "double" }, "postPer": { "type": "number", "format": "double" }, "currentAmount": { "type": "number", "format": "double" }, "currentPer": { "type": "number", "format": "double" }, "macWeightPercentage": { "type": "number", "format": "double" }, "assetMACWeightingName": { "type": "string" }, "isExcluded": { "type": "boolean" }, "postQuantity": { "type": "number", "format": "double" }, "currentQuantity": { "type": "number", "format": "double" }, "cashEffectivePercent": { "type": "number", "format": "double" }, "locationAlternateAnalytics": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.LocationAlternateAnalyticsDto" }, "xml": { "name": "LocationAlternateAnalyticsDto", "wrapped": true }, "type": "array" }, "securityHoldingDistributionAnalytics": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.SecurityHoldingDistributionAnalyticDto" }, "xml": { "name": "SecurityHoldingDistributionAnalyticDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ModelTargetAnalytics" }, "type": "object" }, "OAS.DataProcess.Trading.RepExpTrading.CompareTool.DTO.Rebalance.Response.UnassignedPosition": { "properties": { "ocSecurityId": { "type": "integer", "format": "int32" }, "securityName": { "type": "string" }, "category": { "type": "string" }, "assetClass": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "positionId": { "type": "integer", "format": "int32" }, "holdingAnalyticsId": { "type": "integer", "format": "int32" }, "securityStatus": { "type": "string" }, "orionConnectAccountId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "securityId": { "type": "integer", "format": "int32" }, "marketValue": { "type": "number", "format": "double" }, "quantity": { "type": "number", "format": "double" }, "originalMarketValue": { "type": "number", "format": "double" }, "originalQuantity": { "type": "number", "format": "double" }, "currentPercent": { "type": "number", "format": "double" }, "postPercent": { "type": "number", "format": "double" }, "securitySymbol": { "type": "string" }, "securityPrice": { "type": "number", "format": "double" }, "securityType": { "type": "string" }, "isPositionDisallow": { "type": "boolean" }, "accountType": { "type": "string" }, "isCustidialCash": { "type": "boolean" }, "isFixedIncomeTrading": { "type": "boolean" } }, "xml": { "name": "UnassignedPosition" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.RebalancerSessionDataDto": { "required": [ "correlationId", "rebalanceType", "type" ], "properties": { "correlationId": { "type": "string" }, "tradeInstanceId": { "type": "integer", "format": "int32" }, "ocRequestTime": { "type": "string", "format": "date-time" }, "v2UploadRequestTimeToS3": { "type": "string", "format": "date-time" }, "firmId": { "type": "integer", "format": "int32" }, "modelId": { "type": "integer", "format": "int32" }, "tradeOutputFilePath": { "type": "string" }, "success": { "type": "boolean" }, "message": { "type": "string" }, "rebalanceType": { "type": "integer", "format": "int32" }, "type": { "type": "integer", "format": "int32" }, "fetchData": { "type": "boolean" }, "portfolioId": { "type": "integer", "format": "int32" }, "generateTradeLog": { "type": "boolean" }, "cashMethod": { "type": "integer", "format": "int32" }, "sleeveAccountMethod": { "type": "integer", "format": "int32" }, "sleevePortfolioRebalanceLevel": { "type": "integer", "format": "int32" }, "accountsDetail": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.AccountsDetailDto" }, "xml": { "name": "AccountsDetailDto", "wrapped": true }, "type": "array" }, "useDefaultPreferences": { "type": "boolean" }, "taxSensitivity": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.TaxSensitivityDto" }, "filter": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.FilterDto" }, "rebalancerTradeLogFilePath": { "type": "string" }, "sleeveAccountIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "focusedRebalanceType": { "type": "integer", "format": "int32" }, "tradeToolSelectionId": { "type": "integer", "format": "int32" }, "tradeInstanceType": { "type": "integer", "format": "int32" }, "tradeInstanceSubType": { "type": "integer", "format": "int32" } }, "xml": { "name": "RebalancerSessionDataDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.AccountAnalyticsValueDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "orionConnectAccountId": { "type": "integer", "format": "int32" }, "cashNeedAmount": { "type": "number", "format": "double" }, "cashNeedPercent": { "type": "number", "format": "double" }, "targetReserveCash": { "type": "number", "format": "double" }, "actualReserveCash": { "type": "number", "format": "double" }, "targetReserveCashPV": { "type": "number", "format": "double" }, "targetSetAsideCash": { "type": "number", "format": "double" }, "actualSetAsideCash": { "type": "number", "format": "double" }, "setAsideMinCashAmount": { "type": "number", "format": "double" }, "setAsideMaxCashAmount": { "type": "number", "format": "double" }, "cashTargetDollar": { "type": "number", "format": "double" }, "cashTargetPercent": { "type": "number", "format": "double" }, "cashValue": { "type": "number", "format": "double" }, "cashPercent": { "type": "number", "format": "double" }, "pendingValue": { "type": "number", "format": "double" }, "pendingValuePercent": { "type": "number", "format": "double" }, "pendingCashValue": { "type": "number", "format": "double" }, "pendingCashPercentage": { "type": "number", "format": "double" }, "accountManagedValue": { "type": "number", "format": "double" }, "targetCash": { "type": "number", "format": "double" }, "LowTargetBalanceIn$": { "type": "number", "format": "double" }, "LowTradeTargetBalanceIn$": { "type": "number", "format": "double" }, "UpperTargetBalanceIn$": { "type": "number", "format": "double" }, "UppperTradeTargetBalanceIn$": { "type": "number", "format": "double" }, "ReserveCashBillingAccount$": { "type": "number", "format": "double" }, "sleeveTargetPercent": { "type": "number", "format": "double" }, "sleeveLowerTolerancePercent": { "type": "number", "format": "double" }, "sleeveUpperTolerancePercent": { "type": "number", "format": "double" }, "sleeveTargetDollar": { "type": "number", "format": "double" }, "sleeveLowerToleranceDollar": { "type": "number", "format": "double" }, "sleeveUpperToleranceDollar": { "type": "number", "format": "double" }, "sleeveLowerTradeToleranceDollar": { "type": "number", "format": "double" }, "sleeveUpperTradeToleranceDollar": { "type": "number", "format": "double" }, "sleeveStatus": { "type": "string" } }, "xml": { "name": "AccountAnalyticsValueDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.PortfolioAnalyticsValueDto": { "properties": { "portfolioId": { "type": "integer", "format": "int32" }, "levelOneBuyAmountIn$": { "type": "number", "format": "double" }, "portfolioWorthTarget": { "type": "number", "format": "double" }, "percentDeviation": { "type": "number", "format": "double" }, "cashNeedAmount": { "type": "number", "format": "double" }, "cashNeedPercent": { "type": "number", "format": "double" }, "targetReserveCash": { "type": "number", "format": "double" }, "actualReserveCash": { "type": "number", "format": "double" }, "cashTargetDollar": { "type": "number", "format": "double" }, "cashTargetPercent": { "type": "number", "format": "double" }, "cashValue": { "type": "number", "format": "double" }, "cashPercent": { "type": "number", "format": "double" }, "pendingValue": { "type": "number", "format": "double" }, "pendingValuePercent": { "type": "number", "format": "double" }, "pendingCashValue": { "type": "number", "format": "double" }, "pendingCashPercentage": { "type": "number", "format": "double" }, "outOfTolerance": { "type": "boolean" }, "outOfBalance": { "type": "boolean" }, "modelOUTOfTolerance": { "type": "boolean" }, "cashOutOfTolerance": { "type": "boolean" } }, "xml": { "name": "PortfolioAnalyticsValueDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.GainLossDto": { "properties": { "overallGain": { "type": "number", "format": "double" }, "overallLoss": { "type": "number", "format": "double" }, "shortTermGain": { "type": "number", "format": "double" }, "longTermGain": { "type": "number", "format": "double" }, "shortTermLoss": { "type": "number", "format": "double" }, "longTermLoss": { "type": "number", "format": "double" }, "aggregatedGainLoss": { "type": "number", "format": "double" } }, "xml": { "name": "GainLossDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.SellTradeLotsDto": { "properties": { "taxlotAnalyticsId": { "type": "integer", "format": "int32" }, "taxlotId": { "type": "integer", "format": "int32" }, "dateAcquired": { "type": "string" }, "amountTraded": { "type": "number", "format": "double" }, "taxlotNote": { "type": "string" }, "acquiredPrice": { "type": "number", "format": "double" }, "quantity": { "type": "number", "format": "double" }, "redemptionFee": { "type": "number", "format": "double" }, "taxlotTypeId": { "type": "integer", "format": "int32" }, "isEligibleForNormalRedemptionFee": { "type": "boolean" }, "isEligibleForCustodialRedemptionFee": { "type": "boolean" }, "originalTaxlotQuantity": { "type": "number", "format": "double" }, "gainLoss": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.GainLossDto" } }, "xml": { "name": "SellTradeLotsDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.TradeOrderMessageDto": { "properties": { "tradeOrderMessageId": { "type": "integer", "format": "int32" }, "tradeOrderMessage": { "type": "string" }, "messageArguments": { "items": { "type": "string" }, "type": "array" }, "tradeMessageString": { "type": "string" } }, "xml": { "name": "TradeOrderMessageDto" }, "type": "object" }, "OAS.DataProcess.Trading.RepExpTrading.CompareTool.DTO.Rebalance.Response.EquivalenceAnalytics": { "properties": { "securityId": { "type": "integer", "format": "int32" }, "securitySymbol": { "type": "string" }, "ocSecurityId": { "type": "integer", "format": "int32" }, "securityName": { "type": "string" }, "category": { "type": "string" }, "assetClass": { "type": "string" }, "rebalModelTargetValueId": { "type": "integer", "format": "int32" }, "equivalentSecurityId": { "type": "integer", "format": "int32" }, "equivalentSymbol": { "type": "string" }, "postAmount": { "type": "number", "format": "double" }, "postPer": { "type": "number", "format": "double" }, "currentAmount": { "type": "number", "format": "double" }, "currentPer": { "type": "number", "format": "double" }, "postQuantity": { "type": "number", "format": "double" }, "currentQuantity": { "type": "number", "format": "double" }, "securityHoldingDistributionAnalytics": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.SecurityHoldingDistributionAnalyticDto" }, "xml": { "name": "SecurityHoldingDistributionAnalyticDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "EquivalenceAnalytics" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.LocationAlternateAnalyticsDto": { "properties": { "rebalModelTargetValueId": { "type": "integer", "format": "int32" }, "accountTypeId": { "type": "integer", "format": "int32" }, "accountType": { "type": "string" }, "custodianId": { "type": "integer", "format": "int32" }, "parentSecurityId": { "type": "integer", "format": "int32" }, "locationAlternativeId": { "type": "integer", "format": "int32" }, "postAmount": { "type": "number", "format": "double" }, "postPer": { "type": "number", "format": "double" }, "currentAmount": { "type": "number", "format": "double" }, "currentPer": { "type": "number", "format": "double" }, "isDoNotBuySellDueToMacRules": { "type": "boolean" }, "postQuantity": { "type": "number", "format": "double" }, "currentQuantity": { "type": "number", "format": "double" }, "securityHoldingDistributionAnalytics": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.SecurityHoldingDistributionAnalyticDto" }, "xml": { "name": "SecurityHoldingDistributionAnalyticDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "LocationAlternateAnalyticsDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.SecurityHoldingDistributionAnalyticDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "accountType": { "type": "string" }, "currentAmount": { "type": "number", "format": "double" }, "currentPer": { "type": "number", "format": "double" }, "postAmount": { "type": "number", "format": "double" }, "postPer": { "type": "number", "format": "double" }, "currentQuantity": { "type": "number", "format": "double" }, "postQuantity": { "type": "number", "format": "double" }, "equivalenceLevel": { "type": "string" } }, "xml": { "name": "SecurityHoldingDistributionAnalyticDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.AccountsDetailDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "amount": { "type": "number", "format": "double" }, "setAsideCashAmount": { "type": "number", "format": "double" } }, "xml": { "name": "AccountsDetailDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.TaxSensitivityDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "indicatorValue": { "type": "string" }, "optionName": { "type": "string" }, "preferenceDefaultValue": { "type": "string" }, "defaultValue": { "type": "string" }, "relatedType": { "type": "integer", "format": "int32" }, "relatedTypeId": { "type": "integer", "format": "int32" }, "prefOrder": { "type": "integer", "format": "int32" } }, "xml": { "name": "TaxSensitivityDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.FilterDto": { "properties": { "minimumTradeAmountType": { "type": "string" }, "minimumTradeAmount": { "type": "number", "format": "double" }, "allowWashSales": { "type": "boolean" }, "allowShortTermGains": { "type": "string" }, "roundEquityRollup": { "type": "boolean" }, "priorityRanking": { "type": "string" }, "method": { "type": "string" }, "raiseOrSpendFullAmount": { "type": "boolean" }, "isSetAsideCash": { "type": "boolean" }, "rebalanceType": { "type": "string" }, "abilityToStopSalesWithRedemptionFeePenalties": { "type": "boolean" }, "overrideStopTradesWithinXNumberOfDaysOfGoingFromSTGToLTG": { "type": "boolean" }, "stopTradesWithinXNumberOfDaysFromStgToLtg": { "type": "integer", "format": "int32" }, "overrideBuyMinimumTransactionAmountFalse": { "type": "boolean" }, "buyMinimumTransactionAmountType": { "type": "string" }, "buyMinimumTransactionAmount": { "type": "number", "format": "double" }, "overrideSellMinimumTransactionAmount": { "type": "boolean" }, "sellMinimumTransactionAmountType": { "type": "string" }, "sellMinimumTransactionAmount": { "type": "number", "format": "double" }, "overrideBuyMaximumTransactionAmount": { "type": "number", "format": "double" }, "buyMaximumTransactionAmountType": { "type": "string" }, "buyMaximumTransactionAmount": { "type": "number", "format": "double" }, "overrideSellMaximumTransactionAmount": { "type": "boolean" }, "sellMaximumTransactionAmountType": { "type": "string" }, "sellMaximumTransactionAmount": { "type": "number", "format": "double" }, "overrideMinimumInitialBuyTransactionAmount": { "type": "boolean" }, "minimumInitialBuyTransactionAmount": { "type": "number", "format": "double" }, "overrideTransactionCostLimit": { "type": "boolean" }, "transactionCostLimit": { "type": "number", "format": "double" }, "tacticalRebalanceDoNotSellUnAssignedSecurities": { "type": "boolean" }, "tacticalRebalanceDoNotRebalanceCash": { "type": "boolean" }, "maximumCapitalGainsAllowed": { "type": "string" }, "maxGainAmount": { "type": "number", "format": "double" }, "maxGainAmountType": { "type": "string" }, "includeYTDGainLoss": { "type": "boolean" }, "tacticalRebalanceSecurities": { "items": { "type": "string" }, "type": "array" }, "tacticalRebalanceCashProtection": { "type": "string" }, "journalAllExcessCashNeeded": { "type": "boolean" }, "protectSetAsideCashInContributionSleeve": { "type": "boolean" }, "accountIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "focusedRebalanceType": { "type": "string" }, "sleeveContributionOrDistributionMethod": { "type": "string" }, "spendCashToolCashProtection": { "type": "string" }, "tradeTolerancePercent": { "type": "number", "format": "double" }, "rebalanceTarget": { "type": "string" }, "sleevePortfolioRebalanceTarget": { "type": "string" }, "sleeveTradeTolerancePercent": { "type": "number", "format": "double" }, "sleevePortfolioRebalanceLevel": { "type": "string" }, "individualSleeveRebalanceMethod": { "type": "string" }, "liquidateEquivalents": { "type": "boolean" }, "liquidateGroupEquivalents": { "type": "boolean" }, "sleevePortfolioMinCashThreshold": { "type": "number", "format": "double" }, "raiseCashIncludeTargetCash": { "type": "boolean" }, "liquidateUnassignedSecurities": { "type": "boolean" }, "rebalanceLevelSetting": { "type": "string" }, "taxSensitivitySetting": { "type": "string" }, "maxShortTermGainAmount": { "type": "number", "format": "double" }, "maxShortTermGainAmountType": { "type": "string" } }, "xml": { "name": "FilterDto" }, "type": "object" }, "OAS.DataProcess.Trading.RepExpTrading.TradeOrder.BuySellRequestDto": { "required": [ "accountId", "account", "portfolioId", "tradeOrders" ], "properties": { "accountId": { "type": "integer", "format": "int32" }, "account": { "type": "string" }, "portfolioId": { "type": "integer", "format": "int32" }, "tradeOrders": { "items": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.TradeOrder.TradeOrderProcessDto" }, "xml": { "name": "TradeOrderProcessDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "BuySellRequestDto" }, "type": "object" }, "OAS.DataProcess.Trading.RepExpTrading.TradeOrder.TradeOrderProcessDto": { "required": [ "productId", "action", "tradeType", "amount" ], "properties": { "productId": { "type": "integer", "format": "int32" }, "action": { "type": "string", "enum": [ "Buy", "Sell", "JournalIn", "JournalOut" ] }, "tradeType": { "type": "string", "enum": [ "Dollars", "Shares", "Percent" ] }, "amount": { "type": "number", "format": "double" } }, "xml": { "name": "TradeOrderProcessDto" }, "type": "object" }, "OAS.DataProcess.Trading.RepExpTrading.TradeOrder.NonsleeveTradeOrderProcessDto": { "properties": { "productId": { "type": "integer", "format": "int32" }, "dollarAmount": { "type": "number", "format": "double" }, "action": { "type": "string", "enum": [ "Buy", "Sell", "JournalIn", "JournalOut" ] }, "accountId": { "type": "integer", "format": "int32" } }, "xml": { "name": "NonsleeveTradeOrderProcessDto" }, "type": "object" }, "OAS.DataProcess.Trading.RepExpTrading.TradeOrder.GlobalTradeDto": { "properties": { "productToSell": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.TradeOrder.GlobalTradeItemDto" }, "productFromId": { "type": "integer", "format": "int32" }, "modelAggIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "productsToBuy": { "items": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.TradeOrder.GlobalTradeItemDto" }, "xml": { "name": "GlobalTradeItemDto", "wrapped": true }, "type": "array" }, "updateAllocations": { "type": "boolean" }, "modelAggIdsWithAccounts": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "models": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelFullDto" }, "xml": { "name": "ModelFullDto", "wrapped": true }, "type": "array" }, "includedAccounts": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, "xml": { "name": "GlobalTradeDto" }, "type": "object" }, "OAS.DataProcess.Trading.RepExpTrading.TradeOrder.GlobalTradeItemDto": { "properties": { "productId": { "type": "integer", "format": "int32" }, "allocation": { "type": "number", "format": "double" }, "ticker": { "type": "string" } }, "xml": { "name": "GlobalTradeItemDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.ModelFullDto": { "properties": { "fundFamilyId": { "type": "integer", "format": "int32" }, "shareClassId": { "type": "integer", "format": "int32" }, "platformId": { "type": "integer", "format": "int32" }, "isListTraded": { "type": "boolean" }, "modNotes": { "type": "string" }, "representativeId": { "type": "integer", "format": "int32" }, "sequence": { "type": "integer", "format": "int32" }, "changeReason": { "type": "string" }, "modelLevels": { "type": "integer", "format": "int32" }, "dynamicEffectiveDate": { "type": "string", "format": "date-time" }, "custodianId": { "type": "integer", "format": "int32" }, "items": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelItemFullDto" }, "xml": { "name": "ModelItemFullDto", "wrapped": true }, "type": "array" }, "accounts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelAccountFullDto" }, "xml": { "name": "ModelAccountFullDto", "wrapped": true }, "type": "array" }, "ranges": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelRangeFullDto" }, "xml": { "name": "ModelRangeFullDto", "wrapped": true }, "type": "array" }, "riskRangeId": { "type": "integer", "format": "int32" }, "defaultModelAggId": { "type": "integer", "format": "int32" }, "eclipseFirmId": { "type": "integer", "format": "int32" }, "EclipseFirmIds": { "description": "A pipe-delimited list of Eclipse Firm IDs that are associated with this model.", "type": "string" }, "communityModel": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Communities.CommunityModelDto" }, "eclipseModelId": { "description": "The Eclipse model ID for non-community models.", "type": "integer", "format": "int32" }, "riskScore": { "type": "number", "format": "double" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "lastRebalanced": { "type": "string", "format": "date-time" }, "fundName": { "type": "string" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "groupNum": { "type": "string" }, "subAdvisor": { "type": "string" }, "modelNum": { "type": "integer", "format": "int32" }, "percEquity": { "type": "integer", "format": "int32" }, "modelType": { "type": "string" }, "fundList": { "type": "string" }, "modelTol": { "type": "integer", "format": "int32" }, "cashPerc": { "type": "integer", "format": "int32" }, "cashTol": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "class": { "type": "string" }, "modelCode": { "type": "string" }, "managementStyle": { "type": "string" }, "notes": { "type": "string" }, "isDynamic": { "type": "boolean" }, "custodian": { "type": "string" }, "subAdvisorId": { "type": "integer", "format": "int32" }, "communityModelId": { "type": "integer", "format": "int64" }, "useRestrictions": { "type": "boolean" }, "isSMA": { "type": "boolean" }, "assetClassId": { "type": "integer", "format": "int32" }, "riskCategoryId": { "type": "integer", "format": "int32" } }, "xml": { "name": "ModelFullDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.ModelAccountFullDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "accountName": { "type": "string" }, "accountNumber": { "type": "string" }, "canDelete": { "type": "boolean" }, "lastRebalanced": { "type": "string", "format": "date-time" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "value": { "type": "number", "format": "double" }, "modelId": { "type": "integer", "format": "int32" } }, "xml": { "name": "ModelAccountFullDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.ModelRangeFullDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "summary": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "upperScore": { "type": "integer", "format": "int32" }, "lowerScore": { "type": "integer", "format": "int32" }, "userDefinedFields": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.EntityOptionDto" }, "xml": { "name": "EntityOptionDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ModelRangeFullDto" }, "type": "object" }, "OAS.DataProcess.Trading.RepExpTrading.TradeOrder.TradeOrderAccountHoldings": { "properties": { "accountNumber": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "accountName": { "type": "string" }, "accountValue": { "type": "number", "format": "double" }, "ticker": { "type": "string" }, "model": { "type": "string" }, "modelId": { "type": "integer", "format": "int32" }, "targetDollars": { "type": "number", "format": "double" }, "targetDollarsString": { "type": "string" }, "targetShares": { "type": "number", "format": "double" }, "targetSharesString": { "type": "string" }, "postDollars": { "type": "number", "format": "double" }, "postPercent": { "type": "number", "format": "double" }, "postShares": { "type": "number", "format": "double" }, "differenceDollars": { "type": "number", "format": "double" }, "differencePercent": { "type": "number", "format": "double" }, "differenceShares": { "type": "number", "format": "double" }, "price": { "type": "number", "format": "double" }, "unrealizedGLDollars": { "type": "number", "format": "double" }, "unrealizedGLPercent": { "type": "number", "format": "double" }, "unrealizedGLShortTermDollars": { "type": "number", "format": "double" }, "unrealizedGLShortTermPercent": { "type": "number", "format": "double" }, "unrealizedGLLongTermDollars": { "type": "number", "format": "double" }, "unrealizedGLLongTermPercent": { "type": "number", "format": "double" }, "tradeGLShortTermDollars": { "type": "number", "format": "double" }, "tradeGLShortTermPercent": { "type": "number", "format": "double" }, "tradeGLLongTermDollars": { "type": "number", "format": "double" }, "tradeGLLongTermPercent": { "type": "number", "format": "double" }, "tradeGLDollars": { "type": "number", "format": "double" }, "tradeGLPercent": { "type": "number", "format": "double" }, "estimatedTax": { "type": "number", "format": "double" }, "washAmount": { "type": "number", "format": "double" }, "washUnits": { "type": "number", "format": "double" }, "custodian": { "type": "string" }, "costBasis": { "type": "number", "format": "double" }, "targetedTicker": { "type": "string" }, "modelName": { "type": "string" }, "security": { "type": "string" }, "securityType": { "type": "string" }, "managedValue": { "type": "number", "format": "double" }, "excludedValue": { "type": "number", "format": "double" }, "regType": { "type": "string" }, "equivalentLevel": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "currentPercent": { "type": "number", "format": "double" }, "currentShares": { "type": "number", "format": "double" }, "productCategoryName": { "type": "string" }, "targetPercent": { "type": "number", "format": "double" }, "targetPercentString": { "type": "string" }, "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "productClass": { "type": "string" }, "availableCash": { "type": "number", "format": "double" }, "currentValue": { "type": "number", "format": "double" }, "securityId": { "type": "integer", "format": "int32" } }, "xml": { "name": "TradeOrderAccountHoldings" }, "type": "object" }, "OAS.DataProcess.Trading.RepExpTrading.CompareTool.DTO.ImplementScenario.ImplementScenarioConfigurationDto": { "properties": { "scenarioType": { "type": "string", "enum": [ "Rebalance", "ChangeAllocation", "RaiseCash", "DepositCash" ] }, "scenarioData": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.CompareTool.DTO.ImplementScenario.ScenarioData" }, "rebalancerSessionData": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.RebalancerSessionDataDto" }, "sleeveAssignmentConfiguration": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveAssignmentConfigurationDto" }, "modelAssignmentConfiguration": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Models.ModelAssignmentConfigurationDto" }, "portfolioDetails": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.PortfolioDetailDto" }, "correlationId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "scenarioId": { "type": "string" } }, "xml": { "name": "ImplementScenarioConfigurationDto" }, "type": "object" }, "OAS.DataProcess.Trading.RepExpTrading.CompareTool.DTO.ImplementScenario.ScenarioData": { "properties": { "currentPortfolio": { "$ref": "#/definitions/OAS.DataProcess.CompareTool.Models.CompareToolViewModelDto" }, "rebalanceType": { "type": "string", "enum": [ "PartialLocationOptimization", "FullLocationOptimization", "StandardRebalance", "FocusedRebalance", "RaiseCash", "SpendCash", "CashNeed", "Analytics", "FullRebalance", "FullSleeveRebalance", "SellRebalance", "SellRebalanceOversell", "SellFullRebalance", "ProRata", "SellRebalanceTaxSensitive", "SellRebalanceBestTolerance", "Current" ] }, "accountSleeves": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.AccountSleeveMinimalDto" }, "xml": { "name": "AccountSleeveMinimalDto", "wrapped": true }, "type": "array" }, "cashConfig": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.CompareTool.DTO.Rebalance.CashConfigDto" }, "rawData": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.CompareTool.DTO.Rebalance.Response.RebalanceResponseDto" }, "sleeveStrategyAggId": { "type": "integer", "format": "int32" } }, "xml": { "name": "ScenarioData" }, "type": "object" }, "OAS.WebApi.DTO.Trading.SleeveAssignmentConfigurationDto": { "properties": { "requestedById": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "registrationSleeve": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RegistrationSleeveMinimalDto" }, "sleeveStrategies": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" }, "sleevedAccounts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.AccountSleeveMinimalDto" }, "xml": { "name": "AccountSleeveMinimalDto", "wrapped": true }, "type": "array" }, "guardrailBand": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RiskGuardrailBandDto" }, "astroAccounts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RetAstroAccountDto" }, "xml": { "name": "RetAstroAccountDto", "wrapped": true }, "type": "array" }, "verboseAccounts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountVerboseDto" }, "xml": { "name": "AccountVerboseDto", "wrapped": true }, "type": "array" }, "tradeQueueRebalanceNeeded": { "type": "boolean" }, "ociTaxLotLevelsEnabled": { "type": "boolean" }, "allowCustomization": { "type": "boolean" }, "readOnly": { "type": "boolean" }, "sleeveStrategyAggEclipseFirmId": { "description": "Eclipse Firm assigned to the registration's sleeve strategy aggregate, when one is assigned.\r\nRead-only signal used to lock the Eclipse Firm field; the stored value remains on\r\n{OAS.WebApi.DTO.Trading.SleeveAssignmentConfigurationDto.RegistrationSleeve}.", "type": "integer", "format": "int32" }, "message": { "type": "string" }, "eclipsePortfolioMissing": { "type": "boolean" } }, "xml": { "name": "SleeveAssignmentConfigurationDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Models.ModelAssignmentConfigurationDto": { "properties": { "modelId": { "type": "integer", "format": "int32" }, "portfolioId": { "type": "integer", "format": "int32" } }, "xml": { "name": "ModelAssignmentConfigurationDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.PortfolioDetailDto": { "properties": { "taxlots": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.TaxlotDto" }, "xml": { "name": "TaxlotDto", "wrapped": true }, "type": "array" }, "positions": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.PositionDto" }, "xml": { "name": "PositionDto", "wrapped": true }, "type": "array" }, "accounts": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.AccountsDto" }, "xml": { "name": "AccountsDto", "wrapped": true }, "type": "array" }, "portfolioInformation": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.PortfolioInfoDto" }, "xml": { "name": "PortfolioInfoDto", "wrapped": true }, "type": "array" }, "macSettingsAtAssetCategory": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.MacSettingsAssetCategoryLevelDto" }, "xml": { "name": "MacSettingsAssetCategoryLevelDto", "wrapped": true }, "type": "array" }, "macSettingsAtAssetClass": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.MacSettingsAssetClassLevelDto" }, "xml": { "name": "MacSettingsAssetClassLevelDto", "wrapped": true }, "type": "array" }, "macSettingsAtAssetSubClass": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.MacSettingsAssetSubClassLevelDto" }, "xml": { "name": "MacSettingsAssetSubClassLevelDto", "wrapped": true }, "type": "array" }, "setAsideCash": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.SetAsideCashDto" }, "xml": { "name": "SetAsideCashDto", "wrapped": true }, "type": "array" }, "buyTradesWithinThirtyDaysFromTaxableAccount": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.BuyTradesWithinThirtyDaysFromTaxableAccountDto" }, "xml": { "name": "BuyTradesWithinThirtyDaysFromTaxableAccountDto", "wrapped": true }, "type": "array" }, "restrictedPlanByAccount": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.RestrictedPlanByAccountDto" }, "xml": { "name": "RestrictedPlanByAccountDto", "wrapped": true }, "type": "array" }, "holdUntilTrades": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.HoldUntilTradesDto" }, "xml": { "name": "HoldUntilTradesDto", "wrapped": true }, "type": "array" }, "smaAccountWeightings": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.SmaAccountWeightingsDto" }, "xml": { "name": "SmaAccountWeightingsDto", "wrapped": true }, "type": "array" }, "accountSurplusCash": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.AccountSurplusCashDto" }, "xml": { "name": "AccountSurplusCashDto", "wrapped": true }, "type": "array" }, "sleevePreferences": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.SleevePreferencesDto" }, "xml": { "name": "SleevePreferencesDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "PortfolioDetailDto" }, "type": "object" }, "OAS.DataProcess.CompareTool.Models.CompareToolViewModelDto": { "properties": { "entityId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "name": { "type": "string" }, "repId": { "type": "integer", "format": "int32" }, "eclipseFirmId": { "type": "integer", "format": "int32" }, "storageKey": { "type": "string" }, "storageTag": { "type": "string" }, "actualValue": { "type": "number", "format": "double" }, "cashValue": { "type": "number", "format": "double" }, "cashTarget": { "type": "number", "format": "double" }, "setAsideCash": { "type": "number", "format": "double" }, "reserveCash": { "type": "number", "format": "double" }, "cashInTolerance": { "type": "boolean" }, "portfolioInTolerance": { "type": "boolean" }, "riskTarget": { "type": "integer", "format": "int32" }, "totalGainLoss": { "type": "number", "format": "double" }, "ytdRealizedLongTermGain": { "type": "number", "format": "double" }, "ytdRealizedShortTermGain": { "type": "number", "format": "double" }, "maxCapitalGains": { "type": "number", "format": "double" }, "accounts": { "items": { "$ref": "#/definitions/OAS.DataProcess.CompareTool.Models.AccountCompareToolViewModelDto" }, "xml": { "name": "AccountCompareToolViewModelDto", "wrapped": true }, "type": "array" }, "models": { "items": { "$ref": "#/definitions/OAS.DataProcess.CompareTool.Models.ModelCompareToolViewModelDto" }, "xml": { "name": "ModelCompareToolViewModelDto", "wrapped": true }, "type": "array" }, "risk": { "$ref": "#/definitions/OAS.DataProcess.CompareTool.Models.RiskOptionsDto" }, "accountsAggregate": { "$ref": "#/definitions/OAS.DataProcess.CompareTool.Models.CalculatedAggregate" }, "modelsAggregate": { "$ref": "#/definitions/OAS.DataProcess.CompareTool.Models.CalculatedAggregate" }, "taxQualification": { "type": "string" }, "isSleeved": { "type": "boolean" } }, "xml": { "name": "CompareToolViewModelDto" }, "type": "object" }, "OAS.DataProcess.Trading.RepExpTrading.CompareTool.DTO.Rebalance.CashConfigDto": { "properties": { "cashOptionType": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "amount": { "type": "number", "format": "double" }, "capitalGainsOption": { "type": "string" }, "capitalGainsLimit": { "type": "number", "format": "double" }, "cashWizardMode": { "type": "string", "enum": [ "UMA_Raise", "UMA_Deposit", "PG_Raise", "PG_Deposit" ] }, "compareCashTargets": { "items": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.CompareTool.DTO.Rebalance.CompareCashTargets" }, "xml": { "name": "CompareCashTargets", "wrapped": true }, "type": "array" } }, "xml": { "name": "CashConfigDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.RegistrationSleeveMinimalDto": { "properties": { "sleeveStrategyId": { "type": "integer", "format": "int32" }, "sleeveStrategyAggId": { "type": "integer", "format": "int32" }, "custodialAccountNumber": { "type": "string" }, "registrationId": { "type": "integer", "format": "int32" }, "currentValue": { "type": "number", "format": "double" }, "isDoNotTrade": { "type": "boolean" }, "eclipseFirmId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "eclipseFirm": { "type": "string" }, "riskTolerance": { "type": "number", "format": "double" }, "autoRebalFrequency": { "type": "string", "enum": [ "None", "Monthly", "Quarterly", "Semiannual", "Annual" ] }, "autoRebalMonth": { "type": "integer", "format": "int32" }, "autoRebalDay": { "type": "integer", "format": "int32" }, "contributionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "distributionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "isActive": { "type": "boolean" }, "lastRebalanceDate": { "type": "string", "format": "date-time" }, "tolerancePercent": { "type": "number", "format": "double" } }, "xml": { "name": "RegistrationSleeveMinimalDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.RiskGuardrailBandDto": { "properties": { "driftRangeHigh": { "type": "integer", "format": "int32" }, "driftRangeLow": { "type": "integer", "format": "int32" } }, "xml": { "name": "RiskGuardrailBandDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.RetAstroAccountDto": { "properties": { "astroTaxSchedules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.AstroAccountTaxSchedulesDto" }, "xml": { "name": "AstroAccountTaxSchedulesDto", "wrapped": true }, "type": "array" }, "sectors": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.RetAstroSectorDto" }, "xml": { "name": "RetAstroSectorDto", "wrapped": true }, "type": "array" }, "modelAgg": { "type": "string" }, "modelAggId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "astroTemplate": { "type": "string" }, "maxRealizedGain": { "type": "number", "format": "double" }, "fedShortTaxRate": { "type": "number", "format": "double" }, "fedLongTaxRate": { "type": "number", "format": "double" }, "shortTermTaxRate": { "type": "number", "format": "double" }, "longTermTaxRate": { "type": "number", "format": "double" }, "ticketCharge": { "type": "number", "format": "double" }, "maxTrackingError": { "type": "number", "format": "double" }, "minTrackingError": { "type": "number", "format": "double" }, "assets": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.AstroAssetDto" }, "xml": { "name": "AstroAssetDto", "wrapped": true }, "type": "array" }, "sleeves": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.AstroSleeveDto" }, "xml": { "name": "AstroSleeveDto", "wrapped": true }, "type": "array" }, "esgRestriction": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Integrations.Astro.EsgCategoryRestrictionDto" }, "xml": { "name": "EsgCategoryRestrictionDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "RetAstroAccountDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.TaxlotDto": { "properties": { "taxlotId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "orionConnectAccountId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "isSMA": { "type": "integer", "format": "int32" }, "taxableType": { "type": "string" }, "securityId": { "type": "integer", "format": "int32" }, "symbol": { "type": "string" }, "dateAcquired": { "type": "string" }, "orginalQuantity": { "type": "number", "format": "double" }, "costPerShare": { "type": "number", "format": "double" }, "originalMarketValue": { "type": "number", "format": "double" }, "securityType": { "type": "string" }, "pendingQuantity": { "type": "number", "format": "double" }, "pendingMarketValue": { "type": "number", "format": "double" }, "taxLotAnalyticsId": { "type": "integer", "format": "int32" }, "taxlotTypeId": { "type": "integer", "format": "int32" }, "isLongTerm": { "type": "integer", "format": "int32" }, "isSettled": { "type": "integer", "format": "int32" } }, "xml": { "name": "TaxlotDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.PositionDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "positionId": { "type": "integer", "format": "int32" }, "orionConnectAccountId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "isSMA": { "type": "integer", "format": "int32" }, "isTradableMoneyMarket": { "type": "integer", "format": "int32" }, "isUnassigned": { "type": "boolean" }, "taxableType": { "type": "string" }, "securityId": { "type": "integer", "format": "int32" }, "pendingMarketValue": { "type": "number", "format": "double" }, "originalMarketValue": { "type": "number", "format": "double" }, "pendingQuantity": { "type": "number", "format": "double" }, "originalQuantity": { "type": "number", "format": "double" }, "symbol": { "type": "string" }, "isFixedIncomeTrading": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "isCustodialCash": { "type": "integer", "format": "int32" }, "orionEclipseName": { "type": "string" }, "status": { "type": "string" }, "securityTypeName": { "type": "string" }, "securityTypeId": { "type": "integer", "format": "int32" }, "price": { "type": "number", "format": "double" }, "priceType": { "type": "string" }, "priceDateTime": { "type": "string" }, "holdingAnalyticsId": { "type": "integer", "format": "int32" }, "excludedHoldings": { "type": "integer", "format": "int32" } }, "xml": { "name": "PositionDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.AccountsDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "orionConnectAccountId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "portfolioId": { "type": "integer", "format": "int32" }, "ytdRealizedStgl": { "type": "number", "format": "double" }, "custodianId": { "type": "integer", "format": "int32" }, "custodialAccountNumber": { "type": "string" }, "advisorId": { "type": "integer", "format": "int32" }, "modelId": { "type": "integer", "format": "int32" }, "modelName": { "type": "string" }, "isSMAModel": { "type": "integer", "format": "int32" }, "billingAccount": { "type": "integer", "format": "int32" }, "isSMA": { "type": "integer", "format": "int32" }, "taxableType": { "type": "string" }, "isDoNotBuySell": { "type": "integer", "format": "int32" }, "sleeveTarget": { "type": "number", "format": "double" }, "sleeveContributionPercent": { "type": "number", "format": "double" }, "sleeveDistributionPercent": { "type": "number", "format": "double" }, "sleeveType": { "type": "string" }, "isDisabled": { "type": "integer", "format": "int32" }, "dynamicModel": { "type": "integer", "format": "int32" }, "smaTradeable": { "type": "string" }, "custodianTradeExecutionTypeId": { "type": "integer", "format": "int32" }, "tradeExecutionTypeName": { "type": "string" }, "substitutedModelId": { "type": "integer", "format": "int32" }, "substitutedModelName": { "type": "string" }, "systematicDate": { "type": "string", "format": "date-time" }, "monthlySystematicWithdrawal": { "type": "number", "format": "double" }, "nextMonthlySystematicWithdrawalDate": { "type": "string", "format": "date-time" }, "quarterlySystematicWithdrawal": { "type": "number", "format": "double" }, "nextQuarterlySystematicWithdrawalDate": { "type": "string", "format": "date-time" }, "semiAnnualSystematicWithdrawal": { "type": "number", "format": "double" }, "nextSemiAnnualSystematicWithdrawalDate": { "type": "string", "format": "date-time" }, "annualSystematicWithdrawal": { "type": "number", "format": "double" }, "nextAnnualSystematicWithdrawalDate": { "type": "string", "format": "date-time" }, "systematicPurchase": { "type": "number", "format": "double" }, "onlyCreateFractionalShareLiquidationTrades": { "type": "boolean" }, "nextSystematicPurchaseDate": { "type": "string", "format": "date-time" }, "tradeExecutionTypeId": { "type": "integer", "format": "int32" }, "sleeveToleranceLower": { "type": "number", "format": "double" }, "sleeveToleranceUpper": { "type": "number", "format": "double" }, "isModelMacEnabled": { "type": "integer", "format": "int32" }, "accountMacStatus": { "type": "string" }, "custodianAllowFractionalEquityOrder": { "type": "integer", "format": "int32" }, "custodianFractionalEquityPrecision": { "type": "integer", "format": "int32" }, "astroEnabled": { "type": "integer", "format": "int32" }, "excludeRebalanceSleeve": { "type": "integer", "format": "int32" }, "sleeveStrategyId": { "type": "string" }, "sleeveStrategyName": { "type": "string" }, "modelSecurityType": { "type": "string" }, "modelSecurityTypeId": { "type": "string" }, "sleeveStrategyLowerTolerancePercent": { "type": "number", "format": "double" }, "sleeveStrategyUpperTolerancePercent": { "type": "number", "format": "double" }, "ytdGainLoss": { "type": "number", "format": "double" } }, "xml": { "name": "AccountsDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.PortfolioInfoDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "modelId": { "type": "integer", "format": "int32" }, "isSleevePortfolio": { "type": "integer", "format": "int32" }, "teamId": { "type": "integer", "format": "int32" }, "sleeveContributionMethod": { "type": "string" }, "sleeveDistributionMethod": { "type": "string" }, "doNotTrade": { "type": "integer", "format": "int32" }, "dynamicModel": { "type": "integer", "format": "int32" }, "tradingInstruction": { "type": "string" }, "needAnalytics": { "type": "integer", "format": "int32" }, "substitutedModelId": { "type": "integer", "format": "int32" }, "portfolioMacStatus": { "type": "string" }, "isModelMacEnabled": { "type": "integer", "format": "int32" }, "sellEmphasisOn": { "type": "integer", "format": "int32" }, "buyEmphasisOn": { "type": "integer", "format": "int32" } }, "xml": { "name": "PortfolioInfoDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.MacSettingsAssetCategoryLevelDto": { "properties": { "portfolioId": { "type": "integer", "format": "int32" }, "modelId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "securityMACWeightId": { "type": "integer", "format": "int32" }, "securitySymbol": { "type": "string" }, "securityType": { "type": "string" }, "securityStatus": { "type": "string" }, "isTaxable": { "type": "boolean" }, "isTaxDeffered": { "type": "boolean" }, "isTaxExempted": { "type": "boolean" }, "isFixedIncomeTrading": { "type": "boolean" }, "securityCategoryId": { "type": "integer", "format": "int32" }, "securityClassId": { "type": "integer", "format": "int32" }, "securitySubClassId": { "type": "integer", "format": "int32" }, "securityId": { "type": "integer", "format": "int32" }, "rank": { "type": "integer", "format": "int32" }, "weightingPercentage": { "type": "number", "format": "double" }, "assetCategoryId": { "type": "integer", "format": "int32" }, "categoryName": { "type": "string" } }, "xml": { "name": "MacSettingsAssetCategoryLevelDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.MacSettingsAssetClassLevelDto": { "properties": { "portfolioId": { "type": "integer", "format": "int32" }, "modelId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "securityMACWeightId": { "type": "integer", "format": "int32" }, "securitySymbol": { "type": "string" }, "securityType": { "type": "string" }, "securityStatus": { "type": "string" }, "isTaxable": { "type": "boolean" }, "isTaxDeffered": { "type": "boolean" }, "isTaxExempted": { "type": "boolean" }, "isFixedIncomeTrading": { "type": "boolean" }, "securityCategoryId": { "type": "integer", "format": "int32" }, "securityClassId": { "type": "integer", "format": "int32" }, "securitySubClassId": { "type": "integer", "format": "int32" }, "securityId": { "type": "integer", "format": "int32" }, "rank": { "type": "integer", "format": "int32" }, "weightingPercentage": { "type": "number", "format": "double" }, "assetClassId": { "type": "integer", "format": "int32" }, "className": { "type": "string" } }, "xml": { "name": "MacSettingsAssetClassLevelDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.MacSettingsAssetSubClassLevelDto": { "properties": { "portfolioId": { "type": "integer", "format": "int32" }, "modelId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "securityMACWeightId": { "type": "integer", "format": "int32" }, "securitySymbol": { "type": "string" }, "securityType": { "type": "string" }, "securityStatus": { "type": "string" }, "isTaxable": { "type": "boolean" }, "isTaxDeffered": { "type": "boolean" }, "isTaxExempted": { "type": "boolean" }, "isFixedIncomeTrading": { "type": "boolean" }, "securityCategoryId": { "type": "integer", "format": "int32" }, "securityClassId": { "type": "integer", "format": "int32" }, "securitySubClassId": { "type": "integer", "format": "int32" }, "securityId": { "type": "integer", "format": "int32" }, "rank": { "type": "integer", "format": "int32" }, "weightingPercentage": { "type": "number", "format": "double" }, "assetSubClassId": { "type": "integer", "format": "int32" }, "subclassName": { "type": "string" } }, "xml": { "name": "MacSettingsAssetSubClassLevelDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.SetAsideCashDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "setAsideCashAmountType": { "type": "string" }, "percentCalculationType": { "type": "string" }, "cashAmount": { "type": "number", "format": "double" }, "minCashAmount": { "type": "number", "format": "double" }, "maxCashAmount": { "type": "number", "format": "double" }, "portfolioSetAsideCashId": { "type": "integer", "format": "int32" } }, "xml": { "name": "SetAsideCashDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.BuyTradesWithinThirtyDaysFromTaxableAccountDto": { "properties": { "tlhAlternateSymbol": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" } }, "xml": { "name": "BuyTradesWithinThirtyDaysFromTaxableAccountDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.RestrictedPlanByAccountDto": { "properties": { "portfolioId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "restrictedPlanId": { "type": "integer", "format": "int32" }, "restrictedPlanName": { "type": "string" }, "securityId": { "type": "integer", "format": "int32" }, "securitySymbol": { "type": "string" }, "doNotBuyGroupEquivalency": { "type": "integer", "format": "int32" }, "buyPriority": { "type": "integer", "format": "int32" }, "sellPriority": { "type": "integer", "format": "int32" } }, "xml": { "name": "RestrictedPlanByAccountDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.HoldUntilTradesDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "holdUntilTrade": { "type": "integer", "format": "int32" } }, "xml": { "name": "HoldUntilTradesDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.SmaAccountWeightingsDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "modelDetailId": { "type": "integer", "format": "int32" }, "modelId": { "type": "integer", "format": "int32" }, "modelNodeName": { "type": "string" }, "orionConnectAccountId": { "type": "integer", "format": "int32" }, "weightPercent": { "type": "number", "format": "double" } }, "xml": { "name": "SmaAccountWeightingsDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.AccountSurplusCashDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "surplusCash": { "type": "number", "format": "double" } }, "xml": { "name": "AccountSurplusCashDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.SleevePreferencesDto": { "properties": { "optionId": { "type": "integer", "format": "int32" }, "prefValue": { "type": "string" }, "optionOrder": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "SleevePreferencesDto" }, "type": "object" }, "OAS.DataProcess.CompareTool.Models.AccountCompareToolViewModelDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "ocAccountId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "accountNumber": { "type": "string" }, "modelId": { "type": "integer", "format": "int32" }, "modelName": { "type": "string" }, "actualValue": { "type": "number", "format": "double" }, "actualPercent": { "type": "number", "format": "double" }, "targetPercent": { "type": "number", "format": "double" }, "targetValue": { "type": "number", "format": "double" }, "targetCashPercent": { "type": "number", "format": "double" }, "targetCashValue": { "type": "number", "format": "double" }, "actualCashPercent": { "type": "number", "format": "double" }, "actualCashValue": { "type": "number", "format": "double" }, "costBasis": { "type": "number", "format": "double" }, "unrealizedGainLoss": { "type": "number", "format": "double" }, "custodianId": { "type": "integer", "format": "int32" }, "registrationTypeId": { "type": "integer", "format": "int32" }, "accountType": { "type": "string", "enum": [ "Normal sleeve", "Custodial account", "Contribution sleeve", "Distribution sleeve", "Unmanaged sleeve" ] }, "assets": { "items": { "$ref": "#/definitions/OAS.DataProcess.CompareTool.Models.AssetCompareToolViewModelDto" }, "xml": { "name": "AssetCompareToolViewModelDto", "wrapped": true }, "type": "array" }, "assetsAggregates": { "$ref": "#/definitions/OAS.DataProcess.CompareTool.Models.CalculatedAggregate" } }, "xml": { "name": "AccountCompareToolViewModelDto" }, "type": "object" }, "OAS.DataProcess.CompareTool.Models.ModelCompareToolViewModelDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "modelAggId": { "type": "integer", "format": "int32" }, "eclipseModelId": { "type": "integer", "format": "int32" }, "communityModelId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "riskScore": { "type": "number", "format": "double" }, "targetPercent": { "type": "number", "format": "double" }, "targetValue": { "type": "number", "format": "double" }, "actualPercent": { "type": "number", "format": "double" }, "actualValue": { "type": "number", "format": "double" }, "items": { "items": { "$ref": "#/definitions/OAS.DataProcess.CompareTool.Models.ModelItemCompareToolViewModelDto" }, "xml": { "name": "ModelItemCompareToolViewModelDto", "wrapped": true }, "type": "array" }, "itemsAggregate": { "$ref": "#/definitions/OAS.DataProcess.CompareTool.Models.CalculatedAggregate" } }, "xml": { "name": "ModelCompareToolViewModelDto" }, "type": "object" }, "OAS.DataProcess.CompareTool.Models.RiskOptionsDto": { "properties": { "riskScoreEnabled": { "type": "boolean" }, "bandName": { "type": "string" }, "driftRangeLow": { "type": "integer", "format": "int32" }, "driftRangeHigh": { "type": "integer", "format": "int32" } }, "xml": { "name": "RiskOptionsDto" }, "type": "object" }, "OAS.DataProcess.CompareTool.Models.CalculatedAggregate": { "properties": { "calculateValue": { "type": "number", "format": "double" }, "calculatePercent": { "type": "number", "format": "double" }, "calculateValueDiff": { "type": "number", "format": "double" }, "calculatePercentDiff": { "type": "number", "format": "double" }, "calculateTargetValue": { "type": "number", "format": "double" }, "calculateTargetPercent": { "type": "number", "format": "double" }, "calculateTargetValueDiff": { "type": "number", "format": "double" }, "calculateTargetPercentDiff": { "type": "number", "format": "double" } }, "xml": { "name": "CalculatedAggregate" }, "type": "object" }, "OAS.DataProcess.Trading.RepExpTrading.CompareTool.DTO.Rebalance.CompareCashTargets": { "properties": { "id": { "type": "integer", "format": "int32" }, "cashTarget": { "type": "number", "format": "double" } }, "xml": { "name": "CompareCashTargets" }, "type": "object" }, "OAS.WebApi.DTO.Trading.RetAstroSectorDto": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "penalty": { "type": "number", "format": "double" }, "minimumValue": { "type": "number", "format": "double" }, "maximumValue": { "type": "number", "format": "double" }, "sectorId": { "type": "string" }, "error": { "type": "boolean" } }, "xml": { "name": "RetAstroSectorDto" }, "type": "object" }, "OAS.DataProcess.CompareTool.Models.AssetCompareToolViewModelDto": { "properties": { "assetId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "securityId": { "type": "integer", "format": "int32" }, "ocSecurityId": { "type": "integer", "format": "int32" }, "symbol": { "type": "string" }, "units": { "type": "number", "format": "double" }, "price": { "type": "number", "format": "double" }, "actualValue": { "type": "number", "format": "double" }, "actualPercent": { "type": "number", "format": "double" }, "targetValue": { "type": "number", "format": "double" }, "targetPercent": { "type": "number", "format": "double" }, "modelTargetValue": { "type": "number", "format": "double" }, "modelTargetPercent": { "type": "number", "format": "double" }, "isCustodialCash": { "type": "boolean" }, "category": { "type": "string" }, "class": { "type": "string" }, "unrealizedGainLoss": { "type": "number", "format": "double" }, "isUnassigned": { "type": "boolean" }, "lots": { "items": { "$ref": "#/definitions/OAS.DataProcess.CompareTool.Models.EclipseTaxLotDto" }, "xml": { "name": "EclipseTaxLotDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "AssetCompareToolViewModelDto" }, "type": "object" }, "OAS.DataProcess.CompareTool.Models.ModelItemCompareToolViewModelDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "modelId": { "type": "integer", "format": "int32" }, "securityId": { "type": "integer", "format": "int32" }, "ocSecurityId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "symbol": { "type": "string" }, "category": { "type": "string" }, "class": { "type": "string" }, "isCustodialCash": { "type": "boolean" }, "targetPercent": { "type": "number", "format": "double" }, "targetValue": { "type": "number", "format": "double" }, "actualValue": { "type": "number", "format": "double" }, "actualPercent": { "type": "number", "format": "double" } }, "xml": { "name": "ModelItemCompareToolViewModelDto" }, "type": "object" }, "OAS.DataProcess.CompareTool.Models.EclipseTaxLotDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "assetId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "units": { "type": "number", "format": "double" }, "price": { "type": "number", "format": "double" }, "costBasis": { "type": "number", "format": "double" }, "unrealizedGainLoss": { "type": "number", "format": "double" }, "accountNumber": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "accountName": { "type": "string" }, "custodian": { "type": "string" }, "securityId": { "type": "integer", "format": "int32" }, "symbol": { "type": "string" }, "securityName": { "type": "string" }, "securityPrice": { "type": "number", "format": "double" }, "stUnrealizedGainLoss": { "type": "number", "format": "double" }, "stLotUnrealizedGainLossPercent": { "type": "number", "format": "double" }, "stHoldingUnrealizedGainLossPercent": { "type": "number", "format": "double" }, "ltUnrealizedGainLoss": { "type": "number", "format": "double" }, "ltLotUnrealizedGainLossPercent": { "type": "number", "format": "double" }, "ltHoldingUnrealizedGainLossPercent": { "type": "number", "format": "double" }, "lotUnrealizedGainLossPercent": { "type": "number", "format": "double" }, "holdingUnrealizedGainLossPercent": { "type": "number", "format": "double" }, "washUnits": { "type": "number", "format": "double" }, "washAmount": { "type": "number", "format": "double" }, "costAmount": { "type": "number", "format": "double" }, "estimatedTax": { "type": "number", "format": "double" }, "securityType": { "type": "string" }, "quantity": { "type": "number", "format": "double" }, "costPerShare": { "type": "number", "format": "double" }, "isLongTerm": { "type": "boolean" } }, "xml": { "name": "EclipseTaxLotDto" }, "type": "object" }, "OAS.DataProcess.Trading.RepExpTrading.SetAsideCash.SetAsideCashRecordDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "portfolioId": { "type": "integer", "format": "int32" }, "portfolioName": { "type": "string" }, "type": { "type": "integer", "format": "int32" }, "status": { "type": "boolean" }, "amount": { "type": "number", "format": "double" }, "eclipseAccountId": { "type": "integer", "format": "int32" }, "orionConnectAccountId": { "type": "integer", "format": "int32" }, "accountName": { "type": "string" }, "frequency": { "type": "integer", "format": "int32" }, "expirationType": { "type": "integer", "format": "int32" }, "expirationDate": { "type": "string" }, "defaultButton": { "type": "boolean" }, "description": { "type": "string" }, "dcaDetails": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.SetAsideCash.DcaRecordDetails" }, "oneTimeDetails": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.SetAsideCash.OneTimeWithdrawalDetails" }, "protectCashDetails": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.SetAsideCash.ProtectCashDetails" } }, "xml": { "name": "SetAsideCashRecordDto" }, "type": "object" }, "OAS.DataProcess.Trading.RepExpTrading.SetAsideCash.DcaRecordDetails": { "properties": { "totalPurchaseAmount": { "type": "number", "format": "double" }, "numPurchases": { "type": "integer", "format": "int32" }, "individualPurchaseAmount": { "type": "number", "format": "double" }, "nextPurchaseDate": { "type": "string" }, "subsequentPurchaseAmount": { "type": "integer", "format": "int32" }, "subsequentPurchaseFreq": { "type": "string" }, "detailIndex": { "type": "integer", "format": "int32" }, "frequencyType": { "type": "string", "enum": [ "Daily", "Weekly", "Monthly", "Yearly" ] }, "dcaEclipseIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, "xml": { "name": "DcaRecordDetails" }, "type": "object" }, "OAS.DataProcess.Trading.RepExpTrading.SetAsideCash.OneTimeWithdrawalDetails": { "properties": { "withdrawalAmount": { "type": "number", "format": "double" }, "scheduleWithdrawalOn": { "type": "integer", "format": "int32" }, "withdrawalDate": { "type": "string" }, "transactionType": { "type": "integer", "format": "int32" }, "toleranceBand": { "type": "number", "format": "double" } }, "xml": { "name": "OneTimeWithdrawalDetails" }, "type": "object" }, "OAS.DataProcess.Trading.RepExpTrading.SetAsideCash.ProtectCashDetails": { "properties": { "protectionTarget": { "type": "number", "format": "double" }, "minimumCash": { "type": "number", "format": "double" }, "maximumCash": { "type": "number", "format": "double" }, "beginningDate": { "type": "string" }, "expirationType": { "type": "integer", "format": "int32" }, "expirationDate": { "type": "string" }, "transactionType": { "type": "integer", "format": "int32" }, "toleranceBand": { "type": "number", "format": "double" }, "isPercent": { "type": "boolean" } }, "xml": { "name": "ProtectCashDetails" }, "type": "object" }, "OAS.DataModel.Trading.RepExpTrading.CollectionResultOfOAS.WebApi.DTO.Search.SearchProductDto[]": { "properties": { "data": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Search.SearchProductDto" }, "xml": { "name": "SearchProductDto", "wrapped": true }, "type": "array" }, "total": { "type": "integer", "format": "int32" }, "errorCode": { "type": "string" }, "errorMessage": { "type": "string" } }, "xml": { "name": "CollectionResult`1" }, "type": "object" }, "OAS.DataProcess.Trading.RepExpTrading.SearchProducts.ProductDetailDto": { "properties": { "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "productCategoryName": { "type": "string" }, "productClassName": { "type": "string" }, "productRiskScore": { "type": "integer", "format": "int32" } }, "xml": { "name": "ProductDetailDto" }, "type": "object" }, "System.Web.Http.OData.Query.ODataQueryOptionsOfOAS.DataProcess.Trading.RepExpTrading.RetModelAggLookupDto": { "properties": { "ifMatch": { "readOnly": true, "type": "object" }, "ifNoneMatch": { "readOnly": true, "type": "object" }, "context": { "$ref": "#/definitions/System.Web.Http.OData.ODataQueryContext", "readOnly": true }, "request": { "readOnly": true, "type": "object" }, "rawValues": { "$ref": "#/definitions/System.Web.Http.OData.Query.ODataRawQueryOptions", "readOnly": true }, "selectExpand": { "$ref": "#/definitions/System.Web.Http.OData.Query.SelectExpandQueryOption", "readOnly": true }, "filter": { "$ref": "#/definitions/System.Web.Http.OData.Query.FilterQueryOption", "readOnly": true }, "orderBy": { "$ref": "#/definitions/System.Web.Http.OData.Query.OrderByQueryOption", "readOnly": true }, "skip": { "$ref": "#/definitions/System.Web.Http.OData.Query.SkipQueryOption", "readOnly": true }, "top": { "$ref": "#/definitions/System.Web.Http.OData.Query.TopQueryOption", "readOnly": true }, "inlineCount": { "$ref": "#/definitions/System.Web.Http.OData.Query.InlineCountQueryOption", "readOnly": true }, "validator": { "$ref": "#/definitions/System.Web.Http.OData.Query.Validators.ODataQueryValidator" } }, "xml": { "name": "ODataQueryOptions`1" }, "type": "object" }, "System.Web.Http.OData.Query.ODataQueryOptionsOfOAS.DataProcess.Trading.RepExpTrading.Audit.RetSleeveAuditDto": { "properties": { "ifMatch": { "readOnly": true, "type": "object" }, "ifNoneMatch": { "readOnly": true, "type": "object" }, "context": { "$ref": "#/definitions/System.Web.Http.OData.ODataQueryContext", "readOnly": true }, "request": { "readOnly": true, "type": "object" }, "rawValues": { "$ref": "#/definitions/System.Web.Http.OData.Query.ODataRawQueryOptions", "readOnly": true }, "selectExpand": { "$ref": "#/definitions/System.Web.Http.OData.Query.SelectExpandQueryOption", "readOnly": true }, "filter": { "$ref": "#/definitions/System.Web.Http.OData.Query.FilterQueryOption", "readOnly": true }, "orderBy": { "$ref": "#/definitions/System.Web.Http.OData.Query.OrderByQueryOption", "readOnly": true }, "skip": { "$ref": "#/definitions/System.Web.Http.OData.Query.SkipQueryOption", "readOnly": true }, "top": { "$ref": "#/definitions/System.Web.Http.OData.Query.TopQueryOption", "readOnly": true }, "inlineCount": { "$ref": "#/definitions/System.Web.Http.OData.Query.InlineCountQueryOption", "readOnly": true }, "validator": { "$ref": "#/definitions/System.Web.Http.OData.Query.Validators.ODataQueryValidator" } }, "xml": { "name": "ODataQueryOptions`1" }, "type": "object" }, "OAS.DataProcess.Trading.RepExpTrading.SelfDirected.SelfDirectedDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "modelId": { "type": "integer", "format": "int32" }, "newMoneyModelAggId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "riskScore": { "type": "number", "format": "double" }, "tempAccountId": { "type": "integer", "format": "int64" }, "allocationItems": { "items": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.SelfDirected.SelfDirectedModelItemDto" }, "xml": { "name": "SelfDirectedModelItemDto", "wrapped": true }, "type": "array" }, "newMoneyItems": { "items": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.SelfDirected.SelfDirectedModelItemDto" }, "xml": { "name": "SelfDirectedModelItemDto", "wrapped": true }, "type": "array" }, "rebalanceAutomatically": { "type": "boolean" }, "custodialCashDetail": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.SelfDirected.CustodialCashDetailDto" }, "canEditModel": { "type": "boolean" }, "subAdvisorId": { "type": "integer", "format": "int32" } }, "xml": { "name": "SelfDirectedDto" }, "type": "object" }, "OAS.DataProcess.Trading.RepExpTrading.SelfDirected.SelfDirectedModelItemDto": { "properties": { "deductFeesFromProduct": { "type": "boolean" }, "isCustodialCash": { "type": "boolean" }, "currentPercent": { "type": "number", "format": "double" }, "currentValue": { "type": "number", "format": "double" }, "currentShares": { "type": "number", "format": "double" }, "productCategoryName": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "productClass": { "type": "string" }, "ticker": { "type": "string" }, "targetPercent": { "type": "number", "format": "double" }, "itemTol": { "type": "integer", "format": "int32" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "itemTolUpper": { "type": "number", "format": "double" }, "itemTolLower": { "type": "number", "format": "double" }, "oub": { "type": "number", "format": "double" }, "modelAggId": { "type": "integer", "format": "int32" }, "productRiskScore": { "type": "integer", "format": "int32" } }, "xml": { "name": "SelfDirectedModelItemDto" }, "type": "object" }, "OAS.DataProcess.Trading.RepExpTrading.SelfDirected.CustodialCashDetailDto": { "properties": { "product": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelItemFullDto" }, "requiredMinimum": { "type": "number", "format": "double" } }, "xml": { "name": "CustodialCashDetailDto" }, "type": "object" }, "OAS.DataProcess.Trading.RepExpTrading.CompareTool.DTO.Rebalance.RebalanceRequestWrapperDto": { "properties": { "sessionData": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.RebalancerSessionDataDto" }, "portfolioDetails": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.PortfolioDetailDto" }, "allPreferences": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.AllPreferencesDto" }, "modelData": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.ModelDataDto" }, "washSales": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.WashSaleDto" }, "type": { "type": "string", "enum": [ "NormalPortfolio", "NormalAccount", "SleeveAccount", "SleevePortfolio" ] }, "scenarioType": { "type": "string", "enum": [ "Rebalance", "ChangeAllocation", "RaiseCash", "DepositCash" ] }, "compareToolData": { "$ref": "#/definitions/OAS.DataProcess.CompareTool.Models.CompareToolViewModelDto" }, "accountSleeves": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.AccountSleeveMinimalDto" }, "xml": { "name": "AccountSleeveMinimalDto", "wrapped": true }, "type": "array" }, "cashConfig": { "$ref": "#/definitions/OAS.DataProcess.Trading.RepExpTrading.CompareTool.DTO.Rebalance.CashConfigDto" }, "sleeveStrategyAggId": { "type": "integer", "format": "int32" }, "needsAnalytics": { "type": "boolean" }, "portfolioRiskScore": { "type": "integer", "format": "int32" } }, "xml": { "name": "RebalanceRequestWrapperDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.AllPreferencesDto": { "properties": { "generalPreference": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.GeneralPreferenceDto" }, "xml": { "name": "GeneralPreferenceDto", "wrapped": true }, "type": "array" }, "generalPreferenceForAccount": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.GeneralPreferenceForAccountDto" }, "xml": { "name": "GeneralPreferenceForAccountDto", "wrapped": true }, "type": "array" }, "securityPreference": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.SecurityPreferenceDto" }, "xml": { "name": "SecurityPreferenceDto", "wrapped": true }, "type": "array" }, "securityPreferenceForAccount": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.SecurityPreferenceForAccountDto" }, "xml": { "name": "SecurityPreferenceForAccountDto", "wrapped": true }, "type": "array" }, "redemptionFeePreference": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.RedemptionFeePreferenceDto" }, "xml": { "name": "RedemptionFeePreferenceDto", "wrapped": true }, "type": "array" }, "redemptionFeePreferenceForAccount": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.RedemptionFeePreferenceForAccountDto" }, "xml": { "name": "RedemptionFeePreferenceForAccountDto", "wrapped": true }, "type": "array" }, "tradeMaxFeePreference": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.TradeMaxFeePreferenceDto" }, "xml": { "name": "TradeMaxFeePreferenceDto", "wrapped": true }, "type": "array" }, "tradeMaxFeePreferenceForAccount": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.TradeMaxFeePreferenceForAccountDto" }, "xml": { "name": "TradeMaxFeePreferenceForAccountDto", "wrapped": true }, "type": "array" }, "tradeMinFeePreference": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.TradeMinFeePreferenceDto" }, "xml": { "name": "TradeMinFeePreferenceDto", "wrapped": true }, "type": "array" }, "tradeMinFeePreferenceForAccount": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.TradeMinFeePreferenceForAccountDto" }, "xml": { "name": "TradeMinFeePreferenceForAccountDto", "wrapped": true }, "type": "array" }, "transactionFeePreference": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.TransactionFeePreferenceDto" }, "xml": { "name": "TransactionFeePreferenceDto", "wrapped": true }, "type": "array" }, "transactionFeePreferenceForAccount": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.TransactionFeePreferenceForAccountDto" }, "xml": { "name": "TransactionFeePreferenceForAccountDto", "wrapped": true }, "type": "array" }, "dividendReinvestSettingPreference": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.DividendReinvestSettingPreferenceDto" }, "xml": { "name": "DividendReinvestSettingPreferenceDto", "wrapped": true }, "type": "array" }, "dividendReinvestSettingPreferenceForAccount": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.DividendReinvestSettingPreferenceForAccountDto" }, "xml": { "name": "DividendReinvestSettingPreferenceForAccountDto", "wrapped": true }, "type": "array" }, "custodianRedemptionSettingPreference": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.CustodianRedemptionSettingPreferenceDto" }, "xml": { "name": "CustodianRedemptionSettingPreferenceDto", "wrapped": true }, "type": "array" }, "custodianRedemptionFeePreferenceForAccount": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.CustodianRedemptionFeePreferenceForAccountDto" }, "xml": { "name": "CustodianRedemptionFeePreferenceForAccountDto", "wrapped": true }, "type": "array" }, "capGainReinvestSettingPreference": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.CapGainReinvestSettingPreferenceDto" }, "xml": { "name": "CapGainReinvestSettingPreferenceDto", "wrapped": true }, "type": "array" }, "capGainReinvestSettingPreferenceForAccount": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.CapGainReinvestSettingPreferenceForAccountDto" }, "xml": { "name": "CapGainReinvestSettingPreferenceForAccountDto", "wrapped": true }, "type": "array" }, "locationOptimizationPreference": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.LocationOptimizationPreferenceDto" }, "xml": { "name": "LocationOptimizationPreferenceDto", "wrapped": true }, "type": "array" }, "tradeSettingPreference": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.TradeSettingPreferenceDto" }, "xml": { "name": "TradeSettingPreferenceDto", "wrapped": true }, "type": "array" }, "tradeSettingPreferenceForAccount": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.TradeSettingPreferenceForAccountDto" }, "xml": { "name": "TradeSettingPreferenceForAccountDto", "wrapped": true }, "type": "array" }, "locationAlternatesInPreferences": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.LocationAlternatesInPreferencesDto" }, "xml": { "name": "LocationAlternatesInPreferencesDto", "wrapped": true }, "type": "array" }, "tradeSettingByAccountType": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.TradeSettingByAccountTypeDto" }, "xml": { "name": "TradeSettingByAccountTypeDto", "wrapped": true }, "type": "array" }, "securitySettingPreferences": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.SecuritySettingPreferencesDto" }, "xml": { "name": "SecuritySettingPreferencesDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "AllPreferencesDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.ModelDataDto": { "properties": { "modelNodes": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.ModelNodesDto" }, "xml": { "name": "ModelNodesDto", "wrapped": true }, "type": "array" }, "targetSecurities": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.TargetSecuritiesDto" }, "xml": { "name": "TargetSecuritiesDto", "wrapped": true }, "type": "array" }, "tlhSecurities": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.TlhSecuritiesDto" }, "xml": { "name": "TlhSecuritiesDto", "wrapped": true }, "type": "array" }, "securitySetEquivalents": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.SecuritySetEquivalentsDto" }, "xml": { "name": "SecuritySetEquivalentsDto", "wrapped": true }, "type": "array" }, "preferenceLevelEquivalents": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.PreferenceLevelEquivalentsDto" }, "xml": { "name": "PreferenceLevelEquivalentsDto", "wrapped": true }, "type": "array" }, "groupEquivalents": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.GroupEquivalentsDto" }, "xml": { "name": "GroupEquivalentsDto", "wrapped": true }, "type": "array" }, "securitiesDetail": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.SecuritiesDetailDto" }, "xml": { "name": "SecuritiesDetailDto", "wrapped": true }, "type": "array" }, "alternateSecurityIds": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.AlternateSecurityIdsDto" }, "xml": { "name": "AlternateSecurityIdsDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ModelDataDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.WashSaleDto": { "properties": { "buyBuySell": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.BuyBuySellDto" }, "xml": { "name": "BuyBuySellDto", "wrapped": true }, "type": "array" }, "buySellBuy": { "items": { "$ref": "#/definitions/OAT.Eclipse.Compare.Core.Dtos.BuySellBuyDto" }, "xml": { "name": "BuySellBuyDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "WashSaleDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.GeneralPreferenceDto": { "properties": { "name": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "indicatorValue": { "type": "string" }, "optionName": { "type": "string" }, "preferenceDefaultValue": { "type": "string" }, "defaultValue": { "type": "string" }, "relatedType": { "type": "integer", "format": "int32" }, "relatedTypeId": { "type": "integer", "format": "int32" }, "prefOrder": { "type": "integer", "format": "int32" } }, "xml": { "name": "GeneralPreferenceDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.GeneralPreferenceForAccountDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "portfolioId": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "indicatorValue": { "type": "string" }, "optionName": { "type": "string" }, "preferenceDefaultValue": { "type": "string" }, "defaultValue": { "type": "string" }, "relatedType": { "type": "integer", "format": "int32" }, "relatedTypeId": { "type": "integer", "format": "int32" }, "prefOrder": { "type": "integer", "format": "int32" } }, "xml": { "name": "GeneralPreferenceForAccountDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.SecurityPreferenceDto": { "properties": { "name": { "type": "string" }, "defaultValue": { "type": "string" }, "minValue": { "type": "number", "format": "double" }, "maxValue": { "type": "number", "format": "double" }, "value": { "type": "string" }, "securityId": { "type": "integer", "format": "int32" }, "isMultiAssetClass": { "type": "integer", "format": "int32" }, "securityType": { "type": "string" }, "securityPrice": { "type": "number", "format": "double" }, "securityPriceDate": { "type": "string" }, "securityStatus": { "type": "string" }, "securitySymbol": { "type": "string" }, "securityTypeId": { "type": "integer", "format": "int32" }, "relatedType": { "type": "integer", "format": "int32" }, "relatedTypeId": { "type": "integer", "format": "int32" } }, "xml": { "name": "SecurityPreferenceDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.SecurityPreferenceForAccountDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "portfolioId": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "defaultValue": { "type": "string" }, "minValue": { "type": "number", "format": "double" }, "maxValue": { "type": "number", "format": "double" }, "value": { "type": "string" }, "securityId": { "type": "integer", "format": "int32" }, "securityType": { "type": "string" }, "securityPrice": { "type": "number", "format": "double" }, "securityPriceDate": { "type": "string" }, "securityStatus": { "type": "string" }, "securitySymbol": { "type": "string" }, "securityTypeId": { "type": "integer", "format": "int32" }, "relatedType": { "type": "integer", "format": "int32" }, "relatedTypeId": { "type": "integer", "format": "int32" } }, "xml": { "name": "SecurityPreferenceForAccountDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.RedemptionFeePreferenceDto": { "properties": { "securityId": { "type": "integer", "format": "int32" }, "securityTypeId": { "type": "integer", "format": "int32" }, "securityType": { "type": "string" }, "redemptionFeeTypeId": { "type": "string" }, "redemptionFeeAmount": { "type": "number", "format": "double" }, "redemptionFeeDays": { "type": "integer", "format": "int32" }, "redemptionFeeMinAmount": { "type": "number", "format": "double" }, "redemptionFeeMaxAmount": { "type": "number", "format": "double" }, "relatedType": { "type": "integer", "format": "int32" }, "relatedTypeId": { "type": "integer", "format": "int32" } }, "xml": { "name": "RedemptionFeePreferenceDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.RedemptionFeePreferenceForAccountDto": { "properties": { "portfolioId": { "type": "string" }, "accountId": { "type": "string" }, "custodianID": { "type": "integer", "format": "int32" }, "securityId": { "type": "integer", "format": "int32" }, "securityTypeId": { "type": "integer", "format": "int32" }, "securityType": { "type": "string" }, "redemptionFeeTypeId": { "type": "string" }, "redemptionFeeAmount": { "type": "number", "format": "double" }, "redemptionFeeDays": { "type": "integer", "format": "int32" }, "redemptionFeeMinAmount": { "type": "number", "format": "double" }, "redemptionFeeMaxAmount": { "type": "number", "format": "double" }, "relatedType": { "type": "integer", "format": "int32" }, "relatedTypeId": { "type": "integer", "format": "int32" } }, "xml": { "name": "RedemptionFeePreferenceForAccountDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.TradeMaxFeePreferenceDto": { "properties": { "securityId": { "type": "integer", "format": "int32" }, "securityTypeId": { "type": "integer", "format": "int32" }, "sellTradeMaxAmtBySecurity": { "type": "number", "format": "double" }, "sellTradeMaxPctBySecurity": { "type": "number", "format": "double" }, "buyTradeMaxAmtBySecurity": { "type": "number", "format": "double" }, "buyTradeMaxPctBySecurity": { "type": "number", "format": "double" }, "relatedType": { "type": "integer", "format": "int32" }, "relatedTypeId": { "type": "integer", "format": "int32" } }, "xml": { "name": "TradeMaxFeePreferenceDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.TradeMaxFeePreferenceForAccountDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "portfolioId": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "securityId": { "type": "integer", "format": "int32" }, "securityTypeId": { "type": "integer", "format": "int32" }, "sellTradeMaxAmtBySecurity": { "type": "number", "format": "double" }, "sellTradeMaxPctBySecurity": { "type": "number", "format": "double" }, "buyTradeMaxAmtBySecurity": { "type": "number", "format": "double" }, "buyTradeMaxPctBySecurity": { "type": "number", "format": "double" }, "relatedType": { "type": "integer", "format": "int32" }, "relatedTypeId": { "type": "integer", "format": "int32" } }, "xml": { "name": "TradeMaxFeePreferenceForAccountDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.TradeMinFeePreferenceDto": { "properties": { "securityId": { "type": "integer", "format": "int32" }, "securityTypeId": { "type": "integer", "format": "int32" }, "sellTradeMinAmtBySecurity": { "type": "number", "format": "double" }, "sellTradeMinPctBySecurity": { "type": "number", "format": "double" }, "buyTradeMinAmtBySecurity": { "type": "number", "format": "double" }, "buyTradeMinPctBySecurity": { "type": "number", "format": "double" }, "relatedType": { "type": "integer", "format": "int32" }, "relatedTypeId": { "type": "integer", "format": "int32" } }, "xml": { "name": "TradeMinFeePreferenceDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.TradeMinFeePreferenceForAccountDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "portfolioId": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "securityId": { "type": "integer", "format": "int32" }, "securityTypeId": { "type": "integer", "format": "int32" }, "sellTradeMinAmtBySecurity": { "type": "number", "format": "double" }, "sellTradeMinPctBySecurity": { "type": "number", "format": "double" }, "buyTradeMinAmtBySecurity": { "type": "number", "format": "double" }, "buyTradeMinPctBySecurity": { "type": "number", "format": "double" }, "relatedType": { "type": "integer", "format": "int32" }, "relatedTypeId": { "type": "integer", "format": "int32" } }, "xml": { "name": "TradeMinFeePreferenceForAccountDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.TransactionFeePreferenceDto": { "properties": { "securityId": { "type": "integer", "format": "int32" }, "securityTypeId": { "type": "integer", "format": "int32" }, "buyTransactionFee": { "type": "number", "format": "double" }, "sellTransactionFee": { "type": "number", "format": "double" }, "relatedType": { "type": "integer", "format": "int32" }, "relatedTypeId": { "type": "integer", "format": "int32" } }, "xml": { "name": "TransactionFeePreferenceDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.TransactionFeePreferenceForAccountDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "portfolioId": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "securityId": { "type": "integer", "format": "int32" }, "securityTypeId": { "type": "integer", "format": "int32" }, "buyTransactionFee": { "type": "number", "format": "double" }, "sellTransactionFee": { "type": "number", "format": "double" }, "relatedType": { "type": "integer", "format": "int32" }, "relatedTypeId": { "type": "integer", "format": "int32" } }, "xml": { "name": "TransactionFeePreferenceForAccountDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.DividendReinvestSettingPreferenceDto": { "properties": { "securityId": { "type": "integer", "format": "int32" }, "securityTypeId": { "type": "integer", "format": "int32" }, "taxableDivReInvest": { "type": "integer", "format": "int32" }, "taxDefDivReinvest": { "type": "integer", "format": "int32" }, "taxExemptDivReinvest": { "type": "integer", "format": "int32" }, "relatedType": { "type": "integer", "format": "int32" }, "relatedTypeId": { "type": "integer", "format": "int32" } }, "xml": { "name": "DividendReinvestSettingPreferenceDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.DividendReinvestSettingPreferenceForAccountDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "portfolioId": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "securityId": { "type": "integer", "format": "int32" }, "securityTypeId": { "type": "integer", "format": "int32" }, "taxableDivReInvest": { "type": "integer", "format": "int32" }, "taxDefDivReinvest": { "type": "integer", "format": "int32" }, "taxExemptDivReinvest": { "type": "integer", "format": "int32" }, "relatedType": { "type": "integer", "format": "int32" }, "relatedTypeId": { "type": "integer", "format": "int32" } }, "xml": { "name": "DividendReinvestSettingPreferenceForAccountDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.CustodianRedemptionSettingPreferenceDto": { "properties": { "securityId": { "type": "integer", "format": "int32" }, "securityTypeId": { "type": "integer", "format": "int32" }, "custodianRedemptionFeeTypeId": { "type": "integer", "format": "int32" }, "custodianRedemptionFeeAmount": { "type": "number", "format": "double" }, "custodianRedemptionFeeMinAmount": { "type": "number", "format": "double" }, "custodianRedemptionFeeMaxAmount": { "type": "number", "format": "double" }, "custodianRedemptionDays": { "type": "integer", "format": "int32" }, "relatedType": { "type": "integer", "format": "int32" }, "relatedTypeId": { "type": "integer", "format": "int32" } }, "xml": { "name": "CustodianRedemptionSettingPreferenceDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.CustodianRedemptionFeePreferenceForAccountDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "portfolioId": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "securityId": { "type": "integer", "format": "int32" }, "securityTypeId": { "type": "integer", "format": "int32" }, "custodianRedemptionFeeTypeId": { "type": "integer", "format": "int32" }, "custodianRedemptionFeeAmount": { "type": "number", "format": "double" }, "custodianRedemptionFeeMinAmount": { "type": "number", "format": "double" }, "custodianRedemptionFeeMaxAmount": { "type": "number", "format": "double" }, "custodianRedemptionDays": { "type": "integer", "format": "int32" }, "relatedType": { "type": "integer", "format": "int32" }, "relatedTypeId": { "type": "integer", "format": "int32" } }, "xml": { "name": "CustodianRedemptionFeePreferenceForAccountDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.CapGainReinvestSettingPreferenceDto": { "properties": { "securityId": { "type": "integer", "format": "int32" }, "securityTypeId": { "type": "integer", "format": "int32" }, "capGainReinvestTaxable": { "type": "integer", "format": "int32" }, "capGainsReinvestTaxExempt": { "type": "integer", "format": "int32" }, "capGainsReinvestTaxDef": { "type": "integer", "format": "int32" }, "relatedType": { "type": "integer", "format": "int32" }, "relatedTypeId": { "type": "integer", "format": "int32" } }, "xml": { "name": "CapGainReinvestSettingPreferenceDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.CapGainReinvestSettingPreferenceForAccountDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "portfolioId": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "securityId": { "type": "integer", "format": "int32" }, "securityTypeId": { "type": "integer", "format": "int32" }, "capGainReinvestTaxable": { "type": "boolean" }, "capGainsReinvestTaxExempt": { "type": "boolean" }, "capGainsReinvestTaxDef": { "type": "boolean" }, "relatedType": { "type": "integer", "format": "int32" }, "relatedTypeId": { "type": "integer", "format": "int32" } }, "xml": { "name": "CapGainReinvestSettingPreferenceForAccountDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.LocationOptimizationPreferenceDto": { "properties": { "group": { "type": "string" }, "displayName": { "type": "string" }, "defaultValue": { "type": "integer", "format": "int32" }, "assetType": { "type": "string" }, "assetTypeId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "locationPriorityIndex": { "type": "number", "format": "double" }, "relatedType": { "type": "integer", "format": "int32" }, "relatedTypeId": { "type": "integer", "format": "int32" }, "assetTypeName": { "type": "string" } }, "xml": { "name": "LocationOptimizationPreferenceDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.TradeSettingPreferenceDto": { "properties": { "securityId": { "type": "integer", "format": "int32" }, "securityTypeId": { "type": "integer", "format": "int32" }, "buyPriority": { "type": "integer", "format": "int32" }, "sellPriority": { "type": "integer", "format": "int32" }, "excludedFromTrading": { "type": "boolean" }, "relatedType": { "type": "integer", "format": "int32" }, "relatedTypeId": { "type": "integer", "format": "int32" } }, "xml": { "name": "TradeSettingPreferenceDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.TradeSettingPreferenceForAccountDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "portfolioId": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "securityId": { "type": "integer", "format": "int32" }, "securityTypeId": { "type": "integer", "format": "int32" }, "buyPriority": { "type": "integer", "format": "int32" }, "sellPriority": { "type": "integer", "format": "int32" }, "excludedFromTrading": { "type": "integer", "format": "int32" }, "relatedType": { "type": "integer", "format": "int32" }, "relatedTypeId": { "type": "integer", "format": "int32" } }, "xml": { "name": "TradeSettingPreferenceForAccountDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.LocationAlternatesInPreferencesDto": { "properties": { "securityId": { "type": "integer", "format": "int32" }, "relatedType": { "type": "integer", "format": "int32" }, "relatedTypeId": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "taxableAlternate": { "type": "integer", "format": "int32" }, "taxableSecurityType": { "type": "string" }, "taxableSecurityStatus": { "type": "string" }, "taxableAssetCategoryId": { "type": "integer", "format": "int32" }, "taxableAssetClassId": { "type": "integer", "format": "int32" }, "taxableAssetSubClassId": { "type": "integer", "format": "int32" }, "taxableSecuritySymbol": { "type": "string" }, "isTaxableFixedIncomeTrading": { "type": "integer", "format": "int32" }, "taxDeferredAlternate": { "type": "integer", "format": "int32" }, "taxDeferredSecurityType": { "type": "string" }, "taxDeferredSecurityStatus": { "type": "string" }, "taxDeferredAssetCategoryId": { "type": "integer", "format": "int32" }, "taxDeferredAssetClassId": { "type": "integer", "format": "int32" }, "taxDeferredAssetSubClassId": { "type": "integer", "format": "int32" }, "taxDeferredSecuritySymbol": { "type": "string" }, "isTaxDefFixedIncomeTrading": { "type": "integer", "format": "int32" }, "taxExemptAlternate": { "type": "integer", "format": "int32" }, "taxExemptSecurityType": { "type": "string" }, "taxExemptSecurityStatus": { "type": "string" }, "taxExemptAssetCategoryId": { "type": "integer", "format": "int32" }, "taxExemptAssetClassId": { "type": "integer", "format": "int32" }, "taxExemptAssetSubClassId": { "type": "integer", "format": "int32" }, "taxExemptSecuritySymbol": { "type": "string" }, "isTaxExemptFixedIncomeTrading": { "type": "integer", "format": "int32" } }, "xml": { "name": "LocationAlternatesInPreferencesDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.TradeSettingByAccountTypeDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "accountTaxableTypeId": { "type": "integer", "format": "int32" }, "accountTaxableType": { "type": "string" }, "securityId": { "type": "integer", "format": "int32" }, "buyPriority": { "type": "integer", "format": "int32" }, "sellPriority": { "type": "integer", "format": "int32" } }, "xml": { "name": "TradeSettingByAccountTypeDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.SecuritySettingPreferencesDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "displayName": { "type": "string" }, "defaultValue": { "type": "string" } }, "xml": { "name": "SecuritySettingPreferencesDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.ModelNodesDto": { "properties": { "name": { "type": "string" }, "modelDetailId": { "type": "integer", "format": "int32" }, "modelAllocation": { "type": "number", "format": "double" }, "lowerModelTolerancePercent": { "type": "number", "format": "double" }, "upperModelTolerancePercent": { "type": "number", "format": "double" }, "relatedType": { "type": "string" }, "relatedTypeId": { "type": "integer", "format": "int32" }, "rebalancePriority": { "type": "integer", "format": "int32" }, "tags": { "type": "string" }, "isDeleted": { "type": "integer", "format": "int32" }, "modelId": { "type": "integer", "format": "int32" }, "modelElementId": { "type": "integer", "format": "int32" }, "leftValue": { "type": "integer", "format": "int32" }, "rightValue": { "type": "integer", "format": "int32" }, "rank": { "type": "integer", "format": "int32" }, "levelNumber": { "type": "integer", "format": "int32" }, "assetName": { "type": "string" } }, "xml": { "name": "ModelNodesDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.TargetSecuritiesDto": { "properties": { "modelAllocation": { "type": "number", "format": "double" }, "lowerModelTolerancePercent": { "type": "number", "format": "double" }, "upperModelTolerancePercent": { "type": "number", "format": "double" }, "securitySetId": { "type": "integer", "format": "int32" }, "rank": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "taxableSecurityId": { "type": "integer", "format": "int32" }, "taxDeferredSecurityId": { "type": "integer", "format": "int32" }, "taxExemptSecurityId": { "type": "integer", "format": "int32" }, "minTradeAmount": { "type": "number", "format": "double" }, "minInitialBuyDollar": { "type": "number", "format": "double" }, "buyPriority": { "type": "integer", "format": "int32" }, "sellPriority": { "type": "integer", "format": "int32" }, "taxSecuritySymbol": { "type": "string" }, "taxDeferredSecuritySymbol": { "type": "string" }, "taxExemptSecuritySymbol": { "type": "string" }, "taxSecurityAssetCategoryId": { "type": "integer", "format": "int32" }, "isTaxableFixedIncomeTrading": { "type": "integer", "format": "int32" }, "taxDeferredSecurityAssetCategoryId": { "type": "integer", "format": "int32" }, "isTaxDefFixedIncomeTrading": { "type": "integer", "format": "int32" }, "taxExemptSecurityAssetCategoryId": { "type": "integer", "format": "int32" }, "isTaxExemptFixedIncomeTrading": { "type": "integer", "format": "int32" }, "taxSecurityAssetClassId": { "type": "integer", "format": "int32" }, "taxDeferredSecurityAssetClassId": { "type": "integer", "format": "int32" }, "taxExemptSecurityAssetClassId": { "type": "integer", "format": "int32" }, "taxSecurityAssetSubClassId": { "type": "integer", "format": "int32" }, "taxDeferredSecurityAssetSubClassId": { "type": "integer", "format": "int32" }, "taxExemptSecurityAssetSubClassId": { "type": "integer", "format": "int32" }, "taxSecurityType": { "type": "string" }, "taxDeferredSecurityType": { "type": "string" }, "taxExemptSecurityType": { "type": "string" }, "taxSecurityStatus": { "type": "string" }, "taxDeferredSecurityStatus": { "type": "string" }, "taxExemptSecurityStatus": { "type": "string" }, "symbol": { "type": "string" }, "assetCategoryId": { "type": "integer", "format": "int32" }, "assetClassId": { "type": "integer", "format": "int32" }, "assetSubClassId": { "type": "integer", "format": "int32" }, "isFixedIncomeTrading": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "securityStatus": { "type": "string" }, "isCustodialCash": { "type": "integer", "format": "int32" }, "securityType": { "type": "string" }, "securitySetModelDetailId": { "type": "integer", "format": "int32" }, "taxableMinTradeAmount": { "type": "number", "format": "double" }, "taxableMinInitialBuyDollar": { "type": "number", "format": "double" }, "taxDeferredMinTradeAmount": { "type": "number", "format": "double" }, "taxDeferredMinInitialBuyDollar": { "type": "number", "format": "double" }, "taxExemptMinTradeAmount": { "type": "number", "format": "double" }, "taxExemptMinInitialBuyDollar": { "type": "number", "format": "double" } }, "xml": { "name": "TargetSecuritiesDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.TlhSecuritiesDto": { "properties": { "securitySetModelDetailId": { "type": "integer", "format": "int32" }, "securitySetId": { "type": "integer", "format": "int32" }, "targetSecurityId": { "type": "integer", "format": "int32" }, "targetSecuritySymbol": { "type": "string" }, "tlhCustodianId": { "type": "integer", "format": "int32" }, "tlhSecurityId": { "type": "integer", "format": "int32" }, "tlhSecuritySymbol": { "type": "string" }, "tlhAssetCategoryId": { "type": "integer", "format": "int32" }, "tlhAssetClassId": { "type": "integer", "format": "int32" }, "tlhAssetSubClassId": { "type": "string" }, "tlhSecurityType": { "type": "string" }, "tlhSecurityStatus": { "type": "string" }, "isTLHFixedIncomeTrading": { "type": "boolean" } }, "xml": { "name": "TlhSecuritiesDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.SecuritySetEquivalentsDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "securitySetId": { "type": "integer", "format": "int32" }, "rank": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "equivalentSecurityId": { "type": "integer", "format": "int32" }, "isGroupEquivalent": { "type": "integer", "format": "int32" }, "taxableSecurityId": { "type": "integer", "format": "int32" }, "taxDeferredSecurityId": { "type": "integer", "format": "int32" }, "taxExemptSecurityId": { "type": "integer", "format": "int32" }, "minTradeAmount": { "type": "number", "format": "double" }, "minInitialBuyDollar": { "type": "number", "format": "double" }, "buyPriority": { "type": "integer", "format": "int32" }, "sellPriority": { "type": "integer", "format": "int32" }, "securitySetModelDetailId": { "type": "integer", "format": "int32" }, "taxableMinTradeAmount": { "type": "number", "format": "double" }, "taxableMinInitialBuyDollar": { "type": "number", "format": "double" }, "taxDeferredMinTradeAmount": { "type": "number", "format": "double" }, "taxDeferredMinInitialBuyDollar": { "type": "number", "format": "double" }, "taxExemptMinTradeAmount": { "type": "number", "format": "double" }, "taxExemptMinInitialBuyDollar": { "type": "number", "format": "double" }, "equivalenceLevel": { "type": "integer", "format": "int32" }, "equivalenceLevelId": { "type": "integer", "format": "int32" } }, "xml": { "name": "SecuritySetEquivalentsDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.PreferenceLevelEquivalentsDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "securitySetId": { "type": "integer", "format": "int32" }, "rank": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "equivalentSecurityId": { "type": "integer", "format": "int32" }, "isGroupEquivalent": { "type": "integer", "format": "int32" }, "taxableSecurityId": { "type": "integer", "format": "int32" }, "taxDeferredSecurityId": { "type": "integer", "format": "int32" }, "taxExemptSecurityId": { "type": "integer", "format": "int32" }, "minTradeAmount": { "type": "number", "format": "double" }, "minInitialBuyDollar": { "type": "number", "format": "double" }, "buyPriority": { "type": "integer", "format": "int32" }, "sellPriority": { "type": "integer", "format": "int32" }, "securitySetModelDetailId": { "type": "integer", "format": "int32" }, "taxableMinTradeAmount": { "type": "number", "format": "double" }, "taxableMinInitialBuyDollar": { "type": "number", "format": "double" }, "taxDeferredMinTradeAmount": { "type": "number", "format": "double" }, "taxDeferredMinInitialBuyDollar": { "type": "number", "format": "double" }, "taxExemptMinTradeAmount": { "type": "number", "format": "double" }, "taxExemptMinInitialBuyDollar": { "type": "number", "format": "double" }, "equivalenceLevel": { "type": "integer", "format": "int32" }, "equivalenceLevelId": { "type": "integer", "format": "int32" } }, "xml": { "name": "PreferenceLevelEquivalentsDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.GroupEquivalentsDto": { "properties": { "securitySetId": { "type": "integer", "format": "int32" }, "equivalentSecurityId": { "type": "integer", "format": "int32" }, "isGroupEquivalent": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "securitySetModelDetailId": { "type": "integer", "format": "int32" }, "buyPriority": { "type": "integer", "format": "int32" }, "sellPriority": { "type": "integer", "format": "int32" }, "equivalenceLevel": { "type": "integer", "format": "int32" }, "equivalenceLevelId": { "type": "integer", "format": "int32" } }, "xml": { "name": "GroupEquivalentsDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.SecuritiesDetailDto": { "properties": { "securityId": { "type": "integer", "format": "int32" }, "cusipId": { "type": "string" }, "isCustodialCash": { "type": "boolean" }, "securityType": { "type": "string" }, "securityPrice": { "type": "number", "format": "double" }, "securityPriceDate": { "type": "string" }, "securityStatus": { "type": "string" }, "securitySymbol": { "type": "string" }, "securityTypeId": { "type": "integer", "format": "int32" }, "isMultiAssetClass": { "type": "integer", "format": "int32" }, "isFixedIncomeTrading": { "type": "integer", "format": "int32" }, "assetCategoryId": { "type": "integer", "format": "int32" }, "assetClassId": { "type": "integer", "format": "int32" }, "assetSubClassId": { "type": "integer", "format": "int32" }, "isTradableMoneyMarket": { "type": "integer", "format": "int32" } }, "xml": { "name": "SecuritiesDetailDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.AlternateSecurityIdsDto": { "properties": { "custodianId": { "type": "integer", "format": "int32" }, "relatedType": { "type": "integer", "format": "int32" }, "relatedTypeId": { "type": "integer", "format": "int32" }, "securityId": { "type": "integer", "format": "int32" }, "taxableSecurityId": { "type": "integer", "format": "int32" }, "taxDeferredSecurityId": { "type": "integer", "format": "int32" }, "taxExemptSecurityId": { "type": "integer", "format": "int32" } }, "xml": { "name": "AlternateSecurityIdsDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.BuyBuySellDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "portfolioId": { "type": "integer", "format": "int32" }, "securityId": { "type": "integer", "format": "int32" }, "symbol": { "type": "string" }, "isBuyBuySell": { "type": "integer", "format": "int32" }, "quantity": { "type": "number", "format": "double" }, "totalGainLossAmount": { "type": "number", "format": "double" }, "originalQuantity": { "type": "number", "format": "double" } }, "xml": { "name": "BuyBuySellDto" }, "type": "object" }, "OAT.Eclipse.Compare.Core.Dtos.BuySellBuyDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "portfolioId": { "type": "integer", "format": "int32" }, "securityId": { "type": "integer", "format": "int32" }, "symbol": { "type": "string" }, "isBuyBuySell": { "type": "integer", "format": "int32" }, "quantity": { "type": "number", "format": "double" }, "totalGainLossAmount": { "type": "number", "format": "double" } }, "xml": { "name": "BuySellBuyDto" }, "type": "object" }, "OAS.DataProcess.Trading.RepExpTrading.ModelAssignment.ModelUpdateDto": { "properties": { "subAdvisorId": { "type": "integer", "format": "int32" }, "modelAggId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "modelAggType": { "type": "integer", "format": "int32" }, "riskScore": { "type": "integer", "format": "int32" } }, "xml": { "name": "ModelUpdateDto" }, "type": "object" }, "OAS.DataProcess.Trading.RepExpTrading.Models.RetRebalanceRequestDto": { "properties": { "registrationId": { "type": "integer", "format": "int32" }, "accountIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "rebalanceType": { "type": "string", "enum": [ "Portfolio", "Sleeve", "Model" ] }, "regLevel": { "type": "boolean" }, "response": { "type": "string" }, "waitForStatus": { "type": "boolean" }, "sleeveConfig": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveAssignmentConfigurationDto" } }, "xml": { "name": "RetRebalanceRequestDto" }, "type": "object" }, "OAS.DataProcess.Trading.RepExpTrading.ModelAssignment.PortfolioUpdateDto": { "properties": { "modelAggId": { "type": "integer", "format": "int32" }, "doNotTrade": { "type": "boolean" }, "rebalanceTypeId": { "type": "integer", "format": "int32" }, "rebalanceOptionId": { "type": "integer", "format": "int32" }, "rebalanceDay": { "type": "integer", "format": "int32" } }, "xml": { "name": "PortfolioUpdateDto" }, "type": "object" }, "OAS.WebApi.DTO.ReportAdministration.ReportListFullDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "reportName": { "type": "string" }, "reportDescription": { "type": "string" }, "isVersion": { "type": "boolean" }, "versionDescription": { "type": "string" }, "orientationType": { "type": "string", "enum": [ "Portrait", "Landscape" ] }, "layoutType": { "type": "string", "enum": [ "Standard", "Advanced" ] }, "zeroValuePages": { "type": "boolean" }, "ownerEntity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "ownerEntityId": { "type": "integer", "format": "int32" }, "isCreatedByRep": { "type": "boolean" }, "isQuarterlyStatement": { "type": "boolean" }, "isCreatedByMe": { "type": "boolean" }, "createdBy": { "type": "string" }, "useIncludeOptionForInception": { "type": "boolean" }, "webLevel": { "type": "string", "enum": [ "None", "Advisor", "BrokerDealer", "Wholesaler", "Rep", "Client" ] }, "optionGroupId": { "type": "integer", "format": "int32" }, "includeUserByDefault": { "type": "boolean" }, "includeBlankPageAfterCover": { "type": "boolean" }, "repUsers": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "clientUsers": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "repAssignments": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "clientAssignments": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "historicalAccounts": { "type": "string", "enum": [ "None", "CostBasis", "Performance" ] }, "registrationSort": { "type": "string", "enum": [ "None", "RegistrationName", "AccountType" ] }, "accountSort": { "type": "string", "enum": [ "None", "ValueAscending", "ValueDescending", "ManagementStyle", "AccountNumber" ] }, "dateDefaults": { "additionalProperties": { "$ref": "#/definitions/OAS.WebApi.DTO.ReportAdministration.ReportOptionDateDto" }, "type": "object" }, "userDefaults": { "additionalProperties": { "type": "string" }, "type": "object" }, "reportDefaults": { "additionalProperties": { "type": "string" }, "type": "object" }, "coverPageId": { "type": "integer", "format": "int32" }, "reportBuilderThemeId": { "type": "integer", "format": "int32" }, "templateType": { "type": "string", "enum": [ "All", "Standard", "FooterImage", "Disclaimer", "WiderLogo", "HeaderSlim" ] }, "sections": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.ReportAdministration.ReportSectionDto" }, "xml": { "name": "ReportSectionDto", "wrapped": true }, "type": "array" }, "householdSections": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.ReportAdministration.ReportSectionDto" }, "xml": { "name": "ReportSectionDto", "wrapped": true }, "type": "array" }, "registrationSections": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.ReportAdministration.ReportSectionDto" }, "xml": { "name": "ReportSectionDto", "wrapped": true }, "type": "array" }, "accountSections": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.ReportAdministration.ReportSectionDto" }, "xml": { "name": "ReportSectionDto", "wrapped": true }, "type": "array" }, "disclaimerSections": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.ReportAdministration.ReportSectionDto" }, "xml": { "name": "ReportSectionDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ReportListFullDto" }, "type": "object" }, "OAS.WebApi.DTO.ReportAdministration.ReportOptionDateDto": { "properties": { "value": { "type": "string" }, "sign": { "type": "string" }, "modifier": { "type": "integer", "format": "int32" } }, "xml": { "name": "ReportOptionDateDto" }, "type": "object" }, "OAS.WebApi.DTO.ReportAdministration.ReportSectionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "displayName": { "type": "string" }, "description": { "type": "string" }, "width": { "type": "string", "enum": [ "PortraitFull", "LandscapeFull", "LandscapeHalf" ] }, "templateType": { "type": "string", "enum": [ "All", "Standard", "FooterImage", "Disclaimer", "WiderLogo", "HeaderSlim" ] }, "parameters": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.ReportAdministration.ReportSectionParameterDto" }, "xml": { "name": "ReportSectionParameterDto", "wrapped": true }, "type": "array" }, "createdDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "ReportSectionDto" }, "type": "object" }, "OAS.WebApi.DTO.ReportAdministration.ReportSectionParameterDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "displayName": { "type": "string" }, "value": { "type": "string" } }, "xml": { "name": "ReportSectionParameterDto" }, "type": "object" }, "OAS.WebApi.DTO.ReportAdministration.ReportListDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "reportName": { "type": "string" }, "reportDescription": { "type": "string" }, "isVersion": { "type": "boolean" }, "versionDescription": { "type": "string" }, "orientationType": { "type": "string", "enum": [ "Portrait", "Landscape" ] }, "layoutType": { "type": "string", "enum": [ "Standard", "Advanced" ] }, "zeroValuePages": { "type": "boolean" }, "ownerEntity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "ownerEntityId": { "type": "integer", "format": "int32" }, "isCreatedByRep": { "type": "boolean" }, "isQuarterlyStatement": { "type": "boolean" }, "isCreatedByMe": { "type": "boolean" }, "createdBy": { "type": "string" }, "useIncludeOptionForInception": { "type": "boolean" }, "historicalAccounts": { "type": "string", "enum": [ "None", "CostBasis", "Performance" ] }, "registrationSort": { "type": "string", "enum": [ "None", "RegistrationName", "AccountType" ] }, "accountSort": { "type": "string", "enum": [ "None", "ValueAscending", "ValueDescending", "ManagementStyle", "AccountNumber" ] }, "versions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.ReportAdministration.ReportVersionDto" }, "xml": { "name": "ReportVersionDto", "wrapped": true }, "type": "array" }, "sections": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.ReportAdministration.ReportSectionDto" }, "xml": { "name": "ReportSectionDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ReportListDto" }, "type": "object" }, "OAS.WebApi.DTO.ReportAdministration.ReportVersionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "reportDescription": { "type": "string" }, "isVersion": { "type": "boolean" }, "versionDescription": { "type": "string" }, "orientationType": { "type": "string", "enum": [ "Portrait", "Landscape" ] }, "layoutType": { "type": "string", "enum": [ "Standard", "Advanced" ] }, "zeroValuePages": { "type": "boolean" }, "ownerEntity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "ownerEntityId": { "type": "integer", "format": "int32" }, "isCreatedByRep": { "type": "boolean" }, "isQuarterlyStatement": { "type": "boolean" }, "isCreatedByMe": { "type": "boolean" }, "createdBy": { "type": "string" }, "useIncludeOptionForInception": { "type": "boolean" }, "historicalAccounts": { "type": "string", "enum": [ "None", "CostBasis", "Performance" ] }, "registrationSort": { "type": "string", "enum": [ "None", "RegistrationName", "AccountType" ] }, "accountSort": { "type": "string", "enum": [ "None", "ValueAscending", "ValueDescending", "ManagementStyle", "AccountNumber" ] } }, "xml": { "name": "ReportVersionDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.RunReport.ReportSectionOptionDto": { "properties": { "category": { "type": "string" }, "childParameter": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "string" }, "display": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "input": { "type": "string" }, "options": { "type": "object" } }, "xml": { "name": "ReportSectionOptionDto" }, "type": "object" }, "OAS.WebApi.DTO.ReportAdministration.ReportSectionCategoryDto": { "properties": { "category": { "type": "string" }, "reportSections": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.ReportAdministration.ReportSectionDto" }, "xml": { "name": "ReportSectionDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ReportSectionCategoryDto" }, "type": "object" }, "OAS.DataModel.ReportAdministration.SimpleReportBuilderTheme": { "properties": { "owner": { "type": "string" }, "isActive": { "type": "boolean" }, "isRepEnabled": { "type": "boolean" }, "canEdit": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "SimpleReportBuilderTheme" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.VerboseActivitySettingsDto": { "properties": { "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "groupings": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.AdvancedActivityGrouping" }, "xml": { "name": "AdvancedActivityGrouping", "wrapped": true }, "type": "array" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "activitySummaryCategory": { "type": "string", "enum": [ "Unmanaged", "Performance", "ActivitySummary", "Allocation", "PortfolioDetail", "TaxDetail" ] }, "unmanagedActivitySummaryCategory": { "type": "string", "enum": [ "Unmanaged", "Performance", "ActivitySummary", "Allocation", "PortfolioDetail", "TaxDetail" ] }, "activitySummaryDetail": { "type": "string", "enum": [ "BeginningMarketValue", "BeginningBondAccrual", "EndingMarketValue", "EndingBondAccrual", "Contributions", "Distributions", "NetDividendsInterestGainsWithdrawn", "MiscellaneousCharges", "AdvisoryFeesPaid", "DividendsAndInterest", "DividendInterestReinvested", "ExchangeIn", "ExchangeOut", "MergeIn", "MergeOut", "JournalIn", "JournalOut", "InitialMergeIn", "InitialContributions", "TransfersInOut", "ExchangeInOut" ] }, "returnStyle": { "type": "string", "enum": [ "ActivitySummary", "ActivityDaily", "ActivityTransactionBreakdown", "AssetGroupAssignment" ] }, "periods": { "type": "string", "enum": [ "None", "Day", "MTD", "QTD", "YTD", "OneYear", "ThreeYear", "FiveYear", "TenYear", "Inception", "AllDates" ] }, "dailyFactorLimiter": { "type": "string", "enum": [ "None", "Day", "MTD", "QTD", "YTD", "OneYear", "ThreeYear", "FiveYear", "TenYear", "Inception", "AllDates" ] }, "calendarYears": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "previousYears": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "interval": { "type": "string" }, "useZeroInceptionValue": { "type": "boolean" }, "clientPerformanceInclude": { "type": "string", "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] } }, "xml": { "name": "VerboseActivitySettingsDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Activity.AdvancedActivityGrouping": { "properties": { "grouping": { "type": "string", "enum": [ "Undefined", "Representative", "Client", "Registration", "Account", "Asset", "AssetClass", "ProductType", "Platform", "RiskCategory", "Product", "IndexBlend", "AssetCategory", "AssetLevelStrategy", "AggregateModel", "AccountType", "PortfolioGroup" ] }, "activitySummaryCategory": { "type": "string", "enum": [ "Unmanaged", "Performance", "ActivitySummary", "Allocation", "PortfolioDetail", "TaxDetail" ] }, "activitySummaryDetail": { "type": "string", "enum": [ "BeginningMarketValue", "BeginningBondAccrual", "EndingMarketValue", "EndingBondAccrual", "Contributions", "Distributions", "NetDividendsInterestGainsWithdrawn", "MiscellaneousCharges", "AdvisoryFeesPaid", "DividendsAndInterest", "DividendInterestReinvested", "ExchangeIn", "ExchangeOut", "MergeIn", "MergeOut", "JournalIn", "JournalOut", "InitialMergeIn", "InitialContributions", "TransfersInOut", "ExchangeInOut" ] }, "returnStyle": { "type": "string", "enum": [ "ActivitySummary", "ActivityDaily", "ActivityTransactionBreakdown", "AssetGroupAssignment" ] }, "periods": { "type": "string", "enum": [ "None", "Day", "MTD", "QTD", "YTD", "OneYear", "ThreeYear", "FiveYear", "TenYear", "Inception", "AllDates" ] }, "calendarYears": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "previousYears": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "groupings": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.AdvancedActivityGrouping" }, "xml": { "name": "AdvancedActivityGrouping", "wrapped": true }, "type": "array" } }, "xml": { "name": "AdvancedActivityGrouping" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Activity.ActivityPortfolio": { "properties": { "pkGroup": { "type": "integer", "format": "int32" }, "fkParentGroup": { "type": "integer", "format": "int32" }, "fkBucket": { "type": "integer", "format": "int32" }, "fkEntity": { "type": "integer", "format": "int32" }, "grouping": { "type": "string", "enum": [ "Undefined", "Representative", "Client", "Registration", "Account", "Asset", "AssetClass", "ProductType", "Platform", "RiskCategory", "Product", "IndexBlend", "AssetCategory", "AssetLevelStrategy", "AggregateModel", "AccountType", "PortfolioGroup" ] }, "fkGroupEntity": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "inceptionDate": { "type": "string", "format": "date-time" }, "activitySummaryDetail": { "type": "string", "enum": [ "BeginningMarketValue", "BeginningBondAccrual", "EndingMarketValue", "EndingBondAccrual", "Contributions", "Distributions", "NetDividendsInterestGainsWithdrawn", "MiscellaneousCharges", "AdvisoryFeesPaid", "DividendsAndInterest", "DividendInterestReinvested", "ExchangeIn", "ExchangeOut", "MergeIn", "MergeOut", "JournalIn", "JournalOut", "InitialMergeIn", "InitialContributions", "TransfersInOut", "ExchangeInOut" ] }, "activitySummaryCategory": { "type": "string", "enum": [ "Unmanaged", "Performance", "NotPerformance", "ActivitySummary", "NotActivitySummary", "Allocation", "NotAllocation", "PortfolioDetail", "NotPortfolioDetail", "TaxDetail", "NotTaxDetail" ] }, "portfolios": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.ActivityPortfolio" }, "xml": { "name": "ActivityPortfolio", "wrapped": true }, "type": "array" }, "summaries": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.ActivitySummary" }, "xml": { "name": "ActivitySummary", "wrapped": true }, "type": "array" }, "details": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.ActivityDetail" }, "xml": { "name": "ActivityDetail", "wrapped": true }, "type": "array" }, "transactionBreakdowns": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.ActivityTransactionBreakdown" }, "xml": { "name": "ActivityTransactionBreakdown", "wrapped": true }, "type": "array" }, "assetGroupAssignments": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.ActivityAssetGroupAssignment" }, "xml": { "name": "ActivityAssetGroupAssignment", "wrapped": true }, "type": "array" }, "assetDateGroupAssignments": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.ActivityAssetDateGroupAssignment" }, "xml": { "name": "ActivityAssetDateGroupAssignment", "wrapped": true }, "type": "array" } }, "xml": { "name": "ActivityPortfolio" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Activity.ActivitySummary": { "properties": { "pkGroup": { "type": "integer", "format": "int32" }, "fkReportCategory": { "type": "string", "enum": [ "Unmanaged", "Performance", "NotPerformance", "ActivitySummary", "NotActivitySummary", "Allocation", "NotAllocation", "PortfolioDetail", "NotPortfolioDetail", "TaxDetail", "NotTaxDetail" ] }, "pkDateRange": { "type": "integer", "format": "int32" }, "dateRangeName": { "type": "string" }, "fkActivitySummaryType": { "type": "string", "enum": [ "BeginningMarketValue", "BeginningBondAccrual", "EndingMarketValue", "EndingBondAccrual", "Contributions", "Distributions", "NetDividendsInterestGainsWithdrawn", "MiscellaneousCharges", "AdvisoryFeesPaid", "DividendsAndInterest", "DividendInterestReinvested", "ExchangeIn", "ExchangeOut", "MergeIn", "MergeOut", "JournalIn", "JournalOut", "InitialMergeIn", "InitialContributions", "TransfersInOut", "ExchangeInOut" ] }, "value": { "type": "number", "format": "double" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "ActivitySummary" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Activity.ActivityDetail": { "properties": { "pkGroup": { "type": "integer", "format": "int32" }, "fkReportCategory": { "type": "string", "enum": [ "Unmanaged", "Performance", "NotPerformance", "ActivitySummary", "NotActivitySummary", "Allocation", "NotAllocation", "PortfolioDetail", "NotPortfolioDetail", "TaxDetail", "NotTaxDetail" ] }, "fkActivitySummaryType": { "type": "string", "enum": [ "BeginningMarketValue", "BeginningBondAccrual", "EndingMarketValue", "EndingBondAccrual", "Contributions", "Distributions", "NetDividendsInterestGainsWithdrawn", "MiscellaneousCharges", "AdvisoryFeesPaid", "DividendsAndInterest", "DividendInterestReinvested", "ExchangeIn", "ExchangeOut", "MergeIn", "MergeOut", "JournalIn", "JournalOut", "InitialMergeIn", "InitialContributions", "TransfersInOut", "ExchangeInOut" ] }, "asOfDate": { "type": "string", "format": "date-time" }, "value": { "type": "number", "format": "double" } }, "xml": { "name": "ActivityDetail" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Activity.ActivityTransactionBreakdown": { "properties": { "pkGroup": { "type": "integer", "format": "int32" }, "fkReportCategory": { "type": "string", "enum": [ "Unmanaged", "Performance", "NotPerformance", "ActivitySummary", "NotActivitySummary", "Allocation", "NotAllocation", "PortfolioDetail", "NotPortfolioDetail", "TaxDetail", "NotTaxDetail" ] }, "fkActivitySummaryType": { "type": "string", "enum": [ "BeginningMarketValue", "BeginningBondAccrual", "EndingMarketValue", "EndingBondAccrual", "Contributions", "Distributions", "NetDividendsInterestGainsWithdrawn", "MiscellaneousCharges", "AdvisoryFeesPaid", "DividendsAndInterest", "DividendInterestReinvested", "ExchangeIn", "ExchangeOut", "MergeIn", "MergeOut", "JournalIn", "JournalOut", "InitialMergeIn", "InitialContributions", "TransfersInOut", "ExchangeInOut" ] }, "asOfDate": { "type": "string", "format": "date-time" }, "pkTransaction": { "type": "integer", "format": "int32" }, "value": { "type": "number", "format": "double" } }, "xml": { "name": "ActivityTransactionBreakdown" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Activity.ActivityAssetGroupAssignment": { "properties": { "pkGroup": { "type": "integer", "format": "int32" }, "fkAsset": { "type": "integer", "format": "int32" }, "performance": { "type": "boolean" }, "activitySummary": { "type": "boolean" }, "allocation": { "type": "boolean" }, "portfolioDetail": { "type": "boolean" }, "taxDetail": { "type": "boolean" } }, "xml": { "name": "ActivityAssetGroupAssignment" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Activity.ActivityAssetDateGroupAssignment": { "properties": { "pkGroup": { "type": "integer", "format": "int32" }, "fkAsset": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "weight": { "type": "number", "format": "double" } }, "xml": { "name": "ActivityAssetDateGroupAssignment" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.SimpleTransactionBreakdownActivitySettingsDto": { "properties": { "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "activitySummaryDetail": { "type": "string", "enum": [ "BeginningMarketValue", "BeginningBondAccrual", "EndingMarketValue", "EndingBondAccrual", "Contributions", "Distributions", "NetDividendsInterestGainsWithdrawn", "MiscellaneousCharges", "AdvisoryFeesPaid", "DividendsAndInterest", "DividendInterestReinvested", "ExchangeIn", "ExchangeOut", "MergeIn", "MergeOut", "JournalIn", "JournalOut", "InitialMergeIn", "InitialContributions", "TransfersInOut", "ExchangeInOut" ] }, "clientPerformanceInclude": { "type": "string", "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, "excludeCashSweepTransactions": { "type": "boolean" }, "useZeroInceptionValue": { "type": "boolean" }, "accountNumbersToShow": { "type": "integer", "format": "int32" }, "reportCategory": { "type": "string", "enum": [ "Unmanaged", "Performance", "ActivitySummary", "Allocation", "PortfolioDetail", "TaxDetail" ] }, "accountsInclusionOverride": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.AccountManagementOverride" }, "xml": { "name": "AccountManagementOverride", "wrapped": true }, "type": "array" } }, "xml": { "name": "SimpleTransactionBreakdownActivitySettingsDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.SimpleTransactionBreakdownActivityDto": { "properties": { "fkActivitySummaryType": { "type": "string", "enum": [ "BeginningMarketValue", "BeginningBondAccrual", "EndingMarketValue", "EndingBondAccrual", "Contributions", "Distributions", "NetDividendsInterestGainsWithdrawn", "MiscellaneousCharges", "AdvisoryFeesPaid", "DividendsAndInterest", "DividendInterestReinvested", "ExchangeIn", "ExchangeOut", "MergeIn", "MergeOut", "JournalIn", "JournalOut", "InitialMergeIn", "InitialContributions", "TransfersInOut", "ExchangeInOut" ] }, "activitySummaryTypeName": { "type": "string", "enum": [ "BeginningMarketValue", "BeginningBondAccrual", "EndingMarketValue", "EndingBondAccrual", "Contributions", "Distributions", "NetDividendsInterestGainsWithdrawn", "MiscellaneousCharges", "AdvisoryFeesPaid", "DividendsAndInterest", "DividendInterestReinvested", "ExchangeIn", "ExchangeOut", "MergeIn", "MergeOut", "JournalIn", "JournalOut", "InitialMergeIn", "InitialContributions", "TransfersInOut", "ExchangeInOut" ] }, "value": { "type": "number", "format": "double" }, "transactions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.SimpleTransactionBreakdownDto" }, "xml": { "name": "SimpleTransactionBreakdownDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "SimpleTransactionBreakdownActivityDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.SimpleTransactionBreakdownDto": { "properties": { "asOfDate": { "type": "string", "format": "date-time" }, "pkTransaction": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "ticker": { "type": "string" }, "custodianName": { "type": "string" }, "accountNumber": { "type": "string" }, "maskedAccountNumber": { "type": "string" }, "value": { "type": "number", "format": "double" }, "advisorNotes": { "type": "string" }, "fundFamily": { "type": "string" }, "transactionType": { "type": "string" }, "noUnits": { "type": "number", "format": "double" }, "navPrice": { "type": "number", "format": "double" } }, "xml": { "name": "SimpleTransactionBreakdownDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Activity.HoldingsSettingsDto": { "properties": { "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "grouping": { "type": "string", "enum": [ "Undefined", "Representative", "Client", "Registration", "Account", "Asset", "AssetClass", "ProductType", "Platform", "RiskCategory", "Product", "IndexBlend", "AssetCategory", "AssetLevelStrategy", "AggregateModel", "AccountType", "PortfolioGroup" ] }, "asOfDate": { "type": "string", "format": "date-time" }, "includeCostBasis": { "type": "boolean" }, "includeUnitBalance": { "type": "boolean" }, "includePrice": { "type": "boolean" }, "includeBondAccrual": { "type": "boolean" }, "clientPerformanceInclude": { "type": "string", "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, "useZeroInceptionValue": { "type": "boolean" }, "unmanagedInclusionOverride": { "type": "string", "enum": [ "Unmanaged", "Performance", "ActivitySummary", "Allocation", "PortfolioDetail", "TaxDetail" ] }, "returnAssets": { "type": "boolean" }, "reportCategory": { "type": "string", "enum": [ "Unmanaged", "Performance", "ActivitySummary", "Allocation", "PortfolioDetail", "TaxDetail" ] }, "accountNumberToShow": { "type": "integer", "format": "int32" }, "forUnmanaged": { "type": "boolean" } }, "xml": { "name": "HoldingsSettingsDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Activity.HoldingsReturnDtoBase": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "color": { "type": "string" }, "sortOrder": { "type": "integer", "format": "int32" }, "value": { "type": "number", "format": "double" }, "costBasis": { "type": "number", "format": "double" }, "totalGainLoss": { "type": "number", "format": "double" }, "percentageOfEntity": { "type": "number", "format": "double" }, "inceptionDate": { "type": "string" }, "percentageOfGroup": { "type": "number", "format": "double" }, "assets": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.HoldingsReturnDtoBase" }, "xml": { "name": "HoldingsReturnDtoBase", "wrapped": true }, "type": "array" } }, "xml": { "name": "HoldingsReturnDtoBase" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.CostBasis.CostBasisPayload": { "properties": { "assetId": { "type": "integer", "format": "int32" }, "costBasis": { "type": "number", "format": "double" }, "longTermGainLoss": { "type": "number", "format": "double" }, "shortTermGainLoss": { "type": "number", "format": "double" }, "acquiredDate": { "type": "string" } }, "xml": { "name": "CostBasisPayload" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Activity.DrillDownSummaryActivitySettingsDto": { "properties": { "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "groupings": { "items": { "type": "string", "enum": [ "Undefined", "Representative", "Client", "Registration", "Account", "Asset", "AssetClass", "ProductType", "Platform", "RiskCategory", "Product", "IndexBlend", "AssetCategory", "AssetLevelStrategy", "AggregateModel", "AccountType", "PortfolioGroup" ] }, "xml": { "name": "ReportGrouping", "wrapped": true }, "type": "array" }, "asOfDate": { "type": "string", "format": "date-time" }, "includeCostBasis": { "type": "boolean" }, "includeUnitBalance": { "type": "boolean" }, "includeBondAccrual": { "type": "boolean" }, "showZeroValueAssets": { "type": "boolean" }, "clientPerformanceInclude": { "type": "string", "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, "useZeroInceptionValue": { "type": "boolean" }, "reportCategory": { "type": "string", "enum": [ "Unmanaged", "Performance", "ActivitySummary", "Allocation", "PortfolioDetail", "TaxDetail" ] } }, "xml": { "name": "DrillDownSummaryActivitySettingsDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Activity.DrillDownSummaryActivityBase": { "properties": { "gainLossPercent": { "type": "number", "format": "double" }, "shortTermGainLoss": { "type": "number", "format": "double" }, "longTermGainLoss": { "type": "number", "format": "double" }, "acquiredDate": { "type": "string" }, "grouping": { "type": "string", "enum": [ "Undefined", "Representative", "Client", "Registration", "Account", "Asset", "AssetClass", "ProductType", "Platform", "RiskCategory", "Product", "IndexBlend", "AssetCategory", "AssetLevelStrategy", "AggregateModel", "AccountType", "PortfolioGroup" ] }, "groupEntityId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "color": { "type": "string" }, "sortOrder": { "type": "integer", "format": "int32" }, "value": { "type": "number", "format": "double" }, "percentageOfEntity": { "type": "number", "format": "double" }, "percentageOfGroup": { "type": "number", "format": "double" }, "costBasis": { "type": "number", "format": "double" }, "totalGainLoss": { "type": "number", "format": "double" } }, "xml": { "name": "DrillDownSummaryActivityBase" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Activity.TargetAndActualAllocationSettingsDto": { "properties": { "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "TargetAndActualAllocationSettingsDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Activity.TargetAndActualAllocationDto": { "properties": { "totalPortfolioValue": { "type": "number", "format": "double" }, "message": { "type": "string" }, "asOfDate": { "type": "string", "format": "date-time" }, "grouping": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "values": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.TargetAndActualAllocationEntityDto" }, "xml": { "name": "TargetAndActualAllocationEntityDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "TargetAndActualAllocationDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Activity.TargetAndActualAllocationEntityDto": { "properties": { "name": { "type": "string" }, "entityId": { "type": "integer", "format": "int32" }, "color": { "type": "string" }, "valueActual": { "type": "number", "format": "double" }, "valueTarget": { "type": "number", "format": "double" }, "valueVariance": { "type": "number", "format": "double" }, "percentageActual": { "type": "number", "format": "double" }, "percentageTarget": { "type": "number", "format": "double" }, "percentageVariance": { "type": "number", "format": "double" }, "targetAllocationMinimumRange": { "type": "number", "format": "double" }, "targetAllocationMaximumRange": { "type": "number", "format": "double" } }, "xml": { "name": "TargetAndActualAllocationEntityDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Activity.EstimatedIncomeSettingsDto": { "properties": { "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "groupings": { "items": { "type": "string", "enum": [ "Undefined", "Representative", "Client", "Registration", "Account", "Asset", "AssetClass", "ProductType", "Platform", "RiskCategory", "Product", "IndexBlend", "AssetCategory", "AssetLevelStrategy", "AggregateModel", "AccountType", "PortfolioGroup" ] }, "xml": { "name": "ReportGrouping", "wrapped": true }, "type": "array" }, "endDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "EstimatedIncomeSettingsDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Activity.EstimatedIncomeDto": { "properties": { "grouping": { "type": "string", "enum": [ "Undefined", "Representative", "Client", "Registration", "Account", "Asset", "AssetClass", "ProductType", "Platform", "RiskCategory", "Product", "IndexBlend", "AssetCategory", "AssetLevelStrategy", "AggregateModel", "AccountType", "PortfolioGroup" ] }, "groupEntityId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "color": { "type": "string" }, "sortOrder": { "type": "integer", "format": "int32" }, "marketEndValue": { "type": "number", "format": "double" }, "yieldOnCost": { "type": "number", "format": "double" }, "currentYield": { "type": "number", "format": "double" }, "estimatedAnnualIncome": { "type": "number", "format": "double" }, "allocationPercentage": { "type": "number", "format": "double" }, "children": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.EstimatedIncomeDto" }, "xml": { "name": "EstimatedIncomeDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "EstimatedIncomeDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Activity.FixedIncomeSummaryDto": { "properties": { "fixedIncome": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.FixedIncomeDto" }, "xml": { "name": "FixedIncomeDto", "wrapped": true }, "type": "array" }, "maturityDistribution": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.FixedIncomeDistributionDto" }, "xml": { "name": "FixedIncomeDistributionDto", "wrapped": true }, "type": "array" }, "couponDistribution": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.FixedIncomeDistributionDto" }, "xml": { "name": "FixedIncomeDistributionDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "FixedIncomeSummaryDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Activity.FixedIncomeDto": { "properties": { "grouping": { "type": "string", "enum": [ "Undefined", "Representative", "Client", "Registration", "Account", "Asset", "AssetClass", "ProductType", "Platform", "RiskCategory", "Product", "IndexBlend", "AssetCategory", "AssetLevelStrategy", "AggregateModel", "AccountType", "PortfolioGroup" ] }, "groupEntityId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "color": { "type": "string" }, "sortOrder": { "type": "integer", "format": "int32" }, "marketEndValue": { "type": "number", "format": "double" }, "accruedInterest": { "type": "number", "format": "double" }, "totalEndValue": { "type": "number", "format": "double" }, "maturityDate": { "type": "string", "format": "date-time" }, "couponRate": { "type": "number", "format": "double" }, "yieldOnCost": { "type": "number", "format": "double" }, "currentYield": { "type": "number", "format": "double" }, "yieldToWorst": { "type": "number", "format": "double" }, "yieldToNextCall": { "type": "number", "format": "double" }, "yieldToMaturityCost": { "type": "number", "format": "double" }, "estimatedAnnualIncome": { "type": "number", "format": "double" }, "maturityAmount": { "type": "number", "format": "double" }, "children": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.FixedIncomeDto" }, "xml": { "name": "FixedIncomeDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "FixedIncomeDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Activity.FixedIncomeDistributionDto": { "properties": { "category": { "type": "string" }, "amount": { "type": "number", "format": "double" } }, "xml": { "name": "FixedIncomeDistributionDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Activity.FixedIncomeDetailSummaryDto": { "properties": { "fixedIncome": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.FixedIncomeDto" }, "xml": { "name": "FixedIncomeDto", "wrapped": true }, "type": "array" }, "maturityDistribution": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.FixedIncomeDistributionDto" }, "xml": { "name": "FixedIncomeDistributionDto", "wrapped": true }, "type": "array" }, "couponDistribution": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.FixedIncomeDistributionDto" }, "xml": { "name": "FixedIncomeDistributionDto", "wrapped": true }, "type": "array" }, "yieldOnCost": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.FixedIncomeDistributionDto" }, "xml": { "name": "FixedIncomeDistributionDto", "wrapped": true }, "type": "array" }, "currentYield": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.FixedIncomeDistributionDto" }, "xml": { "name": "FixedIncomeDistributionDto", "wrapped": true }, "type": "array" }, "yieldToWorst": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.FixedIncomeDistributionDto" }, "xml": { "name": "FixedIncomeDistributionDto", "wrapped": true }, "type": "array" }, "estimatedAnnualIncome": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.FixedIncomeDistributionDto" }, "xml": { "name": "FixedIncomeDistributionDto", "wrapped": true }, "type": "array" }, "yieldToNextCall": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.FixedIncomeDistributionDto" }, "xml": { "name": "FixedIncomeDistributionDto", "wrapped": true }, "type": "array" }, "yieldToMaturity": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Activity.FixedIncomeDistributionDto" }, "xml": { "name": "FixedIncomeDistributionDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "FixedIncomeDetailSummaryDto" }, "type": "object" }, "OAS.WebApi.Domains.Reporting.RegressionSessionDto": { "properties": { "id": { "type": "integer", "format": "int64" }, "created": { "type": "string", "format": "date-time" }, "generated": { "type": "string", "format": "date-time" }, "clonedId": { "type": "integer", "format": "int64" }, "dataMatched": { "type": "integer", "format": "int32" }, "visualMatched": { "type": "integer", "format": "int32" }, "totalRecords": { "type": "integer", "format": "int32" }, "errorCount": { "type": "integer", "format": "int32" }, "pendingCount": { "type": "integer", "format": "int32" } }, "xml": { "name": "RegressionSessionDto" }, "type": "object" }, "OAS.WebApi.Domains.Reporting.RegressionInstanceDto": { "properties": { "alClientId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "reportId": { "type": "string" }, "reportName": { "type": "string" }, "instanceId": { "type": "integer", "format": "int64" }, "sessionId": { "type": "integer", "format": "int64" }, "previousSessionId": { "type": "integer", "format": "int64" }, "errorMessage": { "type": "string" }, "dataMatched": { "type": "boolean" }, "visualMatched": { "type": "boolean" }, "category": { "type": "string" } }, "xml": { "name": "RegressionInstanceDto" }, "type": "object" }, "OAS.WebApi.Domains.Reporting.AssignReportsDto": { "properties": { "name": { "type": "string" }, "amount": { "type": "integer", "format": "int32" } }, "xml": { "name": "AssignReportsDto" }, "type": "object" }, "OAS.DataProcess.Reporting.ReportingAi.ReportAssistant.ReportAssistantRequest": { "properties": { "editorContext": { "type": "string", "enum": [ "Report", "SubReport" ] }, "controlType": { "type": "string" }, "controlId": { "type": "string" }, "json": { "type": "string" }, "userContext": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportingAi.ReportAssistant.UserContext" }, "aiChatMessages": { "items": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportingAi.ReportAssistant.AiChatMessage" }, "xml": { "name": "AiChatMessage", "wrapped": true }, "type": "array" }, "promptCommand": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportingAi.ReportAssistant.ReportAssistantPrompt" }, "useLocalService": { "type": "boolean" }, "pageInfo": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportingAi.ReportAssistant.PaginationInfo" }, "correlationId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "summaryContext": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportingAi.ReportAssistant.ConversationSummaryContext" }, "prompt": { "type": "string" }, "resumeFollowup": { "type": "boolean" }, "originalPrompt": { "type": "string" }, "primaryIntent": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportingAi.ReportAssistant.RouteUserIntentOutput" }, "secondaryIntents": { "items": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportingAi.ReportAssistant.SecondaryIntentStepDto" }, "xml": { "name": "SecondaryIntentStepDto", "wrapped": true }, "type": "array" }, "cachedReferenceMaterial": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportingAi.ReportAssistant.CachedReferenceMaterial" } }, "xml": { "name": "ReportAssistantRequest" }, "type": "object" }, "OAS.DataProcess.Reporting.ReportingAi.ReportAssistant.UserContext": { "properties": { "alClientId": { "type": "integer", "format": "int32" }, "loginEntityId": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "loginUserId": { "type": "string" } }, "xml": { "name": "UserContext" }, "type": "object" }, "OAS.DataProcess.Reporting.ReportingAi.ReportAssistant.AiChatMessage": { "properties": { "role": { "type": "string" }, "text": { "type": "string" } }, "xml": { "name": "AiChatMessage" }, "type": "object" }, "OAS.DataProcess.Reporting.ReportingAi.ReportAssistant.ReportAssistantPrompt": { "properties": { "code": { "type": "string" }, "displayName": { "type": "string" }, "prompt": { "type": "string" } }, "xml": { "name": "ReportAssistantPrompt" }, "type": "object" }, "OAS.DataProcess.Reporting.ReportingAi.ReportAssistant.PaginationInfo": { "properties": { "pageNumber": { "type": "integer", "format": "int32" } }, "xml": { "name": "PaginationInfo" }, "type": "object" }, "OAS.DataProcess.Reporting.ReportingAi.ReportAssistant.ConversationSummaryContext": { "properties": { "summary": { "type": "string" }, "messageCount": { "type": "integer", "format": "int32" } }, "xml": { "name": "ConversationSummaryContext" }, "type": "object" }, "OAS.DataProcess.Reporting.ReportingAi.ReportAssistant.RouteUserIntentOutput": { "properties": { "intent": { "type": "string" }, "confidence": { "type": "number", "format": "double" }, "steps": { "items": { "type": "string" }, "type": "array" }, "controlList": { "items": { "type": "string" }, "type": "array" }, "addControlType": { "type": "string" }, "convertToControlType": { "type": "string" }, "referenceControlType": { "type": "string" }, "location": { "type": "string" }, "needsTags": { "type": "boolean" }, "skipGroupingQuery": { "type": "boolean" }, "needsSettings": { "type": "boolean" }, "reason": { "type": "string" }, "followupQuestion": { "type": "string" } }, "xml": { "name": "RouteUserIntentOutput" }, "type": "object" }, "OAS.DataProcess.Reporting.ReportingAi.ReportAssistant.SecondaryIntentStepDto": { "properties": { "request": { "type": "string" }, "controlIntentOutput": { "additionalProperties": { "type": "object" }, "type": "object" } }, "xml": { "name": "SecondaryIntentStepDto" }, "type": "object" }, "OAS.DataProcess.Reporting.ReportingAi.ReportAssistant.CachedReferenceMaterial": { "properties": { "groupingList": { "type": "string" }, "tagList": { "type": "string" }, "settingsList": { "type": "string" } }, "xml": { "name": "CachedReferenceMaterial" }, "type": "object" }, "OAS.DataProcess.Reporting.ReportingAi.ReportAssistant.ReportAssistantResponse": { "properties": { "response": { "type": "string" }, "promptSuggestions": { "items": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportingAi.ReportAssistant.ReportAssistantPromptResponse" }, "xml": { "name": "ReportAssistantPromptResponse", "wrapped": true }, "type": "array" }, "intentParams": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportingAi.ReportAssistant.UserIntentParams" }, "summaryContext": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportingAi.ReportAssistant.ConversationSummaryContext" }, "primaryIntent": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportingAi.ReportAssistant.RouteUserIntentOutput" }, "originalPrompt": { "type": "string" }, "secondaryIntents": { "items": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportingAi.ReportAssistant.SecondaryIntentStepDto" }, "xml": { "name": "SecondaryIntentStepDto", "wrapped": true }, "type": "array" }, "cachedReferenceMaterial": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportingAi.ReportAssistant.CachedReferenceMaterial" } }, "xml": { "name": "ReportAssistantResponse" }, "type": "object" }, "OAS.DataProcess.Reporting.ReportingAi.ReportAssistant.ReportAssistantPromptResponse": { "properties": { "promptType": { "type": "string", "enum": [ "System", "Prompt" ] }, "promptParams": { "type": "string" }, "sortOrder": { "type": "integer", "format": "int32" }, "code": { "type": "string" }, "displayName": { "type": "string" }, "prompt": { "type": "string" } }, "xml": { "name": "ReportAssistantPromptResponse" }, "type": "object" }, "OAS.DataProcess.Reporting.ReportingAi.ReportAssistant.UserIntentParams": { "properties": { "intent": { "type": "string" }, "parentControlId": { "type": "string" }, "addControlLocation": { "type": "string" }, "addControlType": { "type": "string" }, "documentationType": { "type": "string", "enum": [ "Full", "Property" ] }, "requests": { "items": { "type": "string" }, "type": "array" } }, "xml": { "name": "UserIntentParams" }, "type": "object" }, "OAS.DataProcess.Reporting.ReportingAi.ReportAssistant.ReportAssistantControlListResponse": { "properties": { "displayName": { "type": "string" }, "defaultSchema": { "type": "string" } }, "xml": { "name": "ReportAssistantControlListResponse" }, "type": "object" }, "OAS.DataProcess.Reporting.ReportingAi.ReportAssistant.PromptSystemResponse": { "properties": { "code": { "type": "string" }, "displayName": { "type": "string" }, "allowedLocations": { "type": "integer", "format": "int32" }, "prompt": { "type": "string" }, "promptType": { "type": "string", "enum": [ "System", "Prompt" ] }, "promptAction": { "type": "string", "enum": [ "Add", "Edit", "PromptCommand", "Dropdown", "Link" ] }, "promptParams": { "type": "string" }, "promptResponse": { "type": "string" }, "promptCodeSuggestions": { "items": { "type": "string" }, "type": "array" }, "properties": { "additionalProperties": { "type": "object" }, "type": "object" }, "invalidValues": { "additionalProperties": { "type": "object" }, "type": "object" }, "sortOrder": { "type": "integer", "format": "int32" } }, "xml": { "name": "PromptSystemResponse" }, "type": "object" }, "OAS.DataModel.Reporting.Compares.AutomatedComparesTestDto": { "properties": { "clientsToRunFor": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "reportIdsToRunFor": { "items": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "type": "array" } }, "xml": { "name": "AutomatedComparesTestDto" }, "type": "object" }, "OAS.WebApi.Domains.Reporting.TestVisualDto": { "properties": { "baselineInstanceId": { "type": "integer", "format": "int32" }, "cloneInstanceId": { "type": "integer", "format": "int32" } }, "xml": { "name": "TestVisualDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.ReportBatchVerboseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "hasCoverPage": { "type": "boolean" }, "canEdit": { "type": "boolean" }, "isGenerating": { "type": "boolean" }, "reportName": { "type": "string" }, "batch": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportBatchVerboseBatchDto" }, "inserts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportBatchInsertDto" }, "xml": { "name": "ReportBatchInsertDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ReportBatchVerboseDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.ReportBatchVerboseBatchDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "postedReportName": { "type": "string" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "reportId": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportIdResolver" }, "qpeItemId": { "type": "integer", "format": "int32" }, "auditedBy": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "printAlternativeAddresses": { "type": "boolean" }, "dynamicGroupingId": { "type": "integer", "format": "int32" }, "customReportId": { "type": "integer", "format": "int32" }, "videoStatementId": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "isLockedDown": { "type": "boolean" }, "entitySelectionMethod": { "type": "string", "enum": [ "Manual", "DynamicGroup", "CustomReport", "All", "Active", "ActiveWithValue", "BillInstance" ] }, "representativeId": { "type": "integer", "format": "int32" }, "billInstanceId": { "type": "integer", "format": "int32" }, "emailSubject": { "type": "string" }, "emailBody": { "type": "string" }, "emailFrom": { "type": "string" }, "folder": { "type": "string" }, "customReport": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportFullDto" }, "statementDeliveryMethod": { "type": "string", "enum": [ "UseAssigned", "Mail", "Email", "Website" ] }, "ftpFileName": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "fromInception": { "type": "boolean" }, "showInternalOnlyWarning": { "type": "boolean" }, "includeAllBills": { "type": "boolean" }, "expirationDate": { "type": "string", "format": "date-time" }, "restrictReps": { "type": "boolean" }, "isAdvisoryFee": { "type": "boolean" } }, "xml": { "name": "ReportBatchVerboseBatchDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.ReportBatchInsertDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "location": { "type": "string", "enum": [ "BeforeCoverPage", "AfterCoverPageBeforeReport", "AfterReport" ] }, "sequence": { "type": "integer", "format": "int32" }, "type": { "type": "string", "enum": [ "BlankPage", "CustomInsert", "BatchInsert", "BlankPageEvenOnly" ] }, "hasFile": { "type": "boolean" }, "entityCount": { "type": "integer", "format": "int32" }, "warningMessage": { "type": "string" } }, "xml": { "name": "ReportBatchInsertDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.ReportIdResolver": { "properties": { "reportGuid": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "reportListId": { "type": "integer", "format": "int32" } }, "xml": { "name": "ReportIdResolver" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.ReportBatchDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "postedReportName": { "type": "string" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "reportId": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportIdResolver" }, "reportName": { "type": "string" }, "qpeItemId": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "auditedBy": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "printAlternativeAddresses": { "type": "boolean" }, "dynamicGroupingId": { "type": "integer", "format": "int32" }, "customReportId": { "type": "integer", "format": "int32" }, "videoStatementId": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "hasCoverPage": { "type": "boolean" }, "isLockedDown": { "type": "boolean" }, "emailSubject": { "type": "string" }, "emailBody": { "type": "string" }, "restrictReps": { "type": "boolean" } }, "xml": { "name": "ReportBatchDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.ReportBatchReportInfoDto": { "properties": { "id": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportIdResolver" }, "name": { "type": "string" }, "hasCoverPage": { "type": "boolean" }, "allowed": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportBatchReportInfoAllowedEntitysDto" }, "xml": { "name": "ReportBatchReportInfoAllowedEntitysDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ReportBatchReportInfoDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.ReportBatchReportInfoAllowedEntitysDto": { "properties": { "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "selectionMethods": { "items": { "type": "string", "enum": [ "Manual", "DynamicGroup", "CustomReport", "All", "Active", "ActiveWithValue", "BillInstance" ] }, "xml": { "name": "BatchEntitySelectionMethod", "wrapped": true }, "type": "array" } }, "xml": { "name": "ReportBatchReportInfoAllowedEntitysDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.ReportBatchEntityDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "viewableBy": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "syncStatus": { "type": "string", "enum": [ "None", "Added", "Removed" ] }, "generationStatus": { "type": "string", "enum": [ "NotGenerated", "ErroredReport", "OnHold", "Generated", "PendingGeneration", "WillNotBeGenerated" ] }, "errorText": { "type": "string" }, "hasFile": { "type": "boolean" }, "auditedBy": { "type": "string" }, "brokerDealer": { "type": "string" }, "printVendorStatus": { "type": "string", "enum": [ "HasNotBeenSent", "Error", "SuccessfullySent", "Pending", "WillNotBeSent" ] }, "printVendorFileName": { "type": "string" }, "printVendorTime": { "type": "string", "format": "date-time" }, "transmitMethod": { "type": "string" }, "emailStatus": { "type": "string", "enum": [ "HasNotBeenSent", "Error", "SuccessfullySent", "Pending", "WillNotBeSent" ] }, "emailCurrent": { "type": "string" }, "emailUsed": { "type": "string" }, "emailTime": { "type": "string", "format": "date-time" } }, "xml": { "name": "ReportBatchEntityDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.ReportBatchDetectErrorDto": { "properties": { "batchEntityIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "errors": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportBatchDetectErrorOnPageDto" }, "xml": { "name": "ReportBatchDetectErrorOnPageDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ReportBatchDetectErrorDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.ReportBatchDetectErrorOnPageDto": { "properties": { "type": { "type": "string", "enum": [ "Forbidden", "Expected" ] }, "searchText": { "type": "string" }, "scope": { "type": "string", "enum": [ "FirstPage", "LastPage", "AnyPage", "EveryPage" ] } }, "xml": { "name": "ReportBatchDetectErrorOnPageDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.ReportBatchInsertFileDto": { "properties": { "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" } }, "xml": { "name": "ReportBatchInsertFileDto" }, "type": "object" }, "OAS.WebApi.Domains.Reporting.BIController.BIAccountHistory": { "properties": { "aum": { "type": "number", "format": "double" }, "accountId": { "type": "integer", "format": "int32" }, "closedAccountCount": { "type": "number", "format": "double" }, "closedAccountValue": { "type": "number", "format": "double" }, "feePercent": { "type": "number", "format": "double" }, "mergeIn": { "type": "number", "format": "double" }, "mergeOut": { "type": "number", "format": "double" }, "openedAccountCount": { "type": "number", "format": "double" }, "openedAccountValue": { "type": "number", "format": "double" }, "previousAUM": { "type": "number", "format": "double" }, "revenue": { "type": "number", "format": "double" }, "transferIn": { "type": "number", "format": "double" }, "transferOut": { "type": "number", "format": "double" }, "distributions": { "readOnly": true, "type": "number", "format": "double" }, "contributions": { "readOnly": true, "type": "number", "format": "double" }, "date": { "type": "string", "format": "date-time" }, "marketValueIncrease": { "readOnly": true, "type": "number", "format": "double" }, "marketValueDecrease": { "readOnly": true, "type": "number", "format": "double" }, "marketValueIncreaseDecrease": { "readOnly": true, "type": "number", "format": "double" } }, "xml": { "name": "BIAccountHistory" }, "type": "object" }, "OAS.WebApi.Domains.Reporting.BIController.BIProductHistory": { "properties": { "aum": { "type": "number", "format": "double" }, "productId": { "type": "integer", "format": "int32" }, "date": { "type": "string", "format": "date-time" } }, "xml": { "name": "BIProductHistory" }, "type": "object" }, "OAS.WebApi.Domains.Reporting.BIController.BIRepDto": { "properties": { "businessPhone": { "type": "string" }, "email": { "type": "string" }, "repId": { "type": "integer", "format": "int32" }, "repName": { "type": "string" }, "repNo": { "type": "string" } }, "xml": { "name": "BIRepDto" }, "type": "object" }, "OAS.WebApi.Domains.Reporting.BIController.BIHouseholdDto": { "properties": { "active": { "type": "boolean" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "address3": { "type": "string" }, "city": { "type": "string" }, "email": { "type": "string" }, "householdId": { "type": "integer", "format": "int32" }, "householdName": { "type": "string" }, "repId": { "type": "integer", "format": "int32" }, "state": { "type": "string" }, "zip": { "type": "string" } }, "xml": { "name": "BIHouseholdDto" }, "type": "object" }, "OAS.WebApi.Domains.Reporting.BIController.BIAccountDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "accountType": { "type": "string" }, "active": { "type": "boolean" }, "custodian": { "type": "string" }, "fundName": { "type": "string" }, "householdId": { "type": "integer", "format": "int32" }, "managed": { "type": "boolean" }, "managementStyle": { "type": "string" }, "registrationId": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "taxable": { "type": "boolean" }, "birthDate": { "readOnly": true, "type": "string", "format": "date-time" }, "age": { "readOnly": true, "type": "integer", "format": "int32" } }, "xml": { "name": "BIAccountDto" }, "type": "object" }, "OAS.WebApi.Domains.Reporting.BIController.BIAssetDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "assetId": { "type": "integer", "format": "int32" }, "assetValue": { "type": "number", "format": "double" }, "assetValue_1YR": { "type": "number", "format": "double" }, "assetValue_3YR": { "type": "number", "format": "double" }, "assetValue_5YR": { "type": "number", "format": "double" }, "assetValue_StatOfYear": { "type": "number", "format": "double" }, "managed": { "type": "boolean" }, "price": { "type": "number", "format": "double" }, "priceDate": { "type": "string", "format": "date-time" }, "productId": { "type": "integer", "format": "int32" }, "unitBalance": { "type": "number", "format": "double" } }, "xml": { "name": "BIAssetDto" }, "type": "object" }, "OAS.WebApi.Domains.Reporting.BIController.BIProductDto": { "properties": { "assetClass": { "type": "string" }, "cusip": { "type": "string" }, "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "riskCategory": { "type": "string" }, "ticker": { "type": "string" }, "productType": { "readOnly": true, "type": "string" }, "category": { "type": "string" } }, "xml": { "name": "BIProductDto" }, "type": "object" }, "OAS.WebApi.Domains.Reporting.BIController.BIPerformanceDto": { "properties": { "entityId": { "type": "integer", "format": "int32" }, "entityEnum": { "type": "integer", "format": "int32" }, "parentId": { "type": "integer", "format": "int32" }, "groupName": { "type": "string" }, "marketValue": { "type": "number", "format": "double" }, "day": { "type": "number", "format": "double" }, "mtd": { "type": "number", "format": "double" }, "qtd": { "type": "number", "format": "double" }, "ytd": { "type": "number", "format": "double" }, "oneYear": { "type": "number", "format": "double" }, "threeYear": { "type": "number", "format": "double" }, "fiveYear": { "type": "number", "format": "double" }, "tenYear": { "type": "number", "format": "double" }, "inception": { "type": "number", "format": "double" } }, "xml": { "name": "BIPerformanceDto" }, "type": "object" }, "OAS.DataProcess.Billing.Reports.LegacyAdvisoryFeeReport.LegacyAdvisoryFeeReportModel": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "title": { "type": "string" }, "author": { "type": "string" }, "subject": { "type": "string" }, "keywords": { "type": "string" }, "generationTime": { "type": "string", "format": "date-time" }, "coverPage": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "firstHeader": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "header": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "footer": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "body": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "overlay": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "hud": { "type": "string", "enum": [ "None", "Basic", "Debug" ] }, "urlBuilder": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportUrlBuilderCore", "readOnly": true }, "pdfDownloadUrlBuilder": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportUrlBuilder" }, "renderCssUrlBuilder": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportUrlBuilder" }, "standardCssUrlBuilder": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportUrlBuilder" }, "expirationDate": { "type": "string", "format": "date-time" }, "orientation": { "type": "string", "enum": [ "Portrait", "Landscape" ] }, "paperSize": { "type": "string", "enum": [ "Letter", "Legal", "A4" ] }, "margins": { "$ref": "#/definitions/OAS.DataModel.Reporting.DataEngine.PaperMargins" } }, "xml": { "name": "LegacyAdvisoryFeeReportModel" }, "type": "object" }, "OAS.DataModel.Reporting.Interfaces.IGetRendered": { "properties": { "type": { "readOnly": true, "type": "string" } }, "xml": { "name": "IGetRendered" }, "type": "object" }, "OAS.DataModel.Reporting.ReportUrlBuilderCore": { "properties": {}, "xml": { "name": "ReportUrlBuilderCore" }, "type": "object" }, "OAS.DataModel.Reporting.ReportUrlBuilder": { "properties": { "originalPath": { "readOnly": true, "type": "string" }, "urlKind": { "readOnly": true, "type": "string", "enum": [ "Literal", "OrionApi", "OrionUi" ] } }, "xml": { "name": "ReportUrlBuilder" }, "type": "object" }, "OAS.DataModel.Reporting.DataEngine.PaperMargins": { "properties": { "units": { "type": "string" }, "top": { "type": "number", "format": "double" }, "bottom": { "type": "number", "format": "double" }, "right": { "type": "number", "format": "double" }, "left": { "type": "number", "format": "double" } }, "xml": { "name": "PaperMargins" }, "type": "object" }, "OAS.DataProcess.Billing.Reports.LegacyAdvisoryFeeReport.LegacyAdvisoryFeeReportDto": { "properties": { "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "paymentIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "filterEntityId": { "type": "integer", "format": "int32" }, "isPaid": { "type": "boolean" }, "reportFormat": { "type": "string", "enum": [ "Xml", "Null", "Csv", "Image", "PDF", "Html", "Html40", "Html32", "Mhtml", "Excel", "ExcelX", "HtmlOwc", "Json", "CustomImport" ] } }, "xml": { "name": "LegacyAdvisoryFeeReportDto" }, "type": "object" }, "OAS.DataProcess.Billing.Reports.AdvisoryFeeNotification.AdvisoryFeeNotificationDTO": { "properties": { "billId": { "type": "integer", "format": "int32" }, "reportFormat": { "type": "string", "enum": [ "Xml", "Null", "Csv", "Image", "PDF", "Html", "Html40", "Html32", "Mhtml", "Excel", "ExcelX", "HtmlOwc", "Json", "CustomImport" ] }, "breakOutEachAdjustment": { "type": "boolean" } }, "xml": { "name": "AdvisoryFeeNotificationDTO" }, "type": "object" }, "OAS.DataProcess.Billing.Reports.AdvisoryFeeNotification.AdvisoryFeeNotificationReportModel": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "title": { "type": "string" }, "author": { "type": "string" }, "subject": { "type": "string" }, "keywords": { "type": "string" }, "generationTime": { "type": "string", "format": "date-time" }, "firstHeader": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "header": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "footer": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "body": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "overlay": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "hud": { "type": "string", "enum": [ "None", "Basic", "Debug" ] }, "urlBuilder": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportUrlBuilderCore", "readOnly": true }, "pdfDownloadUrlBuilder": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportUrlBuilder" }, "renderCssUrlBuilder": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportUrlBuilder" }, "standardCssUrlBuilder": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportUrlBuilder" }, "expirationDate": { "type": "string", "format": "date-time" }, "orientation": { "type": "string", "enum": [ "Portrait", "Landscape" ] }, "paperSize": { "type": "string", "enum": [ "Letter", "Legal", "A4" ] }, "margins": { "$ref": "#/definitions/OAS.DataModel.Reporting.DataEngine.PaperMargins" }, "breakOutEachAdjustment": { "type": "boolean" } }, "xml": { "name": "AdvisoryFeeNotificationReportModel" }, "type": "object" }, "OAS.DataProcess.Billing.Reports.PayeePayble.PayeePayableDTO": { "properties": { "reportFormat": { "type": "string", "enum": [ "Xml", "Null", "Csv", "Image", "PDF", "Html", "Html40", "Html32", "Mhtml", "Excel", "ExcelX", "HtmlOwc", "Json", "CustomImport" ] } }, "xml": { "name": "PayeePayableDTO" }, "type": "object" }, "OAS.DataProcess.Billing.Reports.PayeePayable.PayeePayableReportModel": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "title": { "type": "string" }, "author": { "type": "string" }, "subject": { "type": "string" }, "keywords": { "type": "string" }, "generationTime": { "type": "string", "format": "date-time" }, "firstHeader": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "header": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "footer": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "body": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "overlay": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "hud": { "type": "string", "enum": [ "None", "Basic", "Debug" ] }, "urlBuilder": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportUrlBuilderCore", "readOnly": true }, "pdfDownloadUrlBuilder": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportUrlBuilder" }, "renderCssUrlBuilder": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportUrlBuilder" }, "standardCssUrlBuilder": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportUrlBuilder" }, "expirationDate": { "type": "string", "format": "date-time" }, "orientation": { "type": "string", "enum": [ "Portrait", "Landscape" ] }, "paperSize": { "type": "string", "enum": [ "Letter", "Legal", "A4" ] }, "margins": { "$ref": "#/definitions/OAS.DataModel.Reporting.DataEngine.PaperMargins" } }, "xml": { "name": "PayeePayableReportModel" }, "type": "object" }, "OAS.DataProcess.Billing.Reports.RevenuePayout.RevenuePayoutReportModel": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "title": { "type": "string" }, "author": { "type": "string" }, "subject": { "type": "string" }, "keywords": { "type": "string" }, "generationTime": { "type": "string", "format": "date-time" }, "firstHeader": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "header": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "footer": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "body": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "overlay": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "hud": { "type": "string", "enum": [ "None", "Basic", "Debug" ] }, "urlBuilder": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportUrlBuilderCore", "readOnly": true }, "pdfDownloadUrlBuilder": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportUrlBuilder" }, "renderCssUrlBuilder": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportUrlBuilder" }, "standardCssUrlBuilder": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportUrlBuilder" }, "expirationDate": { "type": "string", "format": "date-time" }, "orientation": { "type": "string", "enum": [ "Portrait", "Landscape" ] }, "paperSize": { "type": "string", "enum": [ "Letter", "Legal", "A4" ] }, "margins": { "$ref": "#/definitions/OAS.DataModel.Reporting.DataEngine.PaperMargins" } }, "xml": { "name": "RevenuePayoutReportModel" }, "type": "object" }, "OAS.DataProcess.Billing.Reports.RevenuePayout.RevenuePayoutDTO": { "properties": { "revenuePayoutPaymentId": { "type": "integer", "format": "int32" }, "revenuePayoutId": { "type": "integer", "format": "int32" }, "reportFormat": { "type": "string", "enum": [ "Xml", "Null", "Csv", "Image", "PDF", "Html", "Html40", "Html32", "Mhtml", "Excel", "ExcelX", "HtmlOwc", "Json", "CustomImport" ] } }, "xml": { "name": "RevenuePayoutDTO" }, "type": "object" }, "OAS.DataProcess.Billing.Reports.BillCancellationByAccount.BillCancellationByAccountDTO": { "properties": { "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "reportFormat": { "type": "string", "enum": [ "Xml", "Null", "Csv", "Image", "PDF", "Html", "Html40", "Html32", "Mhtml", "Excel", "ExcelX", "HtmlOwc", "Json", "CustomImport" ] } }, "xml": { "name": "BillCancellationByAccountDTO" }, "type": "object" }, "OAS.DataProcess.Billing.Reports.BillCancellationByAccount.BillCancellationByAccountReportModel": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "title": { "type": "string" }, "author": { "type": "string" }, "subject": { "type": "string" }, "keywords": { "type": "string" }, "generationTime": { "type": "string", "format": "date-time" }, "firstHeader": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "header": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "footer": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "body": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "overlay": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "hud": { "type": "string", "enum": [ "None", "Basic", "Debug" ] }, "urlBuilder": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportUrlBuilderCore", "readOnly": true }, "pdfDownloadUrlBuilder": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportUrlBuilder" }, "renderCssUrlBuilder": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportUrlBuilder" }, "standardCssUrlBuilder": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportUrlBuilder" }, "expirationDate": { "type": "string", "format": "date-time" }, "orientation": { "type": "string", "enum": [ "Portrait", "Landscape" ] }, "paperSize": { "type": "string", "enum": [ "Letter", "Legal", "A4" ] }, "margins": { "$ref": "#/definitions/OAS.DataModel.Reporting.DataEngine.PaperMargins" } }, "xml": { "name": "BillCancellationByAccountReportModel" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.VerboseCalculationSettingsDto": { "properties": { "entity": { "type": "string", "enum": [ "Database", "BrokerDealer", "Representative", "Client", "Registration", "Account", "Asset", "Product", "AggregateModel", "DynamicGrouping", "PortfolioGroup", "UserDetail", "Prospect", "CustomGrouping" ] }, "entityIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "prospectId": { "type": "string" }, "asOfDate": { "type": "string" }, "accountInclusion": { "type": "string", "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, "groupCustodialCashTogether": { "type": "boolean" }, "useSmaSettings": { "type": "boolean" }, "unmanagedInclusionOverride": { "type": "string", "enum": [ "Unmanaged", "Performance", "ActivitySummary", "Allocation", "PortfolioDetail", "TaxDetail" ] }, "includeHistoricalLinks": { "type": "string", "enum": [ "None", "CostBasis", "Performance" ] }, "accountManagementOverride": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculate.ManagementOverride" }, "xml": { "name": "ManagementOverride", "wrapped": true }, "type": "array" }, "exclusions": { "properties": { "account": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "fundFamily": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, "type": "object" }, "groupings": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VerboseCalculationGroupDto" }, "xml": { "name": "VerboseCalculationGroupDto", "wrapped": true }, "type": "array" }, "dateRanges": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VerboseCalculationDateRangeDto" }, "xml": { "name": "VerboseCalculationDateRangeDto", "wrapped": true }, "type": "array" }, "performanceOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VerboseCalculationPerformanceOptionDto" }, "xml": { "name": "VerboseCalculationPerformanceOptionDto", "wrapped": true }, "type": "array" }, "benchmarks": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VerboseCalculationBenchmarkDto" }, "xml": { "name": "VerboseCalculationBenchmarkDto", "wrapped": true }, "type": "array" }, "comparisons": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VerboseCalculationComparisonDto" }, "xml": { "name": "VerboseCalculationComparisonDto", "wrapped": true }, "type": "array" }, "statisticalOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VerboseCalculationStatisticalOptionDto" }, "xml": { "name": "VerboseCalculationStatisticalOptionDto", "wrapped": true }, "type": "array" }, "options": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IStandardOption" }, "xml": { "name": "IStandardOption", "wrapped": true }, "type": "array" }, "activityOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VerboseCalculationActivityOptionDto" }, "xml": { "name": "VerboseCalculationActivityOptionDto", "wrapped": true }, "type": "array" }, "attributionOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VerboseCalculationAttributionOptionDto" }, "xml": { "name": "VerboseCalculationAttributionOptionDto", "wrapped": true }, "type": "array" }, "costBasisOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VerboseCalculationCostBasisOptionDto" }, "xml": { "name": "VerboseCalculationCostBasisOptionDto", "wrapped": true }, "type": "array" }, "groupInfoOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VerboseCalculationGroupInfoOptionDto" }, "xml": { "name": "VerboseCalculationGroupInfoOptionDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "VerboseCalculationSettingsDto" }, "type": "object" }, "OAS.DataModel.Reporting.Calculate.ManagementOverride": { "properties": { "id": { "type": "integer", "format": "int32" }, "isManaged": { "type": "boolean" } }, "xml": { "name": "ManagementOverride" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.VerboseCalculationGroupDto": { "properties": { "grouping": { "type": "string", "enum": [ "Self", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "FundFamily", "Platform", "Custodian", "AggregateModel", "DynamicGrouping", "AssetClass", "AssetLevelStrategy", "AssetCategory", "RiskCategory", "AccountType", "RegistrationTaxType", "ProductType", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "ProductVintageYear", "ProductSubType", "AssetCategoryParent", "PortfolioGroup", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "MaturityPeriod", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "MorningstarGeography", "BillEntityType", "ProductSubHolding", "Country", "Currency", "CustomGrouping", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "Prospect", "Transaction", "Comparison", "CostBasisLot", "ModelInclusion", "ContextChanges", "ActivityOptions", "DateRanges", "Time", "Bill", "Beneficiary", "Trustee", "Systematic", "BillTier", "BillAdjustment", "FeeSchedules", "BillCashflow", "ModelVsActual", "BillAssetLevel", "HouseholdMember", "CustomIndexing", "ProspectAccount", "CustomIndexingScenario", "ProspectAssetClass", "ProspectAssetCategory", "CustomIndexingPreference", "ProspectMandate", "ProspectComparisonAssetClass", "ProspectComparisonAssetCategory", "ProspectComparisonHolding", "ProspectHolding", "ProspectModelAgg", "ProspectAccountStressTestsGrouped", "ProspectAccountStressTestScenario", "ProspectComparisonStressTestsGrouped", "ProspectComparisonStressTestScenario", "ProspectStressTestsGrouped", "ProspectStressTestScenario", "ProspectAccountCorrelation", "ProspectComparisonAccountCorrelation", "ProspectCorrelation", "ProspectOrionPlanningCurrentGoal", "ProspectOrionPlanningProposedGoal", "ProspectOrionPlanningCurrentGoalResults", "ProspectOrionPlanningProposedGoalResults", "ProspectOrionPlanningCurrentGoalStepsResults", "ProspectOrionPlanningProposedGoalStepsResults", "ProspectHoldingSectorResults", "ProspectHoldingGeographyResults", "ProspectAccountHoldingSectorResults", "ProspectAccountHoldingGeographyResults", "ProspectComparisonAccountHoldingSectorResults", "ProspectComparisonAccountHoldingGeographyResults", "ProspectOrionPlanningNetWorth", "ProspectSelfDirectedResults", "ProspectSelfDirectedAssetClass", "ProspectSelfDirectedAssetCategory", "ProspectHouseholdMembers", "ProspectStrategist", "ProspectWeightedAssetClass", "ProspectAccountWeightedAssetClass", "BillingRelatedAccounts", "ProspectAccountBlendedFactSheet", "CustomIndexingBuys", "CustomIndexingSells", "ProspectBlendedAssetClasses", "ProspectBlendedAssetCategories", "ProspectOrionPlanningCurrentNetWorthAssetClasses", "ProspectOrionPlanningProposedNetWorthAssetClasses", "ProspectOrionPlanningNetWorthAsset", "ProspectOrionPlanningCurrentNetWorthAssetCategories", "ProspectOrionPlanningProposedNetWorthAssetCategories", "ProspectOrionPlanningCurrentAssetCategories", "ProspectOrionPlanningProposedAssetCategories", "ProspectOrionPlanningCurrentAssetClasses", "ProspectOrionPlanningProposedAssetClasses", "ProspectComparisonHouseholdManualAccounts", "AdHocGrouping" ] }, "groupings": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VerboseCalculationGroupDto" }, "xml": { "name": "VerboseCalculationGroupDto", "wrapped": true }, "type": "array" }, "performanceOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VerboseCalculationDateRangePerformanceOptionDto" }, "xml": { "name": "VerboseCalculationDateRangePerformanceOptionDto", "wrapped": true }, "type": "array" }, "activityOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VerboseCalculationDateRangeActivityOptionDto" }, "xml": { "name": "VerboseCalculationDateRangeActivityOptionDto", "wrapped": true }, "type": "array" }, "attributionOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VerboseCalculationDateRangeAttributionOptionDto" }, "xml": { "name": "VerboseCalculationDateRangeAttributionOptionDto", "wrapped": true }, "type": "array" }, "costBasisOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VerboseCalculationDateRangeCostBasisOptionDto" }, "xml": { "name": "VerboseCalculationDateRangeCostBasisOptionDto", "wrapped": true }, "type": "array" }, "groupInfoOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VerboseCalculationDateRangeGroupInfoOptionDto" }, "xml": { "name": "VerboseCalculationDateRangeGroupInfoOptionDto", "wrapped": true }, "type": "array" }, "billingOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Billing.VerboseCalculationDateRangeBillingOptionDto" }, "xml": { "name": "VerboseCalculationDateRangeBillingOptionDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "VerboseCalculationGroupDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.VerboseCalculationBenchmarkDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Blend", "Product", "Model", "Custom" ] }, "entityId": { "type": "integer", "format": "int32" } }, "xml": { "name": "VerboseCalculationBenchmarkDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.VerboseCalculationComparisonDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "benchmarks": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, "xml": { "name": "VerboseCalculationComparisonDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.VerboseCalculationStatisticalOptionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "riskFreeBenchmarkId": { "type": "integer", "format": "int32" }, "marketBenchmarkId": { "type": "integer", "format": "int32" }, "options": { "items": { "type": "string", "enum": [ "StandardDeviation", "Mean", "Variance", "Drawdown", "SharpeRatio", "SortinoRatio", "Covariance", "RSquared", "BetaCoefficient", "TreynorRatio", "JensensAlpha", "UpsideCaptureRatio", "DownsideCaptureRatio" ] }, "xml": { "name": "StatisticType", "wrapped": true }, "type": "array" } }, "xml": { "name": "VerboseCalculationStatisticalOptionDto" }, "type": "object" }, "OAS.DataModel.Reporting.Interfaces.IStandardOption": { "properties": { "name": { "readOnly": true, "type": "string" }, "type": { "readOnly": true, "type": "string" }, "id": { "readOnly": true, "type": "integer", "format": "int32" } }, "xml": { "name": "IStandardOption" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.VerboseCalculationActivityOptionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "inceptionValueMethod": { "type": "string", "enum": [ "NewMoney", "Zero", "DayAfter" ] }, "details": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculate.ActivityDetailBase" }, "xml": { "name": "ActivityDetailBase", "wrapped": true }, "type": "array" } }, "xml": { "name": "VerboseCalculationActivityOptionDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.VerboseCalculationAttributionOptionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "calculationMethod": { "type": "string", "enum": [ "BrinsonFachler" ] }, "technique": { "type": "string", "enum": [ "Arithmetic" ] }, "linkingMethod": { "type": "string", "enum": [ "Geometric" ] } }, "xml": { "name": "VerboseCalculationAttributionOptionDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.VerboseCalculationCostBasisOptionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "source": { "type": "string", "enum": [ "Orion", "Custodian" ] }, "realizationType": { "type": "string", "enum": [ "Realized", "Unrealized" ] }, "includeAmortization": { "type": "boolean" }, "includeDividends": { "type": "boolean" }, "includeMoneyMarkets": { "type": "boolean" }, "includeQualifiedAccounts": { "type": "boolean" }, "includeUnknownCostBasis": { "type": "boolean" }, "useInceptionCostBasis": { "type": "boolean" }, "preserveNegativeUnrealizedCostBasis": { "type": "boolean" }, "displayGainsOrLosses": { "type": "string", "enum": [ "Both", "Gains", "Losses" ] } }, "xml": { "name": "VerboseCalculationCostBasisOptionDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.VerboseCalculationGroupInfoOptionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "property": { "type": "string" } }, "xml": { "name": "VerboseCalculationGroupInfoOptionDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.VerboseCalculationDateRangePerformanceOptionDto": { "properties": { "reportCategoryId": { "type": "integer", "format": "int32" }, "dateRangeId": { "type": "integer", "format": "int32" }, "performanceOptionId": { "type": "integer", "format": "int32" }, "comparisonId": { "type": "integer", "format": "int32" }, "statisticalOptionId": { "type": "integer", "format": "int32" }, "returnType": { "type": "string", "enum": [ "Aggregated", "Breakdown" ] }, "returnStyle": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VerboseCalculationReturnStyleDto" } }, "xml": { "name": "VerboseCalculationDateRangePerformanceOptionDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.VerboseCalculationDateRangeActivityOptionDto": { "properties": { "reportCategoryId": { "type": "integer", "format": "int32" }, "dateRangeId": { "type": "integer", "format": "int32" }, "activityOptionId": { "type": "integer", "format": "int32" }, "returnStyle": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VerboseCalculationReturnStyleDto" }, "returnType": { "type": "string", "enum": [ "AggregatedValue", "TransactionBreakdown" ] } }, "xml": { "name": "VerboseCalculationDateRangeActivityOptionDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.VerboseCalculationDateRangeAttributionOptionDto": { "properties": { "reportCategoryId": { "type": "integer", "format": "int32" }, "dateRangeId": { "type": "integer", "format": "int32" }, "attributionOptionId": { "type": "integer", "format": "int32" }, "performanceOptionId": { "type": "integer", "format": "int32" }, "returnStyle": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VerboseCalculationReturnStyleDto" }, "returnType": { "type": "string", "enum": [ "AggregatedValue", "GroupingDetail" ] } }, "xml": { "name": "VerboseCalculationDateRangeAttributionOptionDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.VerboseCalculationDateRangeCostBasisOptionDto": { "properties": { "reportCategoryId": { "type": "integer", "format": "int32" }, "dateRangeId": { "type": "integer", "format": "int32" }, "costBasisOptionId": { "type": "integer", "format": "int32" }, "returnStyle": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VerboseCalculationReturnStyleDto" }, "returnType": { "type": "string", "enum": [ "AggregatedValue", "LotDetail" ] } }, "xml": { "name": "VerboseCalculationDateRangeCostBasisOptionDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.VerboseCalculationDateRangeGroupInfoOptionDto": { "properties": { "reportCategoryId": { "type": "integer", "format": "int32" }, "dateRangeId": { "type": "integer", "format": "int32" }, "groupInfoOptionId": { "type": "integer", "format": "int32" } }, "xml": { "name": "VerboseCalculationDateRangeGroupInfoOptionDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Billing.VerboseCalculationDateRangeBillingOptionDto": { "properties": { "returnType": { "type": "string", "enum": [ "Disclaimers", "FeeSchedules", "DescriptiveData", "PayInstructions", "SpecialInstructions", "PaysFor", "RelatedAccounts", "BillingRule" ] }, "billingOptionId": { "type": "integer", "format": "int32" }, "dateRangeId": { "type": "integer", "format": "int32" }, "reportCategoryId": { "type": "integer", "format": "int32" }, "returnStyle": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VerboseCalculationReturnStyleDto" } }, "xml": { "name": "VerboseCalculationDateRangeBillingOptionDto" }, "type": "object" }, "OAS.DataModel.Reporting.Calculate.ActivityDetailBase": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "isManaged": { "type": "boolean" }, "flipSign": { "type": "boolean" } }, "xml": { "name": "ActivityDetailBase" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.VerboseCalculationReturnStyleDto": { "properties": { "context": { "type": "string", "enum": [ "Self", "Parent" ] }, "frequency": { "type": "string", "enum": [ "Summary", "Annually", "Quarterly", "Monthly", "Weekly", "Daily", "Automatic" ] }, "basedOn": { "type": "string", "enum": [ "Calendar", "RollingForward", "RollingBackward" ] }, "breakBehavior": { "type": "string", "enum": [ "AllowPartialPeriods", "PartialPeriodsWithBreakPoints", "FullPeriodsOnly" ] }, "cumulative": { "type": "boolean" }, "cumulativeBasedOn": { "type": "string", "enum": [ "ForwardFromStartDate", "BackwardFromEndDate" ] } }, "xml": { "name": "VerboseCalculationReturnStyleDto" }, "type": "object" }, "OAS.DataModel.Reporting.Calculate.BatchCalculated": { "properties": { "sessionId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "expirationDate": { "type": "string", "format": "date-time" }, "groups": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculate.GroupCalculated" }, "xml": { "name": "GroupCalculated", "wrapped": true }, "type": "array" }, "buckets": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculate.BucketCalculated" }, "xml": { "name": "BucketCalculated", "wrapped": true }, "type": "array" }, "benchmarks": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculate.BenchmarkCalculated" }, "xml": { "name": "BenchmarkCalculated", "wrapped": true }, "type": "array" }, "comparisons": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculate.ComparisonCalculated" }, "xml": { "name": "ComparisonCalculated", "wrapped": true }, "type": "array" }, "dateRanges": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculate.DateRangeCalculated" }, "xml": { "name": "DateRangeCalculated", "wrapped": true }, "type": "array" }, "activityOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculate.ActivityOption" }, "xml": { "name": "ActivityOption", "wrapped": true }, "type": "array" }, "attributionOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculate.AttributionOption" }, "xml": { "name": "AttributionOption", "wrapped": true }, "type": "array" }, "billingOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculate.BillingOption" }, "xml": { "name": "BillingOption", "wrapped": true }, "type": "array" }, "costBasisOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculate.CostBasisOption" }, "xml": { "name": "CostBasisOption", "wrapped": true }, "type": "array" }, "groupInfoOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculate.GroupInfoCalculated" }, "xml": { "name": "GroupInfoCalculated", "wrapped": true }, "type": "array" }, "performanceOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculate.PerformanceOption" }, "xml": { "name": "PerformanceOption", "wrapped": true }, "type": "array" }, "statisticalOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculate.StatisticalOption" }, "xml": { "name": "StatisticalOption", "wrapped": true }, "type": "array" }, "tradingOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculate.TradingOption" }, "xml": { "name": "TradingOption", "wrapped": true }, "type": "array" } }, "xml": { "name": "BatchCalculated" }, "type": "object" }, "OAS.DataModel.Reporting.Calculate.GroupCalculated": { "properties": { "id": { "type": "integer", "format": "int32" }, "grouping": { "type": "string", "enum": [ "Self", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "FundFamily", "Platform", "Custodian", "AggregateModel", "DynamicGrouping", "AssetClass", "AssetLevelStrategy", "AssetCategory", "RiskCategory", "AccountType", "RegistrationTaxType", "ProductType", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "ProductVintageYear", "ProductSubType", "AssetCategoryParent", "PortfolioGroup", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "MaturityPeriod", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "MorningstarGeography", "BillEntityType", "ProductSubHolding", "Country", "Currency", "CustomGrouping", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "Prospect", "Transaction", "Comparison", "CostBasisLot", "ModelInclusion", "ContextChanges", "ActivityOptions", "DateRanges", "Time", "Bill", "Beneficiary", "Trustee", "Systematic", "BillTier", "BillAdjustment", "FeeSchedules", "BillCashflow", "ModelVsActual", "BillAssetLevel", "HouseholdMember", "CustomIndexing", "ProspectAccount", "CustomIndexingScenario", "ProspectAssetClass", "ProspectAssetCategory", "CustomIndexingPreference", "ProspectMandate", "ProspectComparisonAssetClass", "ProspectComparisonAssetCategory", "ProspectComparisonHolding", "ProspectHolding", "ProspectModelAgg", "ProspectAccountStressTestsGrouped", "ProspectAccountStressTestScenario", "ProspectComparisonStressTestsGrouped", "ProspectComparisonStressTestScenario", "ProspectStressTestsGrouped", "ProspectStressTestScenario", "ProspectAccountCorrelation", "ProspectComparisonAccountCorrelation", "ProspectCorrelation", "ProspectOrionPlanningCurrentGoal", "ProspectOrionPlanningProposedGoal", "ProspectOrionPlanningCurrentGoalResults", "ProspectOrionPlanningProposedGoalResults", "ProspectOrionPlanningCurrentGoalStepsResults", "ProspectOrionPlanningProposedGoalStepsResults", "ProspectHoldingSectorResults", "ProspectHoldingGeographyResults", "ProspectAccountHoldingSectorResults", "ProspectAccountHoldingGeographyResults", "ProspectComparisonAccountHoldingSectorResults", "ProspectComparisonAccountHoldingGeographyResults", "ProspectOrionPlanningNetWorth", "ProspectSelfDirectedResults", "ProspectSelfDirectedAssetClass", "ProspectSelfDirectedAssetCategory", "ProspectHouseholdMembers", "ProspectStrategist", "ProspectWeightedAssetClass", "ProspectAccountWeightedAssetClass", "BillingRelatedAccounts", "ProspectAccountBlendedFactSheet", "CustomIndexingBuys", "CustomIndexingSells", "ProspectBlendedAssetClasses", "ProspectBlendedAssetCategories", "ProspectOrionPlanningCurrentNetWorthAssetClasses", "ProspectOrionPlanningProposedNetWorthAssetClasses", "ProspectOrionPlanningNetWorthAsset", "ProspectOrionPlanningCurrentNetWorthAssetCategories", "ProspectOrionPlanningProposedNetWorthAssetCategories", "ProspectOrionPlanningCurrentAssetCategories", "ProspectOrionPlanningProposedAssetCategories", "ProspectOrionPlanningCurrentAssetClasses", "ProspectOrionPlanningProposedAssetClasses", "ProspectComparisonHouseholdManualAccounts", "AdHocGrouping" ] }, "groupEntityId": { "type": "integer", "format": "int32" }, "groupEntityIdPath": { "type": "string" }, "reportCategories": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculate.GroupReportCategoryCalculated" }, "xml": { "name": "GroupReportCategoryCalculated", "wrapped": true }, "type": "array" }, "groups": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculate.GroupCalculated" }, "xml": { "name": "GroupCalculated", "wrapped": true }, "type": "array" } }, "xml": { "name": "GroupCalculated" }, "type": "object" }, "OAS.DataModel.Reporting.Calculate.BucketCalculated": { "properties": { "id": { "type": "integer", "format": "int32" }, "inceptionDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "closeDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "managedInceptionDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "managedCloseDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "aipLedgerStartDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "assetCount": { "type": "integer", "format": "int32" } }, "xml": { "name": "BucketCalculated" }, "type": "object" }, "OAS.DataModel.Reporting.Calculate.BenchmarkCalculated": { "properties": { "id": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Blend", "Product", "Model", "Custom" ] }, "entityId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "dynamicBenchmarkType": { "type": "string", "enum": [ "None", "AssetClass", "AssetCategory", "ManagementStyle", "AggregateModel", "RiskCategory" ] }, "inceptionDate": { "type": "string" }, "color": { "type": "string" } }, "xml": { "name": "BenchmarkCalculated" }, "type": "object" }, "OAS.DataModel.Reporting.Calculate.ComparisonCalculated": { "properties": { "id": { "type": "integer", "format": "int32" }, "assignmentType": { "type": "string", "enum": [ "UserDefined", "Standard", "Attribution", "ProductReturns" ] } }, "xml": { "name": "ComparisonCalculated" }, "type": "object" }, "OAS.DataModel.Reporting.Calculate.DateRangeCalculated": { "properties": { "type": { "readOnly": true, "type": "string" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "displayName": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "dataMustExistOnRangeStartDate": { "type": "boolean" }, "dataMustExistOnRangeEndDate": { "type": "boolean" }, "allowStartDateAdjustment": { "type": "boolean" }, "startDateMethod": { "type": "string", "enum": [ "Inception", "HoldingPeriod", "AIPLedger" ] } }, "xml": { "name": "DateRangeCalculated" }, "type": "object" }, "OAS.DataModel.Reporting.Calculate.ActivityOption": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "displayName": { "type": "string" }, "inceptionValueMethod": { "type": "string", "enum": [ "NewMoney", "Zero", "DayAfter" ] }, "includeUnmanagedJournals": { "type": "boolean" }, "details": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculate.ActivityDetailBase" }, "xml": { "name": "ActivityDetailBase", "wrapped": true }, "type": "array" } }, "xml": { "name": "ActivityOption" }, "type": "object" }, "OAS.DataModel.Reporting.Calculate.AttributionOption": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "calculationMethod": { "type": "string", "enum": [ "BrinsonFachler" ] }, "technique": { "type": "string", "enum": [ "Arithmetic" ] }, "linkingMethod": { "type": "string", "enum": [ "Geometric" ] } }, "xml": { "name": "AttributionOption" }, "type": "object" }, "OAS.DataModel.Reporting.Calculate.BillingOption": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "billsToReturn": { "type": "string", "enum": [ "AllBills", "LastBill", "MockBills", "LastMockBill" ] }, "includedBillPayMethods": { "items": { "type": "string", "enum": [ "ACH", "Check", "CreditCard", "Direct", "Indirect", "NoFee", "NonManaged", "SpecialInstructions" ] }, "xml": { "name": "BillPayMethod", "wrapped": true }, "type": "array" }, "includeOnlyRelevantFeeSchedules": { "type": "boolean" }, "includeDollarFlatFeeSchedules": { "type": "boolean" }, "useAsOfDateOverride": { "type": "boolean" }, "cashflowRollup": { "type": "boolean" }, "includedBillTypes": { "items": { "type": "string", "enum": [ "Unknown", "Renewal", "NewMoney", "NewAccount", "FinancialPlanningFee", "Performance", "AdvanceCreditDebit" ] }, "xml": { "name": "BillTypeEnum", "wrapped": true }, "type": "array" }, "includedBillAdjustmentTypes": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "includedBillEntities": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, "xml": { "name": "BillingOption" }, "type": "object" }, "OAS.DataModel.Reporting.Calculate.CostBasisOption": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "source": { "type": "string", "enum": [ "Orion", "Custodian" ] }, "realizationType": { "type": "string", "enum": [ "Realized", "Unrealized" ] }, "includeAmortization": { "type": "boolean" }, "includeDividends": { "type": "boolean" }, "includeMoneyMarkets": { "type": "boolean" }, "includeQualifiedAccounts": { "type": "boolean" }, "includeUnknownCostBasis": { "type": "boolean" }, "useInceptionCostBasis": { "type": "boolean" }, "preserveNegativeUnrealizedCostBasis": { "type": "boolean" }, "displayGainsOrLosses": { "type": "string", "enum": [ "Both", "Gains", "Losses" ] } }, "xml": { "name": "CostBasisOption" }, "type": "object" }, "OAS.DataModel.Reporting.Calculate.GroupInfoCalculated": { "properties": { "id": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "property": { "type": "string" } }, "xml": { "name": "GroupInfoCalculated" }, "type": "object" }, "OAS.DataModel.Reporting.Calculate.PerformanceOption": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "calculationMethod": { "type": "string", "enum": [ "TWR", "Simple", "IRR" ] }, "includeAccruedInterest": { "type": "boolean" }, "calcGrossOfFees": { "type": "boolean" }, "calcFirstDayPerformance": { "type": "boolean" }, "calcIntraDayPerformance": { "type": "boolean" }, "annualize": { "type": "boolean" }, "annualizeIncludeDaysWithoutValue": { "type": "boolean" }, "flipSignForShort": { "type": "boolean" }, "suppressMixedRanges": { "type": "boolean" }, "suppressMixedAssetLevelGroups": { "type": "boolean" }, "includeAIPLedger": { "type": "boolean" }, "calcAfterTax": { "type": "boolean" }, "intradayCalculationMethod": { "type": "string", "enum": [ "Standard", "Enhanced", "MarginEnhanced" ] } }, "xml": { "name": "PerformanceOption" }, "type": "object" }, "OAS.DataModel.Reporting.Calculate.StatisticalOption": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "riskFreeBenchmarkId": { "type": "integer", "format": "int32" }, "marketBenchmarkId": { "type": "integer", "format": "int32" }, "options": { "items": { "type": "string", "enum": [ "StandardDeviation", "Mean", "Variance", "Drawdown", "SharpeRatio", "SortinoRatio", "Covariance", "RSquared", "BetaCoefficient", "TreynorRatio", "JensensAlpha", "UpsideCaptureRatio", "DownsideCaptureRatio" ] }, "xml": { "name": "StatisticType", "wrapped": true }, "type": "array" } }, "xml": { "name": "StatisticalOption" }, "type": "object" }, "OAS.DataModel.Reporting.Calculate.TradingOption": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "includeMoneyMarket": { "type": "boolean" }, "includePendingTrades": { "type": "boolean" } }, "xml": { "name": "TradingOption" }, "type": "object" }, "OAS.DataModel.Reporting.Calculate.GroupReportCategoryCalculated": { "properties": { "bucketId": { "type": "integer", "format": "int32" }, "reportCategoryId": { "type": "integer", "format": "int32" }, "groupInfo": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculate.DateRangeGroupInfoOptionCalculated" }, "xml": { "name": "DateRangeGroupInfoOptionCalculated", "wrapped": true }, "type": "array" }, "comparisonBenchmarks": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculate.DateRangeComparisonBenchmarkCalculated" }, "xml": { "name": "DateRangeComparisonBenchmarkCalculated", "wrapped": true }, "type": "array" }, "activityCalculations": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculate.DateRangeActivityOptionCalculated" }, "xml": { "name": "DateRangeActivityOptionCalculated", "wrapped": true }, "type": "array" }, "attributionCalculations": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculate.DateRangeAttributionOptionCalculated" }, "xml": { "name": "DateRangeAttributionOptionCalculated", "wrapped": true }, "type": "array" }, "billingCalculations": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculate.DateRangeBillingOptionCalculated" }, "xml": { "name": "DateRangeBillingOptionCalculated", "wrapped": true }, "type": "array" }, "costBasisCalculations": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculate.DateRangeCostBasisOptionCalculated" }, "xml": { "name": "DateRangeCostBasisOptionCalculated", "wrapped": true }, "type": "array" }, "incomeCalculations": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculate.DateRangeIncomeOptionCalculated" }, "xml": { "name": "DateRangeIncomeOptionCalculated", "wrapped": true }, "type": "array" }, "performanceCalculations": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculate.DateRangePerformanceOptionCalculated" }, "xml": { "name": "DateRangePerformanceOptionCalculated", "wrapped": true }, "type": "array" }, "tradingCalculations": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculate.DateRangeTradingOptionCalculated" }, "xml": { "name": "DateRangeTradingOptionCalculated", "wrapped": true }, "type": "array" } }, "xml": { "name": "GroupReportCategoryCalculated" }, "type": "object" }, "OAS.DataModel.Reporting.Calculate.DateRangeGroupInfoOptionCalculated": { "properties": { "dateRangeId": { "type": "integer", "format": "int32" }, "groupInfoId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "error": { "type": "string" } }, "xml": { "name": "DateRangeGroupInfoOptionCalculated" }, "type": "object" }, "OAS.DataModel.Reporting.Calculate.DateRangeComparisonBenchmarkCalculated": { "properties": { "comparisonId": { "type": "integer", "format": "int32" }, "benchmarkId": { "type": "integer", "format": "int32" }, "sortOrder": { "type": "integer", "format": "int32" } }, "xml": { "name": "DateRangeComparisonBenchmarkCalculated" }, "type": "object" }, "OAS.DataModel.Reporting.Calculate.DateRangeActivityOptionCalculated": { "properties": { "type": { "readOnly": true, "type": "string" }, "dateRangeId": { "type": "integer", "format": "int32" }, "activityOptionId": { "type": "integer", "format": "int32" }, "calculatedActivityOptionId": { "type": "integer", "format": "int32" }, "returnStyle": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IReturnStyle" }, "returnType": { "type": "string", "enum": [ "AggregatedValue", "TransactionBreakdown" ] }, "returns": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculate.ActivityReturnCalculated" }, "xml": { "name": "ActivityReturnCalculated", "wrapped": true }, "type": "array" } }, "xml": { "name": "DateRangeActivityOptionCalculated" }, "type": "object" }, "OAS.DataModel.Reporting.Calculate.DateRangeAttributionOptionCalculated": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "dateRangeId": { "type": "integer", "format": "int32" }, "attributionOptionId": { "type": "integer", "format": "int32" }, "calculatedAttributionOptionId": { "type": "integer", "format": "int32" }, "performanceOptionId": { "type": "integer", "format": "int32" }, "calculatedPerformanceOptionId": { "type": "integer", "format": "int32" }, "returnStyle": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IReturnStyle" }, "returnType": { "type": "string", "enum": [ "AggregatedValue", "GroupingDetail" ] }, "childGroupId": { "type": "integer", "format": "int32" }, "returns": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculate.AttributionReturnCalculated" }, "xml": { "name": "AttributionReturnCalculated", "wrapped": true }, "type": "array" } }, "xml": { "name": "DateRangeAttributionOptionCalculated" }, "type": "object" }, "OAS.DataModel.Reporting.Calculate.DateRangeBillingOptionCalculated": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "dateRangeId": { "type": "integer", "format": "int32" }, "billingOptionId": { "type": "integer", "format": "int32" }, "calculatedBillingOptionId": { "type": "integer", "format": "int32" }, "returnStyle": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IReturnStyle" }, "returnType": { "type": "string", "enum": [ "Disclaimers", "FeeSchedules", "DescriptiveData", "PayInstructions", "SpecialInstructions", "PaysFor", "RelatedAccounts", "BillingRule" ] }, "returns": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculate.BillingReturnCalculatedBase" }, "xml": { "name": "BillingReturnCalculatedBase", "wrapped": true }, "type": "array" } }, "xml": { "name": "DateRangeBillingOptionCalculated" }, "type": "object" }, "OAS.DataModel.Reporting.Calculate.DateRangeCostBasisOptionCalculated": { "properties": { "type": { "readOnly": true, "type": "string" }, "dateRangeId": { "type": "integer", "format": "int32" }, "costBasisOptionId": { "type": "integer", "format": "int32" }, "calculatedCostBasisOptionId": { "type": "integer", "format": "int32" }, "returnStyle": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IReturnStyle" }, "returns": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculate.CostBasisReturnCalculatedBase" }, "xml": { "name": "CostBasisReturnCalculatedBase", "wrapped": true }, "type": "array" }, "returnType": { "type": "string", "enum": [ "AggregatedValue", "LotDetail" ] } }, "xml": { "name": "DateRangeCostBasisOptionCalculated" }, "type": "object" }, "OAS.DataModel.Reporting.Calculate.DateRangeIncomeOptionCalculated": { "properties": { "type": { "readOnly": true, "type": "string" }, "dateRangeId": { "type": "integer", "format": "int32" }, "incomeOptionId": { "type": "integer", "format": "int32" }, "calculatedIncomeOptionId": { "type": "integer", "format": "int32" }, "returnStyle": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IReturnStyle" }, "returns": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculate.IncomeReturnCalculatedBase" }, "xml": { "name": "IncomeReturnCalculatedBase", "wrapped": true }, "type": "array" } }, "xml": { "name": "DateRangeIncomeOptionCalculated" }, "type": "object" }, "OAS.DataModel.Reporting.Calculate.DateRangePerformanceOptionCalculated": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "dateRangeId": { "type": "integer", "format": "int32" }, "performanceOptionId": { "type": "integer", "format": "int32" }, "calculatedPerformanceOptionId": { "type": "integer", "format": "int32" }, "benchmarkId": { "type": "integer", "format": "int32" }, "statisticalOptionId": { "type": "integer", "format": "int32" }, "returnStyle": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IReturnStyle" }, "returnType": { "type": "string", "enum": [ "Aggregated", "Breakdown" ] }, "returns": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculate.PerformanceReturnCalculatedBase" }, "xml": { "name": "PerformanceReturnCalculatedBase", "wrapped": true }, "type": "array" } }, "xml": { "name": "DateRangePerformanceOptionCalculated" }, "type": "object" }, "OAS.DataModel.Reporting.Calculate.DateRangeTradingOptionCalculated": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "dateRangeId": { "type": "integer", "format": "int32" }, "tradingOptionId": { "type": "integer", "format": "int32" }, "calculatedTradingOptionId": { "type": "integer", "format": "int32" }, "returnStyle": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IReturnStyle" }, "returns": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculate.TradingReturn" }, "xml": { "name": "TradingReturn", "wrapped": true }, "type": "array" } }, "xml": { "name": "DateRangeTradingOptionCalculated" }, "type": "object" }, "OAS.DataModel.Reporting.Calculate.ActivityReturnCalculated": { "properties": { "type": { "readOnly": true, "type": "string" }, "startDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "endDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" } }, "xml": { "name": "ActivityReturnCalculated" }, "type": "object" }, "OAS.DataModel.Reporting.Calculate.AttributionReturnCalculated": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "startDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "endDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "benchmarkId": { "type": "integer", "format": "int32" }, "portfolioWeight": { "type": "number", "format": "double" }, "portfolioReturn": { "type": "number", "format": "double" }, "benchmarkWeight": { "type": "number", "format": "double" }, "benchmarkReturn": { "type": "number", "format": "double" }, "allocationEffect": { "type": "number", "format": "double" }, "selectionEffect": { "type": "number", "format": "double" }, "interactionEffect": { "type": "number", "format": "double" }, "totalEffect": { "type": "number", "format": "double" } }, "xml": { "name": "AttributionReturnCalculated" }, "type": "object" }, "OAS.DataModel.Reporting.Calculate.BillingReturnCalculatedBase": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" } }, "xml": { "name": "BillingReturnCalculatedBase" }, "type": "object" }, "OAS.DataModel.Reporting.Calculate.CostBasisReturnCalculatedBase": { "properties": { "type": { "readOnly": true, "type": "string" }, "startDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "endDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "isLongTerm": { "type": "boolean" }, "transAmount": { "type": "number", "format": "double" }, "costBasis": { "type": "number", "format": "double" }, "amortization": { "type": "number", "format": "double" }, "gainLoss": { "type": "number", "format": "double" } }, "xml": { "name": "CostBasisReturnCalculatedBase" }, "type": "object" }, "OAS.DataModel.Reporting.Calculate.IncomeReturnCalculatedBase": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" } }, "xml": { "name": "IncomeReturnCalculatedBase" }, "type": "object" }, "OAS.DataModel.Reporting.Calculate.PerformanceReturnCalculatedBase": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" } }, "xml": { "name": "PerformanceReturnCalculatedBase" }, "type": "object" }, "OAS.DataModel.Reporting.Calculate.TradingReturn": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "startDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "endDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "groupBy": { "type": "string", "enum": [ "None", "IncludedInModel", "NotInModelRebalance", "NotInModel" ] }, "actualPercent": { "type": "number", "format": "double" }, "actualValue": { "type": "number", "format": "double" }, "modelPercent": { "type": "number", "format": "double" }, "modelValue": { "type": "number", "format": "double" }, "percentOutOfBalance": { "type": "number", "format": "double" }, "valueOutOfBalance": { "type": "number", "format": "double" }, "itemTolLower": { "type": "number", "format": "double" }, "itemTolUpper": { "type": "number", "format": "double" }, "isExcluded": { "type": "boolean" }, "hasCashAsset": { "type": "boolean" }, "isOutOfTolerance": { "type": "boolean" } }, "xml": { "name": "TradingReturn" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.VerboseCalculationDateRangeFullDto": { "properties": { "isDefault": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "displayName": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "dataMustExistOnRangeStartDate": { "type": "boolean" }, "dataMustExistOnRangeEndDate": { "type": "boolean" }, "allowStartDateAdjustment": { "type": "boolean" }, "startDateMethod": { "type": "string", "enum": [ "Inception", "HoldingPeriod", "AIPLedger" ] } }, "xml": { "name": "VerboseCalculationDateRangeFullDto" }, "type": "object" }, "OAS.DataModel.Reporting.Compares.ReportDataCompareBatchDto": { "properties": { "runAFlags": { "$ref": "#/definitions/OAS.DataModel.JsonConverter.ReportFeatureOverriderDto" }, "runBFlags": { "$ref": "#/definitions/OAS.DataModel.JsonConverter.ReportFeatureOverriderDto" }, "alClientsToRunFor": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "numberOfHouseHoldsToRunFor": { "type": "integer", "format": "int32" }, "numberOfReportsToRunFor": { "type": "integer", "format": "int32" }, "reportIdsToRunFor": { "items": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "type": "array" }, "addVersions": { "type": "boolean" }, "workerLimit": { "type": "integer", "format": "int32" }, "description": { "type": "string" } }, "xml": { "name": "ReportDataCompareBatchDto" }, "type": "object" }, "OAS.DataModel.JsonConverter.ReportFeatureOverriderDto": { "properties": { "dynamicBenchmarkProcessType": { "type": "string", "enum": [ "Cloud", "LocalService" ] }, "forceAssetGroupingIntraDayPerformance": { "type": "boolean" }, "activityProcessType": { "type": "string", "enum": [ "Cloud", "LocalService" ] }, "costBasisProcessType": { "type": "string", "enum": [ "Old", "Cloud", "LocalService" ] }, "useMultiThreadedGroupInfo": { "type": "boolean" }, "morningstarLevel2Assignment": { "type": "boolean" }, "localPriceCutOverDate": { "type": "string", "format": "date-time" }, "noScope": { "type": "boolean" }, "ensureAssetsUpdated": { "type": "boolean" }, "storeReportDataCompressed": { "type": "boolean" }, "showEInModelNames": { "type": "boolean" }, "performanceProcessType": { "type": "string", "enum": [ "Cloud", "LocalService" ] }, "forceNonSummaryPerformanceToUseTwr": { "type": "boolean" }, "forceNetOfFeesPerformance": { "type": "boolean" }, "costBasisStoredSource": { "type": "string", "enum": [ "Orion", "Custodian" ] }, "useGlobalSettingsUniqueIds": { "type": "boolean" }, "showEquations": { "type": "boolean" }, "isReportCompare": { "type": "boolean" }, "tradingWithParentGrouping": { "type": "boolean" }, "useBenchmarksInAccountChangeHistory": { "type": "boolean" }, "benchmarkAssignmentOverride": { "type": "string" }, "useAsOfDateForAdvizr": { "type": "boolean" }, "accountNumbersToShow": { "type": "integer", "format": "int32" }, "useBatchSettingsBulkCopy": { "type": "boolean" }, "showExcludedFromRebalance": { "type": "boolean" }, "useInMemoryForModelVsActual": { "type": "boolean" }, "useNewLineChartRenderer": { "type": "boolean" }, "useNewScatterPlotChartRenderer": { "type": "boolean" }, "useInMemoryIncomeCalculation": { "type": "boolean" }, "useModelAllocationHistory": { "type": "boolean" }, "useDisclaimerShadowDom": { "type": "boolean" } }, "xml": { "name": "ReportFeatureOverriderDto" }, "type": "object" }, "OAS.DataModel.Reporting.Composite.SimpleCompositeRange": { "properties": { "lowerBound": { "type": "integer", "format": "int32" }, "upperBound": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "SimpleCompositeRange" }, "type": "object" }, "OAS.WebApi.DTO.Utility.Charts.ChartDto": { "properties": { "chartName": { "type": "string" }, "chartType": { "type": "string", "enum": [ "PieChart", "SpreadSheet", "Percent", "Series", "Column", "Scatter" ] }, "chartOrder": { "type": "integer", "format": "int32" }, "span": { "type": "integer", "format": "int32" }, "data": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Charts.ChartDataDto" }, "xml": { "name": "ChartDataDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ChartDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.Charts.PerformanceChartDto": { "properties": { "columns": { "items": { "type": "string" }, "type": "array" }, "data": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Charts.PerformanceChartDataDto" }, "xml": { "name": "PerformanceChartDataDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "PerformanceChartDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.Charts.PerformanceChartDataDto": { "properties": { "action": { "type": "string" }, "values": { "items": { "type": "string" }, "type": "array" } }, "xml": { "name": "PerformanceChartDataDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.Charts.GrowthChartDto": { "properties": { "series": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Charts.GrowthChartDataDto" }, "xml": { "name": "GrowthChartDataDto", "wrapped": true }, "type": "array" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "duration": { "type": "integer", "format": "int32" }, "chartName": { "type": "string" }, "chartType": { "type": "string", "enum": [ "PieChart", "SpreadSheet", "Percent", "Series", "Column", "Scatter" ] }, "chartOrder": { "type": "integer", "format": "int32" }, "span": { "type": "integer", "format": "int32" }, "data": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Charts.ChartDataDto" }, "xml": { "name": "ChartDataDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "GrowthChartDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.Charts.GrowthChartDataDto": { "properties": { "name": { "type": "string" }, "data": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Charts.GrowthChartSeriesDto" }, "xml": { "name": "GrowthChartSeriesDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "GrowthChartDataDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.Charts.GrowthChartSeriesDto": { "properties": { "performance": { "type": "string" }, "value": { "type": "number", "format": "double" }, "date": { "type": "string", "format": "date-time" } }, "xml": { "name": "GrowthChartSeriesDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.Charts.HistogramDto": { "properties": { "series": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Charts.HistogramDataDto" }, "xml": { "name": "HistogramDataDto", "wrapped": true }, "type": "array" }, "categories": { "items": { "type": "string" }, "type": "array" }, "chartName": { "type": "string" }, "chartType": { "type": "string", "enum": [ "PieChart", "SpreadSheet", "Percent", "Series", "Column", "Scatter" ] }, "chartOrder": { "type": "integer", "format": "int32" }, "span": { "type": "integer", "format": "int32" }, "data": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Charts.ChartDataDto" }, "xml": { "name": "ChartDataDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "HistogramDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.Charts.HistogramDataDto": { "properties": { "type": { "type": "string", "enum": [ "PieChart", "SpreadSheet", "Percent", "Series", "Column", "Scatter" ] }, "histoValues": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "name": { "type": "string" }, "chartType": { "description": "Old ChartType. Only used in Bill Summary. Do not use for future charts.", "type": "string" }, "value": { "type": "number", "format": "double" } }, "xml": { "name": "HistogramDataDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.Charts.ScatterDto": { "properties": { "series": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Charts.ScatterSeriesDto" }, "xml": { "name": "ScatterSeriesDto", "wrapped": true }, "type": "array" }, "chartName": { "type": "string" }, "chartType": { "type": "string", "enum": [ "PieChart", "SpreadSheet", "Percent", "Series", "Column", "Scatter" ] }, "chartOrder": { "type": "integer", "format": "int32" }, "span": { "type": "integer", "format": "int32" }, "data": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Charts.ChartDataDto" }, "xml": { "name": "ChartDataDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ScatterDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.Charts.ScatterSeriesDto": { "properties": { "scatterPoint": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Charts.ScatterSeriesDto.Metric" }, "name": { "type": "string" }, "chartType": { "description": "Old ChartType. Only used in Bill Summary. Do not use for future charts.", "type": "string" }, "value": { "type": "number", "format": "double" } }, "xml": { "name": "ScatterSeriesDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.Charts.ScatterSeriesDto.Metric": { "properties": { "performance": { "type": "number", "format": "double" }, "beta": { "type": "number", "format": "double" }, "standardDev": { "type": "number", "format": "double" } }, "xml": { "name": "Metric" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Composite.CompositeAdHocInstanceDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "nickName": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "status": { "type": "string" }, "error": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "CompositeAdHocInstanceDto" }, "type": "object" }, "OAS.DataModel.Reporting.Composite.CompositeAdHocAccount": { "required": [ "id", "registrationName", "startDate", "endDate", "beginningMarketValue", "endingMarketValue", "stockRatio", "riskTolerance", "income", "included", "createdBy", "createdDate", "isPreliminary", "cashBalance" ], "properties": { "id": { "type": "integer", "format": "int32" }, "compositeAdHocInstanceId": { "type": "integer", "format": "int32" }, "compositeAdHocInstance": { "$ref": "#/definitions/OAS.DataModel.Reporting.Composite.CompositeAdHocInstance" }, "accountId": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string", "maxLength": 255, "minLength": 0 }, "accountNumber": { "type": "string", "maxLength": 50, "minLength": 0 }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "beginningMarketValue": { "type": "number", "format": "double" }, "endingMarketValue": { "type": "number", "format": "double" }, "stockRatio": { "type": "number", "format": "double" }, "riskTolerance": { "type": "number", "format": "double" }, "income": { "type": "number", "format": "double" }, "included": { "type": "boolean" }, "feeAmount": { "type": "number", "format": "double" }, "weightedReturn": { "type": "number", "format": "double" }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "grossFeePerformance": { "type": "number", "format": "double" }, "netFeePerformance": { "type": "number", "format": "double" }, "afterTaxGrossFeePerformance": { "type": "number", "format": "double" }, "afterTaxNetFeePerformance": { "type": "number", "format": "double" }, "wrapFeePercentage": { "type": "number", "format": "double" }, "isPreliminary": { "type": "boolean" }, "billSchedule": { "type": "string", "maxLength": 50, "minLength": 0 }, "compositeTextRepresentativeId": { "type": "integer", "format": "int32" }, "compositeTextAggregateModelId": { "type": "integer", "format": "int32" }, "compositeTextPlatformId": { "type": "integer", "format": "int32" }, "compositeTextCustodianId": { "type": "integer", "format": "int32" }, "compositeTextFundFamilyId": { "type": "integer", "format": "int32" }, "compositeTextPlanId": { "type": "integer", "format": "int32" }, "importSource": { "type": "string", "maxLength": 512, "minLength": 0 }, "riskBudget": { "type": "integer", "format": "int32" }, "isTradingBlocked": { "type": "boolean" }, "billPayMethodId": { "type": "integer", "format": "int32" }, "tradingInstr": { "type": "string", "maxLength": 512, "minLength": 0 }, "cashBalance": { "type": "number", "format": "double" }, "systemNotes": { "type": "string" }, "advisorNotes": { "type": "string" }, "compositePortfolioGroupId": { "type": "integer", "format": "int32" }, "isDiscretionary": { "type": "boolean" }, "isUnfunded": { "type": "boolean" }, "isBundled": { "type": "boolean" }, "isExcludedFromFirmAssets": { "type": "boolean" }, "assetBondPercent": { "type": "number", "format": "double" }, "assetEquityPercent": { "type": "number", "format": "double" }, "assetMoneyMarketPercent": { "type": "number", "format": "double" }, "otherAssetPercent": { "type": "number", "format": "double" }, "portfolioGroupEntity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "portfolioGroupCompositeId": { "type": "integer", "format": "int32" }, "fillInFields": { "type": "boolean" }, "entityId": { "type": "integer", "format": "int32" }, "representative": { "$ref": "#/definitions/OAS.DataModel.Reporting.Composite.CompositeText" }, "aggregateModel": { "$ref": "#/definitions/OAS.DataModel.Reporting.Composite.CompositeText" }, "platform": { "$ref": "#/definitions/OAS.DataModel.Reporting.Composite.CompositeText" }, "custodian": { "$ref": "#/definitions/OAS.DataModel.Reporting.Composite.CompositeText" }, "fundFamily": { "$ref": "#/definitions/OAS.DataModel.Reporting.Composite.CompositeText" }, "plan": { "$ref": "#/definitions/OAS.DataModel.Reporting.Composite.CompositeText" }, "account": { "$ref": "#/definitions/OAS.DataModel.Portfolio.Account" }, "billPayMethod": { "$ref": "#/definitions/OAS.DataModel.Billing.BillPayMethod" }, "portfolioGroup": { "$ref": "#/definitions/OAS.DataModel.Portfolio.PortfolioGroup" } }, "xml": { "name": "CompositeAdHocAccount" }, "type": "object" }, "OAS.DataModel.Reporting.Composite.CompositeAdHocInstance": { "required": [ "id", "startDate", "endDate", "createdBy", "createdDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "nickName": { "type": "string", "maxLength": 255, "minLength": 0 }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "statusText": { "type": "string", "maxLength": 255, "minLength": 0 }, "error": { "type": "string", "maxLength": 255, "minLength": 0 }, "hangfireJobId": { "type": "string", "maxLength": 80, "minLength": 0 }, "hangfireJobType": { "type": "string", "enum": [ "GenerateReports", "SendEmails", "SendToPrintVendor", "BillingGenerator", "CompositeAccounts", "CompositeAdHocAccounts", "DetectAdditionalErrors", "DeleteBillInstance" ] }, "createdBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string", "maxLength": 50, "minLength": 0 }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "CompositeAdHocInstance" }, "type": "object" }, "OAS.DataModel.Reporting.Composite.CompositeText": { "required": [ "id", "parentId", "entity", "entityName" ], "properties": { "id": { "type": "integer", "format": "int32" }, "parentId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityName": { "type": "string", "maxLength": 255, "minLength": 0 } }, "xml": { "name": "CompositeText" }, "type": "object" }, "OAS.WebApi.Domains.Reporting.Composite.CompositeAdHocDefinition": { "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "nickname": { "type": "string" } }, "xml": { "name": "CompositeAdHocDefinition" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Composite.ValidateHistoricalCompositeAccountDto": { "properties": { "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" }, "warningMessage": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "accountNumber": { "type": "string" }, "performance": { "type": "number", "format": "double" }, "begDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "begValue": { "type": "number", "format": "double" }, "endValue": { "type": "number", "format": "double" }, "stockRatio": { "type": "number", "format": "double" }, "riskTolerance": { "type": "number", "format": "double" }, "income": { "type": "number", "format": "double" }, "included": { "type": "boolean" }, "feeAmount": { "type": "number", "format": "double" }, "weightedReturn": { "type": "number", "format": "double" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "netFeePerformance": { "type": "number", "format": "double" }, "afterTaxNetFeePerformance": { "type": "number", "format": "double" }, "afterTaxGrossFeePerformance": { "type": "number", "format": "double" }, "wrapFeePercentage": { "type": "number", "format": "double" }, "isPreliminary": { "type": "boolean" }, "billSchedule": { "type": "string" }, "representativeName": { "type": "string" }, "modelAggName": { "type": "string" }, "platformName": { "type": "string" }, "custodianName": { "type": "string" }, "fundFamilyName": { "type": "string" }, "planName": { "type": "string" }, "importSource": { "type": "string" }, "riskBudget": { "type": "integer", "format": "int32" }, "cashBalance": { "type": "number", "format": "double" }, "isTradingBlocked": { "type": "boolean" }, "tradingInstructions": { "type": "string" }, "payMethod": { "type": "string" }, "acctStartDate": { "type": "string", "format": "date-time" }, "systemNotes": { "type": "string" }, "advisorNotes": { "type": "string" }, "registrationLastName": { "type": "string" }, "clientLastName": { "type": "string" }, "billStartDate": { "type": "string", "format": "date-time" }, "outsideId": { "type": "string" }, "isLocked": { "type": "boolean" }, "portfolioGroupId": { "type": "integer", "format": "int32" }, "isDiscretionary": { "type": "boolean" }, "isUnfunded": { "type": "boolean" }, "isBundled": { "type": "boolean" }, "isExcludedFromFirmAssets": { "type": "boolean" }, "assetBondPercent": { "type": "number", "format": "double" }, "assetEquityPercent": { "type": "number", "format": "double" }, "assetMoneyMarketPercent": { "type": "number", "format": "double" }, "otherAssetPercent": { "type": "number", "format": "double" }, "clientFullName": { "type": "string" }, "businessLine": { "type": "string" }, "netAccrual": { "type": "number", "format": "double" } }, "xml": { "name": "ValidateHistoricalCompositeAccountDto" }, "type": "object" }, "OAS.Remote.Composites.CompositeDefinition": { "properties": { "keys": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Rep", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Beneficiary", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QPEDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "Banking", "RMD", "Systematic", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "AdditionalRep", "DownloadSource", "DownloadRecord", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "numberOfMonths": { "type": "integer", "format": "int32" }, "minimumInceptionDate": { "type": "string", "format": "date-time" }, "minimumAccountValue": { "type": "number", "format": "double" }, "recalc": { "type": "boolean" }, "overwrite": { "type": "boolean" }, "securityTicket": { "type": "string", "format": "byte" }, "commonSecurityTicket": { "type": "string", "format": "byte" }, "authToken": { "type": "string" }, "commonServer": { "type": "string" }, "databaseID": { "type": "integer", "format": "int32" }, "correlationId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "a_UserDetailId": { "type": "integer", "format": "int32" }, "i_UserDetailId": { "type": "integer", "format": "int32" } }, "xml": { "name": "CompositeDefinition" }, "type": "object" }, "OAS.WebApi.DTO.ValidateImport.AccountDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "number": { "type": "string" }, "amount": { "type": "number", "format": "double" }, "isValid": { "type": "boolean" }, "message": { "type": "string" } }, "xml": { "name": "AccountDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Composite.CompositeAdHocAccountDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "accountNumber": { "type": "string" }, "performance": { "type": "number", "format": "double" }, "begDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "begValue": { "type": "number", "format": "double" }, "endValue": { "type": "number", "format": "double" }, "stockRatio": { "type": "number", "format": "double" }, "riskTolerance": { "type": "number", "format": "double" }, "income": { "type": "number", "format": "double" }, "included": { "type": "boolean" }, "feeAmount": { "type": "number", "format": "double" }, "weightedReturn": { "type": "number", "format": "double" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "netFeePerformance": { "type": "number", "format": "double" }, "afterTaxNetFeePerformance": { "type": "number", "format": "double" }, "afterTaxGrossFeePerformance": { "type": "number", "format": "double" }, "wrapFeePercentage": { "type": "number", "format": "double" }, "isPreliminary": { "type": "boolean" }, "billSchedule": { "type": "string" }, "representativeName": { "type": "string" }, "modelAggName": { "type": "string" }, "platformName": { "type": "string" }, "custodianName": { "type": "string" }, "fundFamilyName": { "type": "string" }, "planName": { "type": "string" }, "importSource": { "type": "string" }, "riskBudget": { "type": "integer", "format": "int32" }, "cashBalance": { "type": "number", "format": "double" }, "isTradingBlocked": { "type": "boolean" }, "tradingInstructions": { "type": "string" }, "payMethod": { "type": "string" }, "acctStartDate": { "type": "string", "format": "date-time" }, "systemNotes": { "type": "string" }, "advisorNotes": { "type": "string" }, "registrationLastName": { "type": "string" }, "clientLastName": { "type": "string" }, "billStartDate": { "type": "string", "format": "date-time" }, "outsideId": { "type": "string" }, "isLocked": { "type": "boolean" }, "portfolioGroupId": { "type": "integer", "format": "int32" }, "isDiscretionary": { "type": "boolean" }, "isUnfunded": { "type": "boolean" }, "isBundled": { "type": "boolean" }, "isExcludedFromFirmAssets": { "type": "boolean" }, "assetBondPercent": { "type": "number", "format": "double" }, "assetEquityPercent": { "type": "number", "format": "double" }, "assetMoneyMarketPercent": { "type": "number", "format": "double" }, "otherAssetPercent": { "type": "number", "format": "double" }, "clientFullName": { "type": "string" }, "businessLine": { "type": "string" }, "netAccrual": { "type": "number", "format": "double" } }, "xml": { "name": "CompositeAdHocAccountDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Composite.CompositeAccountLogDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "begDate": { "type": "string", "format": "date-time" }, "runLog": { "type": "string" } }, "xml": { "name": "CompositeAccountLogDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Composite.CompositeTextViewDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "parentId": { "type": "integer", "format": "int32" }, "entityName": { "type": "string" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "actualName": { "type": "string" } }, "xml": { "name": "CompositeTextViewDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Composite.CompositeGIPSDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "reportName": { "type": "string" }, "description": { "type": "string" }, "urlString": { "type": "string" } }, "xml": { "name": "CompositeGIPSDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Composite.CompositeFirmAssetDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "importSource": { "type": "string" }, "totalValue": { "type": "number", "format": "double" }, "isImported": { "type": "boolean" } }, "xml": { "name": "CompositeFirmAssetDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Composite.CompositeDashboardRequestDto": { "properties": { "reportId": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "targetIndexes": { "items": { "type": "string" }, "type": "array" }, "showAllAccounts": { "type": "boolean" }, "runReportAutomatically": { "type": "boolean" }, "feeOptionId": { "type": "integer", "format": "int32" }, "performanceHigh": { "type": "number", "format": "double" }, "performanceLow": { "type": "number", "format": "double" }, "standardDeviationHigh": { "type": "number", "format": "double" }, "standardDeviationLow": { "type": "number", "format": "double" }, "treynorHigh": { "type": "number", "format": "double" }, "treynorLow": { "type": "number", "format": "double" }, "betaHigh": { "type": "number", "format": "double" }, "betaLow": { "type": "number", "format": "double" }, "alphaHigh": { "type": "number", "format": "double" }, "alphaLow": { "type": "number", "format": "double" }, "compPercentHigh": { "type": "number", "format": "double" }, "compPercentLow": { "type": "number", "format": "double" }, "sharpeHigh": { "type": "number", "format": "double" }, "sharpeLow": { "type": "number", "format": "double" }, "sortinoHigh": { "type": "number", "format": "double" }, "sortinoLow": { "type": "number", "format": "double" }, "compDispersion": { "type": "number", "format": "double" } }, "xml": { "name": "CompositeDashboardRequestDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.Charts.DashboardChartDto": { "properties": { "columns": { "items": { "type": "string" }, "type": "array" }, "data": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Charts.IndexPerformanceChartDataDto" }, "xml": { "name": "IndexPerformanceChartDataDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "DashboardChartDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.Charts.IndexPerformanceChartDataDto": { "properties": { "indexValue": { "items": { "type": "string" }, "type": "array" }, "data": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Charts.PerformanceChartDataDto" }, "xml": { "name": "PerformanceChartDataDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "IndexPerformanceChartDataDto" }, "type": "object" }, "OAS.DataProcess.Reporting.Composite.ModelReturns.CalculateRollingReturnsRequest": { "properties": { "update": { "type": "boolean" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "aggregateModelIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, "xml": { "name": "CalculateRollingReturnsRequest" }, "type": "object" }, "OAS.DataProcess.Reporting.Composite.ModelReturns.CompositeModelRollingReturnDto": { "properties": { "aggregateModelId": { "type": "integer", "format": "int32" }, "statisticType": { "type": "string", "enum": [ "StandardDeviation", "Mean", "Variance", "Drawdown", "SharpeRatio", "SortinoRatio", "Covariance", "RSquared", "BetaCoefficient", "TreynorRatio", "JensensAlpha", "UpsideCaptureRatio", "DownsideCaptureRatio" ] }, "timeframeEnum": { "type": "string", "enum": [ "MTD", "QTD", "YTD", "OneYear", "TwoYear", "ThreeYear", "FiveYear", "TenYear", "Inception" ] }, "startDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "endDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "modelName": { "type": "string" }, "inceptionDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "netFeeUnannualized": { "type": "number", "format": "double" }, "netFeeAnnualized": { "type": "number", "format": "double" }, "statisticResult": { "type": "number", "format": "double" }, "factSheetTimeframe": { "type": "string" } }, "xml": { "name": "CompositeModelRollingReturnDto" }, "type": "object" }, "OAS.DataProcess.Reporting.Composite.ModelReturns.FactSheetModelAgg": { "properties": { "modelAggId": { "type": "integer", "format": "int32" }, "modelAggName": { "type": "string" }, "subAdvisorName": { "type": "string" }, "modelType": { "type": "string" }, "esg": { "type": "boolean" }, "taxAware": { "type": "boolean" }, "modelAssetClass": { "type": "string" }, "minimumPurchaseAmount": { "type": "number", "format": "double" }, "strategistFee": { "type": "number", "format": "double" }, "mandate": { "type": "string" }, "communityModelId": { "type": "integer", "format": "int64" }, "riskScore": { "type": "number", "format": "double" }, "morningStarId": { "type": "string" }, "benchmarkEntity": { "type": "string", "enum": [ "Blend", "Product", "Model", "Custom" ] }, "benchmarkId": { "type": "integer", "format": "int32" }, "benchmarkName": { "type": "string" }, "modelReturns": { "items": { "$ref": "#/definitions/OAS.DataProcess.Reporting.Composite.ModelReturns.CompositeModelRollingReturnDto" }, "xml": { "name": "CompositeModelRollingReturnDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "FactSheetModelAgg" }, "type": "object" }, "OAS.DataProcess.Reporting.Composite.ModelReturns.CompositeModelAggRequest": { "properties": { "asOfDate": { "type": "string", "format": "date-time" }, "aggregateModelIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "periods": { "items": { "type": "string", "enum": [ "MTD", "QTD", "YTD", "OneYear", "TwoYear", "ThreeYear", "FiveYear", "TenYear", "Inception" ] }, "xml": { "name": "Timeframe", "wrapped": true }, "type": "array" } }, "xml": { "name": "CompositeModelAggRequest" }, "type": "object" }, "OAS.DataProcess.Reporting.Composite.ModelReturns.CompositeModelAggDto": { "properties": { "aggregateModelId": { "type": "integer", "format": "int32" }, "startDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "endDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "period": { "type": "string" }, "performance": { "type": "number", "format": "double" } }, "xml": { "name": "CompositeModelAggDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Composite.CompositeInstanceDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "nickName": { "type": "string" }, "hangfireJobId": { "type": "string" }, "hangfireJobType": { "type": "string", "enum": [ "GenerateReports", "SendEmails", "SendToPrintVendor", "BillingGenerator", "CompositeAccounts", "CompositeAdHocAccounts", "DetectAdditionalErrors", "DeleteBillInstance" ] }, "statusText": { "type": "string" }, "accountCount": { "type": "integer", "format": "int32" } }, "xml": { "name": "CompositeInstanceDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Composite.CompositeAccountDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "accountNumber": { "type": "string" }, "performance": { "type": "number", "format": "double" }, "begDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "begValue": { "type": "number", "format": "double" }, "endValue": { "type": "number", "format": "double" }, "stockRatio": { "type": "number", "format": "double" }, "riskTolerance": { "type": "number", "format": "double" }, "income": { "type": "number", "format": "double" }, "included": { "type": "boolean" }, "feeAmount": { "type": "number", "format": "double" }, "weightedReturn": { "type": "number", "format": "double" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "netFeePerformance": { "type": "number", "format": "double" }, "afterTaxNetFeePerformance": { "type": "number", "format": "double" }, "afterTaxGrossFeePerformance": { "type": "number", "format": "double" }, "wrapFeePercentage": { "type": "number", "format": "double" }, "isPreliminary": { "type": "boolean" }, "billSchedule": { "type": "string" }, "representativeName": { "type": "string" }, "modelAggName": { "type": "string" }, "platformName": { "type": "string" }, "custodianName": { "type": "string" }, "fundFamilyName": { "type": "string" }, "planName": { "type": "string" }, "importSource": { "type": "string" }, "riskBudget": { "type": "integer", "format": "int32" }, "cashBalance": { "type": "number", "format": "double" }, "isTradingBlocked": { "type": "boolean" }, "tradingInstructions": { "type": "string" }, "payMethod": { "type": "string" }, "acctStartDate": { "type": "string", "format": "date-time" }, "systemNotes": { "type": "string" }, "advisorNotes": { "type": "string" }, "registrationLastName": { "type": "string" }, "clientLastName": { "type": "string" }, "billStartDate": { "type": "string", "format": "date-time" }, "outsideId": { "type": "string" }, "isLocked": { "type": "boolean" }, "portfolioGroupId": { "type": "integer", "format": "int32" }, "isDiscretionary": { "type": "boolean" }, "isUnfunded": { "type": "boolean" }, "isBundled": { "type": "boolean" }, "isExcludedFromFirmAssets": { "type": "boolean" }, "assetBondPercent": { "type": "number", "format": "double" }, "assetEquityPercent": { "type": "number", "format": "double" }, "assetMoneyMarketPercent": { "type": "number", "format": "double" }, "otherAssetPercent": { "type": "number", "format": "double" }, "clientFullName": { "type": "string" }, "businessLine": { "type": "string" }, "netAccrual": { "type": "number", "format": "double" } }, "xml": { "name": "CompositeAccountDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Composite.CompositeArchivedReportDto": { "properties": { "blobId": { "type": "integer", "format": "int32" }, "reportName": { "type": "string" }, "reportDescription": { "type": "string" }, "blobType": { "type": "string" }, "fileName": { "type": "string" }, "isZip": { "type": "boolean" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "CompositeArchivedReportDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Composite.MissingCompositeAccountDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "accountStartDate": { "type": "string", "format": "date-time" }, "monthsSinceInception": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "isActive": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "cancelledDate": { "type": "string", "format": "date-time" }, "lastTransactionDate": { "type": "string", "format": "date-time" }, "compositeStartDate": { "type": "string" }, "minimumInceptionDate": { "type": "string" }, "includeInQpe": { "type": "string" }, "monthEndValue": { "type": "number", "format": "double" }, "isManaged": { "type": "boolean" } }, "xml": { "name": "MissingCompositeAccountDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Composite.CompositeAccountSummaryDto": { "properties": { "isPreliminary": { "type": "boolean" }, "begDate": { "type": "string", "format": "date-time" }, "accountCount": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "CompositeAccountSummaryDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Composite.DisclosureDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "disclosureName": { "type": "string" }, "disclosureText": { "type": "string" }, "disclosureOrder": { "type": "integer", "format": "int32" }, "reports": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.ReportDisclosureDto" }, "xml": { "name": "ReportDisclosureDto", "wrapped": true }, "type": "array" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" } }, "xml": { "name": "DisclosureDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Composite.ReportDisclosureDto": { "properties": { "disclosureId": { "type": "integer", "format": "int32" }, "compositeReportId": { "type": "integer", "format": "int32" }, "compositeReportName": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" } }, "xml": { "name": "ReportDisclosureDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Composite.CompositeRuleDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "ruleDetail": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeRuleDetailDto" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "CompositeRuleDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Composite.CompositeRuleDetailDto": { "properties": { "filters": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeRuleFilterDto" }, "xml": { "name": "CompositeRuleFilterDto", "wrapped": true }, "type": "array" }, "minValue": { "type": "number", "format": "double" }, "minEndValue": { "type": "number", "format": "double" }, "cashFlowPercent": { "type": "number", "format": "double" }, "cashOutFlowPercent": { "type": "number", "format": "double" }, "cashInFlowPercent": { "type": "number", "format": "double" }, "minAssetAllocation": { "type": "number", "format": "double" }, "noFeePayingAccounts": { "type": "boolean" }, "notes": { "type": "string" }, "discretionaryAccounts": { "type": "boolean" }, "nonDiscretionaryAccounts": { "type": "boolean" }, "minFixedIncomePercent": { "type": "number", "format": "double" }, "tradeHoldDays": { "type": "integer", "format": "int32" }, "minRestricted": { "type": "number", "format": "double" }, "maxRestricted": { "type": "number", "format": "double" }, "minCapitalGainBudget": { "type": "number", "format": "double" }, "maxCapitalGainBudget": { "type": "number", "format": "double" } }, "xml": { "name": "CompositeRuleDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Composite.CompositeRuleFilterDto": { "properties": { "entity": { "type": "string", "enum": [ "Model", "ManagementStyle", "Custodian", "Rep", "Plan", "RiskRange", "StockBondRange" ] }, "entityEnum": { "readOnly": true, "type": "integer", "format": "int32" }, "ids": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, "xml": { "name": "CompositeRuleFilterDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Composite.CompositeReportDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "reportName": { "type": "string" }, "lastUpdate": { "type": "string", "format": "date-time" }, "webEnabled": { "type": "boolean" }, "composites": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeReportCompositeDto" }, "xml": { "name": "CompositeReportCompositeDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "CompositeReportDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Composite.CompositeReportCompositeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "compositeName": { "type": "string" }, "groups": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeReportCompositeGroupDto" }, "xml": { "name": "CompositeReportCompositeGroupDto", "wrapped": true }, "type": "array" }, "benchmarks": { "type": "string" }, "disclaimer": { "type": "string" }, "statisticalMarketIndex": { "type": "string" } }, "xml": { "name": "CompositeReportCompositeDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Composite.CompositeReportCompositeGroupDto": { "properties": { "compositeGroupType": { "type": "string", "enum": [ "FundFamily", "ManagementStyle", "Custodian", "Model", "StockRange", "RiskTolRange", "RiskBudgetRange", "Plan401K", "Rep", "Account", "BusinessLine", "AccountManager", "BrokerDealer", "Branch" ] }, "groupType": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "isGroupedBy": { "type": "boolean" }, "keys": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" }, "optionalFilters": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Composite.CompositeReportCompositeGroupOptionalFiltersDto" } }, "xml": { "name": "CompositeReportCompositeGroupDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Composite.CompositeReportCompositeGroupOptionalFiltersDto": { "properties": { "minValue": { "type": "number", "format": "double" }, "percentCashflow": { "type": "number", "format": "double" }, "minAssetAllocation": { "type": "number", "format": "double" }, "noFeePayingAccounts": { "type": "boolean" }, "modelFeeAmount": { "type": "number", "format": "double" } }, "xml": { "name": "CompositeReportCompositeGroupOptionalFiltersDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Composite.CompositeReportGroupDescriptionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "compositeReportGroupId": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "changeDate": { "type": "string", "format": "date-time" }, "changeReason": { "type": "string" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "CompositeReportGroupDescriptionDto" }, "type": "object" }, "OAS.DataProcess.Reporting.Composite.Reports.Models.CompositeReportGenerateDto": { "properties": { "compositeReportId": { "type": "integer", "format": "int32" }, "compositeReportName": { "type": "string" }, "compositeReportType": { "type": "string", "enum": [ "Standard", "Firmwide", "Membership", "Interval", "Daily" ] }, "startDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "endDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "periods": { "items": { "$ref": "#/definitions/OAS.DataProcess.Reporting.DateRangeTimeframe" }, "xml": { "name": "DateRangeTimeframe", "wrapped": true }, "type": "array" }, "feeOption": { "type": "string", "enum": [ "Gross", "NetActual", "NetAccrual", "GrossAndNetActual", "ModelFee", "GrossAfterTax", "NetAfterTax" ] }, "wrapFee": { "type": "boolean" }, "showStatistics": { "type": "boolean" }, "statisticalIndex": { "type": "string" }, "showBenchmarks": { "type": "boolean" }, "overrideIndexes": { "type": "string" }, "comparisonChartPeriod": { "type": "string", "enum": [ "None", "Period", "QTD", "YTD", "OneYear", "ThreeYear", "FiveYear", "TenYear", "Inception" ] }, "annualizePerformance": { "type": "boolean" }, "accountFilter": { "type": "string" }, "dispersion": { "type": "string", "enum": [ "StandardDeviation", "HighLow", "InterQuartile" ] }, "reportFormat": { "type": "string", "enum": [ "Xml", "Null", "Csv", "Image", "PDF", "Html", "Html40", "Html32", "Mhtml", "Excel", "ExcelX", "HtmlOwc", "Json", "CustomImport" ] }, "showInternalOnlyWarning": { "type": "boolean" }, "interval": { "type": "string", "enum": [ "Period", "Monthly", "Quarterly", "Yearly" ] }, "compositeAdHocInstance": { "type": "integer", "format": "int32" }, "isDashboardRequest": { "type": "boolean" }, "disclosure": { "type": "string" }, "archiveReport": { "type": "boolean" } }, "xml": { "name": "CompositeReportGenerateDto" }, "type": "object" }, "OAS.DataProcess.Reporting.DateRangeTimeframe": { "properties": { "periodId": { "type": "string" }, "startDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "endDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "suppressed": { "type": "boolean" } }, "xml": { "name": "DateRangeTimeframe" }, "type": "object" }, "OAS.DataProcess.Reporting.Composite.Reports.Models.InternalCompositeGroupResponse": { "properties": { "compositeReportType": { "type": "string", "enum": [ "Standard", "Firmwide", "Membership", "Interval", "Daily" ] }, "compositeResponse": { "$ref": "#/definitions/OAS.DataProcess.Reporting.Composite.CompositeResponse" }, "benchmarkReturns": { "items": { "$ref": "#/definitions/OAS.DataProcess.Performance.BenchmarkService.BenchmarkApiReturn" }, "xml": { "name": "BenchmarkApiReturn", "wrapped": true }, "type": "array" }, "statisticReturns": { "items": { "$ref": "#/definitions/OAS.DataProcess.Reporting.Composite.CompositeStatisticResponse" }, "xml": { "name": "CompositeStatisticResponse", "wrapped": true }, "type": "array" }, "compositeGroupReturns": { "items": { "$ref": "#/definitions/OAS.DataProcess.Reporting.Composite.Reports.Models.CompositeReportGroupResponse" }, "xml": { "name": "CompositeReportGroupResponse", "wrapped": true }, "type": "array" }, "showStatistics": { "type": "boolean" }, "showBenchmarks": { "type": "boolean" }, "comparisonChartPeriod": { "type": "string", "enum": [ "None", "Period", "QTD", "YTD", "OneYear", "ThreeYear", "FiveYear", "TenYear", "Inception" ] }, "interval": { "type": "string" }, "benchmarks": { "type": "string" }, "disclosure": { "type": "string" }, "feeOption": { "type": "string", "enum": [ "Gross", "NetActual", "NetAccrual", "GrossAndNetActual", "ModelFee", "GrossAfterTax", "NetAfterTax" ] } }, "xml": { "name": "InternalCompositeGroupResponse" }, "type": "object" }, "OAS.DataProcess.Reporting.Composite.CompositeResponse": { "properties": { "compositeName": { "type": "string" }, "groupName": { "type": "string" }, "periods": { "items": { "$ref": "#/definitions/OAS.DataProcess.Reporting.Composite.CompositePeriodResponse" }, "xml": { "name": "CompositePeriodResponse", "wrapped": true }, "type": "array" }, "inceptionDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "disclaimer": { "type": "string" }, "compositeMonthlyPerformance": { "items": { "$ref": "#/definitions/OAS.DataProcess.Reporting.Composite.CompositeMonthlyReturn" }, "xml": { "name": "CompositeMonthlyReturn", "wrapped": true }, "type": "array" }, "cumulative": { "items": { "$ref": "#/definitions/OAS.DataProcess.Reporting.Composite.Reports.CumulativeResponse" }, "xml": { "name": "CumulativeResponse", "wrapped": true }, "type": "array" }, "comparisonChartPeriod": { "type": "string" }, "header": { "type": "string" }, "sort": { "type": "integer", "format": "int32" }, "dashboardCompositeAccountDetails": { "items": { "$ref": "#/definitions/OAS.DataProcess.Reporting.Composite.Reports.DashboardCompositeAccountDetail" }, "xml": { "name": "DashboardCompositeAccountDetail", "wrapped": true }, "type": "array" }, "feeOption": { "type": "string", "enum": [ "Gross", "NetActual", "NetAccrual", "GrossAndNetActual", "ModelFee", "GrossAfterTax", "NetAfterTax" ] } }, "xml": { "name": "CompositeResponse" }, "type": "object" }, "OAS.DataProcess.Performance.BenchmarkService.BenchmarkApiReturn": { "properties": { "requestType": { "type": "string" }, "groupId": { "type": "string" }, "benchmarkName": { "type": "string" }, "indexBlendId": { "type": "integer", "format": "int32" }, "periods": { "items": { "$ref": "#/definitions/OAS.DataProcess.Performance.BenchmarkService.BenchmarkApiPeriodReturn" }, "xml": { "name": "BenchmarkApiPeriodReturn", "wrapped": true }, "type": "array" } }, "xml": { "name": "BenchmarkApiReturn" }, "type": "object" }, "OAS.DataProcess.Reporting.Composite.CompositeStatisticResponse": { "properties": { "statisticType": { "type": "string", "enum": [ "StandardDeviation", "Mean", "Variance", "Drawdown", "SharpeRatio", "SortinoRatio", "Covariance", "RSquared", "BetaCoefficient", "TreynorRatio", "JensensAlpha", "UpsideCaptureRatio", "DownsideCaptureRatio" ] }, "periods": { "items": { "$ref": "#/definitions/OAS.DataProcess.Reporting.Composite.CompositeStatisticReturn" }, "xml": { "name": "CompositeStatisticReturn", "wrapped": true }, "type": "array" } }, "xml": { "name": "CompositeStatisticResponse" }, "type": "object" }, "OAS.DataProcess.Reporting.Composite.Reports.Models.CompositeReportGroupResponse": { "properties": { "compositeName": { "type": "string" }, "groupName": { "type": "string" }, "disclaimer": { "type": "string" }, "results": { "items": { "$ref": "#/definitions/OAS.DataProcess.Reporting.Composite.Reports.Models.CompositeReportResponse" }, "xml": { "name": "CompositeReportResponse", "wrapped": true }, "type": "array" } }, "xml": { "name": "CompositeReportGroupResponse" }, "type": "object" }, "OAS.DataProcess.Reporting.Composite.CompositePeriodResponse": { "properties": { "periodId": { "type": "string" }, "startDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "endDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "performance": { "type": "number", "format": "double" }, "endingNumberAccounts": { "type": "integer", "format": "int32" }, "endingMarketValue": { "type": "number", "format": "double" }, "feeOption": { "type": "string", "enum": [ "Gross", "NetActual", "NetAccrual", "GrossAndNetActual", "ModelFee", "GrossAfterTax", "NetAfterTax" ] } }, "xml": { "name": "CompositePeriodResponse" }, "type": "object" }, "OAS.DataProcess.Reporting.Composite.CompositeMonthlyReturn": { "properties": { "endDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "performance": { "type": "number", "format": "double" }, "endingMarketValue": { "type": "number", "format": "double" }, "endingNumberAccounts": { "type": "integer", "format": "int32" }, "nonFeePayingAssets": { "type": "number", "format": "double" }, "bundledAssets": { "type": "number", "format": "double" } }, "xml": { "name": "CompositeMonthlyReturn" }, "type": "object" }, "OAS.DataProcess.Reporting.Composite.Reports.CumulativeResponse": { "properties": { "name": { "type": "string" }, "cumulativePerformance": { "items": { "$ref": "#/definitions/OAS.DataProcess.Reporting.Composite.Reports.CumulativePerformance" }, "xml": { "name": "CumulativePerformance", "wrapped": true }, "type": "array" } }, "xml": { "name": "CumulativeResponse" }, "type": "object" }, "OAS.DataProcess.Reporting.Composite.Reports.DashboardCompositeAccountDetail": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "monthlyPerformance": { "items": { "$ref": "#/definitions/OAS.DataProcess.Reporting.Composite.CompositeMonthlyReturn" }, "xml": { "name": "CompositeMonthlyReturn", "wrapped": true }, "type": "array" }, "periods": { "items": { "$ref": "#/definitions/OAS.DataProcess.Reporting.Composite.CompositePeriodResponse" }, "xml": { "name": "CompositePeriodResponse", "wrapped": true }, "type": "array" } }, "xml": { "name": "DashboardCompositeAccountDetail" }, "type": "object" }, "OAS.DataProcess.Performance.BenchmarkService.BenchmarkApiPeriodReturn": { "properties": { "periodId": { "type": "string" }, "startDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "endDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "performance": { "type": "number", "format": "double" }, "annualizedPerformance": { "type": "number", "format": "double" }, "daysInPeriod": { "type": "integer", "format": "int32" }, "startPrice": { "type": "number", "format": "double" } }, "xml": { "name": "BenchmarkApiPeriodReturn" }, "type": "object" }, "OAS.DataProcess.Reporting.Composite.CompositeStatisticReturn": { "properties": { "periodId": { "type": "string" }, "startDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "endDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "value": { "type": "number", "format": "double" }, "statisticType": { "type": "string", "enum": [ "StandardDeviation", "Mean", "Variance", "Drawdown", "SharpeRatio", "SortinoRatio", "Covariance", "RSquared", "BetaCoefficient", "TreynorRatio", "JensensAlpha", "UpsideCaptureRatio", "DownsideCaptureRatio" ] } }, "xml": { "name": "CompositeStatisticReturn" }, "type": "object" }, "OAS.DataProcess.Reporting.Composite.Reports.Models.CompositeReportResponse": { "properties": { "columnHeader": { "type": "string" }, "result": { "$ref": "#/definitions/OAS.DataModel.Reporting.Engine.IContextCalculationResult" } }, "xml": { "name": "CompositeReportResponse" }, "type": "object" }, "OAS.DataProcess.Reporting.Composite.Reports.CumulativePerformance": { "properties": { "endDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "performance": { "type": "number", "format": "double" } }, "xml": { "name": "CumulativePerformance" }, "type": "object" }, "OAS.DataModel.Reporting.Engine.IContextCalculationResult": { "properties": {}, "xml": { "name": "IContextCalculationResult" }, "type": "object" }, "OAS.DataModel.Reporting.Composites.CompositeReportModel": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "generationTime": { "type": "string", "format": "date-time" }, "title": { "type": "string" }, "author": { "type": "string" }, "subject": { "type": "string" }, "keywords": { "type": "string" }, "firstHeader": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "header": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "footer": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "body": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "overlay": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "hud": { "type": "string", "enum": [ "None", "Basic", "Debug" ] }, "urlBuilder": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportUrlBuilderCore", "readOnly": true }, "pdfDownloadUrlBuilder": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportUrlBuilder" }, "renderCssUrlBuilder": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportUrlBuilder" }, "standardCssUrlBuilder": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportUrlBuilder" }, "expirationDate": { "type": "string", "format": "date-time" }, "orientation": { "type": "string", "enum": [ "Portrait", "Landscape" ] }, "paperSize": { "type": "string", "enum": [ "Letter", "Legal", "A4" ] }, "margins": { "$ref": "#/definitions/OAS.DataModel.Reporting.DataEngine.PaperMargins" } }, "xml": { "name": "CompositeReportModel" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Custom.CustomReportDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "scheduleIsActive": { "type": "boolean" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "activeScheduleCount": { "type": "integer", "format": "int32" }, "isCustom": { "type": "boolean" }, "isFavorite": { "type": "boolean" }, "scheduleId": { "type": "integer", "format": "int32" }, "isLandscape": { "type": "boolean" }, "reportClass": { "type": "string" }, "isInternal": { "type": "boolean" }, "guid": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "promptClass": { "type": "string" }, "reportType": { "type": "string", "enum": [ "Query", "CustomImport", "Scrub" ] }, "userOwnerId": { "type": "integer", "format": "int32" }, "queryType": { "readOnly": true, "type": "string", "enum": [ "None", "Custom", "Excel", "All" ] }, "title": { "readOnly": true, "type": "string" }, "isNoteEnabled": { "type": "boolean" }, "isReadOnly": { "type": "boolean" }, "isQuerySmith": { "type": "boolean" }, "category": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "xml": { "name": "CustomReportDto" }, "type": "object" }, "OAS.DataProcess.Reporting.CustomReportProcess.CustomReportCustomImportResponseDto": { "properties": { "importCommon": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportCommonDto" }, "import": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportEditableDto" } }, "xml": { "name": "CustomReportCustomImportResponseDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.ImportEditableDto": { "properties": { "importId": { "type": "integer", "format": "int32" }, "importTypeId": { "type": "integer", "format": "int32" }, "importMetadata": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ImportMetadataDto" }, "workingData": { "type": "object" }, "importName": { "type": "string" } }, "xml": { "name": "ImportEditableDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.ImportMetadataDto": { "properties": { "validationMessage": { "type": "string" }, "validated": { "type": "boolean" }, "imported": { "type": "boolean" }, "reversed": { "type": "boolean" }, "importReverseId": { "type": "integer", "format": "int32" }, "importTypeReverseId": { "type": "integer", "format": "int32" }, "preImportDataIsNull": { "type": "boolean" }, "postImportDataIsNull": { "type": "boolean" }, "rowCounts": { "type": "object" }, "importCommonId": { "type": "integer", "format": "int32" } }, "xml": { "name": "ImportMetadataDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Custom.CustomReportCustomImportDto": { "properties": { "singleDbImportTypes": { "items": { "$ref": "#/definitions/OAS.DataModel.Utility.ImportType" }, "xml": { "name": "ImportType", "wrapped": true }, "type": "array" }, "multiDbImportTypes": { "items": { "$ref": "#/definitions/OAS.DataModel.Utility.ImportType" }, "xml": { "name": "ImportType", "wrapped": true }, "type": "array" } }, "xml": { "name": "CustomReportCustomImportDto" }, "type": "object" }, "OAS.DataModel.Utility.ImportType": { "required": [ "id", "importTypeName", "importTypeDescription", "tags" ], "properties": { "id": { "type": "integer", "format": "int32" }, "importTypeName": { "type": "string", "maxLength": 100, "minLength": 0 }, "importTypeDescription": { "type": "string", "maxLength": 1000, "minLength": 0 }, "configJson": { "type": "string" }, "privilegeId": { "type": "integer", "format": "int32" }, "tags": { "type": "string" }, "importTypeReverseId": { "type": "integer", "format": "int32" }, "storedProcedure": { "type": "string" }, "requiredFields": { "readOnly": true, "type": "string" } }, "xml": { "name": "ImportType" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Custom.CustomReportRankedDto": { "properties": { "rank": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "scheduleIsActive": { "type": "boolean" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "activeScheduleCount": { "type": "integer", "format": "int32" }, "isCustom": { "type": "boolean" }, "isFavorite": { "type": "boolean" }, "scheduleId": { "type": "integer", "format": "int32" }, "isLandscape": { "type": "boolean" }, "reportClass": { "type": "string" }, "isInternal": { "type": "boolean" }, "guid": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "promptClass": { "type": "string" }, "reportType": { "type": "string", "enum": [ "Query", "CustomImport", "Scrub" ] }, "userOwnerId": { "type": "integer", "format": "int32" }, "queryType": { "readOnly": true, "type": "string", "enum": [ "None", "Custom", "Excel", "All" ] }, "title": { "readOnly": true, "type": "string" }, "isNoteEnabled": { "type": "boolean" }, "isReadOnly": { "type": "boolean" }, "isQuerySmith": { "type": "boolean" }, "category": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "xml": { "name": "CustomReportRankedDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Custom.CustomReportScheduleDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "customReportId": { "type": "integer", "format": "int32" }, "parameters": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportPromptArrayWithErrorDataDto" }, "frequencyInfo": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportScheduleFrequencyDto" }, "notes": { "type": "string" }, "isActive": { "type": "boolean" }, "lastRunDate": { "type": "string", "format": "date-time" }, "uploadTargetId": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string" }, "createdByIsActive": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "CustomReportScheduleDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.UploadTargetDto": { "properties": { "pkUploadTarget": { "type": "integer", "format": "int32" }, "fkUploadFormat": { "type": "integer", "format": "int32" }, "userID": { "type": "string" }, "password": { "type": "string" }, "pgpUserID": { "type": "string" }, "transmitMethod": { "type": "string", "enum": [ "Empty", "None", "FTP", "DSTHTTP", "Network", "SFTP", "FTPS", "S3" ] }, "url": { "type": "string" }, "useForScrubs": { "type": "boolean" }, "sqlText": { "type": "string" }, "finalProcess": { "type": "string" }, "instructionCode": { "type": "string" }, "parameters": { "type": "string" }, "description": { "type": "string" }, "blobType": { "type": "string" } }, "xml": { "name": "UploadTargetDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Custom.CustomReportNoteDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "customReportId": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "note": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "rowData": { "type": "object" } }, "xml": { "name": "CustomReportNoteDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Custom.CustomReportVerboseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "report": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportVerboseReportDto" }, "prompts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportPromptDto" }, "xml": { "name": "CustomReportPromptDto", "wrapped": true }, "type": "array" }, "databaseIdList": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, "xml": { "name": "CustomReportVerboseDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Custom.CustomReportVerboseReportDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "title": { "type": "string" }, "reportDescription": { "type": "string" }, "category": { "type": "string" }, "sqlText": { "type": "string" }, "isLandscape": { "type": "boolean" }, "reportClass": { "type": "string" }, "isInternal": { "type": "boolean" }, "isReadOnly": { "type": "boolean" }, "isQuerySmith": { "type": "boolean" }, "guid": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "promptClass": { "type": "string" }, "reportType": { "type": "string", "enum": [ "Query", "CustomImport", "Scrub" ] }, "userOwnerId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "alClients": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportAlClientDto" }, "xml": { "name": "CustomReportAlClientDto", "wrapped": true }, "type": "array" }, "importTypes": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportImportDto" }, "xml": { "name": "CustomReportImportDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "CustomReportVerboseReportDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Custom.CustomReportAlClientDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "customReportId": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "reportDescription": { "type": "string" } }, "xml": { "name": "CustomReportAlClientDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Custom.CustomReportImportDto": { "properties": { "customReportId": { "type": "integer", "format": "int32" }, "importTypeId": { "type": "integer", "format": "int32" }, "isInternalOnly": { "type": "boolean" } }, "xml": { "name": "CustomReportImportDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Custom.CustomReportQuerySmithSaveDto": { "description": "Request body for the QuerySmith create and update routes. They authorize on QueryStudioQueries rather than\r\nDataQueryAdmin, so only author-editable fields are accepted; SQL, firm associations and classification such as\r\nEntity and IsInternal are assigned server-side.", "properties": { "report": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportQuerySmithSaveReportDto" }, "prompts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportPromptDto" }, "xml": { "name": "CustomReportPromptDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "CustomReportQuerySmithSaveDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Custom.CustomReportQuerySmithSaveReportDto": { "properties": { "title": { "type": "string" }, "reportDescription": { "type": "string" }, "category": { "type": "string" } }, "xml": { "name": "CustomReportQuerySmithSaveReportDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Widgets.DashboardDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "widgets": { "type": "string" }, "dashboardLevel": { "type": "string", "enum": [ "Portfolio", "Representative", "Advisor" ] }, "visibilityLevel": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "description": { "type": "string" }, "isDefault": { "type": "boolean" }, "systemType": { "type": "string", "enum": [ "None", "Composites", "Portfolio" ] } }, "xml": { "name": "DashboardDto" }, "type": "object" }, "OAS.DataProcess.Performance.ScopeCache.ScopeCacheResult": { "properties": { "cacheName": { "type": "string" }, "lastUpdated": { "type": "string", "format": "date-time" }, "scopeResult": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Calculate.ScopeDto" } }, "xml": { "name": "ScopeCacheResult" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Calculate.ScopeDto": { "properties": { "sessionId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "asOfDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "dataLastUpdated": { "type": "string", "format": "date-time" }, "calculations": { "items": { "$ref": "#/definitions/OAS.DataAccess.Domains.Reporting.DataEngine.IGotCalculated" }, "xml": { "name": "IGotCalculated", "wrapped": true }, "type": "array" } }, "xml": { "name": "ScopeDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Deliver.AdvisorEmailSentDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "advisorEmailId": { "type": "integer", "format": "int32" }, "entityEnum": { "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" }, "blobId": { "type": "integer", "format": "int32" }, "entityName": { "type": "string" }, "email": { "type": "string" }, "errorsText": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "dateSent": { "readOnly": true, "type": "string" }, "modifiedBy": { "type": "string" }, "modifiedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "AdvisorEmailSentDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.DeliverDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "scheduleActive": { "type": "boolean" }, "name": { "type": "string" }, "templateBy": { "type": "string" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "nextSend": { "type": "string", "format": "date-time" }, "fromEmail": { "type": "string" }, "bccEmail": { "type": "string" }, "groupSendTo": { "type": "string" }, "groupSendToId": { "type": "integer", "format": "int32" }, "subject": { "type": "string" }, "scheduleStartDate": { "type": "string", "format": "date-time" }, "scheduleType": { "type": "string", "enum": [ "Weekly", "Monthly", "Quarterly", "Yearly", "OnDemand" ] }, "period": { "type": "string", "enum": [ "Period", "LastWeek", "LastMonth", "LastQtd", "LastYear", "MTD", "QTD", "YTD", "OneYear", "ThreeYear", "FiveYear", "TenYear", "Inception" ] }, "periodStartDate": { "type": "string", "format": "date-time" }, "periodEndDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string" }, "modifiedDate": { "type": "string", "format": "date-time" }, "emailsSent": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "twitterId": { "type": "string" }, "facebookUrl": { "type": "string" }, "linkedInUrl": { "type": "string" } }, "xml": { "name": "DeliverDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Deliver.AdvisorEmailSectionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "category": { "type": "string" }, "categoryIcon": { "type": "string" }, "userControlUrl": { "type": "string" }, "screenshotUrl": { "type": "string" }, "columnSpan": { "type": "integer", "format": "int32" }, "optionType": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string" }, "modifiedDate": { "type": "string", "format": "date-time" }, "options": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Deliver.AdvisorEmailSectionOptionDto" }, "xml": { "name": "AdvisorEmailSectionOptionDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "AdvisorEmailSectionDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Deliver.AdvisorEmailSectionOptionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "advisorEmailSectionId": { "type": "integer", "format": "int32" }, "displayName": { "type": "string" }, "optionName": { "type": "string" }, "dataType": { "type": "string", "enum": [ "Boolean", "Integer", "Decimal", "String", "List", "Multiselect" ] }, "defaultValue": { "type": "string" }, "availableValues": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string" }, "modifiedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "AdvisorEmailSectionOptionDto" }, "type": "object" }, "OAS.DataModel.Reporting.Deliver.AdvisorRenderedEmailDto": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "id": { "type": "integer", "format": "int32" }, "title": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "faceBookLink": { "type": "string" }, "linkedInLink": { "type": "string" }, "twitterLink": { "type": "string" }, "loginLink": { "type": "boolean" }, "sections": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Deliver.AdvisorRenderedSectionDto" }, "xml": { "name": "AdvisorRenderedSectionDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "AdvisorRenderedEmailDto" }, "type": "object" }, "OAS.DataModel.Reporting.Deliver.AdvisorRenderedSectionDto": { "properties": { "sectionName": { "type": "string" }, "col": { "type": "integer", "format": "int32" }, "row": { "type": "integer", "format": "int32" }, "control": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" } }, "xml": { "name": "AdvisorRenderedSectionDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.AdvisorEmailVerboseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "template": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.AdvisorEmailTemplateDto" }, "assignedSections": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.AdvisorEmailAssignedSectionDto" }, "xml": { "name": "AdvisorEmailAssignedSectionDto", "wrapped": true }, "type": "array" }, "sentEmails": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Deliver.AdvisorEmailSentDto" }, "xml": { "name": "AdvisorEmailSentDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "AdvisorEmailVerboseDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.AdvisorEmailTemplateDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "groupSendToId": { "type": "integer", "format": "int32" }, "public": { "type": "boolean" }, "name": { "type": "string" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "fromEmail": { "type": "string" }, "bccEmail": { "type": "string" }, "subject": { "type": "string" }, "twitterId": { "type": "string" }, "facebookUrl": { "type": "string" }, "linkedInUrl": { "type": "string" }, "showLoginLink": { "type": "boolean" }, "period": { "type": "string", "enum": [ "Period", "LastWeek", "LastMonth", "LastQtd", "LastYear", "MTD", "QTD", "YTD", "OneYear", "ThreeYear", "FiveYear", "TenYear", "Inception" ] }, "periodStartDate": { "type": "string", "format": "date-time" }, "periodEndDate": { "type": "string", "format": "date-time" }, "scheduleActive": { "type": "boolean" }, "scheduleStartDate": { "type": "string", "format": "date-time" }, "scheduleType": { "type": "string", "enum": [ "Weekly", "Monthly", "Quarterly", "Yearly", "OnDemand" ] }, "scheduleWeekDay": { "type": "string", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ] }, "scheduleMonthDay": { "type": "integer", "format": "int32" }, "scheduleQuarterOnMonth": { "type": "integer", "format": "int32" }, "scheduleQuarterOnDay": { "type": "integer", "format": "int32" }, "scheduleYearOnMonth": { "type": "integer", "format": "int32" }, "scheduleYearOnDay": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string" }, "modifiedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "AdvisorEmailTemplateDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.AdvisorEmailAssignedSectionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "advisorEmailId": { "type": "integer", "format": "int32" }, "advisorEmailSectionId": { "type": "integer", "format": "int32" }, "row": { "type": "integer", "format": "int32" }, "column": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string" }, "modifiedDate": { "type": "string", "format": "date-time" }, "optionValues": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.AdvisorEmailSectionOptionValueDto" }, "xml": { "name": "AdvisorEmailSectionOptionValueDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "AdvisorEmailAssignedSectionDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.AdvisorEmailSectionOptionValueDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "advisorEmailId": { "type": "integer", "format": "int32" }, "advisorEmailSectionId": { "type": "integer", "format": "int32" }, "advisorEmailSectionOptionId": { "type": "integer", "format": "int32" }, "assignedSectionId": { "type": "integer", "format": "int32" }, "optionValue": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "modifiedBy": { "type": "string" }, "modifiedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "AdvisorEmailSectionOptionValueDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Deliver.DeliverInstanceDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "reportName": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "isActive": { "type": "boolean" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "messageType": { "type": "string", "enum": [ "Email", "Text" ] }, "triggerType": { "readOnly": true, "type": "string" }, "lastSent": { "type": "string", "format": "date-time" }, "nextSend": { "type": "string", "format": "date-time" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "canBeDeleted": { "type": "boolean" } }, "xml": { "name": "DeliverInstanceDto" }, "type": "object" }, "OAS.DataModel.Reporting.Deliver.DeliverTestPayload": { "properties": { "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "emailAddresses": { "items": { "type": "string" }, "type": "array" } }, "xml": { "name": "DeliverTestPayload" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Deliver.DeliverInstanceVerboseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "reportOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportOption" }, "xml": { "name": "ReportOption", "wrapped": true }, "type": "array" }, "template": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Deliver.DeliverInstanceVerboseTemplateDto" }, "extensionEmail": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Deliver.DeliverInstanceVerboseEmailDto" }, "triggers": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Deliver.DeliverInstanceVerboseTriggerDto" }, "xml": { "name": "DeliverInstanceVerboseTriggerDto", "wrapped": true }, "type": "array" }, "groups": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Deliver.DeliverInstanceVerboseGroupDto" }, "xml": { "name": "DeliverInstanceVerboseGroupDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "DeliverInstanceVerboseDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Deliver.DeliverInstanceVerboseTemplateDto": { "properties": { "reportId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "isActive": { "type": "boolean" }, "messageType": { "type": "string", "enum": [ "Email", "Text" ] }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] } }, "xml": { "name": "DeliverInstanceVerboseTemplateDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Deliver.DeliverInstanceVerboseEmailDto": { "properties": { "subject": { "type": "string" }, "from": { "type": "string" }, "bcc": { "type": "string" } }, "xml": { "name": "DeliverInstanceVerboseEmailDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Deliver.DeliverInstanceVerboseTriggerDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "triggerOption": { "$ref": "#/definitions/OAS.DataAccess.Domains.Reporting.TriggerOption" }, "deliverText": { "type": "string" }, "nextSendDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "DeliverInstanceVerboseTriggerDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Deliver.DeliverInstanceVerboseGroupDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "DeliverInstanceVerboseGroupDto" }, "type": "object" }, "OAS.DataAccess.Domains.Reporting.TriggerOption": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" } }, "xml": { "name": "TriggerOption" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.WebEntityGroupDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "groupName": { "type": "string" }, "groupEntity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "groupType": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string" }, "includeAll": { "type": "boolean" }, "includeExcludeCount": { "type": "integer", "format": "int32" }, "selectedItems": { "description": "Field to allow UI to send down selected items", "items": { "type": "integer", "format": "int32" }, "type": "array" } }, "xml": { "name": "WebEntityGroupDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Deliver.DeliverTriggerDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "deliverId": { "type": "integer", "format": "int32" }, "triggerOption": { "$ref": "#/definitions/OAS.DataAccess.Domains.Reporting.TriggerOption" }, "deliverText": { "type": "string" }, "nextSendDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "DeliverTriggerDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Deliver.DeliverTriggersDisplayDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "deliverId": { "type": "integer", "format": "int32" }, "deliverName": { "type": "string" }, "nextSendDate": { "type": "string", "format": "date-time" }, "isActive": { "type": "boolean" }, "sentItemsCount": { "type": "integer", "format": "int32" } }, "xml": { "name": "DeliverTriggersDisplayDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Deliver.DeliverEmailDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "deliverId": { "type": "integer", "format": "int32" }, "deliverTriggerId": { "type": "integer", "format": "int32" }, "hasFile": { "type": "boolean" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "generateStatus": { "type": "string", "enum": [ "NotGenerated", "Errored", "Generated", "PendingGeneration" ] }, "generateStatusTimestamp": { "type": "string", "format": "date-time" }, "emailStatus": { "type": "string", "enum": [ "HasNotBeenSent", "Error", "PendingReview", "SuccessfullySent", "PendingSend", "WillNotBeSent" ] }, "emailStatusTimestamp": { "type": "string", "format": "date-time" }, "sendTo": { "type": "string" }, "errorText": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "messageType": { "type": "string", "enum": [ "Email", "Text" ] } }, "xml": { "name": "DeliverEmailDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Element.FactSheetParametersDto": { "properties": { "repId": { "type": "integer", "format": "int32" }, "orionRepId": { "type": "integer", "format": "int32" }, "modelAggId": { "type": "integer", "format": "int32" }, "modelId": { "type": "integer", "format": "int32" }, "modelName": { "type": "string" }, "overlayModelName": { "type": "string" }, "modelAggAllocations": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Element.ModelAggAllocations" }, "xml": { "name": "ModelAggAllocations", "wrapped": true }, "type": "array" }, "targetRiskScore": { "type": "integer", "format": "int32" }, "isOatTenant": { "type": "boolean" } }, "xml": { "name": "FactSheetParametersDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Element.ModelAggAllocations": { "properties": { "modelAggId": { "type": "integer", "format": "int32" }, "allocation": { "type": "integer", "format": "int32" } }, "xml": { "name": "ModelAggAllocations" }, "type": "object" }, "Element.Proposal.Dto.Responses.ProposalResponse": { "properties": { "status": { "type": "string", "enum": [ "New", "InProgress", "Completed", "CompletedWithErrors", "MaximumProcessingAttemptsReached", "Error", "NoDataFound", "Unknown" ] }, "pdfBytes": { "type": "string", "format": "byte" }, "prospectId": { "type": "string" }, "messages": { "items": { "type": "string" }, "type": "array" }, "proposalName": { "type": "string" }, "proposalError": { "type": "string" } }, "xml": { "name": "ProposalResponse" }, "type": "object" }, "Element.Proposal.Dto.FactSheet.FactSheetDataDto": { "properties": { "title": { "type": "string" }, "entityName": { "type": "string" }, "secondaryEntityId": { "type": "integer", "format": "int32" }, "secondaryEntityName": { "type": "string" }, "sleeveStrategyAggregateId": { "type": "integer", "format": "int32" }, "riskScore": { "type": "integer", "format": "int32" }, "expenseRatio": { "type": "number", "format": "double" }, "historicalPerformanceChartHeader": { "type": "string" }, "historicalPerformanceChartHtml": { "type": "string" }, "riskReturnChartHtml": { "type": "string" }, "isWeathAdvisory": { "type": "boolean" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "lastCalendarYearPerformanceDate": { "type": "string", "format": "date-time" }, "performanceChartData": { "$ref": "#/definitions/Element.Proposal.Dto.FactSheet.FactSheetPerformanceChartDto" }, "benchmark": { "$ref": "#/definitions/Element.Proposal.Dto.FactSheet.FactSheetBenchmarkDto" }, "threeMonthRiskProfile": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.RiskProfileDto" }, "oneYearRiskProfile": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.RiskProfileDto" }, "threeYearRiskProfile": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.RiskProfileDto" }, "fiveYearRiskProfile": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.RiskProfileDto" }, "tenYearRiskProfile": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.RiskProfileDto" }, "inceptionRiskProfile": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.RiskProfileDto" }, "messages": { "items": { "type": "string" }, "type": "array" }, "returns": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.FactSheet.FactSheetReturnDto" }, "xml": { "name": "FactSheetReturnDto", "wrapped": true }, "type": "array" }, "performances": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.FactSheet.FactSheetPerformanceDto" }, "xml": { "name": "FactSheetPerformanceDto", "wrapped": true }, "type": "array" }, "riskStatistics": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.FactSheet.FactSheetRiskStatisticsDto" }, "xml": { "name": "FactSheetRiskStatisticsDto", "wrapped": true }, "type": "array" }, "riskGrossStatistics": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.FactSheet.FactSheetRiskStatisticsDto" }, "xml": { "name": "FactSheetRiskStatisticsDto", "wrapped": true }, "type": "array" }, "assetClasses": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalAssetClassDto" }, "xml": { "name": "ProposalAssetClassDto", "wrapped": true }, "type": "array" }, "assetCategories": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalAssetCategoryDto" }, "xml": { "name": "ProposalAssetCategoryDto", "wrapped": true }, "type": "array" }, "modelAggAssetClass": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalAssetClassDto" }, "modelAggAssetCategory": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalAssetCategoryDto" }, "calendarYearPerformanceGroups": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.FactSheet.CalendarYearPerformanceGroupDto" }, "xml": { "name": "CalendarYearPerformanceGroupDto", "wrapped": true }, "type": "array" }, "portfolioOverview": { "type": "string" }, "portfolioManagementTeam": { "type": "string" }, "wealthAdvisoryAccount": { "type": "boolean" }, "wealthAdvisoryBenchmarks": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.FactSheet.FactSheetBenchmarkDto" }, "xml": { "name": "FactSheetBenchmarkDto", "wrapped": true }, "type": "array" }, "entityId": { "type": "integer", "format": "int32" }, "factSheetType": { "type": "string", "enum": [ "NoData", "Composite", "FinMason", "Product", "Blended" ] }, "factSheetDataGenerationId": { "readOnly": true, "type": "string" }, "loggingId": { "readOnly": true, "type": "string" }, "tenantCode": { "type": "string" }, "createDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "FactSheetDataDto" }, "type": "object" }, "Element.Proposal.Dto.FactSheet.FactSheetPerformanceChartDto": { "properties": { "rangeBeginDate": { "type": "string", "format": "date-time" }, "rangeEndDate": { "type": "string", "format": "date-time" }, "performanceChartSeriesData": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.FactSheet.FactSheetPerformanceChartSeriesDataDto" }, "xml": { "name": "FactSheetPerformanceChartSeriesDataDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "FactSheetPerformanceChartDto" }, "type": "object" }, "Element.Proposal.Dto.FactSheet.FactSheetBenchmarkDto": { "properties": { "name": { "type": "string" }, "returns": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.FactSheet.FactSheetReturnDto" }, "xml": { "name": "FactSheetReturnDto", "wrapped": true }, "type": "array" }, "indexes": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.FactSheet.FactSheetBenchmarkIndexDto" }, "xml": { "name": "FactSheetBenchmarkIndexDto", "wrapped": true }, "type": "array" }, "riskStatistics": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.FactSheet.FactSheetRiskStatisticsDto" }, "xml": { "name": "FactSheetRiskStatisticsDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "FactSheetBenchmarkDto" }, "type": "object" }, "OrionRiskIntelligence.Dto.RiskProfile.RiskProfileDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "portfolio": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.PortfolioDto" }, "benchmark": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.BenchmarkDto" }, "correlations": { "items": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.CorrelationDto" }, "xml": { "name": "CorrelationDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "RiskProfileDto" }, "type": "object" }, "Element.Proposal.Dto.FactSheet.FactSheetReturnDto": { "properties": { "timeFrame": { "type": "string", "enum": [ "Inception", "OneMonth", "ThreeMonth", "YearToDate", "OneYear", "ThreeYear", "FiveYear", "TenYear", "Period", "Year2000", "Year2001", "Year2002", "Year2003", "Year2004", "Year2005", "Year2006", "Year2007", "Year2008", "Year2009", "Year2010", "Year2011", "Year2012", "Year2013", "Year2014", "Year2015", "Year2016", "Year2017", "Year2018", "Year2019", "Year2020", "Year2021", "Year2022", "Year2023", "Year2024", "Year2025", "Year2026", "Year2027", "Year2028", "Year2029", "Year2030" ] }, "fieldValue": { "type": "number", "format": "double" }, "isAnnualized": { "type": "boolean" }, "ticker": { "type": "string" } }, "xml": { "name": "FactSheetReturnDto" }, "type": "object" }, "Element.Proposal.Dto.FactSheet.FactSheetPerformanceDto": { "properties": { "timeFrame": { "type": "string", "enum": [ "Inception", "OneMonth", "ThreeMonth", "YearToDate", "OneYear", "ThreeYear", "FiveYear", "TenYear", "Period", "Year2000", "Year2001", "Year2002", "Year2003", "Year2004", "Year2005", "Year2006", "Year2007", "Year2008", "Year2009", "Year2010", "Year2011", "Year2012", "Year2013", "Year2014", "Year2015", "Year2016", "Year2017", "Year2018", "Year2019", "Year2020", "Year2021", "Year2022", "Year2023", "Year2024", "Year2025", "Year2026", "Year2027", "Year2028", "Year2029", "Year2030" ] }, "bestPeriod": { "type": "string", "format": "date-time" }, "bestReturn": { "type": "number", "format": "double" }, "worstPeriod": { "type": "string", "format": "date-time" }, "worstReturn": { "type": "number", "format": "double" } }, "xml": { "name": "FactSheetPerformanceDto" }, "type": "object" }, "Element.Proposal.Dto.FactSheet.FactSheetRiskStatisticsDto": { "properties": { "timeFrame": { "type": "string", "enum": [ "Inception", "OneMonth", "ThreeMonth", "YearToDate", "OneYear", "ThreeYear", "FiveYear", "TenYear", "Period", "Year2000", "Year2001", "Year2002", "Year2003", "Year2004", "Year2005", "Year2006", "Year2007", "Year2008", "Year2009", "Year2010", "Year2011", "Year2012", "Year2013", "Year2014", "Year2015", "Year2016", "Year2017", "Year2018", "Year2019", "Year2020", "Year2021", "Year2022", "Year2023", "Year2024", "Year2025", "Year2026", "Year2027", "Year2028", "Year2029", "Year2030" ] }, "standardDeviation": { "type": "number", "format": "double" }, "sharpeRatio": { "type": "number", "format": "double" }, "sortinoRatio": { "type": "number", "format": "double" }, "beta": { "type": "number", "format": "double" }, "maxDrawdown": { "type": "number", "format": "double" }, "covariance": { "type": "number", "format": "double" }, "relativeRiskScore": { "type": "number", "format": "double" }, "annualizedReturn": { "type": "number", "format": "double" }, "cumulativeReturn": { "type": "number", "format": "double" }, "alpha": { "type": "number", "format": "double" }, "rSquared": { "type": "number", "format": "double" } }, "xml": { "name": "FactSheetRiskStatisticsDto" }, "type": "object" }, "Element.Proposal.Dto.Proposal.Core.ProposalAssetClassDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "allocation": { "type": "number", "format": "double" }, "investmentAmount": { "type": "number", "format": "double" }, "color": { "type": "string" } }, "xml": { "name": "ProposalAssetClassDto" }, "type": "object" }, "Element.Proposal.Dto.Proposal.Core.ProposalAssetCategoryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "allocation": { "type": "number", "format": "double" }, "investmentAmount": { "type": "number", "format": "double" }, "color": { "type": "string" }, "categoryAssetClasses": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalAssetClassDto" }, "xml": { "name": "ProposalAssetClassDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProposalAssetCategoryDto" }, "type": "object" }, "Element.Proposal.Dto.FactSheet.CalendarYearPerformanceGroupDto": { "properties": { "name": { "type": "string" }, "calendarYearPerformances": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.FactSheet.CalendarYearPerformanceDto" }, "xml": { "name": "CalendarYearPerformanceDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "CalendarYearPerformanceGroupDto" }, "type": "object" }, "Element.Proposal.Dto.FactSheet.FactSheetPerformanceChartSeriesDataDto": { "properties": { "performanceDate": { "type": "string", "format": "date-time" }, "allocationPercent": { "type": "number", "format": "double" }, "allocationAmount": { "type": "number", "format": "double" } }, "xml": { "name": "FactSheetPerformanceChartSeriesDataDto" }, "type": "object" }, "Element.Proposal.Dto.FactSheet.FactSheetBenchmarkIndexDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "code": { "type": "string" }, "value": { "type": "number", "format": "double" }, "riskStatistics": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.FactSheet.FactSheetRiskStatisticsDto" }, "xml": { "name": "FactSheetRiskStatisticsDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "FactSheetBenchmarkIndexDto" }, "type": "object" }, "OrionRiskIntelligence.Dto.RiskProfile.PortfolioDto": { "properties": { "ccrScore": { "type": "number", "format": "double" }, "expectedReturn": { "type": "number", "format": "double" }, "expectedReturn5Yr": { "type": "number", "format": "double" }, "liquidity": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.LiquidityDto" }, "strategyFee": { "type": "number", "format": "double" }, "usePctAllocation": { "type": "string" }, "timeframe": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.TimeFrameDto" }, "portStartDate": { "type": "string", "format": "date-time" }, "jsonPositions": { "items": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.PositionDto" }, "xml": { "name": "PositionDto", "wrapped": true }, "type": "array" }, "value": { "type": "number", "format": "double" }, "feeAnalysis": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.FeeAnalysisDto" }, "timeframesp500Beta": { "type": "number", "format": "double" }, "pvh": { "items": { "type": "object" }, "type": "array" }, "leversToWatch": { "items": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.LeversToWatchDto" }, "xml": { "name": "LeversToWatchDto", "wrapped": true }, "type": "array" }, "insigLevers": { "items": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.LeversToWatchDto" }, "xml": { "name": "LeversToWatchDto", "wrapped": true }, "type": "array" }, "riskMeasures": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.RiskMeasureDto" }, "mddstart": { "type": "string", "format": "date-time" }, "worstScenarioImpact": { "type": "number", "format": "double" }, "excludedSymbols": { "items": { "type": "object" }, "type": "array" }, "mpt": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.MptDto" }, "pctLiquid": { "type": "number", "format": "double" }, "famaFactors": { "items": { "type": "object" }, "type": "array" }, "analyzableValue": { "type": "number", "format": "double" }, "assetClasses": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.AssetClassesDto" }, "mddend": { "type": "string", "format": "date-time" }, "averageYield": { "type": "number", "format": "double" }, "averageDuration": { "type": "number", "format": "double" }, "isTickerWrapper": { "type": "boolean" }, "dividendYield": { "readOnly": true, "type": "number", "format": "double" }, "marketCap": { "readOnly": true, "type": "number", "format": "double" }, "priceToEarnings": { "readOnly": true, "type": "number", "format": "double" } }, "xml": { "name": "PortfolioDto" }, "type": "object" }, "OrionRiskIntelligence.Dto.RiskProfile.BenchmarkDto": { "properties": { "expectedReturn": { "type": "number", "format": "double" }, "expectedReturn5Yr": { "type": "number", "format": "double" }, "liquidity": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.LiquidityDto" }, "strategyFee": { "type": "number", "format": "double" }, "usePctAllocation": { "type": "string" }, "timeframe": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.TimeFrameDto" }, "portStartDate": { "type": "string", "format": "date-time" }, "jsonPositions": { "items": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.PositionDto" }, "xml": { "name": "PositionDto", "wrapped": true }, "type": "array" }, "id": { "type": "string" }, "value": { "type": "number", "format": "double" }, "feeAnalysis": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.FeeAnalysisDto" }, "timeframesp500Beta": { "type": "number", "format": "double" }, "pvh": { "items": { "type": "object" }, "type": "array" }, "leversToWatch": { "items": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.LeversToWatchDto" }, "xml": { "name": "LeversToWatchDto", "wrapped": true }, "type": "array" }, "riskMeasures": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.RiskMeasureDto" }, "isTickerWrapper": { "type": "string" }, "mddstart": { "type": "string", "format": "date-time" }, "worstScenarioImpact": { "type": "number", "format": "double" }, "excludedSymbols": { "items": { "type": "object" }, "type": "array" }, "assetType": { "type": "string" }, "mpt": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.MptDto" }, "industryid": { "type": "string" }, "name": { "type": "string" }, "pctLiquid": { "type": "number", "format": "double" }, "famaFactors": { "items": { "type": "object" }, "type": "array" }, "analyzableValue": { "type": "number", "format": "double" }, "assetClasses": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.AssetClassesDto" }, "mddend": { "type": "string", "format": "date-time" } }, "xml": { "name": "BenchmarkDto" }, "type": "object" }, "OrionRiskIntelligence.Dto.RiskProfile.CorrelationDto": { "properties": { "ticker1": { "type": "string" }, "correlation": { "type": "number", "format": "double" }, "pvalue": { "type": "number", "format": "double" }, "ticker2": { "type": "string" }, "name2": { "type": "string" }, "name1": { "type": "string" } }, "xml": { "name": "CorrelationDto" }, "type": "object" }, "Element.Proposal.Dto.FactSheet.CalendarYearPerformanceDto": { "properties": { "year": { "type": "integer", "format": "int32" }, "returnPercent": { "type": "number", "format": "double" } }, "xml": { "name": "CalendarYearPerformanceDto" }, "type": "object" }, "OrionRiskIntelligence.Dto.RiskProfile.LiquidityDto": { "properties": { "5y": { "type": "number", "format": "double" }, "3y": { "type": "number", "format": "double" }, "now": { "type": "number", "format": "double" }, "1y": { "type": "number", "format": "double" }, "3m": { "type": "number", "format": "double" }, "10y": { "type": "number", "format": "double" } }, "xml": { "name": "LiquidityDto" }, "type": "object" }, "OrionRiskIntelligence.Dto.RiskProfile.TimeFrameDto": { "properties": { "endDate": { "type": "string", "format": "date-time" }, "timeString": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "TimeFrameDto" }, "type": "object" }, "OrionRiskIntelligence.Dto.RiskProfile.PositionDto": { "properties": { "pricedatemap": { "type": "string" }, "industry": { "type": "string" }, "liquidity": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.LiquidityDto" }, "volatility": { "type": "number", "format": "double" }, "type": { "type": "string" }, "firstHistory": { "type": "string", "format": "date-time" }, "indDesc": { "type": "string" }, "price": { "type": "number", "format": "double" }, "yield": { "type": "number", "format": "double" }, "lastGoodPrice": { "type": "number", "format": "double" }, "pctAllocation": { "type": "number", "format": "double" }, "marketCap": { "type": "number", "format": "double" }, "ticker": { "type": "string" }, "mgrStartDate": { "type": "string" }, "quantity": { "type": "number", "format": "double" }, "pricedate": { "type": "string" }, "mddstart": { "type": "string" }, "trueYield": { "type": "number", "format": "double" }, "tradedcurrencyid": { "type": "integer", "format": "int32" }, "expenseRatio": { "type": "number", "format": "double" }, "name": { "type": "string" }, "orionProductId": { "type": "integer", "format": "int32" }, "mddend": { "type": "string" }, "bookValuePerShare": { "type": "number", "format": "double" }, "priceToEarnings": { "type": "number", "format": "double" }, "tempdata": { "type": "string" }, "priceStartDate": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "tickerid": { "type": "integer", "format": "int32" }, "avgVolume": { "type": "number", "format": "double" }, "mdd": { "type": "number", "format": "double" }, "tags": { "type": "string" }, "industryid": { "type": "integer", "format": "int32" }, "52wkChange": { "type": "number", "format": "double" }, "locationid": { "type": "integer", "format": "int32" }, "currencyid": { "type": "integer", "format": "int32" }, "totalReturn": { "type": "number", "format": "double" }, "worstImpact": { "type": "number", "format": "double" }, "expectedReturn5Yr": { "type": "number", "format": "double" }, "expectedReturn": { "type": "number", "format": "double" }, "jsonInfo": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.JsonInfoDto" }, "feeStdDevBelow": { "type": "number", "format": "double" }, "feeStdDevAbove": { "type": "number", "format": "double" } }, "xml": { "name": "PositionDto" }, "type": "object" }, "OrionRiskIntelligence.Dto.RiskProfile.FeeAnalysisDto": { "properties": { "totalPctFee": { "type": "number", "format": "double" }, "aumFee": { "type": "number", "format": "double" }, "expenseRatio": { "type": "number", "format": "double" }, "name": { "type": "string" }, "currency": { "type": "string" } }, "xml": { "name": "FeeAnalysisDto" }, "type": "object" }, "OrionRiskIntelligence.Dto.RiskProfile.LeversToWatchDto": { "properties": { "monthAgoValue": { "type": "number", "format": "double" }, "priceToEarnings": { "type": "number", "format": "double" }, "range": { "type": "number", "format": "double" }, "industry": { "type": "string" }, "volatility": { "type": "number", "format": "double" }, "type": { "type": "string" }, "leverid": { "type": "integer", "format": "int32" }, "priceStartDate": { "type": "string", "format": "date-time" }, "price": { "type": "number", "format": "double" }, "yield": { "type": "number", "format": "double" }, "id": { "type": "integer", "format": "int32" }, "tickerid": { "type": "integer", "format": "int32" }, "value": { "type": "number", "format": "double" }, "impact2yr": { "type": "number", "format": "double" }, "marketCap": { "type": "object" }, "ticker": { "type": "string" }, "portfolioImpact": { "type": "number", "format": "double" }, "mgrStartDate": { "type": "string", "format": "date-time" }, "pricedate": { "type": "string", "format": "date-time" }, "yearAgoValue": { "type": "number", "format": "double" }, "stderror": { "type": "number", "format": "double" }, "avgVolume": { "type": "number", "format": "double" }, "impact": { "type": "number", "format": "double" }, "mddstart": { "type": "string", "format": "date-time" }, "mdd": { "type": "number", "format": "double" }, "trueYield": { "type": "number", "format": "double" }, "tags": { "type": "string" }, "unit": { "type": "string" }, "industryid": { "type": "integer", "format": "int32" }, "52wkChange": { "type": "number", "format": "double" }, "locationid": { "type": "integer", "format": "int32" }, "expenseRatio": { "type": "number", "format": "double" }, "name": { "type": "string" }, "leverdesc": { "type": "string" }, "levername": { "type": "string" }, "orionProductId": { "type": "integer", "format": "int32" }, "mddend": { "type": "string", "format": "date-time" }, "litype": { "type": "string" }, "operatingMargin": { "type": "number", "format": "double" }, "bookValuePerShare": { "type": "number", "format": "double" }, "revenue": { "type": "integer", "format": "int64" }, "eps": { "type": "number", "format": "double" }, "cashPerShare": { "type": "number", "format": "double" }, "payoutRatio": { "type": "number", "format": "double" }, "pegRatio": { "type": "number", "format": "double" }, "profitMargin": { "type": "number", "format": "double" }, "sharesOutstanding": { "type": "integer", "format": "int64" }, "returnOnAssets": { "type": "number", "format": "double" }, "debtToEquity": { "type": "number", "format": "double" }, "priceToSales": { "type": "number", "format": "double" }, "returnOnEquity": { "type": "number", "format": "double" }, "rsquared": { "type": "number", "format": "double" }, "priceToBook": { "type": "number", "format": "double" }, "jsonInfo": { "type": "string" }, "jsonInfoDto": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.JsonInfoDto", "readOnly": true } }, "xml": { "name": "LeversToWatchDto" }, "type": "object" }, "OrionRiskIntelligence.Dto.RiskProfile.RiskMeasureDto": { "properties": { "sp500Beta": { "type": "number", "format": "double" }, "aumfee": { "type": "number", "format": "double" }, "annualizedReturn": { "type": "number", "format": "double" }, "totalReturn": { "type": "number", "format": "double" }, "yield": { "type": "number", "format": "double" }, "expenseRatio": { "type": "number", "format": "double" }, "volatility": { "type": "number", "format": "double" }, "mdd": { "type": "number", "format": "double" }, "sharperatio": { "type": "number", "format": "double" }, "sortinoRatio": { "type": "number", "format": "double" } }, "xml": { "name": "RiskMeasureDto" }, "type": "object" }, "OrionRiskIntelligence.Dto.RiskProfile.MptDto": { "properties": { "econBreakdown": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.EconBreakdownDto" }, "regionBreakdown": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.RegionBreakdownDto" }, "sectorBreakdown": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.SectorBreakdownDto" }, "styleRawBreakdown": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.StyleRawBreakdownDto" }, "avgCreditRating": { "type": "string" }, "fiCountries": { "items": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.FiCountryDto" }, "xml": { "name": "FiCountryDto", "wrapped": true }, "type": "array" }, "fiCouponDetails": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.FiCouponDetailsDto" }, "fiMaturityBreakdown": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.FiMaturityBreakdownDto" }, "fiSectorDetails": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.FiSectorDetailsDto" }, "fiRegions": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.FiRegionsDto" }, "mktCapBreakdown": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.MktCapBreakdownDto" }, "styleBoxBreakdown": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.StyleBoxBreakdownDto" }, "fiSectorBreakdown": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.FiSectorBreakdownDto" }, "fiCreditBreakdown": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.FiCreditBreakdownDto" }, "fiMaturityDetails": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.FiMaturityDetailDto" }, "avgCreditQuality": { "type": "number", "format": "double" }, "avgWeightedCoupon": { "type": "number", "format": "double" }, "avgMaturity": { "type": "number", "format": "double" } }, "xml": { "name": "MptDto" }, "type": "object" }, "OrionRiskIntelligence.Dto.RiskProfile.AssetClassesDto": { "properties": { "detailed": { "items": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.DetailDto" }, "xml": { "name": "DetailDto", "wrapped": true }, "type": "array" }, "industry": { "items": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.DetailDto" }, "xml": { "name": "DetailDto", "wrapped": true }, "type": "array" }, "basic": { "items": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.DetailDto" }, "xml": { "name": "DetailDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "AssetClassesDto" }, "type": "object" }, "OrionRiskIntelligence.Dto.RiskProfile.JsonInfoDto": { "properties": { "thirtyDayYield": { "type": "number", "format": "double" }, "ttmYield": { "type": "number", "format": "double" }, "avgCreditRating": { "type": "number", "format": "double" }, "avgMaturity": { "type": "number", "format": "double" }, "avgWeightedCoupon": { "type": "number", "format": "double" }, "lastDivDate": { "type": "string" } }, "xml": { "name": "JsonInfoDto" }, "type": "object" }, "OrionRiskIntelligence.Dto.RiskProfile.EconBreakdownDto": { "properties": { "US Stock": { "type": "number", "format": "double" }, "International Developed Markets": { "type": "number", "format": "double" }, "Emerging Markets": { "type": "number", "format": "double" } }, "xml": { "name": "EconBreakdownDto" }, "type": "object" }, "OrionRiskIntelligence.Dto.RiskProfile.RegionBreakdownDto": { "properties": { "Middle East + Africa": { "type": "number", "format": "double" }, "Europe": { "type": "number", "format": "double" }, "North America": { "type": "number", "format": "double" }, "Asia + Pacific": { "type": "number", "format": "double" }, "Latin America": { "type": "number", "format": "double" } }, "xml": { "name": "RegionBreakdownDto" }, "type": "object" }, "OrionRiskIntelligence.Dto.RiskProfile.SectorBreakdownDto": { "properties": { "Utilities": { "type": "number", "format": "double" }, "Energy": { "type": "number", "format": "double" }, "Consumer Staples": { "type": "number", "format": "double" }, "Technology": { "type": "number", "format": "double" }, "Real Estate": { "type": "number", "format": "double" }, "Materials": { "type": "number", "format": "double" }, "Financials": { "type": "number", "format": "double" }, "Communications": { "type": "number", "format": "double" }, "Healthcare": { "type": "number", "format": "double" }, "Industrials": { "type": "number", "format": "double" }, "Consumer Discretionary": { "type": "number", "format": "double" } }, "xml": { "name": "SectorBreakdownDto" }, "type": "object" }, "OrionRiskIntelligence.Dto.RiskProfile.StyleRawBreakdownDto": { "properties": { "large-value": { "type": "number", "format": "double" }, "mid-blend": { "type": "number", "format": "double" }, "large-blend": { "type": "number", "format": "double" }, "small-growth": { "type": "number", "format": "double" }, "mid-value": { "type": "number", "format": "double" }, "small-blend": { "type": "number", "format": "double" }, "large-growth": { "type": "number", "format": "double" }, "small-value": { "type": "number", "format": "double" }, "mid-growth": { "type": "number", "format": "double" } }, "xml": { "name": "StyleRawBreakdownDto" }, "type": "object" }, "OrionRiskIntelligence.Dto.RiskProfile.FiCountryDto": { "properties": { "country": { "type": "string" }, "value": { "type": "number", "format": "double" } }, "xml": { "name": "FiCountryDto" }, "type": "object" }, "OrionRiskIntelligence.Dto.RiskProfile.FiCouponDetailsDto": { "properties": { "4-6%": { "type": "number", "format": "double" }, "10-12%": { "type": "number", "format": "double" }, "Over 12%": { "type": "number", "format": "double" }, "0%": { "type": "number", "format": "double" }, "0-4%": { "type": "number", "format": "double" }, "8-10%": { "type": "number", "format": "double" }, "6-8%": { "type": "number", "format": "double" } }, "xml": { "name": "FiCouponDetailsDto" }, "type": "object" }, "OrionRiskIntelligence.Dto.RiskProfile.FiMaturityBreakdownDto": { "properties": { "Intermediate": { "type": "number", "format": "double" }, "Long": { "type": "number", "format": "double" }, "Less than 1 Year": { "type": "number", "format": "double" }, "Short": { "type": "number", "format": "double" } }, "xml": { "name": "FiMaturityBreakdownDto" }, "type": "object" }, "OrionRiskIntelligence.Dto.RiskProfile.FiSectorDetailsDto": { "properties": { "Convertible": { "type": "number", "format": "double" }, "Commercial MBS": { "type": "number", "format": "double" }, "Bank Loan": { "type": "number", "format": "double" }, "Non-Agency MBS": { "type": "number", "format": "double" }, "Cash Equivalent": { "type": "number", "format": "double" }, "Agency MBS": { "type": "number", "format": "double" }, "Asset-Backed": { "type": "number", "format": "double" }, "US Treasury": { "type": "number", "format": "double" }, "Corporate Bond": { "type": "number", "format": "double" }, "Foreign Govt": { "type": "number", "format": "double" }, "Other": { "type": "number", "format": "double" }, "Municipal": { "type": "number", "format": "double" } }, "xml": { "name": "FiSectorDetailsDto" }, "type": "object" }, "OrionRiskIntelligence.Dto.RiskProfile.FiRegionsDto": { "properties": { "Europe": { "type": "number", "format": "double" }, "North America": { "type": "number", "format": "double" }, "Asia + Pacific": { "type": "number", "format": "double" } }, "xml": { "name": "FiRegionsDto" }, "type": "object" }, "OrionRiskIntelligence.Dto.RiskProfile.MktCapBreakdownDto": { "properties": { "small": { "type": "number", "format": "double" }, "large": { "type": "number", "format": "double" }, "mid": { "type": "number", "format": "double" } }, "xml": { "name": "MktCapBreakdownDto" }, "type": "object" }, "OrionRiskIntelligence.Dto.RiskProfile.StyleBoxBreakdownDto": { "properties": { "Blend": { "type": "number", "format": "double" }, "Growth": { "type": "number", "format": "double" }, "Value": { "type": "number", "format": "double" } }, "xml": { "name": "StyleBoxBreakdownDto" }, "type": "object" }, "OrionRiskIntelligence.Dto.RiskProfile.FiSectorBreakdownDto": { "properties": { "Government": { "type": "number", "format": "double" }, "Cash Equivalent": { "type": "number", "format": "double" }, "Corporate": { "type": "number", "format": "double" }, "Securitized": { "type": "number", "format": "double" }, "Other": { "type": "number", "format": "double" }, "Municipal": { "type": "number", "format": "double" } }, "xml": { "name": "FiSectorBreakdownDto" }, "type": "object" }, "OrionRiskIntelligence.Dto.RiskProfile.FiCreditBreakdownDto": { "properties": { "aaa": { "type": "number", "format": "double" }, "aa": { "type": "number", "format": "double" }, "a": { "type": "number", "format": "double" }, "bbb": { "type": "number", "format": "double" }, "bb": { "type": "number", "format": "double" }, "b": { "type": "number", "format": "double" }, "Below B / Unrated": { "type": "number", "format": "double" } }, "xml": { "name": "FiCreditBreakdownDto" }, "type": "object" }, "OrionRiskIntelligence.Dto.RiskProfile.FiMaturityDetailDto": { "properties": { "<1 Yr": { "type": "number", "format": "double" }, "1-3 Yrs": { "type": "number", "format": "double" }, "3-5 Yrs": { "type": "number", "format": "double" }, "5-7 Yrs": { "type": "number", "format": "double" }, "7-10 Yrs": { "type": "number", "format": "double" }, "10-15 Yrs": { "type": "number", "format": "double" }, "15-20 Yrs": { "type": "number", "format": "double" }, "20-30 Yrs": { "type": "number", "format": "double" }, "30+ Yrs": { "type": "number", "format": "double" } }, "xml": { "name": "FiMaturityDetailDto" }, "type": "object" }, "OrionRiskIntelligence.Dto.RiskProfile.DetailDto": { "properties": { "pct": { "type": "number", "format": "double" }, "ticker": { "type": "string" }, "quantity": { "type": "number", "format": "double" }, "price": { "type": "number", "format": "double" }, "name": { "type": "string" } }, "xml": { "name": "DetailDto" }, "type": "object" }, "Element.Proposal.Dto.Responses.FactSheetResponse": { "properties": { "modelAggId": { "type": "integer", "format": "int32" }, "tenantCode": { "type": "string" }, "status": { "type": "string", "enum": [ "New", "InProgress", "Completed", "CompletedWithErrors", "MaximumProcessingAttemptsReached", "Error", "NoDataFound", "Unknown" ] }, "pdfBytes": { "type": "string", "format": "byte" }, "prospectId": { "type": "string" }, "messages": { "items": { "type": "string" }, "type": "array" }, "proposalName": { "type": "string" }, "proposalError": { "type": "string" } }, "xml": { "name": "FactSheetResponse" }, "type": "object" }, "Element.Proposal.Dto.Prospects.ProspectDto": { "properties": { "prospectId": { "type": "string" }, "orionPlanningHouseholdId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "repId": { "type": "integer", "format": "int32" } }, "xml": { "name": "ProspectDto" }, "type": "object" }, "Element.Proposal.Dto.Proposal.Core.ProposalProspectDto": { "properties": { "weightedAssetClassAllocations": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalAssetClassDto" }, "xml": { "name": "ProposalAssetClassDto", "wrapped": true }, "type": "array" }, "prospectId": { "type": "string" }, "name": { "type": "string" }, "brokerDealerId": { "type": "integer", "format": "int32" }, "brokerDealerName": { "type": "string" }, "repId": { "type": "integer", "format": "int32" }, "targetRiskScore": { "type": "integer", "format": "int32" }, "calculatedRiskScore": { "type": "integer", "format": "int32" }, "investmentAmount": { "type": "number", "format": "double" }, "proposalId": { "type": "string" }, "targetInvestmentObjective": { "type": "string" }, "calculatedInvestmentObjective": { "type": "string" }, "proposedRetirementExpenseRatio": { "type": "number", "format": "double" }, "proposedRetirementObjective": { "type": "string" }, "isWeathAdvisory": { "type": "boolean" }, "additionalRepNames": { "type": "string" }, "rep": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalProspectRepDto" }, "fees": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Fees.FeesDto" }, "newHouseholdFees": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Fees.NewHouseholdFees" }, "newHouseholdPaperworkFees": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Fees.NewHouseholdPaperworkFees" }, "riskProfile": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.RiskProfileDto" }, "holdings": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalHoldingDto" }, "xml": { "name": "ProposalHoldingDto", "wrapped": true }, "type": "array" }, "stressTestGroups": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Integrations.OrionRiskIntelligence.StressTestsGroupedDto" }, "xml": { "name": "StressTestsGroupedDto", "wrapped": true }, "type": "array" }, "proposalRiskQuestionnaireAnswers": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalRiskQuestionnaireAnswerDto" }, "xml": { "name": "ProposalRiskQuestionnaireAnswerDto", "wrapped": true }, "type": "array" }, "householdMembers": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProspectHouseholdMemberDto" }, "xml": { "name": "ProspectHouseholdMemberDto", "wrapped": true }, "type": "array" }, "riskIntelligenceSectors": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalSectorDto" }, "xml": { "name": "ProposalSectorDto", "wrapped": true }, "type": "array" }, "riskIntelligenceGeographies": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalGeographyDto" }, "xml": { "name": "ProposalGeographyDto", "wrapped": true }, "type": "array" }, "investmentObjectives": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalInvestmentObjectiveDto" }, "xml": { "name": "ProposalInvestmentObjectiveDto", "wrapped": true }, "type": "array" }, "mandates": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalMandateDto" }, "xml": { "name": "ProposalMandateDto", "wrapped": true }, "type": "array" }, "prospectAssetClassAllocations": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalAssetClassDto" }, "xml": { "name": "ProposalAssetClassDto", "wrapped": true }, "type": "array" }, "prospectAssetCategoryAllocations": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalAssetCategoryDto" }, "xml": { "name": "ProposalAssetCategoryDto", "wrapped": true }, "type": "array" }, "prospectModelAggAllocations": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalModelAggDto" }, "xml": { "name": "ProposalModelAggDto", "wrapped": true }, "type": "array" }, "comparisonHousehold": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalComparisonHousehold" } }, "xml": { "name": "ProposalProspectDto" }, "type": "object" }, "Element.Proposal.Dto.Proposal.Core.ProposalProspectRepDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "advisorBiography": { "type": "string" } }, "xml": { "name": "ProposalProspectRepDto" }, "type": "object" }, "Element.Proposal.Dto.Proposal.Fees.FeesDto": { "properties": { "adminFee": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Fees.FeeDto" }, "strategistFee": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Fees.FeeDto" }, "advisoryFee": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Fees.FeeDto" }, "totalFee": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Fees.FeeDto" }, "totalFeeValue": { "type": "number", "format": "double" } }, "xml": { "name": "FeesDto" }, "type": "object" }, "Element.Proposal.Dto.Proposal.Fees.NewHouseholdFees": { "properties": { "householdTotalFee": { "type": "number", "format": "double" }, "billEntityFees": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Fees.BillEntityFeeInfo" }, "xml": { "name": "BillEntityFeeInfo", "wrapped": true }, "type": "array" }, "accountFees": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Fees.AccountFeeInfo" }, "xml": { "name": "AccountFeeInfo", "wrapped": true }, "type": "array" } }, "xml": { "name": "NewHouseholdFees" }, "type": "object" }, "Element.Proposal.Dto.Proposal.Fees.NewHouseholdPaperworkFees": { "properties": { "newHouseholdId": { "type": "integer", "format": "int32" }, "householdValue": { "type": "number", "format": "double" }, "billEntityId": { "type": "integer", "format": "int32" }, "billEntityName": { "type": "string" }, "billEntityDesc": { "type": "string" }, "foundInLevel": { "type": "string" }, "billScheduleId": { "type": "integer", "format": "int32" }, "billScheduleType": { "type": "string" }, "billScheduleName": { "type": "string" }, "billScheduleDescription": { "type": "string" }, "billEntityFee": { "type": "number", "format": "double" }, "calculatedFeePoints": { "type": "number", "format": "double" }, "calcMethod": { "type": "string" }, "feeDetails": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Fees.FeeDetail" }, "xml": { "name": "FeeDetail", "wrapped": true }, "type": "array" } }, "xml": { "name": "NewHouseholdPaperworkFees" }, "type": "object" }, "Element.Proposal.Dto.Proposal.Core.ProposalHoldingDto": { "properties": { "newAccountId": { "type": "integer", "format": "int32" }, "ticker": { "type": "string" }, "productName": { "type": "string" }, "assetCategoryId": { "type": "integer", "format": "int32" }, "assetCategory": { "type": "string" }, "assetCategoryColor": { "type": "string" }, "assetClassId": { "type": "integer", "format": "int32" }, "assetClass": { "type": "string" }, "assetClassColor": { "type": "string" }, "riskScore": { "type": "integer", "format": "int32" }, "expenseRatio": { "type": "number", "format": "double" }, "percent": { "type": "number", "format": "double" }, "modelAggAccountWeight": { "type": "number", "format": "double" }, "modelProductWeight": { "type": "number", "format": "double" }, "allocation": { "type": "number", "format": "double" }, "orionModelId": { "type": "integer", "format": "int32" }, "modelAggId": { "type": "integer", "format": "int32" }, "isSelfDirected": { "type": "boolean" }, "productId": { "type": "integer", "format": "int32" }, "investmentAmount": { "type": "number", "format": "double" }, "inceptionDate": { "type": "string", "format": "date-time" }, "tickerAndInceptionDate": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.TickerAndInceptionDate" }, "xml": { "name": "TickerAndInceptionDate", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProposalHoldingDto" }, "type": "object" }, "Element.Proposal.Dto.Integrations.OrionRiskIntelligence.StressTestsGroupedDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "parentid": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string" }, "image": { "type": "string" }, "stressTestScenarios": { "items": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.StressTest.StressTestScenarioDto" }, "xml": { "name": "StressTestScenarioDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "StressTestsGroupedDto" }, "type": "object" }, "Element.Proposal.Dto.Proposal.Core.ProposalRiskQuestionnaireAnswerDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "questionId": { "type": "integer", "format": "int32" }, "answerId": { "type": "integer", "format": "int32" }, "question": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalRiskQuestionnaireQuestionDto" }, "possibleAnswers": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalRiskQuestionnairePossibleAnswerDto" }, "xml": { "name": "ProposalRiskQuestionnairePossibleAnswerDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProposalRiskQuestionnaireAnswerDto" }, "type": "object" }, "Element.Proposal.Dto.Proposal.Core.ProspectHouseholdMemberDto": { "properties": { "fullName": { "type": "string" }, "age": { "type": "integer", "format": "int32" } }, "xml": { "name": "ProspectHouseholdMemberDto" }, "type": "object" }, "Element.Proposal.Dto.Proposal.Core.ProposalSectorDto": { "properties": { "name": { "type": "string" }, "allocation": { "type": "number", "format": "double" }, "investmentAmount": { "type": "number", "format": "double" } }, "xml": { "name": "ProposalSectorDto" }, "type": "object" }, "Element.Proposal.Dto.Proposal.Core.ProposalGeographyDto": { "properties": { "name": { "type": "string" }, "allocation": { "type": "number", "format": "double" }, "investmentAmount": { "type": "number", "format": "double" } }, "xml": { "name": "ProposalGeographyDto" }, "type": "object" }, "Element.Proposal.Dto.Proposal.Core.ProposalInvestmentObjectiveDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "sequenceNumber": { "type": "integer", "format": "int32" }, "riskRangeLow": { "type": "integer", "format": "int32" }, "riskRangeHigh": { "type": "integer", "format": "int32" }, "driftRangeLow": { "type": "integer", "format": "int32" }, "driftRangeHigh": { "type": "integer", "format": "int32" }, "riskScore": { "type": "integer", "format": "int32" }, "detail": { "type": "string" } }, "xml": { "name": "ProposalInvestmentObjectiveDto" }, "type": "object" }, "Element.Proposal.Dto.Proposal.Core.ProposalMandateDto": { "properties": { "name": { "type": "string" }, "allocation": { "type": "number", "format": "double" }, "investmentAmount": { "type": "number", "format": "double" } }, "xml": { "name": "ProposalMandateDto" }, "type": "object" }, "Element.Proposal.Dto.Proposal.Core.ProposalModelAggDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "sleeveStrategyId": { "type": "integer", "format": "int32" }, "sleeveStrategyAggId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "customIndexingKey": { "type": "string" }, "mandate": { "type": "string" }, "allocation": { "type": "number", "format": "double" }, "investmentAmount": { "type": "number", "format": "double" }, "riskScore": { "type": "integer", "format": "int32" }, "managementStyle": { "type": "string" }, "modelAggAssetClass": { "type": "string" }, "isOptimized": { "type": "boolean" }, "index": { "type": "integer", "format": "int32" }, "subAdvisor": { "type": "string" }, "subAdvisorId": { "type": "integer", "format": "int32" }, "objective": { "type": "string" }, "communityModelId": { "type": "integer", "format": "int64" }, "fees": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Fees.FeesDto" }, "benchmark": { "$ref": "#/definitions/Element.Proposal.Dto.FactSheet.FactSheetBenchmarkDto" }, "investmentObjectives": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalInvestmentObjectiveDto" }, "xml": { "name": "ProposalInvestmentObjectiveDto", "wrapped": true }, "type": "array" }, "assetClasses": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalAssetClassDto" }, "xml": { "name": "ProposalAssetClassDto", "wrapped": true }, "type": "array" }, "assetCategories": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalAssetCategoryDto" }, "xml": { "name": "ProposalAssetCategoryDto", "wrapped": true }, "type": "array" }, "returns": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.FactSheet.FactSheetReturnDto" }, "xml": { "name": "FactSheetReturnDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProposalModelAggDto" }, "type": "object" }, "Element.Proposal.Dto.Proposal.Core.ProposalComparisonHousehold": { "properties": { "name": { "type": "string" }, "accounts": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalManualAccount" }, "xml": { "name": "ProposalManualAccount", "wrapped": true }, "type": "array" }, "holdings": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalHoldingDto" }, "xml": { "name": "ProposalHoldingDto", "wrapped": true }, "type": "array" }, "riskProfile": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.RiskProfileDto" }, "assetCategoryAllocations": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalAssetCategoryDto" }, "xml": { "name": "ProposalAssetCategoryDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProposalComparisonHousehold" }, "type": "object" }, "Element.Proposal.Dto.Proposal.Fees.FeeDto": { "properties": { "name": { "type": "string" }, "value": { "type": "number", "format": "double" }, "investmentAmount": { "type": "number", "format": "double" }, "howBilled": { "type": "integer", "format": "int32" }, "points": { "type": "number", "format": "double" }, "dollarAmount": { "type": "number", "format": "double" } }, "xml": { "name": "FeeDto" }, "type": "object" }, "Element.Proposal.Dto.Proposal.Fees.BillEntityFeeInfo": { "properties": { "billEntityId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string" }, "totalFee": { "type": "number", "format": "double" } }, "xml": { "name": "BillEntityFeeInfo" }, "type": "object" }, "Element.Proposal.Dto.Proposal.Fees.AccountFeeInfo": { "properties": { "newAccountId": { "type": "integer", "format": "int32" }, "accountValue": { "type": "number", "format": "double" }, "accountPercentOfHousehold": { "type": "number", "format": "double" }, "accountBillEntityFees": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Fees.BillEntityFeeInfo" }, "xml": { "name": "BillEntityFeeInfo", "wrapped": true }, "type": "array" }, "accountModelAggFees": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Fees.ModelAggFeeInfo" }, "xml": { "name": "ModelAggFeeInfo", "wrapped": true }, "type": "array" }, "name": { "type": "string" }, "description": { "type": "string" }, "totalFee": { "type": "number", "format": "double" } }, "xml": { "name": "AccountFeeInfo" }, "type": "object" }, "Element.Proposal.Dto.Proposal.Fees.FeeDetail": { "properties": { "minAmount": { "type": "number", "format": "double" }, "maxAmount": { "type": "number", "format": "double" }, "rate": { "type": "number", "format": "double" }, "assignedFee": { "type": "number", "format": "double" }, "points": { "type": "number", "format": "double" } }, "xml": { "name": "FeeDetail" }, "type": "object" }, "Element.Proposal.Dto.Proposal.Core.TickerAndInceptionDate": { "properties": { "tickerName": { "type": "string" }, "inceptionDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "TickerAndInceptionDate" }, "type": "object" }, "OrionRiskIntelligence.Dto.StressTest.StressTestScenarioDto": { "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "totalImpact": { "type": "number", "format": "double" }, "outcome": { "type": "string" }, "parentid": { "type": "integer", "format": "int32" }, "index": { "type": "integer", "format": "int32" }, "positions": { "items": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.PositionDto" }, "xml": { "name": "PositionDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "StressTestScenarioDto" }, "type": "object" }, "Element.Proposal.Dto.Proposal.Core.ProposalRiskQuestionnaireQuestionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "mappedId": { "type": "integer", "format": "int32" }, "text": { "type": "string" }, "questionKey": { "type": "string" } }, "xml": { "name": "ProposalRiskQuestionnaireQuestionDto" }, "type": "object" }, "Element.Proposal.Dto.Proposal.Core.ProposalRiskQuestionnairePossibleAnswerDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "mappedId": { "type": "integer", "format": "int32" }, "text": { "type": "string" }, "value": { "type": "integer", "format": "int32" }, "isSelected": { "type": "boolean" } }, "xml": { "name": "ProposalRiskQuestionnairePossibleAnswerDto" }, "type": "object" }, "Element.Proposal.Dto.Proposal.Core.ProposalManualAccount": { "properties": { "manualAccountId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "accountValue": { "type": "number", "format": "double" }, "positions": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalManualAccountPosition" }, "xml": { "name": "ProposalManualAccountPosition", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProposalManualAccount" }, "type": "object" }, "Element.Proposal.Dto.Proposal.Fees.ModelAggFeeInfo": { "properties": { "modelAggId": { "type": "integer", "format": "int32" }, "percentOfAccount": { "type": "number", "format": "double" }, "percentOfHousehold": { "type": "number", "format": "double" }, "value": { "type": "number", "format": "double" }, "calcMethod": { "type": "string" }, "aggregateByHousehold": { "type": "boolean" }, "modelAggBillScheduleEntityFees": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Fees.BillEntityScheduleFeeInfo" }, "xml": { "name": "BillEntityScheduleFeeInfo", "wrapped": true }, "type": "array" }, "name": { "type": "string" }, "description": { "type": "string" }, "totalFee": { "type": "number", "format": "double" } }, "xml": { "name": "ModelAggFeeInfo" }, "type": "object" }, "Element.Proposal.Dto.Proposal.Core.ProposalManualAccountPosition": { "properties": { "manualAccountPositionId": { "type": "integer", "format": "int32" }, "manualAccountId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "ticker": { "type": "string" }, "quantity": { "type": "integer", "format": "int32" }, "marketValue": { "type": "number", "format": "double" }, "orionProductId": { "type": "integer", "format": "int32" }, "riskScore": { "type": "integer", "format": "int32" } }, "xml": { "name": "ProposalManualAccountPosition" }, "type": "object" }, "Element.Proposal.Dto.Proposal.Fees.BillEntityScheduleFeeInfo": { "properties": { "billScheduleId": { "type": "integer", "format": "int32" }, "billScheduleType": { "type": "string" }, "billScheduleName": { "type": "string" }, "foundInLevel": { "type": "string" }, "feeDetails": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Fees.FeeDetail" }, "xml": { "name": "FeeDetail", "wrapped": true }, "type": "array" }, "billEntityId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string" }, "totalFee": { "type": "number", "format": "double" } }, "xml": { "name": "BillEntityScheduleFeeInfo" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.TaxOptimizationDataDto": { "properties": { "advisor": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.Advisor" }, "client": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.Client" }, "meta": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.Meta" }, "styleSettings": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.StyleSettings" }, "accounts": { "items": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.Account" }, "xml": { "name": "Account", "wrapped": true }, "type": "array" }, "addSecurityHoldings": { "type": "boolean" }, "cashAmount": { "type": "number", "format": "double" }, "investorPreferences": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.InvestorPreferences" }, "optimizationStyle": { "type": "string" }, "optimizerData": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.OptimizerData" }, "detailedResultsData": { "items": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.DetailedResultsDatum" }, "xml": { "name": "DetailedResultsDatum", "wrapped": true }, "type": "array" } }, "xml": { "name": "TaxOptimizationDataDto" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.Advisor": { "properties": { "orionConnectToken": { "type": "string" }, "representativeId": { "type": "string" }, "connectId": { "type": "string" }, "firmId": { "type": "string" }, "name": { "type": "string" } }, "xml": { "name": "Advisor" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.Client": { "properties": { "entityId": { "type": "string" }, "entityIdentifier": { "type": "string" }, "entitySource": { "type": "string" }, "entityType": { "type": "string" }, "name": { "type": "string" }, "clientType": { "type": "string" } }, "xml": { "name": "Client" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.Meta": { "properties": { "compositeKey": { "type": "string" } }, "xml": { "name": "Meta" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.StyleSettings": { "properties": { "quantityType": { "type": "string" }, "depositCash": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.DepositCash" }, "fundPortfolio": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.FundPortfolio" }, "multiYear": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.MultiYear" }, "oneYear": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.OneYear" }, "withdrawCash": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.WithdrawCash" } }, "xml": { "name": "StyleSettings" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.Account": { "properties": { "accountId": { "type": "string" }, "accountName": { "type": "string" }, "accountTitle": { "type": "string" }, "lastSynchronized": { "type": "string", "format": "date-time" }, "type": { "type": "string" }, "name": { "type": "string" }, "prospectGuid": { "type": "string" }, "value": { "type": "number", "format": "double" }, "cashValue": { "type": "number", "format": "double" }, "holdings": { "items": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.Holding" }, "xml": { "name": "Holding", "wrapped": true }, "type": "array" }, "modifiedHoldingsForOptimization": { "items": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.Holding" }, "xml": { "name": "Holding", "wrapped": true }, "type": "array" }, "riskProfile": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.RiskProfileDto" }, "netGainsLosses": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.NetGainsAndLosses" } }, "xml": { "name": "Account" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.InvestorPreferences": { "properties": { "capitalGainsTaxRates": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.CapitalGainsTaxRates" }, "esg": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.Esg" }, "targetStrategy": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.TargetStrategy" }, "simpleTargetStrategy": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.SimpleTargetStrategy" }, "advanced": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.Advanced" }, "topThreeScenarios": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "securityRestrictions": { "items": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.SecurityRestriction" }, "xml": { "name": "SecurityRestriction", "wrapped": true }, "type": "array" }, "sectorIndustryConstraints": { "items": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.SectorIndustryConstraint" }, "xml": { "name": "SectorIndustryConstraint", "wrapped": true }, "type": "array" }, "preferenceDisplays": { "items": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.PreferenceDisplay" }, "xml": { "name": "PreferenceDisplay", "wrapped": true }, "type": "array" } }, "xml": { "name": "InvestorPreferences" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.OptimizerData": { "properties": { "optimizationStatus": { "type": "string" }, "processKey": { "type": "string" }, "scenarios": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.Scenarios" } }, "xml": { "name": "OptimizerData" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.DetailedResultsDatum": { "properties": { "scenarioName": { "type": "string" }, "scenarioLabel": { "type": "string" }, "portfolioCharacteristics": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.PortfolioCharacteristics" }, "sectors": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.Sectors" }, "taxAssessment": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.TaxAssessment" }, "riskProfile": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.RiskProfileDto" }, "holdings": { "items": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.DetailedHolding" }, "xml": { "name": "DetailedHolding", "wrapped": true }, "type": "array" }, "allBuys": { "items": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.DetailedHolding" }, "xml": { "name": "DetailedHolding", "wrapped": true }, "type": "array" }, "allSells": { "items": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.DetailedHolding" }, "xml": { "name": "DetailedHolding", "wrapped": true }, "type": "array" } }, "xml": { "name": "DetailedResultsDatum" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.DepositCash": { "properties": { "capitalGainsTarget": { "type": "number", "format": "double" } }, "xml": { "name": "DepositCash" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.FundPortfolio": { "properties": { "capitalGainsTarget": { "type": "number", "format": "double" } }, "xml": { "name": "FundPortfolio" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.MultiYear": { "properties": { "customCapitalGainsTargets": { "type": "boolean" }, "dateTargetSettings": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.DateTargetSettings" } }, "xml": { "name": "MultiYear" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.OneYear": { "properties": { "capitalGainsTarget": { "type": "number", "format": "double" } }, "xml": { "name": "OneYear" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.WithdrawCash": { "properties": { "capitalGainsTarget": { "type": "number", "format": "double" } }, "xml": { "name": "WithdrawCash" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.Holding": { "properties": { "purchaseDate": { "type": "string", "format": "date-time" }, "purchasePrice": { "type": "number", "format": "double" }, "shares": { "type": "number", "format": "double" }, "ticker": { "type": "string" }, "productId": { "type": "string" }, "productName": { "type": "string" }, "holdingWeight": { "type": "number", "format": "double" }, "allocationPercent": { "type": "number", "format": "double" }, "orionProductId": { "type": "integer", "format": "int32" } }, "xml": { "name": "Holding" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.NetGainsAndLosses": { "properties": { "shortTerm": { "type": "number", "format": "double" }, "longTerm": { "type": "number", "format": "double" }, "netUnrealizedGainsAndLosses": { "readOnly": true, "type": "number", "format": "double" } }, "xml": { "name": "NetGainsAndLosses" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.CapitalGainsTaxRates": { "properties": { "longTerm": { "type": "number", "format": "double" }, "shortTerm": { "type": "number", "format": "double" } }, "xml": { "name": "CapitalGainsTaxRates" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.Esg": { "properties": { "preset": { "type": "string" }, "categories": { "items": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.Category" }, "xml": { "name": "Category", "wrapped": true }, "type": "array" } }, "xml": { "name": "Esg" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.TargetStrategy": { "properties": { "benchmarkName": { "type": "string" }, "numberOfHoldings": { "type": "integer", "format": "int32" }, "holdings": { "items": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.Holding" }, "xml": { "name": "Holding", "wrapped": true }, "type": "array" }, "riskProfile": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.RiskProfileDto" } }, "xml": { "name": "TargetStrategy" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.SimpleTargetStrategy": { "properties": { "description": { "type": "string" }, "displayStrategyName": { "type": "string" }, "benchmarkDisplayName": { "type": "string" }, "firmId": { "type": "string" }, "strategyName": { "type": "string" } }, "xml": { "name": "SimpleTargetStrategy" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.Advanced": { "properties": { "maxNumberOfAssets": { "type": "integer", "format": "int32" }, "maxTrackingError": { "type": "number", "format": "double" }, "minTrackingError": { "type": "number", "format": "double" }, "capitalGainsTaxRates": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.CapitalGainsTaxRates" }, "capitalGainsBudget": { "type": "integer", "format": "int32" } }, "xml": { "name": "Advanced" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.SecurityRestriction": { "properties": { "ticker": { "type": "string" }, "minPercentWeight": { "type": "number", "format": "double" }, "maxPercentWeight": { "type": "number", "format": "double" }, "restrictionType": { "type": "string", "enum": [ "none", "sellAllShares", "doNotTrade", "doNotBuy", "doNotSell", "percent", "bringWeightTo" ] } }, "xml": { "name": "SecurityRestriction" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.SectorIndustryConstraint": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "minimumValue": { "type": "number", "format": "double" }, "maximumValue": { "type": "number", "format": "double" } }, "xml": { "name": "SectorIndustryConstraint" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.PreferenceDisplay": { "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "type": { "type": "string" } }, "xml": { "name": "PreferenceDisplay" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.Scenarios": { "properties": { "currentHoldings": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.CurrentHoldings" }, "sellAllHoldings": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.SellAllHoldings" }, "capitalGainsScenarios": { "items": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.CapitalGainsScenario" }, "xml": { "name": "CapitalGainsScenario", "wrapped": true }, "type": "array" } }, "xml": { "name": "Scenarios" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.PortfolioCharacteristics": { "properties": { "proposedCashValue": { "type": "number", "format": "double" }, "costBasis": { "type": "number", "format": "double" }, "numOfSecurities": { "type": "integer", "format": "int32" }, "dividendYield": { "type": "number", "format": "double" }, "proposedActiveWeight": { "type": "number", "format": "double" }, "projectedBeta": { "type": "number", "format": "double" }, "trackingDifference": { "type": "number", "format": "double" }, "netRealizedGainsLosses": { "type": "number", "format": "double" }, "initialActiveWeight": { "type": "number", "format": "double" }, "currentRisk": { "type": "number", "format": "double" }, "proposedRisk": { "type": "number", "format": "double" }, "targetRisk": { "type": "number", "format": "double" }, "proposedTrackingError": { "type": "number", "format": "double" }, "initialBeta": { "type": "number", "format": "double" }, "proposedNumOfSecurities": { "type": "integer", "format": "int32" }, "totalPortFolio": { "type": "number", "format": "double" }, "securitiesValue": { "type": "number", "format": "double" }, "initialCashValue": { "type": "number", "format": "double" }, "proposedCostBasis": { "type": "number", "format": "double" } }, "xml": { "name": "PortfolioCharacteristics" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.Sectors": { "properties": { "initialEnergy": { "type": "number", "format": "double" }, "targetEnergy": { "type": "number", "format": "double" }, "optimizedEnergy": { "type": "number", "format": "double" }, "initialFinancial": { "type": "number", "format": "double" }, "targetFinancial": { "type": "number", "format": "double" }, "optimizedFinancial": { "type": "number", "format": "double" }, "initialHealthCare": { "type": "number", "format": "double" }, "targetHealthCare": { "type": "number", "format": "double" }, "optimizedHealthCare": { "type": "number", "format": "double" }, "initialMaterials": { "type": "number", "format": "double" }, "targetMaterials": { "type": "number", "format": "double" }, "optimizedMaterials": { "type": "number", "format": "double" }, "initialIndustrial": { "type": "number", "format": "double" }, "targetIndustrial": { "type": "number", "format": "double" }, "optimizedIndustrial": { "type": "number", "format": "double" }, "initialIT": { "type": "number", "format": "double" }, "targetIT": { "type": "number", "format": "double" }, "optimizedIT": { "type": "number", "format": "double" }, "initialCommunication": { "type": "number", "format": "double" }, "targetCommunication": { "type": "number", "format": "double" }, "optimizedCommunication": { "type": "number", "format": "double" }, "initialUtilities": { "type": "number", "format": "double" }, "targetUtilities": { "type": "number", "format": "double" }, "optimizedUtilities": { "type": "number", "format": "double" }, "initialRealEstate": { "type": "number", "format": "double" }, "targetRealEstate": { "type": "number", "format": "double" }, "optimizedRealEstate": { "type": "number", "format": "double" }, "initialConsumerCyclical": { "type": "number", "format": "double" }, "targetConsumerCyclical": { "type": "number", "format": "double" }, "optimizedConsumerCyclical": { "type": "number", "format": "double" }, "initialConsumerDefensive": { "type": "number", "format": "double" }, "optimizedConsumerDefensive": { "type": "number", "format": "double" }, "targetConsumerDefensive": { "type": "number", "format": "double" } }, "xml": { "name": "Sectors" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.TaxAssessment": { "properties": { "unRealizedGainsShortTerm": { "type": "number", "format": "double" }, "unRealizedGainsLongTerm": { "type": "number", "format": "double" }, "proposedRealizedGainsShortTerm": { "type": "number", "format": "double" }, "proposedRealizedGainsLongTerm": { "type": "number", "format": "double" }, "unRealizedLossesShortTerm": { "type": "number", "format": "double" }, "unRealizedLossesLongTerm": { "type": "number", "format": "double" }, "netUnRealizedGainsAndLosses": { "readOnly": true, "type": "number", "format": "double" }, "proposedRealizedLossesShortTerm": { "type": "number", "format": "double" }, "proposedRealizedLossesLongTerm": { "type": "number", "format": "double" }, "numOfSecuritiesSold": { "type": "integer", "format": "int32" }, "numOfSecuritiesBought": { "type": "integer", "format": "int32" }, "proposedTurnOverBuys": { "type": "number", "format": "double" }, "proposedTurnOverSells": { "type": "number", "format": "double" }, "fullLiquidationTaxCost": { "type": "number", "format": "double" }, "transitionTaxCost": { "type": "number", "format": "double" }, "proposedTurnover": { "type": "number", "format": "double" }, "proposedUnRealizedGainsShortTerm": { "type": "number", "format": "double" }, "proposedUnRealizedGainsLongTerm": { "type": "number", "format": "double" }, "proposedUnRealizedLossesShortTerm": { "type": "number", "format": "double" }, "proposedUnRealizedLossesLongTerm": { "type": "number", "format": "double" }, "netUnrealizedGainLoss": { "type": "number", "format": "double" } }, "xml": { "name": "TaxAssessment" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.DetailedHolding": { "properties": { "projectName": { "type": "string" }, "ticker": { "type": "string" }, "securityId": { "type": "integer", "format": "int32" }, "securityName": { "type": "string" }, "marketValue": { "type": "number", "format": "double" }, "costBasis": { "type": "number", "format": "double" }, "acquiredDate": { "type": "string", "format": "date-time" }, "initialShares": { "type": "number", "format": "double" }, "finalShares": { "type": "number", "format": "double" }, "changeShare": { "type": "number", "format": "double" }, "initialPercentOfPortfolio": { "type": "number", "format": "double" }, "finalPercentOfPortfolio": { "type": "number", "format": "double" }, "transactionValue": { "type": "number", "format": "double" }, "tax": { "type": "number", "format": "double" }, "realizedGainLoss": { "type": "number", "format": "double" } }, "xml": { "name": "DetailedHolding" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.DateTargetSettings": { "properties": { "range": { "type": "string" }, "chosenNumberOfYears": { "type": "integer", "format": "int32" }, "totalCapitalGainsBudget": { "type": "number", "format": "double" }, "capitalGainsTargetSettings": { "items": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.CapitalGainsTargetSetting" }, "xml": { "name": "CapitalGainsTargetSetting", "wrapped": true }, "type": "array" } }, "xml": { "name": "DateTargetSettings" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.Category": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "Category" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.CurrentHoldings": { "properties": { "name": { "type": "string" }, "statistics": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.Statistics" } }, "xml": { "name": "CurrentHoldings" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.SellAllHoldings": { "properties": { "statistics": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.Statistics" } }, "xml": { "name": "SellAllHoldings" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.CapitalGainsScenario": { "properties": { "name": { "type": "string" }, "statistics": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.Statistics" }, "holdings": { "items": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.Holding" }, "xml": { "name": "Holding", "wrapped": true }, "type": "array" }, "transactions": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.Transactions" } }, "xml": { "name": "CapitalGainsScenario" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.CapitalGainsTargetSetting": { "properties": { "year": { "type": "integer", "format": "int32" }, "shortTermTaxRate": { "type": "number", "format": "double" }, "longTermTaxRate": { "type": "number", "format": "double" } }, "xml": { "name": "CapitalGainsTargetSetting" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.Statistics": { "properties": { "numberOfHoldings": { "type": "integer", "format": "int32" }, "trackingDifference": { "type": "number", "format": "double" }, "annualReturn": { "type": "number", "format": "double" }, "volatility": { "type": "number", "format": "double" }, "sharpeRatio": { "type": "number", "format": "double" }, "yield": { "type": "number", "format": "double" }, "performance": { "type": "number", "format": "double" }, "estimatedCapitalGains": { "type": "number", "format": "double" }, "estimatedTaxSavings": { "type": "number", "format": "double" }, "proposedTurnover": { "type": "number", "format": "double" }, "taxTransitionLiability": { "type": "number", "format": "double" } }, "xml": { "name": "Statistics" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.Transactions": { "properties": { "buys": { "items": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.Buy" }, "xml": { "name": "Buy", "wrapped": true }, "type": "array" }, "sells": { "items": { "$ref": "#/definitions/WebComponent.Dto.CustomIndexing.Sell" }, "xml": { "name": "Sell", "wrapped": true }, "type": "array" } }, "xml": { "name": "Transactions" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.Buy": { "properties": { "ticker": { "type": "string" }, "value": { "type": "number", "format": "double" } }, "xml": { "name": "Buy" }, "type": "object" }, "WebComponent.Dto.CustomIndexing.Sell": { "properties": { "ticker": { "type": "string" }, "value": { "type": "number", "format": "double" } }, "xml": { "name": "Sell" }, "type": "object" }, "Element.Proposal.Dto.Proposal.Core.ProposalAccountDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "nickname": { "type": "string" }, "primaryOwnerName": { "type": "string" }, "jointOwnerName": { "type": "string" }, "objective": { "type": "string" }, "registrationType": { "type": "string" }, "primaryRepName": { "type": "string" }, "hasSsaSelectedAllocation": { "type": "boolean" }, "advisoryFeeSplitReps": { "type": "string" }, "investmentAmount": { "type": "number", "format": "double" }, "riskScore": { "type": "integer", "format": "int32" }, "targetRiskScore": { "type": "integer", "format": "int32" }, "targetRiskObjective": { "type": "string" }, "isWeathAdvisory": { "type": "boolean" }, "custodian": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalCustodianDto" }, "fees": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Fees.FeesDto" }, "newHouseholdFees": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Fees.NewHouseholdFees" }, "newHouseholdPaperworkFees": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Fees.NewHouseholdPaperworkFees" }, "comparisonAccount": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalAccountDto" }, "riskProfile": { "$ref": "#/definitions/OrionRiskIntelligence.Dto.RiskProfile.RiskProfileDto" }, "ssaSelection": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalSsaModelSelectionDto" }, "primaryRep": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalAccountPrimaryRepDto" }, "riskQuestionnaire": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalRiskQuestionnaireDto" }, "modelAggs": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalModelAggDto" }, "xml": { "name": "ProposalModelAggDto", "wrapped": true }, "type": "array" }, "mandates": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalMandateDto" }, "xml": { "name": "ProposalMandateDto", "wrapped": true }, "type": "array" }, "assetClasses": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalAssetClassDto" }, "xml": { "name": "ProposalAssetClassDto", "wrapped": true }, "type": "array" }, "assetCategories": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalAssetCategoryDto" }, "xml": { "name": "ProposalAssetCategoryDto", "wrapped": true }, "type": "array" }, "holdings": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalHoldingDto" }, "xml": { "name": "ProposalHoldingDto", "wrapped": true }, "type": "array" }, "stressTestGroups": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Integrations.OrionRiskIntelligence.StressTestsGroupedDto" }, "xml": { "name": "StressTestsGroupedDto", "wrapped": true }, "type": "array" }, "riskIntelligenceSectors": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalSectorDto" }, "xml": { "name": "ProposalSectorDto", "wrapped": true }, "type": "array" }, "riskIntelligenceGeographies": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalGeographyDto" }, "xml": { "name": "ProposalGeographyDto", "wrapped": true }, "type": "array" }, "investmentObjectives": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalInvestmentObjectiveDto" }, "xml": { "name": "ProposalInvestmentObjectiveDto", "wrapped": true }, "type": "array" }, "weightedAssetClassAllocations": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalAssetClassDto" }, "xml": { "name": "ProposalAssetClassDto", "wrapped": true }, "type": "array" }, "accountAssetClassHoldings": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Product.AssetClassHoldingDto" }, "xml": { "name": "AssetClassHoldingDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProposalAccountDto" }, "type": "object" }, "Element.Proposal.Dto.Proposal.Core.ProposalCustodianDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string" } }, "xml": { "name": "ProposalCustodianDto" }, "type": "object" }, "Element.Proposal.Dto.Proposal.Core.ProposalSsaModelSelectionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "mandate": { "type": "string" }, "assetClass": { "type": "string" }, "allocation": { "type": "number", "format": "double" }, "investmentAmount": { "type": "number", "format": "double" }, "riskScore": { "type": "integer", "format": "int32" } }, "xml": { "name": "ProposalSsaModelSelectionDto" }, "type": "object" }, "Element.Proposal.Dto.Proposal.Core.ProposalAccountPrimaryRepDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" } }, "xml": { "name": "ProposalAccountPrimaryRepDto" }, "type": "object" }, "Element.Proposal.Dto.Proposal.Core.ProposalRiskQuestionnaireDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "answers": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Proposal.Core.ProposalRiskQuestionnaireAnswerDto" }, "xml": { "name": "ProposalRiskQuestionnaireAnswerDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProposalRiskQuestionnaireDto" }, "type": "object" }, "Element.Proposal.Dto.Product.AssetClassHoldingDto": { "properties": { "assetClassName": { "type": "string" }, "assetClassAllocation": { "type": "number", "format": "double" }, "modelAggHoldings": { "items": { "$ref": "#/definitions/Element.Proposal.Dto.Product.ModelAggHoldingDto" }, "xml": { "name": "ModelAggHoldingDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "AssetClassHoldingDto" }, "type": "object" }, "Element.Proposal.Dto.Product.ModelAggHoldingDto": { "properties": { "modelAggName": { "type": "string" }, "modelAggAllocation": { "type": "number", "format": "double" }, "investmentAmount": { "type": "number", "format": "double" }, "estimatedIncome": { "type": "number", "format": "double" } }, "xml": { "name": "ModelAggHoldingDto" }, "type": "object" }, "Element.Proposal.Dto.Requests.ProposalRequest": { "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "fragmentGuids": { "items": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "type": "array" }, "prospectId": { "type": "string" } }, "xml": { "name": "ProposalRequest" }, "type": "object" }, "OAS.DataModel.SimpleGuidKeyEntity": { "properties": { "id": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "xml": { "name": "SimpleGuidKeyEntity" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.FragmentVerboseDto": { "properties": { "id": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "name": { "type": "string" }, "type": { "readOnly": true, "type": "string" }, "portfolio": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.FragmentPortfolioDto" }, "schema": { "$ref": "#/definitions/OAS.DataModel.Reporting.ControlBase" }, "requiredOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportOption" }, "xml": { "name": "ReportOption", "wrapped": true }, "type": "array" }, "additionalOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportOptionCategory" }, "xml": { "name": "ReportOptionCategory", "wrapped": true }, "type": "array" }, "referencedOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.FragmentVerboseReferencedOptionDto" }, "xml": { "name": "FragmentVerboseReferencedOptionDto", "wrapped": true }, "type": "array" }, "loginAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportLoginAccessRuleDto" }, "xml": { "name": "ReportLoginAccessRuleDto", "wrapped": true }, "type": "array" }, "databaseGroupAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportDatabaseGroupAccessRuleDto" }, "xml": { "name": "ReportDatabaseGroupAccessRuleDto", "wrapped": true }, "type": "array" }, "databaseAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportDatabaseAccessRuleDto" }, "xml": { "name": "ReportDatabaseAccessRuleDto", "wrapped": true }, "type": "array" }, "roleAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportRoleAccessRuleDto" }, "xml": { "name": "ReportRoleAccessRuleDto", "wrapped": true }, "type": "array" }, "userAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportUserAccessRuleDto" }, "xml": { "name": "ReportUserAccessRuleDto", "wrapped": true }, "type": "array" }, "representativeAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportRepresentativeAccessRuleDto" }, "xml": { "name": "ReportRepresentativeAccessRuleDto", "wrapped": true }, "type": "array" }, "representativesClientsAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportRepresentativesClientsAccessRuleDto" }, "xml": { "name": "ReportRepresentativesClientsAccessRuleDto", "wrapped": true }, "type": "array" }, "clientAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportClientAccessRuleDto" }, "xml": { "name": "ReportClientAccessRuleDto", "wrapped": true }, "type": "array" }, "brokerDealerAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportBrokerDealerAccessRuleDto" }, "xml": { "name": "ReportBrokerDealerAccessRuleDto", "wrapped": true }, "type": "array" }, "brokerDealersRepresentativesAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportBrokerDealersRepresentativesAccessRuleDto" }, "xml": { "name": "ReportBrokerDealersRepresentativesAccessRuleDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "FragmentVerboseDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.FragmentPortfolioDto": { "properties": { "category": { "type": "string" }, "parentCategory": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "auditedBy": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "isDynamic": { "type": "boolean" } }, "xml": { "name": "FragmentPortfolioDto" }, "type": "object" }, "OAS.DataModel.Reporting.ControlBase": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "id": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "width": { "type": "string" } }, "xml": { "name": "ControlBase" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.FragmentVerboseReferencedOptionDto": { "properties": { "optionGuid": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "option": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportOption" } }, "xml": { "name": "FragmentVerboseReferencedOptionDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ReportRepresentativesClientsAccessRuleDto": { "properties": { "representativeId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "canRun": { "type": "boolean" } }, "xml": { "name": "ReportRepresentativesClientsAccessRuleDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ReportClientAccessRuleDto": { "properties": { "clientId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "canRun": { "type": "boolean" } }, "xml": { "name": "ReportClientAccessRuleDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ReportBrokerDealerAccessRuleDto": { "properties": { "brokerDealerId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "canRun": { "type": "boolean" } }, "xml": { "name": "ReportBrokerDealerAccessRuleDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ReportBrokerDealersRepresentativesAccessRuleDto": { "properties": { "brokerDealerId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "canRun": { "type": "boolean" } }, "xml": { "name": "ReportBrokerDealersRepresentativesAccessRuleDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Element.ProposalParametersDto": { "properties": { "newHouseholdId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "advizrHouseholdId": { "type": "integer", "format": "int32" }, "rationaleText": { "type": "string" }, "proposalFragments": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleGuidKeyEntity" }, "xml": { "name": "SimpleGuidKeyEntity", "wrapped": true }, "type": "array" }, "isOatTenant": { "type": "boolean" }, "isCommunitiesAvailable": { "type": "boolean" } }, "xml": { "name": "ProposalParametersDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ReportSettingsDto": { "required": [ "id", "name", "settings" ], "properties": { "id": { "type": "integer", "format": "int32" }, "guid": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "isSystemDefault": { "type": "boolean" }, "name": { "type": "string", "maxLength": 200, "minLength": 0 }, "optionType": { "type": "string" }, "isDefault": { "type": "boolean" }, "isDisabled": { "type": "boolean" }, "settings": { "type": "string" }, "isGlobal": { "type": "boolean" } }, "xml": { "name": "ReportSettingsDto" }, "type": "object" }, "System.ValueTupleOfSystem.StringAndSystem.Int32AndSystem.Guid": { "properties": { "item1": { "type": "string" }, "item2": { "type": "integer", "format": "int32" }, "item3": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "ValueTuple`3" }, "type": "object" }, "System.ValueTupleOfSystem.GuidAndSystem.Int32": { "properties": { "item1": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "item2": { "type": "integer", "format": "int32" } }, "xml": { "name": "ValueTuple`2" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ReportThemeDto": { "required": [ "id", "name", "description", "css" ], "properties": { "id": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 200, "minLength": 0 }, "description": { "type": "string" }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "auditedBy": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "isDefault": { "type": "boolean" }, "css": { "type": "string" } }, "xml": { "name": "ReportThemeDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ReportThemeSelectionDto": { "properties": { "id": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "name": { "type": "string" }, "isDefault": { "type": "boolean" } }, "xml": { "name": "ReportThemeSelectionDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ReportThemeVerboseDto": { "properties": { "id": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 200, "minLength": 0 }, "description": { "type": "string" }, "category": { "type": "string" }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "css": { "type": "string" }, "import": { "type": "string" }, "options": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportThemeOption" }, "loginAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportLoginAccessRuleDto" }, "xml": { "name": "ReportLoginAccessRuleDto", "wrapped": true }, "type": "array" }, "databaseGroupAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportDatabaseGroupAccessRuleDto" }, "xml": { "name": "ReportDatabaseGroupAccessRuleDto", "wrapped": true }, "type": "array" }, "databaseAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportDatabaseAccessRuleDto" }, "xml": { "name": "ReportDatabaseAccessRuleDto", "wrapped": true }, "type": "array" }, "roleAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportRoleAccessRuleDto" }, "xml": { "name": "ReportRoleAccessRuleDto", "wrapped": true }, "type": "array" }, "userAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportUserAccessRuleDto" }, "xml": { "name": "ReportUserAccessRuleDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ReportThemeVerboseDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ReportThemeOption": { "properties": { "tableGroupLevels": { "type": "integer", "format": "int32" } }, "xml": { "name": "ReportThemeOption" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ReportProtoRunForDto": { "properties": { "entity": { "type": "string", "enum": [ "Database", "BrokerDealer", "Representative", "Client", "Registration", "Account", "Asset", "Product", "AggregateModel", "DynamicGrouping", "PortfolioGroup", "UserDetail", "Prospect", "CustomGrouping" ] }, "entityIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "prospectId": { "type": "string" }, "asOfDate": { "type": "string" }, "accountInclusion": { "type": "string", "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, "groupCustodialCashTogether": { "type": "boolean" }, "useSmaSettings": { "type": "boolean" }, "unmanagedInclusionOverride": { "type": "string", "enum": [ "Unmanaged", "Performance", "ActivitySummary", "Allocation", "PortfolioDetail", "TaxDetail" ] }, "includeHistoricalLinks": { "type": "string", "enum": [ "None", "CostBasis", "Performance" ] }, "accountManagementOverride": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculate.ManagementOverride" }, "xml": { "name": "ManagementOverride", "wrapped": true }, "type": "array" }, "exclusions": { "properties": { "account": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "fundFamily": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, "type": "object" } }, "xml": { "name": "ReportProtoRunForDto" }, "type": "object" }, "OAS.DataModel.Reporting.DataEngine.EnvisionReportModel": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "sessionId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "generationTime": { "type": "string", "format": "date-time" }, "title": { "type": "string" }, "author": { "type": "string" }, "subject": { "type": "string" }, "keywords": { "type": "string" }, "includeBlankPageAfterCover": { "type": "boolean" }, "tableOfContents": { "type": "string", "enum": [ "None", "Normal" ] }, "coverPage": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "firstHeader": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "header": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "footer": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "body": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "overlay": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IGetRendered" }, "hud": { "type": "string", "enum": [ "None", "Basic", "Debug" ] }, "urlBuilder": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportUrlBuilderCore", "readOnly": true }, "pdfDownloadUrlBuilder": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportUrlBuilder" }, "customColorCssUrlBuilder": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportUrlBuilder" }, "renderCssUrlBuilder": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportUrlBuilder" }, "standardCssUrlBuilder": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportUrlBuilder" }, "themeUrlBuilder": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportUrlBuilder" }, "expirationDate": { "type": "string", "format": "date-time" }, "orientation": { "type": "string", "enum": [ "Portrait", "Landscape" ] }, "paperSize": { "type": "string", "enum": [ "Letter", "Legal", "A4" ] }, "margins": { "$ref": "#/definitions/OAS.DataModel.Reporting.DataEngine.PaperMargins" } }, "xml": { "name": "EnvisionReportModel" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ReportDto": { "properties": { "type": { "type": "string" }, "id": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "versionOfReportId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "auditedBy": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "category": { "type": "string" }, "isFavorite": { "type": "boolean" }, "isDeleted": { "type": "boolean" }, "hasThumbnail": { "type": "boolean" }, "deletedDate": { "type": "string", "format": "date-time" }, "deletedBy": { "type": "string" } }, "xml": { "name": "ReportDto" }, "type": "object" }, "OAS.DataModel.SimpleEntityOfSystem.Guid": { "properties": { "id": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "xml": { "name": "SimpleEntity`1" }, "type": "object" }, "OAS.DataModel.Reporting.Envision.Dtos.ReportHistoryDto": { "required": [ "historyId", "reportGuid" ], "properties": { "historyId": { "type": "integer", "format": "int32" }, "changedBy": { "type": "string" }, "changedOn": { "type": "string", "format": "date-time" }, "reportGuid": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "ReportHistoryDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ReportVerboseDto": { "properties": { "id": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "name": { "type": "string" }, "portfolio": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportPortfolioDto" }, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportSchemaDto" }, "requiredOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportOption" }, "xml": { "name": "ReportOption", "wrapped": true }, "type": "array" }, "additionalOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportOptionCategory" }, "xml": { "name": "ReportOptionCategory", "wrapped": true }, "type": "array" }, "versions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportVersionDto" }, "xml": { "name": "ReportVersionDto", "wrapped": true }, "type": "array" }, "loginAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportLoginAccessRuleDto" }, "xml": { "name": "ReportLoginAccessRuleDto", "wrapped": true }, "type": "array" }, "databaseGroupAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportDatabaseGroupAccessRuleDto" }, "xml": { "name": "ReportDatabaseGroupAccessRuleDto", "wrapped": true }, "type": "array" }, "databaseAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportDatabaseAccessRuleDto" }, "xml": { "name": "ReportDatabaseAccessRuleDto", "wrapped": true }, "type": "array" }, "roleAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportRoleAccessRuleDto" }, "xml": { "name": "ReportRoleAccessRuleDto", "wrapped": true }, "type": "array" }, "userAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportUserAccessRuleDto" }, "xml": { "name": "ReportUserAccessRuleDto", "wrapped": true }, "type": "array" }, "representativeAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportRepresentativeAccessRuleDto" }, "xml": { "name": "ReportRepresentativeAccessRuleDto", "wrapped": true }, "type": "array" }, "representativesClientsAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportRepresentativesClientsAccessRuleDto" }, "xml": { "name": "ReportRepresentativesClientsAccessRuleDto", "wrapped": true }, "type": "array" }, "clientAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportClientAccessRuleDto" }, "xml": { "name": "ReportClientAccessRuleDto", "wrapped": true }, "type": "array" }, "brokerDealerAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportBrokerDealerAccessRuleDto" }, "xml": { "name": "ReportBrokerDealerAccessRuleDto", "wrapped": true }, "type": "array" }, "brokerDealersRepresentativesAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportBrokerDealersRepresentativesAccessRuleDto" }, "xml": { "name": "ReportBrokerDealersRepresentativesAccessRuleDto", "wrapped": true }, "type": "array" }, "brokerDealerVersionAssignments": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportBrokerDealerVersionAssignmentDto" }, "xml": { "name": "ReportBrokerDealerVersionAssignmentDto", "wrapped": true }, "type": "array" }, "portfolioGroupVersionAssignments": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportPortfolioGroupVersionAssignmentDto" }, "xml": { "name": "ReportPortfolioGroupVersionAssignmentDto", "wrapped": true }, "type": "array" }, "representativeVersionAssignments": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportRepresentativeVersionAssignmentDto" }, "xml": { "name": "ReportRepresentativeVersionAssignmentDto", "wrapped": true }, "type": "array" }, "clientVersionAssignments": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportClientVersionAssignmentDto" }, "xml": { "name": "ReportClientVersionAssignmentDto", "wrapped": true }, "type": "array" }, "referencedOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.FragmentVerboseReferencedOptionDto" }, "xml": { "name": "FragmentVerboseReferencedOptionDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ReportVerboseDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ReportPortfolioDto": { "properties": { "parentCategory": { "type": "string" }, "category": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "versionOfReportId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "versionOfReportName": { "type": "string" }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "auditedBy": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "isDeleted": { "type": "boolean" }, "hasThumbnail": { "type": "boolean" } }, "xml": { "name": "ReportPortfolioDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ReportSchemaDto": { "properties": { "contextChange": { "$ref": "#/definitions/OAS.DataModel.Reporting.Engine.ContextChange" }, "firstHeader": { "$ref": "#/definitions/OAS.DataModel.Reporting.ControlBase" }, "header": { "$ref": "#/definitions/OAS.DataModel.Reporting.ControlBase" }, "body": { "$ref": "#/definitions/OAS.DataModel.Reporting.ControlBase" }, "footer": { "$ref": "#/definitions/OAS.DataModel.Reporting.ControlBase" }, "overlay": { "$ref": "#/definitions/OAS.DataModel.Reporting.ControlBase" } }, "xml": { "name": "ReportSchemaDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ReportVersionDto": { "properties": { "id": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "name": { "type": "string" }, "isDeleted": { "type": "boolean" } }, "xml": { "name": "ReportVersionDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ReportBrokerDealerVersionAssignmentDto": { "properties": { "brokerDealerId": { "type": "integer", "format": "int32" }, "reportId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "name": { "type": "string" }, "reportVersionId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "ReportBrokerDealerVersionAssignmentDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ReportPortfolioGroupVersionAssignmentDto": { "properties": { "portfolioGroupId": { "type": "integer", "format": "int32" }, "reportId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "name": { "type": "string" }, "reportVersionId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "ReportPortfolioGroupVersionAssignmentDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ReportRepresentativeVersionAssignmentDto": { "properties": { "representativeId": { "type": "integer", "format": "int32" }, "reportId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "name": { "type": "string" }, "reportVersionId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "ReportRepresentativeVersionAssignmentDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ReportClientVersionAssignmentDto": { "properties": { "clientId": { "type": "integer", "format": "int32" }, "reportId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "name": { "type": "string" }, "reportVersionId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "ReportClientVersionAssignmentDto" }, "type": "object" }, "OAS.DataProcess.Reporting.ReportTemplates.ReportThumbnailFileDto": { "properties": { "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" } }, "xml": { "name": "ReportThumbnailFileDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ReportImageDto": { "properties": { "id": { "type": "string" }, "imageUrl": { "type": "string" }, "name": { "type": "string" }, "widthPixels": { "type": "integer", "format": "int32" }, "heightPixels": { "type": "integer", "format": "int32" }, "alt": { "type": "string" } }, "xml": { "name": "ReportImageDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ReportImageFileDto": { "properties": { "id": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" }, "name": { "type": "string" } }, "xml": { "name": "ReportImageFileDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ExcelReportFullDto": { "properties": { "id": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "requiredOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportOption" }, "xml": { "name": "ReportOption", "wrapped": true }, "type": "array" }, "featureFlagOverrides": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IReportFeatureFlagOverrider" }, "deliveryOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportOption" }, "xml": { "name": "ReportOption", "wrapped": true }, "type": "array" }, "queryType": { "readOnly": true, "type": "string", "enum": [ "None", "Custom", "Excel", "All" ] }, "databaseIdList": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "references": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Envision.ReportSettingsReference" }, "xml": { "name": "ReportSettingsReference", "wrapped": true }, "type": "array" }, "category": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "xml": { "name": "ExcelReportFullDto" }, "type": "object" }, "OAS.DataModel.Reporting.Envision.ReportSettingsReference": { "properties": { "optionGuid": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "reportId": { "type": "integer", "format": "int32" }, "reportOption": { "$ref": "#/definitions/OAS.DataModel.Reporting.Envision.ReportSettings" } }, "xml": { "name": "ReportSettingsReference" }, "type": "object" }, "OAS.DataModel.Reporting.Envision.ReportSettings": { "properties": { "id": { "type": "integer", "format": "int32" }, "guid": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "type": { "type": "string", "enum": [ "Activity", "Billing", "Calculation", "Comparison", "CostBasis", "DateRanges", "Formats", "Income", "MaturityPeriod", "Performance", "Category", "Statistical", "Trading", "Transaction", "CoverPage", "PaperLayout", "Themes" ] }, "name": { "type": "string" }, "editable": { "type": "boolean" }, "data": { "type": "string", "format": "byte" }, "isSystemDefault": { "type": "boolean" }, "settingsOfSettings": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Envision.ReportSettingsOfSettings" }, "xml": { "name": "ReportSettingsOfSettings", "wrapped": true }, "type": "array" }, "settingsAlClient": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Envision.ReportSettingsAlClient" }, "xml": { "name": "ReportSettingsAlClient", "wrapped": true }, "type": "array" } }, "xml": { "name": "ReportSettings" }, "type": "object" }, "OAS.DataModel.Reporting.Envision.ReportSettingsOfSettings": { "properties": { "parentReportSettingId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "childReportSettingId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" } }, "xml": { "name": "ReportSettingsOfSettings" }, "type": "object" }, "OAS.DataModel.Reporting.Envision.ReportSettingsAlClient": { "properties": { "reportSettingsId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "alClientId": { "type": "integer", "format": "int32" } }, "xml": { "name": "ReportSettingsAlClient" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.FragmentDto": { "properties": { "id": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "category": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "auditedBy": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "isDynamic": { "type": "boolean" } }, "xml": { "name": "FragmentDto" }, "type": "object" }, "OAS.DataModel.SimpleEntityWithDescriptionOfSystem.Guid": { "properties": { "description": { "type": "string" }, "id": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "xml": { "name": "SimpleEntityWithDescription`1" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ExcelReportScheduleDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "excelReportId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "parameters": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ExcelReportPromptArrayWithErrorDataDto" }, "frequencyInfo": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ExcelReportScheduleFrequencyDto" }, "notes": { "type": "string" }, "isActive": { "type": "boolean" }, "createdByIsActive": { "type": "boolean" }, "lastRunDate": { "type": "string", "format": "date-time" }, "uploadTargetId": { "type": "integer", "format": "int32" }, "auditedBy": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "ExcelReportScheduleDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ExcelReportPromptArrayWithErrorDataDto": { "properties": { "prompts": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportOption" }, "xml": { "name": "ReportOption", "wrapped": true }, "type": "array" }, "isValid": { "type": "boolean" }, "errorMessage": { "type": "string" }, "databaseIdList": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "fileFormat": { "type": "string", "enum": [ "Csv", "Xls", "Xlsx", "Psv" ] }, "fileName": { "type": "string" }, "displayName": { "type": "string" }, "dynamicDateFormat": { "type": "string" } }, "xml": { "name": "ExcelReportPromptArrayWithErrorDataDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ExcelReportScheduleFrequencyDto": { "properties": { "interval": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.Frequency.ExcelReportScheduleFrequencyIntervalDto" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "timeOfDay": { "type": "string", "format": "date-time" }, "isValid": { "type": "boolean" }, "errorMessage": { "type": "string" } }, "xml": { "name": "ExcelReportScheduleFrequencyDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.Frequency.ExcelReportScheduleFrequencyIntervalDto": { "properties": {}, "xml": { "name": "ExcelReportScheduleFrequencyIntervalDto" }, "type": "object" }, "OAS.DataModel.Reporting.Engine.ContextTagResult": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "keyWords": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "label": { "type": "string" }, "category": { "type": "string", "enum": [ "Uncategorized", "Account", "Activity", "Allocation", "Alternatives", "Benchmark", "Beneficiary", "Billing", "CostBasis", "DateTime", "FirmDetails", "FixedIncomeBonds", "Household", "Other", "Performance", "ProductAssetDetail", "Prospect", "Registration", "ReportInformation", "RMD", "TargetAllocation", "TBD", "Astro", "Trading", "Transaction", "CustomIndexing", "OrionPlanning", "PortfolioPreferences", "PortfolioGroup" ] }, "description": { "type": "string" }, "deprecated": { "type": "boolean" }, "path": { "type": "string" }, "format": { "type": "string" }, "options": { "items": { "type": "string", "enum": [ "ReportCategory", "DateRange", "Performance", "Comparison", "Activity", "Income", "Trading", "Size", "Statistical", "Billing", "CostBasis", "Calculation", "Prompt", "Sma", "MaturityPeriod", "LimitMethod", "WeightedBenchmarkGrouping", "TaxInceptionType", "CostPerShareMethod", "MaskString" ] }, "xml": { "name": "PlaceholderOptionType", "wrapped": true }, "type": "array" }, "types": { "items": { "type": "string", "enum": [ "Value", "Set" ] }, "xml": { "name": "PlaceholderDataType", "wrapped": true }, "type": "array" }, "filter": { "$ref": "#/definitions/OAS.DataModel.Reporting.Engine.ContextFilter" }, "excludeLocations": { "items": { "type": "string", "enum": [ "Report", "Cover", "PieChart", "LineChart", "BarChart", "ScatterChart", "ExcelReport", "GaugeChart" ] }, "xml": { "name": "PlaceholderLocation", "wrapped": true }, "type": "array" }, "allowedLocations": { "items": { "type": "string", "enum": [ "Report", "Cover", "PieChart", "LineChart", "BarChart", "ScatterChart", "ExcelReport", "GaugeChart" ] }, "xml": { "name": "PlaceholderLocation", "wrapped": true }, "type": "array" }, "namedSeries": { "items": { "type": "string", "enum": [ "Model", "Target", "Actual" ] }, "xml": { "name": "PlaceholderNamedSeries", "wrapped": true }, "type": "array" }, "containsPii": { "type": "boolean" }, "allowedEntityType": { "items": { "type": "string", "enum": [ "AssetBased", "Prospect", "SecurityClassification" ] }, "xml": { "name": "PlaceholderEntityType", "wrapped": true }, "type": "array" }, "$index": { "type": "string" } }, "xml": { "name": "ContextTagResult" }, "type": "object" }, "OAS.DataModel.Reporting.Engine.ContextFilter": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "change": { "$ref": "#/definitions/OAS.DataModel.Reporting.Engine.ContextChange" }, "filters": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Engine.ContextCalculationFilter" }, "xml": { "name": "ContextCalculationFilter", "wrapped": true }, "type": "array" }, "method": { "type": "string", "enum": [ "All", "Any" ] }, "oldFilterValue": { "type": "string", "enum": [ "None", "HasValue", "HasUnits" ] } }, "xml": { "name": "ContextFilter" }, "type": "object" }, "OAS.DataModel.Reporting.Engine.ContextCalculationFilter": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "context": { "type": "string", "enum": [ "Self", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "FundFamily", "Platform", "Custodian", "AggregateModel", "DynamicGrouping", "AssetClass", "AssetLevelStrategy", "AssetCategory", "RiskCategory", "AccountType", "RegistrationTaxType", "ProductType", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "ProductVintageYear", "ProductSubType", "AssetCategoryParent", "PortfolioGroup", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "MaturityPeriod", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "MorningstarGeography", "BillEntityType", "ProductSubHolding", "Country", "Currency", "CustomGrouping", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "Prospect", "Transaction", "Comparison", "CostBasisLot", "ModelInclusion", "ContextChanges", "ActivityOptions", "DateRanges", "Time", "Bill", "Beneficiary", "Trustee", "Systematic", "BillTier", "BillAdjustment", "FeeSchedules", "BillCashflow", "ModelVsActual", "BillAssetLevel", "HouseholdMember", "CustomIndexing", "ProspectAccount", "CustomIndexingScenario", "ProspectAssetClass", "ProspectAssetCategory", "CustomIndexingPreference", "ProspectMandate", "ProspectComparisonAssetClass", "ProspectComparisonAssetCategory", "ProspectComparisonHolding", "ProspectHolding", "ProspectModelAgg", "ProspectAccountStressTestsGrouped", "ProspectAccountStressTestScenario", "ProspectComparisonStressTestsGrouped", "ProspectComparisonStressTestScenario", "ProspectStressTestsGrouped", "ProspectStressTestScenario", "ProspectAccountCorrelation", "ProspectComparisonAccountCorrelation", "ProspectCorrelation", "ProspectOrionPlanningCurrentGoal", "ProspectOrionPlanningProposedGoal", "ProspectOrionPlanningCurrentGoalResults", "ProspectOrionPlanningProposedGoalResults", "ProspectOrionPlanningCurrentGoalStepsResults", "ProspectOrionPlanningProposedGoalStepsResults", "ProspectHoldingSectorResults", "ProspectHoldingGeographyResults", "ProspectAccountHoldingSectorResults", "ProspectAccountHoldingGeographyResults", "ProspectComparisonAccountHoldingSectorResults", "ProspectComparisonAccountHoldingGeographyResults", "ProspectOrionPlanningNetWorth", "ProspectSelfDirectedResults", "ProspectSelfDirectedAssetClass", "ProspectSelfDirectedAssetCategory", "ProspectHouseholdMembers", "ProspectStrategist", "ProspectWeightedAssetClass", "ProspectAccountWeightedAssetClass", "BillingRelatedAccounts", "ProspectAccountBlendedFactSheet", "CustomIndexingBuys", "CustomIndexingSells", "ProspectBlendedAssetClasses", "ProspectBlendedAssetCategories", "ProspectOrionPlanningCurrentNetWorthAssetClasses", "ProspectOrionPlanningProposedNetWorthAssetClasses", "ProspectOrionPlanningNetWorthAsset", "ProspectOrionPlanningCurrentNetWorthAssetCategories", "ProspectOrionPlanningProposedNetWorthAssetCategories", "ProspectOrionPlanningCurrentAssetCategories", "ProspectOrionPlanningProposedAssetCategories", "ProspectOrionPlanningCurrentAssetClasses", "ProspectOrionPlanningProposedAssetClasses", "ProspectComparisonHouseholdManualAccounts", "AdHocGrouping" ] }, "path": { "type": "string" }, "format": { "type": "string" }, "formatSettings": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculation.Format.FormatSettings" }, "cumulative": { "type": "boolean" }, "subtotalGrouping": { "type": "string", "enum": [ "Self", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "FundFamily", "Platform", "Custodian", "AggregateModel", "DynamicGrouping", "AssetClass", "AssetLevelStrategy", "AssetCategory", "RiskCategory", "AccountType", "RegistrationTaxType", "ProductType", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "ProductVintageYear", "ProductSubType", "AssetCategoryParent", "PortfolioGroup", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "MaturityPeriod", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "MorningstarGeography", "BillEntityType", "ProductSubHolding", "Country", "Currency", "CustomGrouping", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "Prospect", "Transaction", "Comparison", "CostBasisLot", "ModelInclusion", "ContextChanges", "ActivityOptions", "DateRanges", "Time", "Bill", "Beneficiary", "Trustee", "Systematic", "BillTier", "BillAdjustment", "FeeSchedules", "BillCashflow", "ModelVsActual", "BillAssetLevel", "HouseholdMember", "CustomIndexing", "ProspectAccount", "CustomIndexingScenario", "ProspectAssetClass", "ProspectAssetCategory", "CustomIndexingPreference", "ProspectMandate", "ProspectComparisonAssetClass", "ProspectComparisonAssetCategory", "ProspectComparisonHolding", "ProspectHolding", "ProspectModelAgg", "ProspectAccountStressTestsGrouped", "ProspectAccountStressTestScenario", "ProspectComparisonStressTestsGrouped", "ProspectComparisonStressTestScenario", "ProspectStressTestsGrouped", "ProspectStressTestScenario", "ProspectAccountCorrelation", "ProspectComparisonAccountCorrelation", "ProspectCorrelation", "ProspectOrionPlanningCurrentGoal", "ProspectOrionPlanningProposedGoal", "ProspectOrionPlanningCurrentGoalResults", "ProspectOrionPlanningProposedGoalResults", "ProspectOrionPlanningCurrentGoalStepsResults", "ProspectOrionPlanningProposedGoalStepsResults", "ProspectHoldingSectorResults", "ProspectHoldingGeographyResults", "ProspectAccountHoldingSectorResults", "ProspectAccountHoldingGeographyResults", "ProspectComparisonAccountHoldingSectorResults", "ProspectComparisonAccountHoldingGeographyResults", "ProspectOrionPlanningNetWorth", "ProspectSelfDirectedResults", "ProspectSelfDirectedAssetClass", "ProspectSelfDirectedAssetCategory", "ProspectHouseholdMembers", "ProspectStrategist", "ProspectWeightedAssetClass", "ProspectAccountWeightedAssetClass", "BillingRelatedAccounts", "ProspectAccountBlendedFactSheet", "CustomIndexingBuys", "CustomIndexingSells", "ProspectBlendedAssetClasses", "ProspectBlendedAssetCategories", "ProspectOrionPlanningCurrentNetWorthAssetClasses", "ProspectOrionPlanningProposedNetWorthAssetClasses", "ProspectOrionPlanningNetWorthAsset", "ProspectOrionPlanningCurrentNetWorthAssetCategories", "ProspectOrionPlanningProposedNetWorthAssetCategories", "ProspectOrionPlanningCurrentAssetCategories", "ProspectOrionPlanningProposedAssetCategories", "ProspectOrionPlanningCurrentAssetClasses", "ProspectOrionPlanningProposedAssetClasses", "ProspectComparisonHouseholdManualAccounts", "AdHocGrouping" ] }, "filter": { "$ref": "#/definitions/OAS.DataModel.Reporting.Engine.ContextFilter" }, "weightedBenchmarkGrouping": { "type": "string", "enum": [ "Self", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "FundFamily", "Platform", "Custodian", "AggregateModel", "DynamicGrouping", "AssetClass", "AssetLevelStrategy", "AssetCategory", "RiskCategory", "AccountType", "RegistrationTaxType", "ProductType", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "ProductVintageYear", "ProductSubType", "AssetCategoryParent", "PortfolioGroup", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "MaturityPeriod", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "MorningstarGeography", "BillEntityType", "ProductSubHolding", "Country", "Currency", "CustomGrouping", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "Prospect", "Transaction", "Comparison", "CostBasisLot", "ModelInclusion", "ContextChanges", "ActivityOptions", "DateRanges", "Time", "Bill", "Beneficiary", "Trustee", "Systematic", "BillTier", "BillAdjustment", "FeeSchedules", "BillCashflow", "ModelVsActual", "BillAssetLevel", "HouseholdMember", "CustomIndexing", "ProspectAccount", "CustomIndexingScenario", "ProspectAssetClass", "ProspectAssetCategory", "CustomIndexingPreference", "ProspectMandate", "ProspectComparisonAssetClass", "ProspectComparisonAssetCategory", "ProspectComparisonHolding", "ProspectHolding", "ProspectModelAgg", "ProspectAccountStressTestsGrouped", "ProspectAccountStressTestScenario", "ProspectComparisonStressTestsGrouped", "ProspectComparisonStressTestScenario", "ProspectStressTestsGrouped", "ProspectStressTestScenario", "ProspectAccountCorrelation", "ProspectComparisonAccountCorrelation", "ProspectCorrelation", "ProspectOrionPlanningCurrentGoal", "ProspectOrionPlanningProposedGoal", "ProspectOrionPlanningCurrentGoalResults", "ProspectOrionPlanningProposedGoalResults", "ProspectOrionPlanningCurrentGoalStepsResults", "ProspectOrionPlanningProposedGoalStepsResults", "ProspectHoldingSectorResults", "ProspectHoldingGeographyResults", "ProspectAccountHoldingSectorResults", "ProspectAccountHoldingGeographyResults", "ProspectComparisonAccountHoldingSectorResults", "ProspectComparisonAccountHoldingGeographyResults", "ProspectOrionPlanningNetWorth", "ProspectSelfDirectedResults", "ProspectSelfDirectedAssetClass", "ProspectSelfDirectedAssetCategory", "ProspectHouseholdMembers", "ProspectStrategist", "ProspectWeightedAssetClass", "ProspectAccountWeightedAssetClass", "BillingRelatedAccounts", "ProspectAccountBlendedFactSheet", "CustomIndexingBuys", "CustomIndexingSells", "ProspectBlendedAssetClasses", "ProspectBlendedAssetCategories", "ProspectOrionPlanningCurrentNetWorthAssetClasses", "ProspectOrionPlanningProposedNetWorthAssetClasses", "ProspectOrionPlanningNetWorthAsset", "ProspectOrionPlanningCurrentNetWorthAssetCategories", "ProspectOrionPlanningProposedNetWorthAssetCategories", "ProspectOrionPlanningCurrentAssetCategories", "ProspectOrionPlanningProposedAssetCategories", "ProspectOrionPlanningCurrentAssetClasses", "ProspectOrionPlanningProposedAssetClasses", "ProspectComparisonHouseholdManualAccounts", "AdHocGrouping" ] }, "taxInceptionType": { "type": "string", "enum": [ "CostBasis", "BeginningMarketValue" ] }, "costPerShareMethod": { "type": "string", "enum": [ "ValuationPrice", "PercentageOfPar" ] }, "activityOption": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IMakeActivityOption" }, "billingOption": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IMakeBillingOption" }, "calculationOption": { "$ref": "#/definitions/OAS.DataModel.Reporting.Calculation.IMakeCalculationOption" }, "comparisonOption": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IMakeComparisonOption" }, "costBasisOption": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IMakeCostBasisOption" }, "dateRange": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IMakeDateRange" }, "incomeOption": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IMakeIncomeOption" }, "maturityPeriodOption": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IMakeMaturityPeriodOption" }, "performanceOption": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IMakePerformanceOption" }, "projectedIncomeOption": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IMakeProjectedIncomeOption" }, "statisticalOption": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IMakeStatisticalOption" }, "taxOption": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IMakeTaxOption" }, "tradingOption": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IMakeTradingOption" }, "transactionOption": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IMakeTransactionOption" }, "attributionOption": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IMakeAttributionOption" }, "activityOptionId": { "type": "integer", "format": "int32" }, "billingOptionId": { "type": "integer", "format": "int32" }, "calculationOptionId": { "type": "integer", "format": "int32" }, "comparisonOptionId": { "type": "integer", "format": "int32" }, "costBasisOptionId": { "type": "integer", "format": "int32" }, "dateRangeId": { "type": "integer", "format": "int32" }, "incomeOptionId": { "type": "integer", "format": "int32" }, "maturityPeriodOptionId": { "type": "integer", "format": "int32" }, "performanceOptionId": { "type": "integer", "format": "int32" }, "projectedIncomeOptionId": { "type": "integer", "format": "int32" }, "promptOptionId": { "type": "integer", "format": "int32" }, "reportCategoryId": { "type": "integer", "format": "int32" }, "statisticalOptionId": { "type": "integer", "format": "int32" }, "taxOptionId": { "type": "integer", "format": "int32" }, "tradingOptionId": { "type": "integer", "format": "int32" }, "transactionOptionId": { "type": "integer", "format": "int32" }, "attributionId": { "type": "integer", "format": "int32" }, "returnStyle": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IReturnStyle" }, "percentFormat": { "type": "string" }, "dollarFormat": { "type": "string" }, "decimalFormat": { "type": "string" }, "numericFormat": { "type": "string" }, "quickDate": { "type": "string", "enum": [ "Day", "WTD", "MTD", "QTD", "YTD", "OneYear", "TwoYear", "ThreeYear", "FourYear", "FiveYear", "SixYear", "SevenYear", "EightYear", "NineYear", "TenYear", "PreviousOneYear", "PreviousTwoYear", "PreviousThreeYear", "PreviousFourYear", "PreviousFiveYear", "PreviousSixYear", "PreviousSevenYear", "PreviousEightYear", "PreviousNineYear", "PreviousTenYear", "Inception", "HoldingPeriod", "AIPLedger" ] }, "globalsSynced": { "type": "boolean" }, "useSmaSetting": { "type": "boolean" } }, "xml": { "name": "ContextCalculationFilter" }, "type": "object" }, "OAS.DataModel.Reporting.Calculation.Format.FormatSettings": { "properties": { "custom": { "type": "string" }, "showDollarSign": { "type": "boolean" }, "showPercentSign": { "type": "boolean" }, "useNegativeParenthesis": { "type": "boolean" }, "useThousandsSeparator": { "type": "boolean" }, "numberOfDecimal": { "type": "integer", "format": "int32" }, "growthOf": { "type": "string" }, "maskingType": { "type": "string" }, "visibleCharactersAtEnd": { "type": "integer", "format": "int32" }, "maskingCharacter": { "type": "string" }, "valueToReplace": { "type": "string" }, "replaceValueWith": { "type": "string" } }, "xml": { "name": "FormatSettings" }, "type": "object" }, "OAS.DataModel.Reporting.Engine.ContextTagResultFormatted": { "properties": { "formatted": { "type": "string" }, "$index": { "type": "string" } }, "xml": { "name": "ContextTagResultFormatted" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Custom.DataQueryBaseDto": { "properties": { "category": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "queryType": { "readOnly": true, "type": "string", "enum": [ "None", "Custom", "Excel", "All" ] } }, "xml": { "name": "DataQueryBaseDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ExcelReportDto": { "properties": { "id": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "auditedBy": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "isFavorite": { "type": "boolean" }, "scheduleCount": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "queryType": { "readOnly": true, "type": "string", "enum": [ "None", "Custom", "Excel", "All" ] }, "category": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } }, "xml": { "name": "ExcelReportDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ReportPdfDto": { "properties": { "id": { "type": "string" }, "pdfUrl": { "type": "string" }, "name": { "type": "string" }, "pageCount": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" } }, "xml": { "name": "ReportPdfDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ReportPdfFileDto": { "properties": { "id": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" }, "name": { "type": "string" } }, "xml": { "name": "ReportPdfFileDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ExcelReportVerboseDto": { "properties": { "id": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "name": { "type": "string" }, "portfolio": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ExcelReportPortfolioDto" }, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ExcelReportSchemaDto" }, "requiredOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportOption" }, "xml": { "name": "ReportOption", "wrapped": true }, "type": "array" }, "additionalOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportOptionCategory" }, "xml": { "name": "ReportOptionCategory", "wrapped": true }, "type": "array" }, "loginAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportLoginAccessRuleDto" }, "xml": { "name": "ReportLoginAccessRuleDto", "wrapped": true }, "type": "array" }, "databaseGroupAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportDatabaseGroupAccessRuleDto" }, "xml": { "name": "ReportDatabaseGroupAccessRuleDto", "wrapped": true }, "type": "array" }, "databaseAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportDatabaseAccessRuleDto" }, "xml": { "name": "ReportDatabaseAccessRuleDto", "wrapped": true }, "type": "array" }, "roleAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportRoleAccessRuleDto" }, "xml": { "name": "ReportRoleAccessRuleDto", "wrapped": true }, "type": "array" }, "userAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportUserAccessRuleDto" }, "xml": { "name": "ReportUserAccessRuleDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ExcelReportVerboseDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ExcelReportPortfolioDto": { "properties": { "category": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "auditedBy": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "ExcelReportPortfolioDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ExcelReportSchemaDto": { "properties": { "contextChange": { "$ref": "#/definitions/OAS.DataModel.Reporting.Engine.ContextChange" }, "workBook": { "$ref": "#/definitions/OAS.DataModel.Reporting.Controls.WorkBookControl" } }, "xml": { "name": "ExcelReportSchemaDto" }, "type": "object" }, "OAS.DataModel.Reporting.Controls.WorkBookControl": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "id": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "controls": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Controls.WorkSheetControl" }, "xml": { "name": "WorkSheetControl", "wrapped": true }, "type": "array" }, "customClass": { "type": "string" }, "width": { "type": "string" } }, "xml": { "name": "WorkBookControl" }, "type": "object" }, "OAS.DataModel.Reporting.Controls.WorkSheetControl": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "id": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "control": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IRenderDataTable" }, "sheetName": { "type": "string" }, "customClass": { "type": "string" }, "width": { "type": "string" } }, "xml": { "name": "WorkSheetControl" }, "type": "object" }, "OAS.DataModel.Reporting.Interfaces.IRenderDataTable": { "properties": { "id": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "type": { "readOnly": true, "type": "string" } }, "xml": { "name": "IRenderDataTable" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ReportCoverPageDto": { "properties": { "id": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "auditedBy": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "orientation": { "type": "string", "enum": [ "Portrait", "Landscape" ] }, "paperSize": { "type": "string", "enum": [ "Letter", "Legal", "A4" ] }, "isDefault": { "type": "boolean" }, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportCoverPageSchemaDto" }, "additionalOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportOptionCategory" }, "xml": { "name": "ReportOptionCategory", "wrapped": true }, "type": "array" } }, "xml": { "name": "ReportCoverPageDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ReportCoverPageSchemaDto": { "properties": { "body": { "$ref": "#/definitions/OAS.DataModel.Reporting.Controls.PositionedControlListControl" } }, "xml": { "name": "ReportCoverPageSchemaDto" }, "type": "object" }, "OAS.DataModel.Reporting.Controls.PositionedControlListControl": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "id": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "height": { "type": "string" }, "controls": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.Controls.PositionedControl" }, "xml": { "name": "PositionedControl", "wrapped": true }, "type": "array" }, "customClass": { "type": "string" }, "width": { "type": "string" } }, "xml": { "name": "PositionedControlListControl" }, "type": "object" }, "OAS.DataModel.Reporting.Controls.PositionedControl": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "id": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "control": { "$ref": "#/definitions/OAS.DataModel.Reporting.ControlBase" }, "top": { "type": "string" }, "left": { "type": "string" }, "height": { "type": "string" }, "customClass": { "type": "string" }, "width": { "type": "string" } }, "xml": { "name": "PositionedControl" }, "type": "object" }, "OAS.DataModel.SimpleEntityWithOrientationOfSystem.Guid": { "properties": { "orientation": { "type": "string", "enum": [ "Portrait", "Landscape" ] }, "id": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "xml": { "name": "SimpleEntityWithOrientation`1" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ReportCoverPageVerboseDto": { "properties": { "id": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 200, "minLength": 0 }, "portfolio": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportCoverPagePortfolioDto" }, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportCoverPageSchemaDto" }, "additionalOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportOptionCategory" }, "xml": { "name": "ReportOptionCategory", "wrapped": true }, "type": "array" }, "loginAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportLoginAccessRuleDto" }, "xml": { "name": "ReportLoginAccessRuleDto", "wrapped": true }, "type": "array" }, "databaseGroupAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportDatabaseGroupAccessRuleDto" }, "xml": { "name": "ReportDatabaseGroupAccessRuleDto", "wrapped": true }, "type": "array" }, "databaseAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportDatabaseAccessRuleDto" }, "xml": { "name": "ReportDatabaseAccessRuleDto", "wrapped": true }, "type": "array" }, "roleAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportRoleAccessRuleDto" }, "xml": { "name": "ReportRoleAccessRuleDto", "wrapped": true }, "type": "array" }, "userAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportUserAccessRuleDto" }, "xml": { "name": "ReportUserAccessRuleDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ReportCoverPageVerboseDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.ReportCoverPagePortfolioDto": { "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "auditedBy": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "ReportCoverPagePortfolioDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Extracts.UnrealizedTaxLotsDto": { "properties": { "lotId": { "type": "integer", "format": "int64" }, "assetId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "longTermCost": { "type": "number", "format": "double" }, "shortTermCost": { "type": "number", "format": "double" }, "longTermUnits": { "type": "number", "format": "double" }, "shortTermUnits": { "type": "number", "format": "double" }, "acquiredDate": { "type": "string", "format": "date-time" }, "amortizationAmt": { "type": "number", "format": "double" }, "origCostPerShare": { "description": "The Cost as reported to Orion by the custodian", "type": "number", "format": "double" }, "editedDate": { "type": "string", "format": "date-time" }, "costPerShare": { "description": "Has the caluclated costpershare (Cost divided by units)", "type": "number", "format": "double" } }, "xml": { "name": "UnrealizedTaxLotsDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Extracts.AssetValueChangeDto": { "properties": { "assetId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "startAccruedInt": { "type": "number", "format": "double" }, "dividendAccrual": { "type": "number", "format": "double" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "AssetValueChangeDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundGroupDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "groupName": { "type": "string" }, "fundKey": { "type": "string" }, "fundName": { "type": "string" }, "funds": { "items": { "type": "string" }, "type": "array" } }, "xml": { "name": "GeminiFundGroupDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundDto": { "properties": { "id": { "type": "string" }, "fundName": { "type": "string" }, "frontLoad": { "type": "number", "format": "double" }, "backLoad": { "type": "number", "format": "double" }, "ticker": { "type": "string" }, "cusip": { "type": "string" }, "inceptionDate": { "type": "string", "format": "date-time" }, "fiscalYearEnd": { "type": "string", "format": "date-time" }, "advisorInceptionDate": { "type": "string", "format": "date-time" }, "navPrecision": { "type": "integer", "format": "int32" }, "sharePrecision": { "type": "integer", "format": "int32" }, "isClosed": { "type": "boolean" }, "closedDate": { "type": "string", "format": "date-time" }, "isLiquidated": { "type": "boolean" }, "liquidatedDate": { "type": "string", "format": "date-time" }, "class": { "type": "string" }, "fundType": { "type": "string", "enum": [ "Unassigned", "Equity", "FixedIncome", "FiveTwentyNine", "Index" ] }, "identifiers": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundIdentifierDto" }, "xml": { "name": "GeminiFundIdentifierDto", "wrapped": true }, "type": "array" }, "fiscalYearEndFormatted": { "type": "string" }, "notes": { "type": "string" } }, "xml": { "name": "GeminiFundDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundIdentifierDto": { "properties": { "fundKey": { "type": "string" }, "identifier": { "type": "string" } }, "xml": { "name": "GeminiFundIdentifierDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundInceptionDto": { "properties": { "fundKey": { "type": "string" }, "inceptionDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "GeminiFundInceptionDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundStartPriceDto": { "properties": { "fundKey": { "type": "string" }, "startPrice": { "type": "number", "format": "double" } }, "xml": { "name": "GeminiFundStartPriceDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundDataDto": { "properties": { "fundKey": { "type": "string" }, "rateDate": { "type": "string", "format": "date-time" }, "netAssetValue": { "type": "number", "format": "double" }, "offeringPrice": { "type": "number", "format": "double" }, "netAssets": { "type": "number", "format": "double" }, "sharesOutstanding": { "type": "number", "format": "double" }, "distributionFactor": { "type": "string" }, "capGainsFactorShort": { "type": "number", "format": "double" }, "capGainsFactorLong": { "type": "number", "format": "double" }, "returnOfCapital": { "type": "number", "format": "double" }, "expensesGross": { "type": "number", "format": "double" }, "expensesWaived": { "type": "number", "format": "double" }, "userDefinedFields": { "type": "number", "format": "double" }, "fundName": { "type": "string" }, "volume": { "type": "integer", "format": "int32" } }, "xml": { "name": "GeminiFundDataDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundDataKeyDto": { "properties": { "fundKey": { "type": "string" }, "rateDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "GeminiFundDataKeyDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundDivDetailDto": { "properties": { "fundKey": { "type": "string" }, "rateDate": { "type": "string", "format": "date-time" }, "reinvestPrice": { "type": "number", "format": "double" }, "dividendRate": { "type": "number", "format": "double" }, "ordinaryDividend": { "type": "number", "format": "double" }, "qualifiedDividend": { "type": "number", "format": "double" }, "taxFreeDiv": { "type": "number", "format": "double" }, "shortRate": { "type": "number", "format": "double" }, "shortOrdinary": { "type": "number", "format": "double" }, "shortQualified": { "type": "number", "format": "double" }, "longRate": { "type": "number", "format": "double" }, "returnOfCapital": { "type": "number", "format": "double" }, "exDate": { "type": "string", "format": "date-time" }, "recordDate": { "type": "string", "format": "date-time" }, "reinvestDate": { "type": "string", "format": "date-time" }, "payDate": { "type": "string", "format": "date-time" }, "fundName": { "type": "string" } }, "xml": { "name": "GeminiFundDivDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundLoadDto": { "properties": { "load": { "type": "number", "format": "float" }, "forYear": { "type": "integer", "format": "int32" }, "starting": { "type": "integer", "format": "int32" }, "effectiveDate": { "type": "string", "format": "date-time" }, "isBackEnd": { "type": "boolean" }, "fundKey": { "type": "string" }, "fundName": { "type": "string" } }, "xml": { "name": "GeminiFundLoadDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundBackLoadDto": { "properties": { "backLoad": { "type": "number", "format": "double" }, "forYear": { "type": "integer", "format": "int32" }, "effectiveDate": { "type": "string", "format": "date-time" }, "fundKey": { "type": "string" }, "fundName": { "type": "string" } }, "xml": { "name": "GeminiFundBackLoadDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundDivDto": { "properties": { "fundKey": { "type": "string" }, "divYear": { "type": "integer", "format": "int32" }, "qualifiedRate": { "type": "number", "format": "double" }, "taxFreeRate": { "type": "number", "format": "double" }, "qualifiedSTPortion": { "type": "number", "format": "double" }, "fundName": { "type": "string" } }, "xml": { "name": "GeminiFundDivDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundBackLoadKeyDto": { "properties": { "fundKey": { "type": "string" }, "forYear": { "type": "integer", "format": "int32" }, "effectiveDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "GeminiFundBackLoadKeyDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundFrontLoadDto": { "properties": { "frontLoad": { "type": "number", "format": "double" }, "starting": { "type": "integer", "format": "int32" }, "effectiveDate": { "type": "string", "format": "date-time" }, "fundKey": { "type": "string" }, "fundName": { "type": "string" } }, "xml": { "name": "GeminiFundFrontLoadDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundFrontLoadKeyDto": { "properties": { "fundKey": { "type": "string" }, "effectiveDate": { "type": "string", "format": "date-time" }, "starting": { "type": "integer", "format": "int32" } }, "xml": { "name": "GeminiFundFrontLoadKeyDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundDivKeyDto": { "properties": { "fundKey": { "type": "string" }, "divYear": { "type": "integer", "format": "int32" } }, "xml": { "name": "GeminiFundDivKeyDto" }, "type": "object" }, "OAS.DataAccess.Domains.Portfolio.SimpleStringKeyEntityIndex": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "productId": { "type": "integer", "format": "int32" } }, "xml": { "name": "SimpleStringKeyEntityIndex" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundIndexDto": { "properties": { "indexNumber": { "type": "string" }, "indexName": { "type": "string" }, "productId": { "type": "integer", "format": "int32" }, "isBlend": { "type": "boolean" } }, "xml": { "name": "GeminiFundIndexDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundIndexLinkDto": { "properties": { "fundKey": { "type": "string" }, "indexNumber": { "type": "string" }, "indexName": { "type": "string" }, "productId": { "type": "integer", "format": "int32" }, "isPrimary": { "type": "boolean" }, "isBlend": { "type": "boolean" }, "fundName": { "type": "string" } }, "xml": { "name": "GeminiFundIndexLinkDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundIndexLinkKeyDto": { "properties": { "fundKey": { "type": "string" }, "indexNumber": { "type": "string" } }, "xml": { "name": "GeminiFundIndexLinkKeyDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.FundPerformance.PerformanceSettingsDto": { "properties": { "fundKey": { "type": "string" }, "initialInvestment": { "type": "number", "format": "double" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "includeLoad": { "type": "boolean" }, "annualize": { "type": "boolean" }, "additionalPeriods": { "type": "string", "enum": [ "None", "Day", "MTD", "QTD", "YTD", "OneYear", "ThreeYear", "FiveYear", "TenYear", "Inception", "AllDates" ] }, "details": { "type": "string", "enum": [ "Automatic", "Undefined", "PeriodEnd", "Daily", "Monthly", "Weekly" ] }, "includeTaxes": { "type": "string", "enum": [ "None", "PreLiquidation", "PostLiquidation" ] }, "useCurrentLoad": { "type": "boolean" } }, "xml": { "name": "PerformanceSettingsDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundPerformanceDto": { "properties": { "groupId": { "type": "integer", "format": "int32" }, "fundKey": { "type": "string" }, "fundName": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "initialInvestment": { "type": "number", "format": "double" }, "includeLoad": { "type": "boolean" }, "annualize": { "type": "boolean" }, "inceptionDate": { "type": "string", "format": "date-time" }, "summaries": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundPerformanceSummaryDto" }, "xml": { "name": "GeminiFundPerformanceSummaryDto", "wrapped": true }, "type": "array" }, "details": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundPerformanceDetailDto" }, "xml": { "name": "GeminiFundPerformanceDetailDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "GeminiFundPerformanceDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundPerformanceSummaryDto": { "properties": { "period": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "startValue": { "type": "number", "format": "double" }, "endValue": { "type": "number", "format": "double" }, "stTaxAdjust": { "type": "number", "format": "double" }, "ltTaxAdjust": { "type": "number", "format": "double" }, "taxAdjust": { "type": "number", "format": "double" }, "performance": { "type": "number", "format": "double" } }, "xml": { "name": "GeminiFundPerformanceSummaryDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundPerformanceDetailDto": { "properties": { "date": { "type": "string", "format": "date-time" }, "startValue": { "type": "number", "format": "double" }, "endValue": { "type": "number", "format": "double" }, "fundPrice": { "type": "number", "format": "double" }, "divRate": { "type": "number", "format": "double" }, "stRate": { "type": "number", "format": "double" }, "ltRate": { "type": "number", "format": "double" }, "qDivRate": { "type": "number", "format": "double" }, "qstRate": { "type": "number", "format": "double" }, "backLoad": { "type": "number", "format": "double" }, "factor": { "type": "number", "format": "double" }, "performance": { "type": "number", "format": "double" } }, "xml": { "name": "GeminiFundPerformanceDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundTaxDto": { "properties": { "id": { "type": "string", "format": "date-time" }, "longTermRate": { "type": "number", "format": "double" }, "shortTermRate": { "type": "number", "format": "double" } }, "xml": { "name": "GeminiFundTaxDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.FundPerformance.GeminiFundCalendarDto": { "properties": { "id": { "type": "string", "format": "date-time" }, "isWeekend": { "type": "boolean" }, "isHoliday": { "type": "boolean" } }, "xml": { "name": "GeminiFundCalendarDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Notification.NotificationCountSummaryDto": { "properties": { "unreadInboxNotifications": { "type": "integer", "format": "int32" }, "lastUpdate": { "type": "string", "format": "date-time" } }, "xml": { "name": "NotificationCountSummaryDto" }, "type": "object" }, "OAS.WebApi.DTO.Fuse.NotificationTypeSubscriptionDto": { "properties": { "categoryId": { "type": "integer", "format": "int32" }, "categoryName": { "type": "string" }, "categoryDescription": { "type": "string" }, "notificationName": { "type": "string" }, "notificationDescription": { "type": "string" }, "canBeDisabled": { "type": "boolean" }, "subscriptionId": { "type": "integer", "format": "int32" }, "enabled": { "type": "boolean" }, "email": { "type": "boolean" }, "disablePopup": { "type": "boolean" }, "notificationTypeId": { "type": "integer", "format": "int32" } }, "xml": { "name": "NotificationTypeSubscriptionDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Activity.RealizedDrillDownSettingsDto": { "properties": { "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "groupings": { "items": { "type": "string", "enum": [ "Undefined", "Representative", "Client", "Registration", "Account", "Asset", "AssetClass", "ProductType", "Platform", "RiskCategory", "Product", "IndexBlend", "AssetCategory", "AssetLevelStrategy", "AggregateModel", "AccountType", "PortfolioGroup" ] }, "xml": { "name": "ReportGrouping", "wrapped": true }, "type": "array" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "RealizedDrillDownSettingsDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Activity.GainLossDrillDownSummaryBase": { "properties": { "shortTermGainLoss": { "type": "number", "format": "double" }, "longTermGainLoss": { "type": "number", "format": "double" }, "gainLoss": { "readOnly": true, "type": "number", "format": "double" }, "costBasis": { "type": "number", "format": "double" } }, "xml": { "name": "GainLossDrillDownSummaryBase" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Activity.UnrealizedDrillDownSettingsDto": { "properties": { "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "groupings": { "items": { "type": "string", "enum": [ "Undefined", "Representative", "Client", "Registration", "Account", "Asset", "AssetClass", "ProductType", "Platform", "RiskCategory", "Product", "IndexBlend", "AssetCategory", "AssetLevelStrategy", "AggregateModel", "AccountType", "PortfolioGroup" ] }, "xml": { "name": "ReportGrouping", "wrapped": true }, "type": "array" }, "asOfDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "UnrealizedDrillDownSettingsDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Implementation.ImplementationPlanDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "signedOffBy": { "type": "string" }, "signedOffDate": { "type": "string", "format": "date-time" }, "implementationSteps": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Implementation.ImplementationStepDto" }, "xml": { "name": "ImplementationStepDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ImplementationPlanDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Implementation.ImplementationStepDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "implementationPlanId": { "type": "integer", "format": "int32" }, "title": { "type": "string" }, "description": { "type": "string" }, "note": { "type": "string" }, "offsetDays": { "type": "integer", "format": "int32" }, "completedDate": { "type": "string", "format": "date-time" }, "targetDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "ImplementationStepDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Qpe.QpeItemDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "title": { "type": "string" }, "period": { "type": "string", "enum": [ "Quarterly", "Monthly", "TriAnnually" ] }, "startDate": { "type": "string", "format": "date-time" }, "targetDate": { "type": "string", "format": "date-time" }, "signedOffBy": { "type": "string" }, "signedOffDate": { "type": "string", "format": "date-time" }, "workflowItemId": { "type": "integer", "format": "int32" }, "workflowItem": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Qpe.WorkflowItemDto" }, "completedPercent": { "type": "number", "format": "double" }, "newsletters": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Qpe.QpeDashboardBlobDto" }, "xml": { "name": "QpeDashboardBlobDto", "wrapped": true }, "type": "array" }, "newsletter": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Qpe.QpeDashboardNewsletterDto" }, "isOldStyle": { "type": "boolean" }, "friendlyName": { "readOnly": true, "type": "string" } }, "xml": { "name": "QpeItemDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Qpe.WorkflowItemDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "itemDesc": { "type": "string" }, "actions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Qpe.WorkflowActionDto" }, "xml": { "name": "WorkflowActionDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "WorkflowItemDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Qpe.QpeDashboardBlobDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "fileName": { "type": "string" } }, "xml": { "name": "QpeDashboardBlobDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Qpe.QpeDashboardNewsletterDto": { "properties": { "fileName": { "type": "string" } }, "xml": { "name": "QpeDashboardNewsletterDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Qpe.WorkflowActionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "actionDesc": { "type": "string" }, "completedDate": { "type": "string", "format": "date-time" }, "actionComment": { "type": "string" }, "runnableClass": { "type": "string" } }, "xml": { "name": "WorkflowActionDto" }, "type": "object" }, "OAS.DataModel.Reporting.QpeDashboard.SpimQpeDashboardDtlGetDrillDown": { "properties": { "scheduleName": { "type": "string" }, "assignedCount": { "type": "integer", "format": "int32" } }, "xml": { "name": "SpimQpeDashboardDtlGetDrillDown" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Notification.NotificationGroupDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "NotificationGroupDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Notification.NotificationGroupFullDto": { "properties": { "members": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "id": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "NotificationGroupFullDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Notification.NotificationDto": { "properties": { "body": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "data": { "type": "string" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "id": { "type": "integer", "format": "int32" }, "notificationTypeId": { "type": "integer", "format": "int32" }, "preview": { "type": "string" }, "subject": { "type": "string" }, "tags": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "notificationLevel": { "type": "string", "enum": [ "Error", "Warning", "Information" ] }, "state": { "type": "string", "enum": [ "Created", "Processed", "Viewed", "Archived" ] }, "notificationTypeCode": { "type": "string" }, "url": { "type": "string" }, "app": { "type": "string" } }, "xml": { "name": "NotificationDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Notification.NotificationSubscriptionWithDestinationDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "notificationDestinationId": { "type": "integer", "format": "int32" }, "destinations": { "additionalProperties": { "type": "boolean" }, "type": "object" }, "notificationDestination": { "type": "string", "enum": [ "ClientPortal", "OrionApp", "Email", "Rss", "AdvisorMail", "Zapier", "NotificationInbox", "SMSText", "MobilePush" ] }, "userOwnerId": { "type": "integer", "format": "int32" }, "groupType": { "type": "string", "enum": [ "Me", "User", "AllHouseholds", "AllReps", "AllAdvisors", "ServiceTeam", "CustomGroup", "AllUsers", "AllAdministrators" ] }, "isActive": { "type": "boolean" }, "alClientId": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "userName": { "type": "string" }, "notificationGroupId": { "type": "integer", "format": "int32" }, "notificationGroup": { "type": "string" }, "destinationSettings": { "type": "string" }, "notificationType": { "type": "string" }, "notificationTypeId": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "NotificationSubscriptionWithDestinationDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Notification.NotificationSubscriptionsForUserDto": { "properties": { "notificationTypeId": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "destinations": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Notification.UserDestinationDto" }, "xml": { "name": "UserDestinationDto", "wrapped": true }, "type": "array" }, "schedule": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Notification.NotificationSchedule" }, "category": { "type": "string" } }, "xml": { "name": "NotificationSubscriptionsForUserDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Notification.UserDestinationDto": { "properties": { "notificationDestinationId": { "type": "integer", "format": "int32" }, "destinationName": { "type": "string", "enum": [ "ClientPortal", "OrionApp", "Email", "Rss", "AdvisorMail", "Zapier", "NotificationInbox", "SMSText", "MobilePush" ] }, "enabled": { "type": "boolean" }, "notificationSubscriptionId": { "type": "integer", "format": "int32" } }, "xml": { "name": "UserDestinationDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Notification.NotificationSchedule": { "properties": { "frequency": { "type": "string", "enum": [ "Daily", "Weekly", "Monthly", "Once" ] }, "weekly": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Notification.DaysOfWeekBool" }, "monthly": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Notification.MonthsOfYearBool" }, "dayOfMonth": { "type": "integer", "format": "int32" }, "timeOfDay": { "type": "string" } }, "xml": { "name": "NotificationSchedule" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Notification.DaysOfWeekBool": { "properties": { "monday": { "type": "boolean" }, "tuesday": { "type": "boolean" }, "wednesday": { "type": "boolean" }, "thursday": { "type": "boolean" }, "friday": { "type": "boolean" }, "saturday": { "type": "boolean" }, "sunday": { "type": "boolean" }, "toEnumArray": { "items": { "type": "string", "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ] }, "readOnly": true, "type": "array" } }, "xml": { "name": "DaysOfWeekBool" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Notification.MonthsOfYearBool": { "properties": { "january": { "type": "boolean" }, "february": { "type": "boolean" }, "march": { "type": "boolean" }, "april": { "type": "boolean" }, "may": { "type": "boolean" }, "june": { "type": "boolean" }, "july": { "type": "boolean" }, "august": { "type": "boolean" }, "september": { "type": "boolean" }, "october": { "type": "boolean" }, "november": { "type": "boolean" }, "december": { "type": "boolean" }, "toEnumArray": { "items": { "type": "string", "enum": [ "None", "January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December" ] }, "readOnly": true, "xml": { "name": "Months", "wrapped": true }, "type": "array" } }, "xml": { "name": "MonthsOfYearBool" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.VerbosePerformanceSettingsDto": { "properties": { "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "groupings": { "items": { "$ref": "#/definitions/OAS.DataModel.Performance.AdvancedPerformanceGrouping" }, "xml": { "name": "AdvancedPerformanceGrouping", "wrapped": true }, "type": "array" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "returnStyle": { "type": "string", "enum": [ "PortfolioSummary", "PortfolioDaily", "PortfolioDetailed", "BenchmarkSummary", "BenchmarkDaily", "AssetGroupAssignment", "StatisticSummary" ] }, "periods": { "type": "string", "enum": [ "None", "Day", "MTD", "QTD", "YTD", "OneYear", "ThreeYear", "FiveYear", "TenYear", "Inception", "AllDates" ] }, "dailyFactorLimiter": { "type": "string", "enum": [ "None", "Day", "MTD", "QTD", "YTD", "OneYear", "ThreeYear", "FiveYear", "TenYear", "Inception", "AllDates" ] }, "calendarYears": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "previousYears": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "interval": { "type": "string" }, "indexOverrides": { "items": { "type": "string" }, "type": "array" }, "clientPerformanceInclude": { "type": "string", "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, "calculationMethod": { "type": "string", "enum": [ "TWR", "Simple", "IRR" ] }, "debugMode": { "type": "boolean" }, "feeCalculationMethod": { "type": "string", "enum": [ "NetOfFees", "GrossOfFees", "Both" ] }, "annualizePerformance": { "type": "boolean" }, "includeAccruedInterest": { "type": "boolean" }, "allowFirstDayPerformance": { "type": "boolean" }, "allowIntraDayPerformance": { "type": "boolean" }, "forceAssetGroupingIntraDayPerformance": { "type": "boolean" }, "annualizationDayCountMethod": { "type": "string", "enum": [ "DaysWithValueOnly", "AllDaysWithinRange" ] }, "suppressMixedRanges": { "type": "boolean" }, "suppressMixedAssetLevelGroups": { "type": "boolean" }, "unmanagedInclusionOverride": { "type": "string", "enum": [ "Unmanaged", "Performance", "ActivitySummary", "Allocation", "PortfolioDetail", "TaxDetail" ] }, "accountManagementOverride": { "items": { "$ref": "#/definitions/OAS.DataModel.Performance.PerformanceAccountManagement" }, "xml": { "name": "PerformanceAccountManagement", "wrapped": true }, "type": "array" }, "benchmarks": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VerbosePerformanceBenchmarkDto" }, "xml": { "name": "VerbosePerformanceBenchmarkDto", "wrapped": true }, "type": "array" }, "includeProductBreakdown": { "type": "boolean" }, "minimumInceptionDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "VerbosePerformanceSettingsDto" }, "type": "object" }, "OAS.DataModel.Performance.AdvancedPerformanceGrouping": { "properties": { "grouping": { "type": "string", "enum": [ "Undefined", "Representative", "Client", "Registration", "Account", "Asset", "AssetClass", "ProductType", "Platform", "RiskCategory", "Product", "IndexBlend", "AssetCategory", "AssetLevelStrategy", "AggregateModel", "AccountType", "PortfolioGroup" ] }, "returnStyle": { "type": "string", "enum": [ "PortfolioSummary", "PortfolioDaily", "PortfolioDetailed", "BenchmarkSummary", "BenchmarkDaily", "AssetGroupAssignment", "StatisticSummary" ] }, "groupings": { "items": { "$ref": "#/definitions/OAS.DataModel.Performance.AdvancedPerformanceGrouping" }, "xml": { "name": "AdvancedPerformanceGrouping", "wrapped": true }, "type": "array" } }, "xml": { "name": "AdvancedPerformanceGrouping" }, "type": "object" }, "OAS.DataModel.Performance.PerformanceAccountManagement": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "isManaged": { "type": "boolean" } }, "xml": { "name": "PerformanceAccountManagement" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.VerbosePerformanceBenchmarkDto": { "properties": { "entity": { "type": "string", "enum": [ "Blend", "Product", "Model", "Custom" ] }, "entityId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "blends": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.VerbosePerformanceBenchmarkBlendDto" }, "xml": { "name": "VerbosePerformanceBenchmarkBlendDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "VerbosePerformanceBenchmarkDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.VerbosePerformanceBenchmarkBlendDto": { "properties": { "effectiveDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "productId": { "type": "integer", "format": "int32" }, "weight": { "type": "number", "format": "double" } }, "xml": { "name": "VerbosePerformanceBenchmarkBlendDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.DrillDownSummaryPerformanceSettingsDto": { "properties": { "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "groupings": { "items": { "type": "string", "enum": [ "Undefined", "Representative", "Client", "Registration", "Account", "Asset", "AssetClass", "ProductType", "Platform", "RiskCategory", "Product", "IndexBlend", "AssetCategory", "AssetLevelStrategy", "AggregateModel", "AccountType", "PortfolioGroup" ] }, "xml": { "name": "ReportGrouping", "wrapped": true }, "type": "array" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "periods": { "type": "string", "enum": [ "None", "Day", "MTD", "QTD", "YTD", "OneYear", "ThreeYear", "FiveYear", "TenYear", "Inception", "AllDates" ] }, "benchmark": { "type": "string" }, "showZeroValueAssets": { "type": "boolean" }, "showMoneyMarketPerformance": { "type": "boolean" }, "showBenchmarks": { "type": "boolean" }, "performanceCalculationMethod": { "type": "string", "enum": [ "TWR", "Simple", "IRR" ] }, "showBenchmarkMask": { "items": { "type": "boolean" }, "type": "array" }, "clientPerformanceInclude": { "type": "string", "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, "showMarketValues": { "type": "boolean" }, "managedUnmanagedInclusion": { "type": "integer", "format": "int32" }, "reportCategory": { "type": "string", "enum": [ "Unmanaged", "Performance", "ActivitySummary", "Allocation", "PortfolioDetail", "TaxDetail" ] } }, "xml": { "name": "DrillDownSummaryPerformanceSettingsDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Performance.DrillDownSummaryDto": { "properties": { "grouping": { "type": "string", "enum": [ "Undefined", "Representative", "Client", "Registration", "Account", "Asset", "AssetClass", "ProductType", "Platform", "RiskCategory", "Product", "IndexBlend", "AssetCategory", "AssetLevelStrategy", "AggregateModel", "AccountType", "PortfolioGroup" ] }, "fkGroupEntity": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "color": { "type": "string" }, "sortOrder": { "type": "integer", "format": "int32" }, "children": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Performance.DrillDownSummaryDto" }, "xml": { "name": "DrillDownSummaryDto", "wrapped": true }, "type": "array" }, "includeAccruedInt": { "type": "boolean" }, "benchmarks": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Performance.BenchmarkDrillDownSummaryDto" }, "xml": { "name": "BenchmarkDrillDownSummaryDto", "wrapped": true }, "type": "array" }, "dateRanges": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Performance.BenchmarkDateRangeDrillDownSummaryDto" }, "xml": { "name": "BenchmarkDateRangeDrillDownSummaryDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "DrillDownSummaryDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Performance.BenchmarkDrillDownSummaryDto": { "properties": { "fkKey": { "type": "integer", "format": "int32" }, "bmType": { "type": "string" }, "name": { "type": "string" }, "dateRanges": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Performance.BenchmarkDateRangeDrillDownSummaryDto" }, "xml": { "name": "BenchmarkDateRangeDrillDownSummaryDto", "wrapped": true }, "type": "array" }, "color": { "type": "string" } }, "xml": { "name": "BenchmarkDrillDownSummaryDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Performance.BenchmarkDateRangeDrillDownSummaryDto": { "properties": { "pkDateRange": { "type": "integer", "format": "int32" }, "dateRangeName": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "performance": { "type": "number", "format": "double" }, "startValue": { "type": "number", "format": "double" }, "endValue": { "type": "number", "format": "double" } }, "xml": { "name": "BenchmarkDateRangeDrillDownSummaryDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.ActiveFilterListDto": { "properties": { "category": { "type": "string" }, "activeFilters": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.ActiveFilterDto" }, "xml": { "name": "ActiveFilterDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ActiveFilterListDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.ActiveFilterDto": { "properties": { "name": { "type": "string" }, "detail": { "type": "string" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" }, "value": { "type": "number", "format": "double" }, "active": { "type": "boolean" } }, "xml": { "name": "ActiveFilterDto" }, "type": "object" }, "OAS.WebApi.Domains.Reporting.PerformanceController.OverviewPerformanceRequestParameters": { "properties": { "entity": { "description": "Level to run for. For example \"Owner\" returns all performance for the entire database. \"Representative\" returns performance for the specified rep.", "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "description": "EntityId for the level. Use 0 if running for entire database.", "type": "integer", "format": "int32" }, "grouping": { "description": "What level to return. For example Account returns a row for each account in the level.", "type": "string", "enum": [ "Undefined", "Representative", "Client", "Registration", "Account", "Asset", "AssetClass", "ProductType", "Platform", "RiskCategory", "Product", "IndexBlend", "AssetCategory", "AssetLevelStrategy", "AggregateModel", "AccountType", "PortfolioGroup" ] }, "annualizePerformance": { "description": "To annualize performance if over a year period.", "type": "boolean" } }, "xml": { "name": "OverviewPerformanceRequestParameters" }, "type": "object" }, "OAS.WebApi.Domains.Reporting.BIController.BIPerformanceWithDateRangeInfoDto": { "properties": { "performance": { "items": { "$ref": "#/definitions/OAS.WebApi.Domains.Reporting.BIController.BIPerformanceDto" }, "xml": { "name": "BIPerformanceDto", "wrapped": true }, "type": "array" }, "dateRanges": { "items": { "$ref": "#/definitions/OAS.WebApi.Domains.Reporting.BIController.BIPerformanceDateRangeDto" }, "xml": { "name": "BIPerformanceDateRangeDto", "wrapped": true }, "type": "array" }, "status": { "$ref": "#/definitions/OAS.WebApi.Domains.Reporting.BIController.BIPerformanceStatusDto" } }, "xml": { "name": "BIPerformanceWithDateRangeInfoDto" }, "type": "object" }, "OAS.WebApi.Domains.Reporting.BIController.BIPerformanceDateRangeDto": { "properties": { "dateRangeName": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "BIPerformanceDateRangeDto" }, "type": "object" }, "OAS.WebApi.Domains.Reporting.BIController.BIPerformanceStatusDto": { "properties": { "status": { "type": "string" }, "lastUpdated": { "type": "string", "format": "date-time" } }, "xml": { "name": "BIPerformanceStatusDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Activity.ActivitySimpleRequestDto": { "properties": { "clientId": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "activitySummaryDetail": { "type": "string", "enum": [ "BeginningMarketValue", "BeginningBondAccrual", "EndingMarketValue", "EndingBondAccrual", "Contributions", "Distributions", "NetDividendsInterestGainsWithdrawn", "MiscellaneousCharges", "AdvisoryFeesPaid", "DividendsAndInterest", "DividendInterestReinvested", "ExchangeIn", "ExchangeOut", "MergeIn", "MergeOut", "JournalIn", "JournalOut", "InitialMergeIn", "InitialContributions", "TransfersInOut", "ExchangeInOut" ] }, "clientPerformanceInclude": { "type": "string", "enum": [ "Default", "All", "ActiveOnly", "ActiveWithValue", "ActiveRegistrationsOnly", "RegistrationsWithValue" ] }, "useZeroInceptionValue": { "type": "boolean" } }, "xml": { "name": "ActivitySimpleRequestDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.UserTasks.PortalTaskDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "clientName": { "type": "string" }, "status": { "type": "string", "enum": [ "None", "Accepted", "Completed", "Confirmed", "Closed", "Declined", "InProcess", "New", "Pending", "Rejected", "UnAssigned" ] }, "title": { "type": "string" }, "body": { "type": "string" }, "dueDate": { "type": "string", "format": "date-time" }, "publicNotes": { "type": "string" }, "advisorNotes": { "type": "string" }, "assignedTo": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "PortalTaskDto" }, "type": "object" }, "OAS.WebApi.Domains.Reporting.PortalTaskController.EStatementDto": { "properties": { "email": { "type": "string" }, "subject": { "type": "string" }, "body": { "type": "string" }, "isHtml": { "type": "boolean" }, "isMethodChange": { "type": "boolean" } }, "xml": { "name": "EStatementDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.PreviewDto": { "properties": { "entity": { "type": "string", "enum": [ "Database", "BrokerDealer", "Representative", "Client", "Registration", "Account", "Asset", "Product", "AggregateModel", "DynamicGrouping", "PortfolioGroup", "UserDetail", "Prospect", "CustomGrouping" ] }, "entityIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "orientation": { "type": "string", "enum": [ "Portrait", "Landscape" ] }, "start": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.DateExpression" }, "end": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.DateExpression" }, "selectedTheme": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "controls": { "$ref": "#/definitions/OAS.DataModel.Reporting.Controls.ListControl" }, "options": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportOption" }, "xml": { "name": "ReportOption", "wrapped": true }, "type": "array" }, "featureFlagsOverride": { "$ref": "#/definitions/OAS.DataModel.Reporting.Interfaces.IReportFeatureFlagOverrider" } }, "xml": { "name": "PreviewDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Envision.DateExpression": { "properties": { "date": { "type": "string" }, "expression": { "type": "string" }, "dateSource": { "type": "string", "enum": [ "Static", "Dynamic" ] } }, "xml": { "name": "DateExpression" }, "type": "object" }, "OAS.DataModel.Reporting.Controls.ListControl": { "required": [ "$type" ], "properties": { "$type": { "readOnly": true, "type": "string" }, "id": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "controls": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.ControlBase" }, "xml": { "name": "ControlBase", "wrapped": true }, "type": "array" }, "customClass": { "type": "string" }, "width": { "type": "string" } }, "xml": { "name": "ListControl" }, "type": "object" }, "OAS.DataProcess.DTO.Reporting.ProcessManagerSimpleDto": { "properties": { "completedPercent": { "type": "number", "format": "double" }, "id": { "type": "integer", "format": "int32" }, "typeId": { "type": "integer", "format": "int32" }, "title": { "type": "string" }, "period": { "type": "string", "enum": [ "Quarterly", "Monthly", "TriAnnually" ] }, "startDate": { "type": "string", "format": "date-time" }, "targetDate": { "type": "string", "format": "date-time" }, "signedOffBy": { "type": "string" }, "signedOffDate": { "type": "string", "format": "date-time" }, "workflowItemId": { "type": "integer", "format": "int32" }, "isLockedDown": { "type": "boolean" }, "isLegacy": { "type": "boolean" }, "friendlyName": { "readOnly": true, "type": "string" } }, "xml": { "name": "ProcessManagerSimpleDto" }, "type": "object" }, "OAS.DataProcess.DTO.Reporting.ProcessManagerDto": { "properties": { "reviewTasks": { "items": { "$ref": "#/definitions/OAS.DataProcess.DTO.Reporting.ProcessWorkflowPhaseDto" }, "xml": { "name": "ProcessWorkflowPhaseDto", "wrapped": true }, "type": "array" }, "completedPercent": { "type": "number", "format": "double" }, "id": { "type": "integer", "format": "int32" }, "typeId": { "type": "integer", "format": "int32" }, "title": { "type": "string" }, "period": { "type": "string", "enum": [ "Quarterly", "Monthly", "TriAnnually" ] }, "startDate": { "type": "string", "format": "date-time" }, "targetDate": { "type": "string", "format": "date-time" }, "signedOffBy": { "type": "string" }, "signedOffDate": { "type": "string", "format": "date-time" }, "workflowItemId": { "type": "integer", "format": "int32" }, "isLockedDown": { "type": "boolean" }, "isLegacy": { "type": "boolean" }, "friendlyName": { "readOnly": true, "type": "string" } }, "xml": { "name": "ProcessManagerDto" }, "type": "object" }, "OAS.DataProcess.DTO.Reporting.ProcessWorkflowPhaseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string" }, "tasks": { "items": { "$ref": "#/definitions/OAS.DataProcess.DTO.Reporting.ProcessWorkflowDetailsDto" }, "xml": { "name": "ProcessWorkflowDetailsDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProcessWorkflowPhaseDto" }, "type": "object" }, "OAS.DataProcess.DTO.Reporting.ProcessWorkflowDetailsDto": { "properties": { "workflowActionId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "typeId": { "type": "integer", "format": "int32" }, "type": { "type": "string" }, "canSignOff": { "type": "boolean" }, "signedOffDate": { "type": "string", "format": "date-time" }, "signedOffBy": { "type": "string" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "data": { "type": "object" }, "redirectUrl": { "type": "string" }, "taskOffsetInDays": { "type": "integer", "format": "int32" }, "lockdownOption": { "type": "string", "enum": [ "NoEffect", "Prerequisite", "EnabledOnLockdown" ] }, "couldBeAlteredByUser": { "type": "boolean" }, "actionSequence": { "type": "integer", "format": "int32" }, "phaseSequence": { "type": "integer", "format": "int32" } }, "xml": { "name": "ProcessWorkflowDetailsDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.ReportControlDto": { "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "control": { "$ref": "#/definitions/OAS.DataModel.Reporting.ControlBase" } }, "xml": { "name": "ReportControlDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.ReportGroupDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "groupName": { "type": "string" }, "userId": { "type": "integer", "format": "int32" }, "runForEntity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entities": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.ReportGroups.ReportEntityDto" }, "xml": { "name": "ReportEntityDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ReportGroupDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.ReportGroups.ReportEntityDto": { "properties": { "entityId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "name": { "type": "string" } }, "xml": { "name": "ReportEntityDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.ReportInboxDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "openWith": { "type": "string" }, "fileName": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "description": { "type": "string" } }, "xml": { "name": "ReportInboxDto" }, "type": "object" }, "OAS.DataProcess.Reporting.ReportPackages.ReportPackageRunRequest": { "properties": { "startDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "endDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "additionalOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportOptionCategory" }, "xml": { "name": "ReportOptionCategory", "wrapped": true }, "type": "array" }, "guid": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "runFor": { "items": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "xml": { "name": "Entity", "wrapped": true }, "type": "array" }, "defaultRunFor": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "selectedReports": { "items": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "type": "array" }, "selectedEntities": { "items": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportPackages.ReportPackageSelectedEntityDto" }, "xml": { "name": "ReportPackageSelectedEntityDto", "wrapped": true }, "type": "array" }, "layout": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportPackages.ReportPackageLayoutDto" }, "formats": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportPackages.ReportPackageFormatDto" }, "selectedTheme": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "selectedCover": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "pageHeaderFooterName": { "type": "string" }, "adHocSelections": { "items": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportPackages.ReportPackageAdHocSelectionDto" }, "xml": { "name": "ReportPackageAdHocSelectionDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ReportPackageRunRequest" }, "type": "object" }, "OAS.DataProcess.Reporting.ReportPackages.ReportPackageSelectedEntityDto": { "properties": { "entity": { "type": "string", "enum": [ "Database", "BrokerDealer", "Representative", "Client", "Registration", "Account", "Asset", "Product", "AggregateModel", "DynamicGrouping", "PortfolioGroup", "UserDetail", "Prospect", "CustomGrouping" ] }, "entityId": { "type": "integer", "format": "int32" } }, "xml": { "name": "ReportPackageSelectedEntityDto" }, "type": "object" }, "OAS.DataProcess.Reporting.ReportPackages.ReportPackageLayoutDto": { "properties": { "selection": { "type": "string", "enum": [ "Letter", "Legal", "A4" ] }, "orientation": { "type": "string", "enum": [ "Portrait", "Landscape" ] }, "margins": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportPackages.ReportPackageLayoutMarginsDto" } }, "xml": { "name": "ReportPackageLayoutDto" }, "type": "object" }, "OAS.DataProcess.Reporting.ReportPackages.ReportPackageFormatDto": { "properties": { "uniform": { "type": "string" }, "usesUniform": { "type": "boolean" }, "percent": { "type": "string" }, "decimal": { "type": "string" }, "numeric": { "type": "string" }, "dollar": { "type": "string" } }, "xml": { "name": "ReportPackageFormatDto" }, "type": "object" }, "OAS.DataProcess.Reporting.ReportPackages.ReportPackageAdHocSelectionDto": { "properties": { "adhocOptionGuid": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "selectedChildGuid": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "selectedChildGuids": { "items": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "type": "array" }, "category": { "type": "string" }, "resolutionMode": { "type": "string" }, "defaultChildOptionGuid": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "defaultChildOptionGuids": { "items": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "type": "array" }, "childOptionGuids": { "items": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "type": "array" } }, "xml": { "name": "ReportPackageAdHocSelectionDto" }, "type": "object" }, "OAS.DataProcess.Reporting.ReportPackages.ReportPackageLayoutMarginsDto": { "properties": { "top": { "type": "number", "format": "double" }, "right": { "type": "number", "format": "double" }, "bottom": { "type": "number", "format": "double" }, "left": { "type": "number", "format": "double" }, "units": { "type": "string" }, "uniform": { "type": "number", "format": "double" }, "usesUniform": { "type": "boolean" } }, "xml": { "name": "ReportPackageLayoutMarginsDto" }, "type": "object" }, "OAS.DataProcess.Reporting.ReportPackages.ReportPackageAdHocSettingsRequestDto": { "properties": { "selectedReports": { "items": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "type": "array" } }, "xml": { "name": "ReportPackageAdHocSettingsRequestDto" }, "type": "object" }, "OAS.DataProcess.Reporting.ReportPackages.ReportPackageVerboseDto": { "properties": { "id": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "name": { "type": "string" }, "portfolio": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportPackages.ReportPackagePortfolioDto" }, "schema": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportPackages.ReportPackageSchemaDto" }, "loginAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportLoginAccessRuleDto" }, "xml": { "name": "ReportLoginAccessRuleDto", "wrapped": true }, "type": "array" }, "databaseGroupAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportDatabaseGroupAccessRuleDto" }, "xml": { "name": "ReportDatabaseGroupAccessRuleDto", "wrapped": true }, "type": "array" }, "databaseAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportDatabaseAccessRuleDto" }, "xml": { "name": "ReportDatabaseAccessRuleDto", "wrapped": true }, "type": "array" }, "roleAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportRoleAccessRuleDto" }, "xml": { "name": "ReportRoleAccessRuleDto", "wrapped": true }, "type": "array" }, "userAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportUserAccessRuleDto" }, "xml": { "name": "ReportUserAccessRuleDto", "wrapped": true }, "type": "array" }, "representativeAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportRepresentativeAccessRuleDto" }, "xml": { "name": "ReportRepresentativeAccessRuleDto", "wrapped": true }, "type": "array" }, "representativesClientsAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportRepresentativesClientsAccessRuleDto" }, "xml": { "name": "ReportRepresentativesClientsAccessRuleDto", "wrapped": true }, "type": "array" }, "clientAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportClientAccessRuleDto" }, "xml": { "name": "ReportClientAccessRuleDto", "wrapped": true }, "type": "array" }, "brokerDealerAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportBrokerDealerAccessRuleDto" }, "xml": { "name": "ReportBrokerDealerAccessRuleDto", "wrapped": true }, "type": "array" }, "brokerDealersRepresentativesAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportBrokerDealersRepresentativesAccessRuleDto" }, "xml": { "name": "ReportBrokerDealersRepresentativesAccessRuleDto", "wrapped": true }, "type": "array" }, "additionalOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportOptionCategory" }, "xml": { "name": "ReportOptionCategory", "wrapped": true }, "type": "array" } }, "xml": { "name": "ReportPackageVerboseDto" }, "type": "object" }, "OAS.DataProcess.Reporting.ReportPackages.ReportPackagePortfolioDto": { "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "ReportPackagePortfolioDto" }, "type": "object" }, "OAS.DataProcess.Reporting.ReportPackages.ReportPackageSchemaDto": { "properties": { "runFor": { "items": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "xml": { "name": "Entity", "wrapped": true }, "type": "array" }, "defaultRunFor": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "selectedReports": { "items": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "type": "array" }, "selectedTheme": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "selectedCover": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "layout": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportPackages.ReportPackageLayoutDto" }, "formats": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportPackages.ReportPackageFormatDto" }, "inAccessibleReports": { "items": { "type": "string" }, "type": "array" }, "pageHeaderFooterName": { "type": "string" } }, "xml": { "name": "ReportPackageSchemaDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.RunReport.RunReportDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "disclaimer": { "type": "string" }, "hasStorableParameters": { "type": "boolean" }, "hasReportDefaults": { "type": "boolean" }, "hasUserDefaults": { "type": "boolean" }, "hasEntityDefaults": { "type": "boolean" }, "showInternalOnlyWarning": { "type": "boolean" }, "layoutType": { "type": "string", "enum": [ "Standard", "Advanced" ] }, "defaultsType": { "readOnly": true, "type": "string" }, "lastRunDate": { "type": "string", "format": "date-time" }, "storable": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RunReport.RunReportCategoryDto" }, "xml": { "name": "RunReportCategoryDto", "wrapped": true }, "type": "array" }, "unstorable": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RunReport.RunReportCategoryDto" }, "xml": { "name": "RunReportCategoryDto", "wrapped": true }, "type": "array" }, "runTo": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RunReport.RunToDto" }, "entities": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RunReport.RunForDto" }, "xml": { "name": "RunForDto", "wrapped": true }, "type": "array" }, "reportName": { "type": "string" }, "reportDescription": { "type": "string" }, "parentCategory": { "type": "string" }, "category": { "type": "string" }, "runAssignedVersion": { "type": "boolean" } }, "xml": { "name": "RunReportDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.RunReport.RunReportCategoryDto": { "properties": { "category": { "type": "string" }, "parameters": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RunReport.RunReportOptionDto" }, "xml": { "name": "RunReportOptionDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "RunReportCategoryDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.RunReport.RunForDto": { "properties": { "entityId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "personalId": { "type": "integer", "format": "int32" } }, "xml": { "name": "RunForDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.RunReport.RunReportOptionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "childParameter": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "string" }, "display": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "input": { "type": "string" }, "options": { "type": "object" } }, "xml": { "name": "RunReportOptionDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.RunReport.ReportBaseDto": { "properties": { "reportName": { "type": "string" }, "reportDescription": { "type": "string" }, "parentCategory": { "type": "string" }, "category": { "type": "string" }, "runAssignedVersion": { "type": "boolean" } }, "xml": { "name": "ReportBaseDto" }, "type": "object" }, "OAS.DataModel.SimpleEntityBase": { "properties": { "name": { "type": "string" } }, "xml": { "name": "SimpleEntityBase" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.RunReport.BatchReportGenerationStatus": { "properties": { "status": { "type": "string", "enum": [ "NotGenerated", "ErroredReport", "OnHold", "Generated", "PendingGeneration", "WillNotBeGenerated" ] }, "reports": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RunReport.ReportGenerationStatus" }, "xml": { "name": "ReportGenerationStatus", "wrapped": true }, "type": "array" }, "totalReports": { "type": "integer", "format": "int32" } }, "xml": { "name": "BatchReportGenerationStatus" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.RunReport.ReportGenerationStatus": { "properties": { "runFor": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.RunReport.RunForDto" }, "status": { "type": "string", "enum": [ "NotGenerated", "ErroredReport", "OnHold", "Generated", "PendingGeneration", "WillNotBeGenerated" ] }, "location": { "type": "string" } }, "xml": { "name": "ReportGenerationStatus" }, "type": "object" }, "OAS.DataProcess.Reporting.ReportTemplates.ReportTemplateVerboseDto": { "properties": { "id": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "name": { "type": "string" }, "portfolio": { "$ref": "#/definitions/OAS.DataProcess.Reporting.ReportTemplates.ReportTemplatePortfolioDto" }, "schema": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportSchemaDto" }, "requiredOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportOption" }, "xml": { "name": "ReportOption", "wrapped": true }, "type": "array" }, "additionalOptions": { "items": { "$ref": "#/definitions/OAS.DataModel.Reporting.ReportOptionCategory" }, "xml": { "name": "ReportOptionCategory", "wrapped": true }, "type": "array" }, "loginAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportLoginAccessRuleDto" }, "xml": { "name": "ReportLoginAccessRuleDto", "wrapped": true }, "type": "array" }, "databaseGroupAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportDatabaseGroupAccessRuleDto" }, "xml": { "name": "ReportDatabaseGroupAccessRuleDto", "wrapped": true }, "type": "array" }, "databaseAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportDatabaseAccessRuleDto" }, "xml": { "name": "ReportDatabaseAccessRuleDto", "wrapped": true }, "type": "array" }, "roleAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportRoleAccessRuleDto" }, "xml": { "name": "ReportRoleAccessRuleDto", "wrapped": true }, "type": "array" }, "userAccessRules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Envision.ReportUserAccessRuleDto" }, "xml": { "name": "ReportUserAccessRuleDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ReportTemplateVerboseDto" }, "type": "object" }, "OAS.DataProcess.Reporting.ReportTemplates.ReportTemplatePortfolioDto": { "properties": { "category": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "isStandardTemplate": { "type": "boolean" }, "hasThumbnail": { "type": "boolean" }, "canEdit": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "auditedBy": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "ReportTemplatePortfolioDto" }, "type": "object" }, "OAS.DataAccess.Domains.Reporting.RequiredMinimumDistribution.RmdDetail": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "ssn": { "type": "string" }, "registrationType": { "type": "integer", "format": "int32" }, "excludeFromRmdAggregation": { "type": "boolean" }, "rmdAmount": { "type": "number", "format": "double" }, "mtdTotal": { "type": "number", "format": "double" }, "qtdTotal": { "type": "number", "format": "double" }, "ytdTotal": { "type": "number", "format": "double" }, "endOfPreviousYearAccountValue": { "type": "number", "format": "double" }, "calculatedEndOfPreviousYearAccountValue": { "type": "number", "format": "double" }, "endOfPreviousYearAccountValueIsCalculated": { "type": "boolean" }, "amtRemaining": { "type": "number", "format": "double" }, "investorAge": { "type": "number", "format": "double" }, "primaryBeneficiaryName": { "type": "string" }, "primaryBeneficiaryAge": { "type": "number", "format": "double" }, "primaryBeneficiaryRelation": { "type": "string" }, "remainingWithdrawls": { "type": "number", "format": "double" }, "onTrack": { "type": "boolean" }, "rmdEligible": { "type": "boolean" }, "irsTable": { "type": "string", "enum": [ "SingleLife", "JointLifeAndLastSurvivor", "UniformLife" ] }, "factor": { "type": "number", "format": "double" }, "rmdSatisfied": { "type": "boolean" }, "rmdSatisfiedIsCalculated": { "type": "boolean" }, "isCustodial": { "type": "boolean" }, "factorType": { "type": "integer", "format": "int32" }, "recalculated": { "type": "boolean" }, "secureActRule": { "type": "integer", "format": "int32" }, "noData": { "type": "boolean" }, "source": { "type": "string" }, "asOfDate": { "$ref": "#/definitions/OAT.Utilities.Date.IDate" }, "includeCustodialAccount": { "type": "boolean" }, "custodialAccountNumber": { "type": "string" }, "rmdOriginalAmount": { "type": "number", "format": "double" } }, "xml": { "name": "RmdDetail" }, "type": "object" }, "OAS.DataAccess.Reporting.RequiredMinimumDistribution.RmdDashboardBaseDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "accountOnTrack": { "type": "boolean" }, "registrationOnTrack": { "type": "boolean" }, "representativeId": { "type": "integer", "format": "int32" }, "representativeName": { "type": "string" }, "clientId": { "type": "integer", "format": "int32" }, "clientName": { "type": "string" }, "registrationId": { "type": "integer", "format": "int32" }, "registrationLastName": { "type": "string" }, "registrationName": { "type": "string" }, "registrationSsn": { "type": "string" }, "registrationDeceasedSsn": { "type": "string" }, "accountType": { "type": "string" }, "number": { "type": "string" }, "rmdAmount": { "type": "number", "format": "double" }, "rmdOriginalAmount": { "type": "number", "format": "double" }, "endOfPreviousYearAccountValue": { "type": "number", "format": "double" }, "calculatedEndOfPreviousYearAccountValue": { "type": "number", "format": "double" }, "endOfPreviousYearAccountValueIsCalculated": { "type": "boolean" }, "investorAge": { "type": "number", "format": "double" }, "investorAgeText": { "readOnly": true, "type": "string" }, "dateOfBirth": { "type": "string" }, "dateOfDeath": { "type": "string", "format": "date-time" }, "distributionAmountYtd": { "type": "number", "format": "double" }, "source": { "type": "string" }, "isCustodial": { "type": "boolean" }, "isEdbTenYearOverride": { "type": "boolean" }, "isNonPersonBeneficiary": { "type": "boolean" }, "isEligibleDesignatedBeneficiary": { "type": "boolean" }, "moneyMarketValue": { "type": "number", "format": "double" }, "isSoleBeneficiary": { "type": "boolean" }, "rmdSatisfiedStatus": { "type": "string", "enum": [ "RmdNotSatisfied", "RmdSatisfied", "ManuallySatisfied", "RmdSatisfiedByBuffer" ] }, "rmdRemaining": { "readOnly": true, "type": "number", "format": "double" }, "_rmdRemaining": { "type": "number", "format": "double" }, "rmdRemainingGroup": { "readOnly": true, "type": "number", "format": "double" }, "_rmdRemainingGroup": { "type": "number", "format": "double" }, "rmdRemainingGroupApplied": { "readOnly": true, "type": "number", "format": "double" }, "_rmdRemainingGroupApplied": { "type": "number", "format": "double" }, "isActive": { "type": "boolean" }, "rmdSatisfiedOverview": { "readOnly": true, "type": "string" }, "rmdRuleApplied": { "readOnly": true, "type": "string" }, "rmdSecureActRule": { "type": "string", "enum": [ "IraSpouseBeneficiary10YearsYounger", "IraTraditional", "Unknown", "DecedentPreSecureAct", "SpouseDecedentDiedBeforeRBD", "SpouseDecedentDiedAfterRBDYounger", "SpouseDecedentDiedAfterRBDOlder", "NonSpouseDecedentDiedBeforeRBD", "NonSpouseDecedentDiedAfterRBDYounger", "NonSpouseDecedentDiedAfterRBDOlder", "MinorYoungerThan31", "MinorNotYoungerThan31", "NotEligibleDesignatedBeneficiaryDeathBeforeRbd", "NonPersonDecedentDiedBeforeRBD", "NonPersonDecedentDiedAfterRBD", "ForcedEDBDiedBeforeRBD0To10Younger", "ForcedEDBDiedAfterRBD0To10Younger", "TenYearOverride", "NonEdbDeathAfter2020", "TenYearOverrideDeathBeforeRbd", "TenYearOverrideDeathAfterRbd", "NotEligibleDesignatedBeneficiaryDeathAfterRbd", "SpouseAsSoleBeneficieryButNotReachedRmdAge73", "SpouseAsSoleBeneficieryButNotReachedRmdAge75", "NonInitialInheritorBira", "PreSecureActNonSpouseDecedentDiedAfterRbd" ] }, "rmdSatisfied": { "type": "boolean" }, "manualRmdSatisfied": { "type": "boolean" }, "primaryBeneficiaryName": { "type": "string" }, "primaryBeneficiaryAge": { "type": "number", "format": "double" }, "primaryBeneficiaryAgeText": { "readOnly": true, "type": "string" }, "primaryBeneficiaryRelation": { "type": "string" }, "irsTable": { "type": "string" }, "factor": { "type": "number", "format": "double" }, "spouseIsPrimaryBeneAndMoreThan10YrsDiff": { "readOnly": true, "type": "boolean" }, "sweepCash": { "type": "number", "format": "double" }, "accountNotes": { "type": "string" }, "rmdNotes": { "type": "string" }, "custodianName": { "type": "string" }, "clientAddressLine1": { "type": "string" }, "clientAddressLine2": { "type": "string" }, "clientAddressLine3": { "type": "string" }, "clientCity": { "type": "string" }, "clientState": { "type": "string" }, "clientZip": { "type": "string" }, "regRmdSatisfied": { "type": "boolean" }, "outsideId": { "type": "string" }, "custodialAccountNumber": { "type": "string" }, "accountNumbers": { "type": "string" }, "yearOverrides": { "items": { "$ref": "#/definitions/OAS.DataAccess.Reporting.RequiredMinimumDistribution.RmdDashboardYearOverridesDto" }, "xml": { "name": "RmdDashboardYearOverridesDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "RmdDashboardBaseDto" }, "type": "object" }, "OAS.DataAccess.Reporting.RequiredMinimumDistribution.RmdDashboardYearOverridesDto": { "properties": { "year": { "type": "integer", "format": "int32" }, "value": { "type": "number", "format": "double" }, "valueAudit": { "$ref": "#/definitions/OAS.DataAccess.Reporting.RequiredMinimumDistribution.RmdDashboardYearOverrideColumnAuditDto" }, "isSatisfied": { "type": "boolean" }, "isSatisfiedAudit": { "$ref": "#/definitions/OAS.DataAccess.Reporting.RequiredMinimumDistribution.RmdDashboardYearOverrideColumnAuditDto" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "rmdNotes": { "type": "string" }, "rmdNotesAudit": { "$ref": "#/definitions/OAS.DataAccess.Reporting.RequiredMinimumDistribution.RmdDashboardYearOverrideColumnAuditDto" }, "overrideRmdAmount": { "type": "number", "format": "double" }, "overrideRmdAmountAudit": { "$ref": "#/definitions/OAS.DataAccess.Reporting.RequiredMinimumDistribution.RmdDashboardYearOverrideColumnAuditDto" } }, "xml": { "name": "RmdDashboardYearOverridesDto" }, "type": "object" }, "OAS.DataAccess.Reporting.RequiredMinimumDistribution.RmdDashboardYearOverrideColumnAuditDto": { "properties": { "editedBy": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "RmdDashboardYearOverrideColumnAuditDto" }, "type": "object" }, "OAS.DataProcess.Reporting.RequiredMinimumDistribution.CustomFieldColumn": { "properties": { "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "headerName": { "type": "string" }, "fieldName": { "type": "string" }, "value": { "type": "string" }, "type": { "type": "string" } }, "xml": { "name": "CustomFieldColumn" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.RunReport.ScrubScheduleDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "scrubScheduleName": { "type": "string" }, "alClientId": { "type": "integer", "format": "int32" }, "scrubId": { "type": "integer", "format": "int32" }, "frequency": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "lastRunDate": { "type": "string", "format": "date-time" }, "notes": { "type": "string" }, "isActive": { "type": "boolean" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "prompts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Reporting.Custom.CustomReportPromptFullDto" }, "xml": { "name": "CustomReportPromptFullDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ScrubScheduleDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.ClientPortalStaticFileDto": { "properties": { "blobType": { "type": "string", "enum": [ "ClientPortalStatic", "RmdDashboard", "RmdMailMerge", "RmdMailMergeTemplate", "BillingAuditFile", "InsightDocument" ] }, "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" }, "openWith": { "type": "string" }, "blobDesc": { "type": "string" } }, "xml": { "name": "ClientPortalStaticFileDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.VideoStatements.VideoStatementDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "videoId": { "type": "string" }, "viewableBy": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] } }, "xml": { "name": "VideoStatementDto" }, "type": "object" }, "OAS.DataModel.Reporting.Widgets.SpimDashboardAumList": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "percent": { "type": "number", "format": "double" }, "value": { "type": "number", "format": "double" } }, "xml": { "name": "SpimDashboardAumList" }, "type": "object" }, "OAS.DataModel.Reporting.Portfolio.SpimAumInsight": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "value": { "type": "number", "format": "double" } }, "xml": { "name": "SpimAumInsight" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Widgets.AccountAndSuitabilityDto": { "properties": { "account": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountDto" }, "suitability": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.RegistrationSuitabilityDto" } }, "xml": { "name": "AccountAndSuitabilityDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Widgets.AccountAndSystematicsDto": { "properties": { "account": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AccountDto" }, "systematics": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SystematicDto" }, "xml": { "name": "SystematicDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "AccountAndSystematicsDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Widgets.RepTiles.RepresentativeTileDto": { "properties": { "profileIDs": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "id": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "asOfDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "RepresentativeTileDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RepresentativeBlobDto": { "properties": { "representativeId": { "type": "integer", "format": "int32" }, "isViewable": { "type": "boolean" }, "isViewableAdvisor": { "type": "boolean" }, "isViewableRepresentative": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "id": { "type": "integer", "format": "int32" }, "openWith": { "type": "string" }, "fileName": { "type": "string" }, "blobDesc": { "type": "string" }, "blobText": { "type": "string" }, "category": { "type": "string" }, "isZip": { "type": "boolean" } }, "xml": { "name": "RepresentativeBlobDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Widgets.RepTiles.RepresentativeAumDto": { "properties": { "includeAccruedInterest": { "type": "boolean" }, "contributionTypes": { "type": "integer", "format": "int32" }, "distributionTypes": { "type": "integer", "format": "int32" }, "profileIDs": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "id": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "asOfDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "RepresentativeAumDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.StaticFileDto": { "properties": { "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" }, "openWith": { "type": "string" }, "blobDesc": { "type": "string" } }, "xml": { "name": "StaticFileDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Widgets.AssetIndexedAnnuityDto": { "properties": { "assetId": { "type": "integer", "format": "int32" }, "accountAnnuityId": { "type": "integer", "format": "int64" }, "productName": { "type": "string" }, "accountNumber": { "type": "string" }, "ticker": { "type": "string" }, "incomeValue": { "type": "number", "format": "double" }, "basisForNQ": { "type": "number", "format": "double" }, "surrenderValue": { "type": "number", "format": "double" }, "marketValue": { "type": "number", "format": "double" } }, "xml": { "name": "AssetIndexedAnnuityDto" }, "type": "object" }, "OAS.WebApi.Domains.Reporting.DashboardDataEngineController.SaveDashboardToPdfDto": { "properties": { "dashboardId": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "entityId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "notes": { "type": "string" }, "saveToClientDocs": { "type": "boolean" }, "saveWithNotes": { "type": "boolean" } }, "xml": { "name": "SaveDashboardToPdfDto" }, "type": "object" }, "OAS.WebApi.DTO.Reporting.Widgets.WidgetDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "code": { "type": "string" }, "description": { "type": "string" }, "category": { "type": "string" }, "securityCode": { "type": "string" }, "isActive": { "type": "boolean" }, "endpoint": { "type": "string" }, "endpointVerb": { "type": "string" }, "moreRoute": { "type": "string" }, "imageName": { "type": "string" }, "dashboardLevel": { "type": "integer", "format": "int32" }, "widgetParams": { "type": "string" }, "tags": { "type": "string" } }, "xml": { "name": "WidgetDto" }, "type": "object" }, "OAS.WebApi.DTO.Rollups.RollupCompareDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "rollupType": { "type": "integer", "format": "int32" }, "splitFlagName": { "type": "string" }, "notes": { "type": "string" }, "allAssets": { "type": "boolean" }, "assetIds": { "type": "string" }, "productIds": { "type": "string" }, "pricingDates": { "type": "string" }, "poApproval": { "type": "boolean" }, "qaApproval": { "type": "boolean" }, "status": { "type": "integer", "format": "int32" }, "assetsPendingRollupCount": { "type": "integer", "format": "int32" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedBy": { "type": "string" } }, "xml": { "name": "RollupCompareDto" }, "type": "object" }, "OAS.DataModel.Rollups.RollupCompareAssetValueDifference": { "properties": { "priorUnitBalance": { "type": "number", "format": "double" }, "priorNavPrice": { "type": "number", "format": "double" }, "currentUnitBalance": { "type": "number", "format": "double" }, "currentNavPrice": { "type": "number", "format": "double" }, "unitBalanceDifference": { "type": "number", "format": "double" }, "navPriceDifference": { "type": "number", "format": "double" }, "id": { "type": "integer", "format": "int32" }, "rollupCompareId": { "type": "integer", "format": "int32" }, "assetId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "notes": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "RollupCompareAssetValueDifference" }, "type": "object" }, "OAS.DataModel.Rollups.RollupCompareAssetValueChangeDifference": { "properties": { "priorStartValue": { "type": "number", "format": "double" }, "priorValueChange": { "type": "number", "format": "double" }, "priorFeeAmount": { "type": "number", "format": "double" }, "priorStartAccruedInt": { "type": "number", "format": "double" }, "priorAccruedIntChange": { "type": "number", "format": "double" }, "priorIsCashFlowDate": { "type": "boolean" }, "priorPositiveCashFlowAmount": { "type": "number", "format": "double" }, "priorNegativeCashFlowAmount": { "type": "number", "format": "double" }, "priorStartDividend": { "type": "number", "format": "double" }, "priorDividendChange": { "type": "number", "format": "double" }, "currentStartValue": { "type": "number", "format": "double" }, "currentValueChange": { "type": "number", "format": "double" }, "currentFeeAmount": { "type": "number", "format": "double" }, "currentStartAccruedInt": { "type": "number", "format": "double" }, "currentAccruedIntChange": { "type": "number", "format": "double" }, "currentIsCashFlowDate": { "type": "boolean" }, "currentPositiveCashFlowAmount": { "type": "number", "format": "double" }, "currentNegativeCashFlowAmount": { "type": "number", "format": "double" }, "currentStartDividend": { "type": "number", "format": "double" }, "currentDividendChange": { "type": "number", "format": "double" }, "startValueDifference": { "type": "number", "format": "double" }, "valueChangeDifference": { "type": "number", "format": "double" }, "feeAmountDifference": { "type": "number", "format": "double" }, "startAccruedIntDifference": { "type": "number", "format": "double" }, "accruedIntChangeDifference": { "type": "number", "format": "double" }, "positiveCashFlowAmountDifference": { "type": "number", "format": "double" }, "negativeCashFlowAmountDifference": { "type": "number", "format": "double" }, "startDividendDifference": { "type": "number", "format": "double" }, "dividendChangeDifference": { "type": "number", "format": "double" }, "id": { "type": "integer", "format": "int32" }, "rollupCompareId": { "type": "integer", "format": "int32" }, "assetId": { "type": "integer", "format": "int32" }, "asOfDate": { "type": "string", "format": "date-time" }, "notes": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "RollupCompareAssetValueChangeDifference" }, "type": "object" }, "OAS.WebApi.DTO.Scheduler.JobDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "isActive": { "type": "boolean" }, "maxRunTime": { "type": "integer", "format": "int32" }, "jobType": { "type": "string" }, "entryMethod": { "type": "string" }, "assemblyVersion": { "type": "integer", "format": "int32" }, "assemblyResolveLocation": { "type": "string" }, "appConfig": { "type": "string" }, "lastUpdated": { "type": "string", "format": "date-time" }, "adminAssemblyResolveLocation": { "type": "string" }, "enableSecurity": { "type": "boolean" }, "requireApproval": { "type": "boolean" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string" }, "updatedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "JobDto" }, "type": "object" }, "OAS.WebApi.DTO.Scheduler.JobScheduleDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "description": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "string" }, "updatedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "JobScheduleDto" }, "type": "object" }, "OAS.WebApi.DTO.Scheduler.JobResultDto": { "properties": { "detailedMessage": { "type": "string" }, "exceptionDetails": { "type": "string" }, "exceptionMessage": { "type": "string" }, "exceptionType": { "type": "string" }, "logMessage": { "type": "string" }, "shortMessage": { "type": "string" }, "status": { "type": "string", "enum": [ "Unknown", "Scheduled", "Processing", "Success", "Failed", "Rescheduled", "Hold", "Resume", "Delete", "Fail", "RunNow" ] }, "timeStamp": { "type": "string", "format": "date-time" } }, "xml": { "name": "JobResultDto" }, "type": "object" }, "OAS.WebApi.DTO.Scheduler.NotificationGroupDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "groupName": { "type": "string" }, "groupDescription": { "type": "string" } }, "xml": { "name": "NotificationGroupDto" }, "type": "object" }, "OAS.WebApi.DTO.Security.FirmContactDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "authorizedSigner": { "type": "boolean" }, "vendorContact": { "type": "boolean" }, "technicalContact": { "type": "boolean" }, "legalContact": { "type": "boolean" }, "complianceOfficer": { "type": "boolean" }, "email": { "type": "string" }, "name": { "type": "string" }, "operation": { "type": "string", "enum": [ "Delete", "Modify", "Create" ] } }, "xml": { "name": "FirmContactDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.PersonalDto": { "properties": { "salutation": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "name": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string" }, "address3": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "homePhone": { "type": "string" }, "homePhoneExt": { "type": "string" }, "fax": { "type": "string" }, "faxExt": { "type": "string" }, "pager": { "type": "string" }, "pagerExt": { "type": "string" }, "mobilePhone": { "type": "string" }, "businessPhone": { "type": "string" }, "businessPhoneExt": { "type": "string" }, "otherPhone": { "type": "string" }, "otherPhoneExt": { "type": "string" }, "email": { "type": "string" }, "reportName": { "type": "string" }, "company": { "type": "string" }, "jobTitle": { "type": "string" }, "ssN_TaxID": { "type": "string" }, "gender": { "type": "string" }, "webAddress": { "type": "string" }, "dob": { "type": "string" }, "birthDate": { "readOnly": true, "type": "string", "format": "date-time" }, "id": { "type": "integer", "format": "int32" } }, "xml": { "name": "PersonalDto" }, "type": "object" }, "OAS.WebApi.DTO.Security.PartnerAppReadDto": { "description": "Read-only DTO for Partner App list endpoint that excludes sensitive fields.", "properties": { "id": { "type": "integer", "format": "int32" }, "partnerName": { "type": "string" }, "productName": { "type": "string" }, "productDescription": { "type": "string" }, "enabled": { "type": "boolean" }, "useIPRestrictions": { "type": "boolean" }, "useCustodianRestrictions": { "type": "boolean" }, "contactName": { "type": "string" }, "contactPhone": { "type": "string" }, "contactEmail": { "type": "string" }, "supportName": { "type": "string" }, "supportPhone": { "type": "string" }, "supportEmail": { "type": "string" }, "homePageURL": { "type": "string" }, "productLogo": { "type": "string", "format": "byte" }, "termsOfService": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "learnMorePath": { "type": "string" } }, "xml": { "name": "PartnerAppReadDto" }, "type": "object" }, "OAS.WebApi.DTO.Security.PartnerAppSimpleDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "partnerName": { "type": "string" }, "productName": { "type": "string" }, "productShortDescription": { "type": "string" }, "homePageURL": { "type": "string" }, "termsOfService": { "type": "string" }, "installed": { "type": "boolean" }, "partnerAppType": { "type": "integer", "format": "int32" }, "learnMorePath": { "type": "string" }, "acceptedTOS": { "type": "boolean" }, "privilegeId": { "type": "integer", "format": "int32" } }, "xml": { "name": "PartnerAppSimpleDto" }, "type": "object" }, "OAS.WebApi.DTO.Security.PartnerAppFullReadDto": { "description": "Read-only DTO for Partner App full detail endpoint that excludes sensitive fields.", "properties": { "id": { "type": "integer", "format": "int32" }, "partnerName": { "type": "string" }, "productName": { "type": "string" }, "productDescription": { "type": "string" }, "partnerAppType": { "type": "integer", "format": "int32" }, "samlIssuer": { "type": "string" }, "scopes": { "type": "string" }, "certificateThumbprint": { "type": "string" }, "enabled": { "type": "boolean" }, "useIpRestrictions": { "type": "boolean" }, "useCustodianRestrictions": { "type": "boolean" }, "contactName": { "type": "string" }, "contactPhone": { "type": "string" }, "contactEmail": { "type": "string" }, "supportName": { "type": "string" }, "supportPhone": { "type": "string" }, "supportEmail": { "type": "string" }, "homePageURL": { "type": "string" }, "learnMorePath": { "type": "string" }, "termsOfService": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "productLogo": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.PartnerAppImageDto" }, "defaultRefreshTokenLifetime": { "type": "integer", "format": "int32" }, "ipRanges": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.PartnerAppIpRangeDto" }, "xml": { "name": "PartnerAppIpRangeDto", "wrapped": true }, "type": "array" }, "custodianRestrictions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.PartnerAppCustodianRestrictionDto" }, "xml": { "name": "PartnerAppCustodianRestrictionDto", "wrapped": true }, "type": "array" }, "urlWhitelist": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.PartnerAppUrlWhitelistDto" }, "xml": { "name": "PartnerAppUrlWhitelistDto", "wrapped": true }, "type": "array" }, "samlDomains": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.PartnerAppSamlEmailDomainDto" }, "xml": { "name": "PartnerAppSamlEmailDomainDto", "wrapped": true }, "type": "array" }, "advisors": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.PartnerAppAdvisorDto" }, "xml": { "name": "PartnerAppAdvisorDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "PartnerAppFullReadDto" }, "type": "object" }, "OAS.WebApi.DTO.Security.PartnerAppImageDto": { "properties": { "image": { "type": "string", "format": "byte" } }, "xml": { "name": "PartnerAppImageDto" }, "type": "object" }, "OAS.WebApi.DTO.Security.PartnerAppIpRangeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "startAddress": { "type": "string" }, "endAddress": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "PartnerAppIpRangeDto" }, "type": "object" }, "OAS.WebApi.DTO.Security.PartnerAppCustodianRestrictionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "PartnerAppCustodianRestrictionDto" }, "type": "object" }, "OAS.WebApi.DTO.Security.PartnerAppUrlWhitelistDto": { "properties": { "url": { "type": "string" }, "sslRequired": { "type": "boolean" } }, "xml": { "name": "PartnerAppUrlWhitelistDto" }, "type": "object" }, "OAS.WebApi.DTO.Security.PartnerAppSamlEmailDomainDto": { "properties": { "emailDomain": { "type": "string" } }, "xml": { "name": "PartnerAppSamlEmailDomainDto" }, "type": "object" }, "OAS.WebApi.DTO.Security.PartnerAppAdvisorDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "acceptedTOS": { "type": "boolean" }, "acceptedTOSUser": { "type": "string" } }, "xml": { "name": "PartnerAppAdvisorDto" }, "type": "object" }, "OAS.WebApi.DTO.Security.PartnerAndAppSimpleDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "productDescription": { "type": "string" }, "partnerName": { "type": "string" }, "productName": { "type": "string" }, "productShortDescription": { "type": "string" }, "homePageURL": { "type": "string" }, "termsOfService": { "type": "string" }, "installed": { "type": "boolean" }, "learnMorePath": { "type": "string" }, "acceptedTOS": { "type": "boolean" }, "imageName": { "type": "string" }, "appCode": { "type": "string" }, "routeUrl": { "type": "string" }, "privilegeId": { "type": "integer", "format": "int32" } }, "xml": { "name": "PartnerAndAppSimpleDto" }, "type": "object" }, "OAS.WebApi.DTO.Security.PartnerAppUpdateDto": { "description": "DTO for updating Partner App that excludes sensitive fields and audit fields.", "properties": { "id": { "type": "integer", "format": "int32" }, "partnerName": { "type": "string" }, "productName": { "type": "string" }, "productDescription": { "type": "string" }, "partnerAppType": { "type": "integer", "format": "int32", "maximum": 6, "minimum": 0 }, "samlIssuer": { "type": "string", "maxLength": 255, "minLength": 0 }, "scopes": { "type": "string", "maxLength": 1000, "minLength": 0 }, "certificateThumbprint": { "type": "string", "pattern": "^(?:0[xX])?[0-9a-fA-F]{40}$" }, "enabled": { "type": "boolean" }, "useIpRestrictions": { "type": "boolean" }, "useCustodianRestrictions": { "type": "boolean" }, "contactName": { "type": "string" }, "contactPhone": { "type": "string" }, "contactEmail": { "type": "string" }, "supportName": { "type": "string" }, "supportPhone": { "type": "string" }, "supportEmail": { "type": "string" }, "homePageURL": { "type": "string" }, "learnMorePath": { "type": "string" }, "termsOfService": { "type": "string" }, "productLogo": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.PartnerAppImageDto" }, "defaultRefreshTokenLifetime": { "type": "integer", "format": "int32" }, "ipRanges": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.PartnerAppIpRangeDto" }, "xml": { "name": "PartnerAppIpRangeDto", "wrapped": true }, "type": "array" }, "custodianRestrictions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.PartnerAppCustodianRestrictionDto" }, "xml": { "name": "PartnerAppCustodianRestrictionDto", "wrapped": true }, "type": "array" }, "urlWhitelist": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.PartnerAppUrlWhitelistDto" }, "xml": { "name": "PartnerAppUrlWhitelistDto", "wrapped": true }, "type": "array" }, "samlDomains": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.PartnerAppSamlEmailDomainDto" }, "xml": { "name": "PartnerAppSamlEmailDomainDto", "wrapped": true }, "type": "array" }, "advisors": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.PartnerAppAdvisorDto" }, "xml": { "name": "PartnerAppAdvisorDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "PartnerAppUpdateDto" }, "type": "object" }, "OAS.WebApi.DTO.Security.PartnerAppLinkDto": { "properties": { "appLinkId": { "type": "integer", "format": "int32" }, "partnerAppId": { "type": "integer", "format": "int32" }, "appCode": { "type": "string" }, "appDescription": { "type": "string" } }, "xml": { "name": "PartnerAppLinkDto" }, "type": "object" }, "OAS.WebApi.DTO.Security.PrivilegeDto": { "properties": { "loginEntityAllowedAccess": { "type": "string", "enum": [ "None", "Read", "Edit", "Delete" ] }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "code": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string", "enum": [ "Unknown", "Apps", "Records", "Actions", "Advanced", "Applinks", "FeatureFlags" ] }, "categoryName": { "type": "string" }, "availableAccessType": { "type": "string", "enum": [ "None", "Read", "Edit", "Delete" ] }, "categoryId": { "type": "integer", "format": "int32" }, "isIncludedByDefault": { "type": "boolean" }, "revokeOnLockdownType": { "type": "string", "enum": [ "None", "Billing" ] }, "alClientIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "dbLimitationAdminOverride": { "type": "boolean" }, "firmTypeExceptions": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, "xml": { "name": "PrivilegeDto" }, "type": "object" }, "OAS.WebApi.DTO.Security.PrivilegeDetailsDto": { "properties": { "loginEntities": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.PrivilegeLoginEntitiesDto" }, "xml": { "name": "PrivilegeLoginEntitiesDto", "wrapped": true }, "type": "array" }, "firmTypes": { "type": "string", "enum": [ "None", "Foundations", "Essentials", "Advantage", "OrionTradingOnly", "OrionRiskOnly", "OrionComplianceOnly", "OrionPlanningOnly", "OasLegacy" ] }, "loginEntityAllowedAccess": { "type": "string", "enum": [ "None", "Read", "Edit", "Delete" ] }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "code": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string", "enum": [ "Unknown", "Apps", "Records", "Actions", "Advanced", "Applinks", "FeatureFlags" ] }, "categoryName": { "type": "string" }, "availableAccessType": { "type": "string", "enum": [ "None", "Read", "Edit", "Delete" ] }, "categoryId": { "type": "integer", "format": "int32" }, "isIncludedByDefault": { "type": "boolean" }, "revokeOnLockdownType": { "type": "string", "enum": [ "None", "Billing" ] }, "alClientIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "dbLimitationAdminOverride": { "type": "boolean" }, "firmTypeExceptions": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, "xml": { "name": "PrivilegeDetailsDto" }, "type": "object" }, "OAS.WebApi.DTO.Security.PrivilegeLoginEntitiesDto": { "properties": { "id": { "type": "string", "enum": [ "BrokerDealer", "Wholesaler", "Representative", "Client", "RIA", "Administrator", "SubAdvisor", "ThirdPartyAdministrator", "Custodian", "PlanSponsor", "ThirdParty", "ServiceAccount", "Participant", "RepAccountManager", "Payee", "RIATable", "Cotenant" ] }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityDesc": { "type": "string" }, "isTableBased": { "type": "boolean" }, "accessType": { "type": "string", "enum": [ "None", "Read", "Edit", "Delete" ] } }, "xml": { "name": "PrivilegeLoginEntitiesDto" }, "type": "object" }, "OAS.WebApi.DTO.Security.PrivilegeHistoryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "privilegeId": { "type": "integer", "format": "int32" }, "privilegeCategory": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "code": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "integer", "format": "int32" }, "accessType": { "type": "string", "enum": [ "None", "Read", "Edit", "Delete" ] }, "firmTypes": { "type": "string", "enum": [ "None", "Foundations", "Essentials", "Advantage", "OrionTradingOnly", "OrionRiskOnly", "OrionComplianceOnly", "OrionPlanningOnly", "OasLegacy" ] }, "auditedByDisplayName": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "changeType": { "type": "string" }, "isIncludedByDefault": { "type": "boolean" }, "revokeOnLockdownType": { "type": "string", "enum": [ "None", "Billing" ] }, "dbLimitationAdminOverride": { "type": "boolean" } }, "xml": { "name": "PrivilegeHistoryDto" }, "type": "object" }, "OAS.WebApi.DTO.Security.PrivilegeAllowEntityHistoryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "privilege": { "type": "integer", "format": "int32" }, "loginEntity": { "type": "string", "enum": [ "BrokerDealer", "Wholesaler", "Representative", "Client", "RIA", "Administrator", "SubAdvisor", "ThirdPartyAdministrator", "Custodian", "PlanSponsor", "ThirdParty", "ServiceAccount", "Participant", "RepAccountManager", "Payee", "RIATable", "Cotenant" ] }, "accessType": { "type": "string", "enum": [ "None", "Read", "Edit", "Delete" ] }, "auditByDisplayName": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "changeType": { "type": "string" } }, "xml": { "name": "PrivilegeAllowEntityHistoryDto" }, "type": "object" }, "OAS.WebApi.DTO.Security.RoleDetailsDto": { "properties": { "canEdit": { "type": "boolean" }, "privileges": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.RolePrivilegeDto" }, "xml": { "name": "RolePrivilegeDto", "wrapped": true }, "type": "array" }, "defaultDashboardId": { "type": "integer", "format": "int32" }, "dashboards": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" }, "defaultPVDashboardId": { "type": "integer", "format": "int32" }, "pvDashboards": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" }, "id": { "type": "integer", "format": "int32" }, "clientName": { "type": "string" }, "name": { "type": "string" }, "loginEntityId": { "type": "string", "enum": [ "BrokerDealer", "Wholesaler", "Representative", "Client", "RIA", "Administrator", "SubAdvisor", "ThirdPartyAdministrator", "Custodian", "PlanSponsor", "ThirdParty", "ServiceAccount", "Participant", "RepAccountManager", "Payee", "RIATable", "Cotenant" ] }, "isGlobal": { "type": "boolean" }, "loginEntityDescription": { "type": "string" }, "tokenLife": { "type": "number", "format": "double" }, "assignedProfiles": { "type": "integer", "format": "int32" } }, "xml": { "name": "RoleDetailsDto" }, "type": "object" }, "OAS.WebApi.DTO.Security.RolePrivilegeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "categoryId": { "type": "integer", "format": "int32" }, "categoryName": { "type": "string" }, "availableAccessType": { "type": "string", "enum": [ "None", "Read", "Edit", "Delete" ] }, "name": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string", "enum": [ "Unknown", "Apps", "Records", "Actions", "Advanced", "Applinks", "FeatureFlags" ] }, "code": { "type": "string" }, "readIsGranted": { "type": "boolean" }, "editIsGranted": { "type": "boolean" }, "deleteIsGranted": { "type": "boolean" } }, "xml": { "name": "RolePrivilegeDto" }, "type": "object" }, "OAS.WebApi.DTO.Security.RoleDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "clientName": { "type": "string" }, "name": { "type": "string" }, "loginEntityId": { "type": "string", "enum": [ "BrokerDealer", "Wholesaler", "Representative", "Client", "RIA", "Administrator", "SubAdvisor", "ThirdPartyAdministrator", "Custodian", "PlanSponsor", "ThirdParty", "ServiceAccount", "Participant", "RepAccountManager", "Payee", "RIATable", "Cotenant" ] }, "isGlobal": { "type": "boolean" }, "loginEntityDescription": { "type": "string" }, "tokenLife": { "type": "number", "format": "double" }, "assignedProfiles": { "type": "integer", "format": "int32" } }, "xml": { "name": "RoleDto" }, "type": "object" }, "OAS.WebApi.DTO.Security.RoleUserProfileDto": { "properties": { "profileId": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "loginUserId": { "type": "string" }, "loginEntityName": { "type": "string" } }, "xml": { "name": "RoleUserProfileDto" }, "type": "object" }, "OAS.WebApi.Domains.Security.TokenController.OauthBody": { "properties": { "grant_type": { "type": "string" }, "code": { "type": "string" }, "redirect_uri": { "type": "string" }, "client_id": { "type": "string" }, "client_secret": { "type": "string" }, "useCurrentProfile": { "type": "boolean" }, "authorization": { "type": "string" }, "refresh_token": { "type": "string" } }, "xml": { "name": "OauthBody" }, "type": "object" }, "OAS.WebApi.Domains.Security.TokenController.JwtToken": { "properties": { "access_token": { "type": "string" }, "expires_in": { "type": "integer", "format": "int32" }, "refresh_token": { "type": "string" }, "error": { "type": "string" }, "two_factor_opts": { "items": { "$ref": "#/definitions/OAS.WebApi.Domains.Security.TokenController.TwoFactorCodeDeliveryOption" }, "xml": { "name": "TwoFactorCodeDeliveryOption", "wrapped": true }, "type": "array" } }, "xml": { "name": "JwtToken" }, "type": "object" }, "OAS.WebApi.Domains.Security.TokenController.TwoFactorCodeDeliveryOption": { "properties": { "type": { "type": "string", "enum": [ "Email", "Sms" ] }, "value": { "type": "string" } }, "xml": { "name": "TwoFactorCodeDeliveryOption" }, "type": "object" }, "OAS.WebApi.DTO.Security.UserInfoDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "userId": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "isActive": { "type": "boolean" }, "activeDate": { "type": "string", "format": "date-time" }, "inactiveDate": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time" }, "lastPasswordChange": { "type": "string", "format": "date-time" }, "isReset": { "type": "boolean" }, "mobilePhone": { "type": "string" }, "businessPhone": { "type": "string" }, "businessPhoneExtension": { "type": "string" }, "company": { "type": "string" }, "jobTitle": { "type": "string" }, "entityName": { "type": "string" }, "contactType": { "type": "string", "enum": [ "NotApproved", "Approved", "MainContact", "NoLongerWithFirm" ] }, "createdDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "UserInfoDto" }, "type": "object" }, "OAS.WebApi.DTO.Security.LoginActivityDto": { "properties": { "id": { "type": "string" }, "userId": { "type": "integer", "format": "int32" }, "loginDate": { "type": "string", "format": "date-time" }, "failed": { "type": "boolean" }, "failType": { "type": "string", "enum": [ "Success", "IncorrectPassword", "LockedOut", "PasswordEpired", "InactiveUser", "TwoFactorChallenge" ] } }, "xml": { "name": "LoginActivityDto" }, "type": "object" }, "OAS.WebApi.DTO.Security.ActionPasswordSetRequest": { "properties": { "newPassword": { "type": "string" }, "resetUser": { "type": "boolean" } }, "xml": { "name": "ActionPasswordSetRequest" }, "type": "object" }, "OAS.WebApi.DTO.Security.DeactivationPolicySet": { "properties": { "maxUserDeactivationPolicyDays": { "type": "integer", "format": "int32" }, "maxUserDeletionPolicyDays": { "type": "integer", "format": "int32" }, "policies": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.DeactivationPolicy" }, "xml": { "name": "DeactivationPolicy", "wrapped": true }, "type": "array" } }, "xml": { "name": "DeactivationPolicySet" }, "type": "object" }, "OAS.WebApi.DTO.Security.DeactivationPolicy": { "properties": { "firmId": { "type": "integer", "format": "int32" }, "loginEntity": { "type": "string", "enum": [ "BrokerDealer", "Wholesaler", "Representative", "Client", "RIA", "Administrator", "SubAdvisor", "ThirdPartyAdministrator", "Custodian", "PlanSponsor", "ThirdParty", "ServiceAccount", "Participant", "RepAccountManager", "Payee", "RIATable", "Cotenant" ] }, "deletion": { "type": "integer", "format": "int32" }, "deactivation": { "type": "integer", "format": "int32" }, "sortOrder": { "type": "integer", "format": "int32" }, "displayName": { "type": "string" } }, "xml": { "name": "DeactivationPolicy" }, "type": "object" }, "OAS.WebApi.DTO.Security.UserInfoDetailsValidationDto": { "properties": { "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" }, "warningMessage": { "type": "string" }, "profiles": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.ProfileDto" }, "xml": { "name": "ProfileDto", "wrapped": true }, "type": "array" }, "password": { "type": "string" }, "isSecureExchangeRecipient": { "type": "boolean" }, "partnerAppId": { "type": "integer", "format": "int32" }, "twoFactor": { "type": "boolean" }, "errorMessage": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "userId": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "isActive": { "type": "boolean" }, "activeDate": { "type": "string", "format": "date-time" }, "inactiveDate": { "type": "string", "format": "date-time" }, "lastLogin": { "type": "string", "format": "date-time" }, "lastPasswordChange": { "type": "string", "format": "date-time" }, "isReset": { "type": "boolean" }, "mobilePhone": { "type": "string" }, "businessPhone": { "type": "string" }, "businessPhoneExtension": { "type": "string" }, "company": { "type": "string" }, "jobTitle": { "type": "string" }, "entityName": { "type": "string" }, "contactType": { "type": "string", "enum": [ "NotApproved", "Approved", "MainContact", "NoLongerWithFirm" ] }, "createdDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "UserInfoDetailsValidationDto" }, "type": "object" }, "OAS.WebApi.DTO.Settings.AppOptionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "parentAppOptionId": { "type": "integer", "format": "int32" }, "category": { "type": "string" }, "displayName": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "value": { "type": "string" }, "controlType": { "type": "string" }, "canUserOverride": { "type": "boolean" } }, "xml": { "name": "AppOptionDto" }, "type": "object" }, "OAS.WebApi.DTO.Settings.AppDto": { "properties": { "appCode": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "category": { "type": "string" }, "tags": { "type": "string" }, "routeUrl": { "type": "string" }, "securityCode": { "type": "string" }, "imageName": { "type": "string" }, "color": { "type": "string" }, "isActive": { "type": "boolean" }, "ssoType": { "type": "string", "enum": [ "None", "SameTabRedirect", "Portal", "FormPost", "NewTabRedirect", "AdvisoryWorld", "ByAllRep", "Schwab", "Pershing", "GoldmanSachs" ] }, "userOptionCount": { "description": "Indicates the count of options for this App, the User can set.", "type": "integer", "format": "int32" }, "createdDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "AppDto" }, "type": "object" }, "OAS.WebApi.DTO.Settings.AppFullDto": { "properties": { "appCode": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "category": { "type": "string" }, "tags": { "type": "string" }, "routeUrl": { "type": "string" }, "securityCode": { "type": "string" }, "imageName": { "type": "string" }, "color": { "type": "string" }, "isActive": { "type": "boolean" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "ssoType": { "type": "string", "enum": [ "None", "SameTabRedirect", "Portal", "FormPost", "NewTabRedirect", "AdvisoryWorld", "ByAllRep", "Schwab", "Pershing", "GoldmanSachs" ] }, "teamId": { "type": "integer", "format": "int32" }, "parameters": { "type": "string" }, "privilegeId": { "type": "integer", "format": "int32" }, "audienceExclusion": { "type": "string", "enum": [ "None", "WorkflowAssistant" ] }, "teamInfo": { "$ref": "#/definitions/OAS.WebApi.DTO.Authorization.ServiceTeamDto" }, "options": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.AppOptionDefaultDto" }, "xml": { "name": "AppOptionDefaultDto", "wrapped": true }, "type": "array" }, "categories": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.AppCategoryDefaultDto" }, "xml": { "name": "AppCategoryDefaultDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "AppFullDto" }, "type": "object" }, "OAS.WebApi.DTO.Settings.AppOptionDefaultDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "parentAppOptionId": { "type": "integer", "format": "int32" }, "category": { "type": "string" }, "displayName": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "defaultValue": { "type": "string" }, "controlType": { "type": "string" }, "canUserOverride": { "type": "boolean" } }, "xml": { "name": "AppOptionDefaultDto" }, "type": "object" }, "OAS.WebApi.DTO.Settings.AppCategoryDefaultDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "iconName": { "type": "string" }, "sortOrder": { "type": "integer", "format": "int32" }, "audienceExclusion": { "type": "string", "enum": [ "None", "WorkflowAssistant" ] }, "pages": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.AppPageDefaultDto" }, "xml": { "name": "AppPageDefaultDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "AppCategoryDefaultDto" }, "type": "object" }, "OAS.WebApi.DTO.Settings.AppPageDefaultDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "pageCode": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "routeUrl": { "type": "string" }, "securityCode": { "type": "string" }, "includeByDefault": { "type": "boolean" }, "parameters": { "type": "string" }, "helpText": { "type": "string" }, "privilegeId": { "type": "integer", "format": "int32" }, "sortOrder": { "type": "integer", "format": "int32" }, "audienceExclusion": { "type": "string", "enum": [ "None", "WorkflowAssistant" ] } }, "xml": { "name": "AppPageDefaultDto" }, "type": "object" }, "OAS.WebApi.DTO.Settings.AppContextualLinkDto": { "properties": { "name": { "type": "string" }, "category": { "type": "string" }, "description": { "type": "string" }, "routeUrl": { "type": "string" }, "parameters": { "type": "string" } }, "xml": { "name": "AppContextualLinkDto" }, "type": "object" }, "OAS.WebApi.DTO.Settings.EntityOptionLevelDto": { "properties": { "routeName": { "type": "string" }, "displayName": { "type": "string" }, "entity": { "type": "string", "enum": [ "RiskCategories", "BrokerDealers", "Representatives", "AssetClasses", "AssetCategories", "Platforms", "Models", "AggregateModels", "IndexBlends", "FundFamilies", "Database", "Custodians", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Product", "PortfolioGroups", "SleeveStrategyAggregates", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10" ] } }, "xml": { "name": "EntityOptionLevelDto" }, "type": "object" }, "OAS.WebApi.DTO.Settings.EntityOptionDefinitionDto": { "properties": { "childParameter": { "type": "string" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityId": { "type": "integer", "format": "int32" }, "entityName": { "type": "string" }, "userDefineDefinitionId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "category": { "type": "string" }, "type": { "type": "string", "enum": [ "MultiLineEditor", "DropDownEditor", "DropDownList", "CheckBox", "Currency", "Date", "DateTime", "Integer", "String", "Double", "Time", "Long", "CustomObject", "Email" ] }, "maxLength": { "type": "integer", "format": "int32" }, "code": { "type": "string" }, "sequence": { "type": "integer", "format": "int32" }, "options": { "type": "object" }, "input": { "type": "string" }, "securityCode": { "type": "string" }, "canEdit": { "type": "boolean" } }, "xml": { "name": "EntityOptionDefinitionDto" }, "type": "object" }, "OAS.WebApi.DTO.Settings.EntityOptionValueDto": { "properties": { "input": { "type": "string" }, "type": { "type": "string", "enum": [ "MultiLineEditor", "DropDownEditor", "DropDownList", "CheckBox", "Currency", "Date", "DateTime", "Integer", "String", "Double", "Time", "Long", "CustomObject", "Email" ] }, "value": { "type": "string" } }, "xml": { "name": "EntityOptionValueDto" }, "type": "object" }, "OAS.WebApi.DTO.Settings.OptionDto": { "properties": { "fieldName": { "type": "string" }, "fieldValue": { "type": "string" }, "notes": { "type": "string" }, "systemGroup": { "type": "string" } }, "xml": { "name": "OptionDto" }, "type": "object" }, "OAS.WebApi.DTO.Settings.OwnerDto": { "properties": { "payeeId": { "type": "integer", "format": "int32" }, "billStyle": { "type": "string", "enum": [ "Advance", "Arrears" ] }, "billValueMethod": { "type": "string", "enum": [ "PeriodEndingValue", "AvgDailyBalance", "AvgMonthlyBalance" ] }, "code": { "type": "string" }, "fullName": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "addressLine3": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "workPhoneNumber": { "type": "string" }, "email": { "type": "string" }, "faxNumber": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "ownerImage": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.OwnerImageDto" }, "legalName": { "description": "Firm Legal Name", "type": "string" } }, "xml": { "name": "OwnerDto" }, "type": "object" }, "OAS.WebApi.DTO.Settings.OwnerImageDto": { "properties": { "image": { "type": "string", "format": "byte" }, "height": { "type": "number", "format": "double" }, "width": { "type": "number", "format": "double" }, "barColor": { "type": "string", "maxLength": 50, "minLength": 0 } }, "xml": { "name": "OwnerImageDto" }, "type": "object" }, "OAS.WebApi.DTO.Settings.UserDefinedFieldLevelDto": { "properties": { "routeName": { "type": "string" }, "displayName": { "type": "string" }, "entity": { "type": "string", "enum": [ "BrokerDealers", "Wholesalers", "Representatives", "Clients", "Registrations", "Accounts", "Assets", "Transactions", "Products", "FundFamilies", "ModelRanges", "PortfolioGroups" ] } }, "xml": { "name": "UserDefinedFieldLevelDto" }, "type": "object" }, "OAS.WebApi.DTO.Settings.UserDefinedDefinitionDto": { "properties": { "type": { "type": "string", "enum": [ "MultiLineEditor", "DropDownEditor", "DropDownList", "CheckBox", "Currency", "Date", "DateTime", "Integer", "String", "Double", "Time", "Long", "CustomObject", "Email" ] }, "description": { "type": "string" }, "defaultValue": { "type": "string" }, "sequence": { "type": "integer", "format": "int32" }, "code": { "type": "string" }, "category": { "type": "string" }, "customObject": { "type": "string" }, "controlProperties": { "type": "string" }, "securityCode": { "type": "string" }, "isTimeSensitive": { "type": "boolean" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "pageCodes": { "items": { "type": "string" }, "type": "array" }, "options": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.UserDefineOptionDto" }, "xml": { "name": "UserDefineOptionDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "UserDefinedDefinitionDto" }, "type": "object" }, "OAS.WebApi.DTO.Settings.UserDefineOptionDto": { "properties": { "isDefault": { "type": "boolean" }, "listValue": { "type": "string" }, "sequence": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "UserDefineOptionDto" }, "type": "object" }, "OAS.WebApi.DTO.Settings.UserDefinedTimeFieldLevelDto": { "properties": { "routeName": { "type": "string" }, "displayName": { "type": "string" }, "entity": { "type": "string", "enum": [ "Assets", "Products" ] } }, "xml": { "name": "UserDefinedTimeFieldLevelDto" }, "type": "object" }, "OAS.WebApi.DTO.Settings.UserOptionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "optionName": { "type": "string" }, "value": { "type": "string" } }, "xml": { "name": "UserOptionDto" }, "type": "object" }, "OAS.WebApi.DTO.Settings.PageViewDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "pageCode": { "type": "string" }, "filterType": { "type": "string", "enum": [ "All", "Any" ] }, "isPrivate": { "type": "boolean" }, "canEdit": { "type": "boolean" }, "isUserDefault": { "type": "boolean" }, "gridType": { "type": "string", "enum": [ "SlickGrid", "AgGrid" ] }, "agGrid": { "$ref": "#/definitions/OAS.WebApi.DTO.Code.AgGrid.Models.AgGridPageView" }, "slickGridColumnDefs": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Code.SlickGridColumnDef" }, "xml": { "name": "SlickGridColumnDef", "wrapped": true }, "type": "array" }, "filters": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.PageViewFilterDto" }, "xml": { "name": "PageViewFilterDto", "wrapped": true }, "type": "array" }, "groups": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.PageViewGroupDto" }, "xml": { "name": "PageViewGroupDto", "wrapped": true }, "type": "array" }, "sorts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.PageViewSortDto" }, "xml": { "name": "PageViewSortDto", "wrapped": true }, "type": "array" }, "dynamicGroupingInfo": { "$ref": "#/definitions/OAS.WebApi.DTO.Settings.DynamicGroupingInfo" } }, "xml": { "name": "PageViewDto" }, "type": "object" }, "OAS.WebApi.DTO.Code.AgGrid.Models.AgGridPageView": { "properties": { "colState": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Code.AgGrid.Models.ColState" }, "xml": { "name": "ColState", "wrapped": true }, "type": "array" }, "sortState": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Code.AgGrid.Models.SortState" }, "xml": { "name": "SortState", "wrapped": true }, "type": "array" }, "filterState": { "type": "object" } }, "xml": { "name": "AgGridPageView" }, "type": "object" }, "OAS.WebApi.DTO.Code.SlickGridColumnDef": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "field": { "type": "string" }, "behavior": { "type": "string" }, "cssClass": { "type": "string" }, "headerCssClass": { "type": "string" }, "width": { "type": "integer", "format": "int32" }, "resizable": { "type": "boolean" }, "selectable": { "type": "boolean" }, "visible": { "type": "boolean" }, "required": { "type": "boolean" }, "formatter": { "type": "string" }, "precision": { "type": "integer", "format": "int32" }, "editor": { "type": "string" }, "editorKeyField": { "type": "string" }, "massEditor": { "type": "string" }, "editorOptions": { "type": "string" }, "editorUrl": { "type": "string" }, "editorIncludeBlank": { "type": "boolean" }, "conditionType": { "type": "string" }, "sortOrder": { "type": "integer", "format": "int32" }, "enableEdit": { "type": "string" }, "groupTotalsFormatter": { "type": "string" }, "conditions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Code.SlickGridColumnConditions" }, "xml": { "name": "SlickGridColumnConditions", "wrapped": true }, "type": "array" } }, "xml": { "name": "SlickGridColumnDef" }, "type": "object" }, "OAS.WebApi.DTO.Settings.PageViewFilterDto": { "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "key": { "type": "string" }, "include": { "type": "boolean" } }, "xml": { "name": "PageViewFilterDto" }, "type": "object" }, "OAS.WebApi.DTO.Settings.PageViewGroupDto": { "properties": { "getter": { "type": "string" }, "formatter": { "type": "string" }, "collapsed": { "type": "boolean" }, "comparer": { "type": "string" }, "enabled": { "type": "boolean" }, "name": { "type": "string" }, "aggregators": { "items": { "type": "string" }, "type": "array" }, "aggregateCollapsed": { "type": "boolean" } }, "xml": { "name": "PageViewGroupDto" }, "type": "object" }, "OAS.WebApi.DTO.Settings.PageViewSortDto": { "properties": { "columnId": { "type": "string" }, "field": { "type": "string" }, "sortAsc": { "type": "boolean" } }, "xml": { "name": "PageViewSortDto" }, "type": "object" }, "OAS.WebApi.DTO.Settings.DynamicGroupingInfo": { "properties": { "reporting": { "type": "boolean" }, "trading": { "type": "boolean" }, "repProfileAssignment": { "type": "boolean" }, "compass": { "type": "boolean" } }, "xml": { "name": "DynamicGroupingInfo" }, "type": "object" }, "OAS.WebApi.DTO.Code.AgGrid.Models.ColState": { "properties": { "colId": { "type": "string" }, "width": { "type": "integer", "format": "int32" }, "hide": { "type": "boolean" }, "pinned": { "type": "string" }, "sort": { "type": "string" }, "sortIndex": { "type": "integer", "format": "int32" }, "aggFunc": { "type": "string" }, "rowGroup": { "type": "boolean" }, "rowGroupIndex": { "type": "integer", "format": "int32" }, "pivot": { "type": "boolean" }, "pivotIndex": { "type": "integer", "format": "int32" }, "flex": { "type": "integer", "format": "int32" }, "field": { "type": "string" }, "headerName": { "type": "string" }, "conditionType": { "type": "string" }, "filterParams": { "$ref": "#/definitions/OAS.WebApi.DTO.Code.AgGrid.Models.FilterParams" } }, "xml": { "name": "ColState" }, "type": "object" }, "OAS.WebApi.DTO.Code.AgGrid.Models.SortState": { "properties": { "colId": { "type": "string" }, "sort": { "type": "string" } }, "xml": { "name": "SortState" }, "type": "object" }, "OAS.WebApi.DTO.Code.SlickGridColumnConditions": { "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "select1": { "items": { "type": "string" }, "type": "array" } }, "xml": { "name": "SlickGridColumnConditions" }, "type": "object" }, "OAS.WebApi.DTO.Code.AgGrid.Models.FilterParams": { "properties": { "filterOptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Code.AgGrid.Models.FilterOptions" }, "xml": { "name": "FilterOptions", "wrapped": true }, "type": "array" } }, "xml": { "name": "FilterParams" }, "type": "object" }, "OAS.WebApi.DTO.Code.AgGrid.Models.FilterOptions": { "properties": { "displayKey": { "type": "string" }, "displayName": { "type": "string" }, "testFunction": { "type": "string" }, "hideFilterInput": { "readOnly": true, "type": "boolean" } }, "xml": { "name": "FilterOptions" }, "type": "object" }, "OAS.WebApi.Domains.Settings.PageCodeEntityDto": { "properties": { "displayName": { "type": "string" }, "pageCodeName": { "type": "string" } }, "xml": { "name": "PageCodeEntityDto" }, "type": "object" }, "OAS.WebApi.DTO.Settings.WebAcknowledgementDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "acknowledgementType": { "type": "string", "enum": [ "Disclaimer", "Notification" ] }, "displayOrder": { "type": "integer", "format": "int32" }, "title": { "type": "string" }, "userControlPath": { "type": "string" }, "acknowledgementText": { "type": "string" }, "acceptText": { "type": "string" }, "rejectText": { "type": "string" }, "rejectMessage": { "type": "string" }, "acceptNavigateUrl": { "type": "string" }, "buttonSet": { "type": "string", "enum": [ "None", "Confirm", "AcceptDecline", "AcceptDeclineLater" ] }, "yesButtonText": { "type": "string" }, "noButtonText": { "type": "string" }, "expiresOn": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "inputPrompt": { "type": "string" }, "entities": { "items": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "xml": { "name": "Entity", "wrapped": true }, "type": "array" } }, "xml": { "name": "WebAcknowledgementDto" }, "type": "object" }, "OAS.WebApi.DTO.Settings.WebAcknowledgementResponseDto": { "properties": { "userId": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "response": { "type": "string", "enum": [ "None", "Accept", "Decline", "Later" ] }, "responseDate": { "type": "string", "format": "date-time" }, "input": { "type": "string" } }, "xml": { "name": "WebAcknowledgementResponseDto" }, "type": "object" }, "OAS.WebApi.DTO.Settings.WebOptionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "optionType": { "type": "string", "enum": [ "StyleSheet", "SiteHeader", "WebsiteText", "ChartColor", "PageDefaults", "MobileSetting", "EProfileTemplate", "MIG_IPS", "UMAManager", "PBWorksMapping", "Reporting", "Trading", "Credentials" ] }, "fieldName": { "type": "string" }, "fieldValue": { "type": "string" }, "entityId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] } }, "xml": { "name": "WebOptionDto" }, "type": "object" }, "OAS.WebApi.DTO.Status.HangfireStatusDto": { "properties": { "activeServerCount": { "type": "integer", "format": "int32" }, "lastHeartbeat": { "type": "string", "format": "date-time" } }, "xml": { "name": "HangfireStatusDto" }, "type": "object" }, "Hangfire.Storage.Monitoring.ProcessingJobDto": { "properties": { "job": { "$ref": "#/definitions/Hangfire.Common.Job" }, "loadException": { "type": "object" }, "invocationData": { "$ref": "#/definitions/Hangfire.Storage.InvocationData" }, "inProcessingState": { "type": "boolean" }, "serverId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time" }, "stateData": { "additionalProperties": { "type": "string" }, "type": "object" } }, "xml": { "name": "ProcessingJobDto" }, "type": "object" }, "Hangfire.Common.Job": { "properties": { "type": { "readOnly": true, "type": "string" }, "method": { "$ref": "#/definitions/System.Reflection.MethodInfo", "readOnly": true }, "args": { "items": { "type": "object" }, "readOnly": true, "type": "array" }, "queue": { "readOnly": true, "type": "string" }, "arguments": { "items": { "type": "string" }, "readOnly": true, "type": "array" } }, "xml": { "name": "Job" }, "type": "object" }, "Hangfire.Storage.InvocationData": { "properties": { "type": { "readOnly": true, "type": "string" }, "method": { "readOnly": true, "type": "string" }, "parameterTypes": { "readOnly": true, "type": "string" }, "arguments": { "type": "string" }, "queue": { "readOnly": true, "type": "string" } }, "xml": { "name": "InvocationData" }, "type": "object" }, "OAS.WebApi.DTO.Theoretical.InflationRateDto": { "properties": { "asOfDate": { "type": "string", "format": "date-time" }, "annualInflationRate": { "type": "number", "format": "double" } }, "xml": { "name": "InflationRateDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.AccountTradeInfoDto": { "properties": { "isActive": { "type": "boolean" }, "accountId": { "type": "integer", "format": "int32" }, "accountValue": { "readOnly": true, "type": "number", "format": "double" }, "cashValue": { "readOnly": true, "type": "number", "format": "double" }, "cashValuePostTrade": { "type": "number", "format": "double" }, "tradeBlocked": { "type": "boolean" }, "tradingInstructions": { "type": "string" }, "model": { "type": "string" }, "modelAggId": { "type": "integer", "format": "int32" }, "minimumCashDollarAmount": { "readOnly": true, "type": "number", "format": "double" }, "minimumCashBalance": { "type": "number", "format": "double" }, "minimumCashBalanceType": { "type": "string", "enum": [ "Dollars", "Percent" ] }, "replenishMinCash": { "type": "boolean" }, "assets": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SimpleAssetWithValue" }, "xml": { "name": "SimpleAssetWithValue", "wrapped": true }, "type": "array" } }, "xml": { "name": "AccountTradeInfoDto" }, "type": "object" }, "OAS.DataModel.Trading.ContributionCodeExt": { "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int32" }, "displayValue": { "type": "string", "maxLength": 100, "minLength": 0 }, "code": { "type": "string" }, "purchaseType": { "type": "string" }, "purchaseSubType": { "type": "string" }, "isPriorYear": { "type": "boolean" }, "isIRA": { "type": "boolean" } }, "xml": { "name": "ContributionCodeExt" }, "type": "object" }, "OAS.Remote.Trading.ContributionDto": { "properties": { "pkAccount": { "type": "integer", "format": "int32" }, "amount": { "type": "number", "format": "double" }, "contribCode": { "type": "string" }, "fkContribCode": { "type": "integer", "format": "int32" } }, "xml": { "name": "ContributionDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.ConvexRebalanceAccountDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "accountCode": { "type": "string" }, "initialValue": { "type": "number", "format": "double" }, "initialFloor": { "type": "number", "format": "double" }, "currentFloor": { "type": "number", "format": "double" }, "currentRisk": { "type": "number", "format": "double" }, "lastUpdate": { "type": "string", "format": "date-time" }, "useConvexRebalance": { "type": "boolean" }, "continuumNumber": { "type": "string" }, "registrationName": { "type": "string" }, "planner": { "type": "string" }, "branchId": { "type": "string" }, "tradingInstr": { "type": "string" }, "accountValue": { "type": "number", "format": "double" }, "cushionPercent": { "type": "number", "format": "double" }, "modelAggIdSelection": { "type": "integer", "format": "int32" }, "modelAggIdAssigned": { "type": "integer", "format": "int32" }, "modelAggSelection": { "type": "string" }, "modelAggAssigned": { "type": "string" }, "drawdown": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ConvexRebalanceAccountDrawdownDto" }, "xml": { "name": "ConvexRebalanceAccountDrawdownDto", "wrapped": true }, "type": "array" }, "message": { "readOnly": true, "type": "string" } }, "xml": { "name": "ConvexRebalanceAccountDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.ConvexRebalanceAccountDrawdownDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "effectiveDate": { "type": "string", "format": "date-time" }, "factor": { "type": "number", "format": "double" }, "maxRiskPercent": { "type": "integer", "format": "int32" } }, "xml": { "name": "ConvexRebalanceAccountDrawdownDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.DistributionCodeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "extId": { "type": "integer", "format": "int32" }, "distCode": { "type": "string" }, "taxCode": { "type": "string" }, "fedCode": { "type": "string" }, "description": { "type": "string" }, "transDesc": { "type": "string" }, "distDesc": { "type": "string" }, "taxDesc": { "readOnly": true, "type": "string" }, "isValid": { "type": "boolean" }, "isQualified": { "type": "boolean" } }, "xml": { "name": "DistributionCodeDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.FixBlockOrderDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "fixBatchId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "custodianName": { "type": "string" }, "fixVersion": { "type": "string" }, "execBroker": { "type": "string" }, "clOrdId": { "type": "string" }, "handlInst": { "type": "string" }, "execInst": { "type": "string" }, "side": { "type": "string" }, "locateReqd": { "type": "boolean" }, "orderQty": { "type": "number", "format": "double" }, "orderAmt": { "type": "number", "format": "double" }, "ordType": { "type": "string" }, "limitPrice": { "type": "number", "format": "double" }, "stopPrice": { "type": "number", "format": "double" }, "timeInForce": { "type": "string" }, "expireTime": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "tradedBy": { "type": "string" }, "transactTime": { "type": "string", "format": "date-time" }, "orderId": { "type": "string" }, "ordStatus": { "type": "string" }, "cumQty": { "type": "number", "format": "double" }, "avgPrice": { "type": "number", "format": "double" }, "leavesQty": { "type": "number", "format": "double" }, "ordRejReason": { "type": "string" }, "cxlRejReason": { "type": "string" }, "allocRejCode": { "type": "string" }, "lastShares": { "type": "number", "format": "double" }, "msgSequenceNumber": { "type": "integer", "format": "int32" }, "allocId": { "type": "string" }, "refAllocId": { "type": "string" }, "allocStatus": { "type": "string" }, "lastText": { "type": "string" }, "lastTextType": { "type": "integer", "format": "int32" }, "autoAllocate": { "type": "boolean" }, "pendingOrdStatus": { "type": "string" }, "settlmntTyp": { "type": "string" }, "futSettDate": { "type": "string", "format": "date-time" }, "masterAccountNumber": { "type": "string" }, "ticker": { "type": "string" }, "cusip": { "type": "string" }, "batchName": { "type": "string" }, "shortTermGain": { "type": "number", "format": "double" }, "longTermGain": { "type": "number", "format": "double" }, "gainLossMessage": { "type": "string" }, "tradesGainLossNotCalcedCount": { "type": "integer", "format": "int32" }, "blockName": { "readOnly": true, "type": "string" }, "productName": { "type": "string" }, "needsAttention": { "type": "string" }, "productType": { "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, "tradeType": { "type": "integer", "format": "int32" }, "strikePrice": { "type": "number", "format": "double" }, "cfiCode": { "type": "string" }, "orderCapacity": { "type": "string" }, "positionEffect": { "type": "string" }, "maturityDate": { "type": "string", "format": "date-time" }, "solicited": { "type": "boolean" }, "reportBlockStatus": { "type": "string" }, "algorithmTag": { "type": "string" }, "isOpen": { "type": "boolean" }, "isClosed": { "type": "boolean" } }, "xml": { "name": "FixBlockOrderDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.FixFeeDto": { "properties": { "fixBlockOrderId": { "type": "integer", "format": "int32" }, "orderQty": { "type": "number", "format": "double" }, "regulatory": { "type": "number", "format": "double" }, "tax": { "type": "number", "format": "double" }, "localCommission": { "type": "number", "format": "double" }, "exchange": { "type": "number", "format": "double" }, "stamp": { "type": "number", "format": "double" }, "levy": { "type": "number", "format": "double" }, "other": { "type": "number", "format": "double" }, "details": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.FixFeeDetailDto" }, "xml": { "name": "FixFeeDetailDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "FixFeeDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.FixFeeDetailDto": { "properties": { "orderId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "registrationName": { "type": "string" }, "accountType": { "type": "string" }, "orderQty": { "type": "number", "format": "double" }, "regulatory": { "type": "number", "format": "double" }, "tax": { "type": "number", "format": "double" }, "localCommission": { "type": "number", "format": "double" }, "exchange": { "type": "number", "format": "double" }, "stamp": { "type": "number", "format": "double" }, "levy": { "type": "number", "format": "double" }, "other": { "type": "number", "format": "double" }, "commission": { "type": "number", "format": "double" }, "custodian": { "type": "string" } }, "xml": { "name": "FixFeeDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.UpdateBlocksInMassDto": { "properties": { "blockIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "custodianInfos": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.CustodianAlgorithmTagDto" }, "xml": { "name": "CustodianAlgorithmTagDto", "wrapped": true }, "type": "array" }, "ordType": { "type": "string" }, "settlmntTyp": { "type": "string" }, "timeInForce": { "type": "string" }, "editedBy": { "type": "string" }, "isDiscretionary": { "type": "boolean" }, "stopPrice": { "type": "number", "format": "double" }, "limitPrice": { "type": "number", "format": "double" }, "algorithmTag": { "type": "string" }, "execInst": { "type": "string" } }, "xml": { "name": "UpdateBlocksInMassDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.CustodianAlgorithmTagDto": { "properties": { "custodianId": { "type": "integer", "format": "int32" }, "algorithmTag": { "type": "string" } }, "xml": { "name": "CustodianAlgorithmTagDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.FixBlockOrderLogDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "fixBlockOrderId": { "type": "integer", "format": "int32" }, "msgType": { "type": "string" }, "logType": { "type": "integer", "format": "int32" }, "createdDate": { "type": "string", "format": "date-time" }, "blockName": { "type": "string" }, "details": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.FixBlockOrderLogDetailDto" }, "xml": { "name": "FixBlockOrderLogDetailDto", "wrapped": true }, "type": "array" }, "logText": { "type": "string" } }, "xml": { "name": "FixBlockOrderLogDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.FixBlockOrderLogDetailDto": { "properties": { "tagId": { "type": "integer", "format": "int32" }, "fixName": { "type": "string" }, "value": { "type": "string" } }, "xml": { "name": "FixBlockOrderLogDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.OrderDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "tradeIt": { "type": "boolean" }, "productId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "assetId": { "type": "integer", "format": "int32" }, "transactionId": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "fixBlockOrderId": { "type": "integer", "format": "int32" }, "hasBlock": { "readOnly": true, "type": "boolean" }, "trInstanceId": { "type": "integer", "format": "int32" }, "handlInst": { "type": "string" }, "execInst": { "type": "string" }, "side": { "type": "string" }, "optionTradeType": { "type": "string", "enum": [ "None", "CoveredCall" ] }, "optionDwnldMgrId": { "type": "integer", "format": "int32" }, "optionTRInterfaceId": { "type": "integer", "format": "int32" }, "locateReqd": { "type": "boolean" }, "ordType": { "type": "string" }, "assetClassName": { "type": "string" }, "representativeName": { "type": "string" }, "limitPrice": { "type": "number", "format": "double" }, "stopPrice": { "type": "number", "format": "double" }, "timeInForce": { "type": "string" }, "expireTime": { "type": "string", "format": "date-time" }, "warningMessage": { "type": "string" }, "orderQty": { "type": "number", "format": "double" }, "originalOrderQty": { "type": "number", "format": "double" }, "orderAmt": { "type": "number", "format": "double" }, "orderPct": { "type": "number", "format": "double" }, "sharesOwned": { "type": "number", "format": "double" }, "mktValue": { "type": "number", "format": "double" }, "navPrice": { "type": "number", "format": "double" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "notes": { "type": "string" }, "instanceNotes": { "type": "string" }, "tradeReason": { "type": "string" }, "isDiscretionary": { "type": "boolean" }, "settlmntTyp": { "type": "string" }, "futSettDate": { "type": "string", "format": "date-time" }, "rowVersion": { "type": "string", "format": "byte" }, "productName": { "type": "string" }, "ticker": { "type": "string" }, "productType": { "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, "cusip": { "type": "string" }, "accountNumber": { "type": "string" }, "batchName": { "type": "string" }, "allocStatus": { "type": "string" }, "ordStatus": { "type": "string" }, "registrationName": { "type": "string" }, "accountType": { "type": "string" }, "accountValueCurrent": { "type": "number", "format": "double" }, "cashValueCurrent": { "type": "number", "format": "double" }, "cashValuePostTrade": { "type": "number", "format": "double" }, "assetUnitsCurrent": { "type": "number", "format": "double" }, "cashValuePreTradePerc": { "type": "number", "format": "double" }, "cashValuePostTradePerc": { "type": "number", "format": "double" }, "shortTermGain": { "type": "number", "format": "double" }, "longTermGain": { "type": "number", "format": "double" }, "totalGain": { "readOnly": true, "type": "number", "format": "double" }, "daysUntilLongTerm": { "type": "integer", "format": "int32" }, "washAmount": { "type": "number", "format": "double" }, "washUnits": { "type": "number", "format": "double" }, "calculationMethod": { "type": "string" }, "gainLossMessage": { "readOnly": true, "type": "string" }, "blockName": { "readOnly": true, "type": "string" }, "custodian": { "type": "string" }, "custodianId": { "type": "integer", "format": "int32" }, "fixRouting": { "type": "string" }, "tradeToAcctPerc": { "readOnly": true, "type": "number", "format": "double" }, "application": { "type": "string", "enum": [ "Undefined", "GlobalTrade", "Modeling", "CheckReq", "FeeReq", "BuySell", "ACHReq", "EligibleTrades", "All", "CashFundADV", "CashFundSWD", "SWPDCA", "SysPurchTrade", "Distribution", "Contribution" ] }, "tradingInstructions": { "type": "string" }, "repNotes": { "type": "string" }, "clientDirected": { "type": "boolean" }, "subAdvisor": { "type": "string" }, "reinvestDividends": { "type": "boolean" }, "reinvestLTCapGains": { "type": "boolean" }, "reinvestSTCapGains": { "type": "boolean" }, "instanceDescription": { "type": "string" }, "currentModelName": { "description": "This is the model currently assigned to the account. Previously was returned by the {OAS.WebApi.DTO.Trading.OrderDto.ModelName} property.", "type": "string" }, "modelName": { "description": "This is the model assigned to the account at the time the trade was created, starting with the 8/2014 build.", "type": "string" }, "masterAccountNumber": { "type": "string" }, "managementStyle": { "type": "string" }, "groupNum": { "type": "string" }, "qualified": { "type": "boolean" }, "minCashBalanceType": { "type": "string", "enum": [ "Dollars", "Percent" ] }, "minCashBalance": { "type": "number", "format": "double" }, "replenishMinCash": { "type": "boolean" }, "swpAmount": { "type": "number", "format": "double" }, "swpFrequency": { "type": "string", "enum": [ "Monthly", "Quarterly", "Semiannually", "Annually" ] }, "nextSwpDate": { "type": "string", "format": "date-time" }, "cashNeededNext4Months": { "type": "number", "format": "double" }, "targetCashPerc": { "type": "number", "format": "double" }, "targetCash": { "readOnly": true, "type": "number", "format": "double" }, "dollarModelAmount": { "type": "number", "format": "double" }, "totalCashNeed": { "readOnly": true, "type": "number", "format": "double" }, "approvalStatus": { "type": "string", "enum": [ "Approved", "PendingApproval", "NotApproved" ] }, "nsccTradeType": { "type": "string", "enum": [ "UseDefault", "NormalPurchase", "Nav", "Roa", "Loi" ] }, "exchangeId": { "type": "integer", "format": "int32" }, "exchangeTicker": { "type": "string" }, "rebalanceLevel": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "solicited": { "type": "boolean" }, "vspDate": { "type": "string", "format": "date-time" }, "vspPrice": { "type": "number", "format": "double" }, "sellPriority": { "type": "integer", "format": "int32" }, "roaAmount": { "type": "number", "format": "double" }, "trustType": { "type": "string", "enum": [ "None", "CTC", "EAS" ] }, "assetCostCustodianId": { "type": "integer", "format": "int32" }, "cashValuePostTradeExecution": { "type": "number", "format": "double" }, "riskBudget": { "type": "integer", "format": "int32" }, "registrationSleeveStrategyName": { "type": "string" }, "hasFixLog": { "type": "boolean" }, "eclipseOrderId": { "type": "integer", "format": "int32" } }, "xml": { "name": "OrderDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.UnallocatedOrderDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "fixBlockOrderId": { "type": "integer", "format": "int32" }, "orderQty": { "type": "number", "format": "double" }, "originalOrderQty": { "type": "number", "format": "double" }, "orderAmt": { "type": "number", "format": "double" }, "sharesOwned": { "type": "number", "format": "double" }, "mktValue": { "type": "number", "format": "double" }, "rowVersion": { "type": "string", "format": "byte" }, "accountNumber": { "type": "string" }, "registrationName": { "type": "string" }, "accountType": { "type": "string" }, "cashValue": { "type": "number", "format": "double" }, "cashValuePending": { "type": "number", "format": "double" }, "assetUnits": { "type": "number", "format": "double" }, "assetUnitsPending": { "type": "number", "format": "double" } }, "xml": { "name": "UnallocatedOrderDto" }, "type": "object" }, "OAS.Remote.Trading.BuySells": { "properties": { "trades": { "items": { "$ref": "#/definitions/OAS.Remote.Trading.BuySell" }, "readOnly": true, "xml": { "name": "BuySell", "wrapped": true }, "type": "array" }, "routine": { "type": "string", "enum": [ "Undefined", "Rebalance", "GlobalTrades", "BuySell", "SellAll", "TargetPercent", "ProRated", "QuickTrade", "QuickTradeBlock", "Distribution", "OptionTrade" ] }, "scheduled": { "type": "boolean" }, "recalcInstance": { "type": "boolean" }, "scheduledRunTime": { "type": "object" }, "description": { "type": "string" }, "nsccTransactionType": { "type": "string", "enum": [ "UseDefault", "NormalPurchase", "Nav", "Roa", "Loi" ] }, "assetValues": { "type": "string", "enum": [ "UseDefault", "Current", "Pending", "PendingTransactionsAndOrders" ] }, "minTradeAmount": { "type": "number", "format": "double" }, "postProcess": { "type": "string", "enum": [ "Run", "Skip" ] }, "useProductSubstitution": { "type": "string", "enum": [ "UseDefault", "Use", "Ignore" ] }, "stfWarningDays": { "type": "integer", "format": "int32" }, "tradeInstanceID": { "type": "integer", "format": "int32" }, "includeCustodialCash": { "type": "boolean" }, "notes": { "type": "string" }, "inboxAlert": { "type": "boolean" }, "disableRealTimePrices": { "type": "boolean" }, "sessionID": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "caption": { "type": "string" }, "filename": { "type": "string" }, "runDisconnected": { "type": "boolean" }, "instanceType": { "type": "string", "enum": [ "Undefined", "GlobalTrade", "Modeling", "CheckReq", "FeeReq", "BuySell", "ACHReq", "EligibleTrades", "All", "CashFundADV", "CashFundSWD", "SWPDCA", "SysPurchTrade", "Distribution", "Contribution" ] }, "securityTicket": { "type": "string", "format": "byte" }, "commonSecurityTicket": { "type": "string", "format": "byte" }, "authToken": { "type": "string" }, "commonServer": { "type": "string" }, "databaseID": { "type": "integer", "format": "int32" }, "correlationId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "a_UserDetailId": { "type": "integer", "format": "int32" }, "i_UserDetailId": { "type": "integer", "format": "int32" } }, "xml": { "name": "BuySells" }, "type": "object" }, "OAS.Remote.Trading.BuySell": { "properties": { "accountID": { "type": "integer", "format": "int32" }, "assetIDFrom": { "type": "integer", "format": "int32" }, "assetIDTo": { "type": "integer", "format": "int32" }, "productIDFrom": { "type": "integer", "format": "int32" }, "productIDTo": { "type": "integer", "format": "int32" }, "amount": { "type": "number", "format": "double" }, "tradeType": { "type": "string", "enum": [ "Undefined", "Shares", "Dollars", "Percent" ] } }, "xml": { "name": "BuySell" }, "type": "object" }, "OAS.WebApi.Domains.Trading.Dto.GlobalTradeCountRequest": { "properties": { "fundFamilyId": { "type": "integer", "format": "int32" }, "sellProductId": { "type": "integer", "format": "int32" }, "managementStyleList": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "modelAggList": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "accountList": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, "xml": { "name": "GlobalTradeCountRequest" }, "type": "object" }, "OAS.WebApi.DTO.Trading.TradeRequestInstanceDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "tradingPlatform": { "type": "string", "enum": [ "TOM", "Eclipse" ] }, "requestType": { "type": "string", "enum": [ "Undefined", "GlobalTrade", "Modeling", "CheckReq", "FeeReq", "BuySell", "ACHReq", "EligibleTrades", "All", "CashFundADV", "CashFundSWD", "SWPDCA", "SysPurchTrade", "Distribution", "Contribution" ] }, "eclipseRequestType": { "type": "string" }, "caption": { "type": "string" }, "isReady": { "type": "boolean" }, "ordersCount": { "type": "integer", "format": "int32" }, "notes": { "type": "string" }, "errorMessage": { "type": "string" }, "executeStatus": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "entityId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "rowVersion": { "type": "string", "format": "byte" }, "hasUpdatedFees": { "type": "boolean" }, "endDate": { "type": "string", "format": "date-time" }, "downloadManagerId": { "type": "integer", "format": "int32" }, "isNewVersion": { "type": "boolean" }, "minRunDate": { "type": "string", "format": "date-time" }, "blobId": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "isEndResult": { "type": "boolean" }, "closedOrdersCount": { "type": "integer", "format": "int32" }, "openOrdersCount": { "type": "integer", "format": "int32" }, "approvalStatus": { "type": "string", "enum": [ "Approved", "PendingApproval", "NotApproved" ] } }, "xml": { "name": "TradeRequestInstanceDto" }, "type": "object" }, "OAS.Remote.Trading.TradingParameterDto": { "properties": { "parameterName": { "type": "string" }, "parameterValue": { "type": "string" }, "createdDate": { "type": "string" }, "userId": { "type": "string" }, "description": { "type": "string" } }, "xml": { "name": "TradingParameterDto" }, "type": "object" }, "OAS.DataProcess.Reporting.ModelAggsReporting.FocusPointReportingDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "modelAgg": { "type": "integer", "format": "int32" }, "oneYearUpperTolerance": { "type": "number", "format": "double" }, "oneYearLowerTolerance": { "type": "number", "format": "double" }, "threeYearUpperTolerance": { "type": "number", "format": "double" }, "threeYearLowerTolerance": { "type": "number", "format": "double" }, "fiveYearUpperTolerance": { "type": "number", "format": "double" }, "fiveYearLowerTolerance": { "type": "number", "format": "double" }, "tenYearUpperTolerance": { "type": "number", "format": "double" }, "tenYearLowerTolerance": { "type": "number", "format": "double" }, "fifteenYearUpperTolerance": { "type": "number", "format": "double" }, "fifteenYearLowerTolerance": { "type": "number", "format": "double" }, "twentyYearUpperTolerance": { "type": "number", "format": "double" }, "twentyYearLowerTolerance": { "type": "number", "format": "double" } }, "xml": { "name": "FocusPointReportingDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.ModelAggWithDetailsDto": { "properties": { "createdDate": { "type": "string", "format": "date-time" }, "entities": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelAggEntityDto" }, "xml": { "name": "ModelAggEntityDto", "wrapped": true }, "type": "array" }, "accounts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelAggAccountFullDto" }, "xml": { "name": "ModelAggAccountFullDto", "wrapped": true }, "type": "array" }, "items": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelItemFullDto" }, "xml": { "name": "ModelItemFullDto", "wrapped": true }, "type": "array" }, "productTypes": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelAggProductTypeDto" }, "xml": { "name": "ModelAggProductTypeDto", "wrapped": true }, "type": "array" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "isSystemMaintained": { "type": "boolean" }, "accountNumberSuffix": { "type": "string" }, "keepAlways": { "type": "boolean" }, "accountCount": { "type": "integer", "format": "int32" }, "value": { "type": "number", "format": "double" }, "sortOrder": { "type": "integer", "format": "int32" }, "color": { "type": "string" }, "eclipseFirmId": { "type": "integer", "format": "int32" }, "eclipseFirmIds_csv": { "type": "string" }, "modelTags": { "readOnly": true, "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "eclipseModelId": { "type": "integer", "format": "int32" }, "minimumInvestmentAmount": { "type": "number", "format": "double" }, "billFeeSchedule": { "type": "integer", "format": "int32" }, "payoutSchedule": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "entityId": { "type": "integer", "format": "int32" }, "entityEnum": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "include": { "type": "boolean" }, "owned": { "type": "boolean" }, "canMaintain": { "type": "boolean" }, "modelAggTypeId": { "type": "integer", "format": "int32" }, "modelAggType": { "type": "string" }, "riskScore": { "type": "number", "format": "double" }, "proposalEnabled": { "type": "boolean" }, "advisoryWorldModel": { "type": "boolean" }, "hasManagerFactSheet": { "type": "boolean" }, "subAdvisorId": { "type": "integer", "format": "int32" }, "subAdvisorName": { "type": "string" }, "containsCommunityModel": { "type": "boolean" }, "communityModelId": { "type": "integer", "format": "int64" }, "modelAssetType": { "type": "string" }, "modelRiskCategory": { "type": "string" }, "modelAssetClass": { "type": "string" }, "modelStrategyType": { "type": "string" }, "taxManaged": { "type": "boolean" }, "isSociallyResponsible": { "type": "boolean" }, "morningstarId": { "type": "string" }, "isAstroEnabled": { "type": "boolean" }, "syncToAstro": { "type": "boolean" }, "details": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelAggDetailDto" }, "xml": { "name": "ModelAggDetailDto", "wrapped": true }, "type": "array" }, "hasSMAModel": { "type": "boolean" }, "strategistId": { "type": "integer", "format": "int32" }, "worstReturn": { "type": "number", "format": "double" }, "averageReturn": { "type": "number", "format": "double" }, "bestReturn": { "type": "number", "format": "double" }, "associatedModelAggId": { "type": "integer", "format": "int32" }, "astroTemplate": { "type": "string" }, "portfolioOverview": { "type": "string" }, "portfolioManagementTeam": { "type": "string" }, "excludeRebalanceSleeve": { "description": "If true, then sleeved accounts assigned to this model agg will be excluded from portfolio level rebalances.\r\nThis field is intentionally not mapped in the API POST/PUT save, it is only meant to be synced from Eclipse.", "type": "boolean" }, "excludeFromComposites": { "type": "boolean" }, "eclipseModelType": { "type": "string", "enum": [ "Normal", "Unmanaged", "SelfDirected", "SMA", "Optimizer" ] }, "investmentObjectiveId": { "type": "integer", "format": "int32" }, "researchedStatus": { "type": "string" } }, "xml": { "name": "ModelAggWithDetailsDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.ModelAggEntityDto": { "properties": { "entityId": { "type": "integer", "format": "int32" }, "entityEnum": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] } }, "xml": { "name": "ModelAggEntityDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.ModelAggAccountFullDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "accountName": { "type": "string" }, "accountNumber": { "type": "string" }, "canDelete": { "type": "boolean" }, "lastRebalanced": { "type": "string", "format": "date-time" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "value": { "type": "number", "format": "double" }, "isActive": { "type": "boolean" } }, "xml": { "name": "ModelAggAccountFullDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.ModelAggProductTypeDto": { "properties": { "productTypeId": { "type": "integer", "format": "int32" } }, "xml": { "name": "ModelAggProductTypeDto" }, "type": "object" }, "OAS.DataModel.Trading.LimitedAggregateModel": { "properties": { "hasSMAModel": { "type": "boolean" }, "riskScore": { "type": "number", "format": "double" }, "minimumInvestmentAmount": { "type": "number", "format": "double" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "LimitedAggregateModel" }, "type": "object" }, "OAS.WebApi.DTO.Trading.AggregateModelCanMaintainDto": { "properties": { "owned": { "type": "boolean" }, "canMaintain": { "type": "boolean" } }, "xml": { "name": "AggregateModelCanMaintainDto" }, "type": "object" }, "OAS.DataProcess.DTO.Integration.Eclipse.EclipseModelMappingDto": { "properties": { "createdModelAggsInEclipse": { "items": { "$ref": "#/definitions/OAS.DataProcess.DTO.Integration.Eclipse.EclipseModelOrionConnectModelAggMapping" }, "xml": { "name": "EclipseModelOrionConnectModelAggMapping", "wrapped": true }, "type": "array" }, "eclipseFirmId": { "type": "integer", "format": "int32" } }, "xml": { "name": "EclipseModelMappingDto" }, "type": "object" }, "OAS.DataProcess.DTO.Integration.Eclipse.EclipseModelOrionConnectModelAggMapping": { "properties": { "modelAggId": { "type": "integer", "format": "int32" }, "eclipseModelId": { "type": "integer", "format": "int32" }, "modelAggName": { "type": "string" } }, "xml": { "name": "EclipseModelOrionConnectModelAggMapping" }, "type": "object" }, "OAS.WebApi.Domains.Trading.ModelAggsController.SimpleModelAggregation": { "properties": { "details": { "items": { "$ref": "#/definitions/OAS.WebApi.Domains.Trading.ModelAggsController.WeightedModel" }, "xml": { "name": "WeightedModel", "wrapped": true }, "type": "array" } }, "xml": { "name": "SimpleModelAggregation" }, "type": "object" }, "OAS.WebApi.Domains.Trading.ModelAggsController.WeightedModel": { "properties": { "modelId": { "type": "integer", "format": "int32" }, "weightPercent": { "type": "number", "format": "double" } }, "xml": { "name": "WeightedModel" }, "type": "object" }, "OAS.WebApi.DTO.Trading.ModelAggTypeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "ModelAggTypeDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.ModelAnalyzerResultDto": { "properties": { "modelAggId": { "type": "integer", "format": "int32" }, "modelName": { "type": "string" }, "currentCash": { "type": "number", "format": "double" }, "cashValuePostTrade": { "type": "number", "format": "double" }, "costBasis": { "type": "number", "format": "double" }, "currentValue": { "type": "number", "format": "double" }, "cashTradeAmount": { "readOnly": true, "type": "number", "format": "double" }, "productSummary": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelAnalyzerProductDto" }, "xml": { "name": "ModelAnalyzerProductDto", "wrapped": true }, "type": "array" }, "excludedSummary": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelAnalyzerExcludedDto" }, "xml": { "name": "ModelAnalyzerExcludedDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ModelAnalyzerResultDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.ModelAnalyzerProductDto": { "properties": { "ticker": { "type": "string" }, "productName": { "type": "string" }, "productId": { "type": "integer", "format": "int32" }, "currentShares": { "type": "number", "format": "double" }, "postTradeShares": { "type": "number", "format": "double" }, "tradeShares": { "type": "number", "format": "double" }, "costBasis": { "type": "number", "format": "double" }, "currentValue": { "type": "number", "format": "double" }, "postTradeValue": { "type": "number", "format": "double" }, "lastPrice": { "type": "number", "format": "double" }, "targetPercent": { "type": "number", "format": "double" }, "percentDifference": { "type": "number", "format": "double" }, "toleranceBand": { "type": "number", "format": "double" }, "currentPercent": { "type": "number", "format": "double" }, "postTradePercent": { "type": "number", "format": "double" }, "assetSummary": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelAnalyzerAssetDto" }, "xml": { "name": "ModelAnalyzerAssetDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ModelAnalyzerProductDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.ModelAnalyzerExcludedDto": { "properties": { "ticker": { "type": "string" }, "status": { "type": "string", "enum": [ "Open", "SoftClose", "HardClose", "SellOnly", "PurchaseOnly", "Exclude" ] }, "assetSummary": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelAnalyzerAssetDto" }, "xml": { "name": "ModelAnalyzerAssetDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ModelAnalyzerExcludedDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.ModelAnalyzerAssetDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "assetId": { "type": "integer", "format": "int32" }, "ticker": { "type": "string" }, "status": { "type": "string", "enum": [ "Open", "SoftClose", "HardClose", "SellOnly", "PurchaseOnly", "Exclude" ] }, "accountNumber": { "type": "string" }, "accountName": { "type": "string" }, "currentShares": { "type": "number", "format": "double" }, "tradeShares": { "readOnly": true, "type": "number", "format": "double" }, "postTradeShares": { "type": "number", "format": "double" }, "tradeAmount": { "readOnly": true, "type": "number", "format": "double" }, "currentValue": { "type": "number", "format": "double" }, "postTradeValue": { "type": "number", "format": "double" }, "postTradeShortTermGainLoss": { "type": "number", "format": "double" }, "postTradeLongTermGainLoss": { "type": "number", "format": "double" }, "ytdShortTermRealizedGainLoss": { "type": "number", "format": "double" }, "ytdLongTermRealizedGainLoss": { "type": "number", "format": "double" }, "shortTermCostBasis": { "type": "number", "format": "double" }, "longTermCostBasis": { "type": "number", "format": "double" }, "targetPercent": { "type": "number", "format": "double" }, "itemToleranceLower": { "type": "number", "format": "double" }, "toleranceBand": { "readOnly": true, "type": "number", "format": "double" }, "accountValue": { "type": "number", "format": "double" }, "isCustodialCash": { "type": "boolean" }, "isExcluded": { "type": "boolean" }, "isTradingBlocked": { "type": "boolean" }, "lastPrice": { "type": "number", "format": "double" }, "currentPercent": { "readOnly": true, "type": "number", "format": "double" }, "postTradePercent": { "readOnly": true, "type": "number", "format": "double" }, "targetValue": { "readOnly": true, "type": "number", "format": "double" }, "targetShares": { "readOnly": true, "type": "number", "format": "double" }, "percentDifference": { "readOnly": true, "type": "number", "format": "double" }, "valueDifference": { "readOnly": true, "type": "number", "format": "double" }, "sharesDifference": { "readOnly": true, "type": "number", "format": "double" } }, "xml": { "name": "ModelAnalyzerAssetDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.ModelDetailsDto": { "properties": { "modelId": { "type": "integer", "format": "int32" }, "communityModelId": { "type": "integer", "format": "int64" }, "ytdPerformance": { "type": "number", "format": "double" }, "riskScore": { "type": "number", "format": "double" }, "indexBlendId": { "type": "integer", "format": "int32" }, "modelAccounts": { "type": "integer", "format": "int32" }, "prevDayPerformance": { "type": "number", "format": "double" }, "modelName": { "type": "string" }, "strategist": { "type": "string" }, "strategistId": { "type": "integer", "format": "int32" }, "advisorFee": { "type": "number", "format": "double" }, "aum": { "type": "number", "format": "double" }, "aggregateModelId": { "type": "integer", "format": "int32" }, "riskCategory": { "type": "string" }, "assetClass": { "type": "string" } }, "xml": { "name": "ModelDetailsDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.SmaModelAccountTypeRestrictionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "category": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "string" } }, "xml": { "name": "SmaModelAccountTypeRestrictionDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.ModelDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "lastRebalanced": { "type": "string", "format": "date-time" }, "fundName": { "type": "string" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "groupNum": { "type": "string" }, "subAdvisor": { "type": "string" }, "modelNum": { "type": "integer", "format": "int32" }, "percEquity": { "type": "integer", "format": "int32" }, "modelType": { "type": "string" }, "fundList": { "type": "string" }, "modelTol": { "type": "integer", "format": "int32" }, "cashPerc": { "type": "integer", "format": "int32" }, "cashTol": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "class": { "type": "string" }, "modelCode": { "type": "string" }, "managementStyle": { "type": "string" }, "notes": { "type": "string" }, "isDynamic": { "type": "boolean" }, "custodian": { "type": "string" }, "subAdvisorId": { "type": "integer", "format": "int32" }, "communityModelId": { "type": "integer", "format": "int64" }, "useRestrictions": { "type": "boolean" }, "isSMA": { "type": "boolean" }, "assetClassId": { "type": "integer", "format": "int32" }, "riskCategoryId": { "type": "integer", "format": "int32" } }, "xml": { "name": "ModelDto" }, "type": "object" }, "OAS.WebApi.Domains.Trading.ModelsController.ModelsToValidateDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "ModelsToValidateDto" }, "type": "object" }, "OAS.WebApi.Domains.Trading.ModelsController.ValidatedModelDto": { "properties": { "modelId": { "type": "integer", "format": "int32" }, "modelName": { "type": "string" }, "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" } }, "xml": { "name": "ValidatedModelDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.ModelValueDto": { "properties": { "accountCount": { "type": "integer", "format": "int32" }, "value": { "type": "number", "format": "double" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "lastRebalanced": { "type": "string", "format": "date-time" }, "fundName": { "type": "string" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "groupNum": { "type": "string" }, "subAdvisor": { "type": "string" }, "modelNum": { "type": "integer", "format": "int32" }, "percEquity": { "type": "integer", "format": "int32" }, "modelType": { "type": "string" }, "fundList": { "type": "string" }, "modelTol": { "type": "integer", "format": "int32" }, "cashPerc": { "type": "integer", "format": "int32" }, "cashTol": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "class": { "type": "string" }, "modelCode": { "type": "string" }, "managementStyle": { "type": "string" }, "notes": { "type": "string" }, "isDynamic": { "type": "boolean" }, "custodian": { "type": "string" }, "subAdvisorId": { "type": "integer", "format": "int32" }, "communityModelId": { "type": "integer", "format": "int64" }, "useRestrictions": { "type": "boolean" }, "isSMA": { "type": "boolean" }, "assetClassId": { "type": "integer", "format": "int32" }, "riskCategoryId": { "type": "integer", "format": "int32" } }, "xml": { "name": "ModelValueDto" }, "type": "object" }, "OAS.DataModel.Trading.SimpleModel": { "properties": { "isActive": { "type": "boolean" }, "isSMA": { "type": "boolean" }, "assetClassId": { "type": "integer", "format": "int32" }, "riskCategoryId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "SimpleModel" }, "type": "object" }, "OAS.WebApi.DTO.Trading.ModelRestrictionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityType": { "type": "integer", "format": "int32" }, "modelId": { "type": "integer", "format": "int32" }, "subAdvisorDefaultId": { "type": "integer", "format": "int32" }, "entityName": { "type": "string" } }, "xml": { "name": "ModelRestrictionDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.FixTradeRequestHistoryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "tradeRequestFixId": { "type": "integer", "format": "int32" }, "tradeIt": { "type": "boolean" }, "productId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "assetId": { "type": "integer", "format": "int32" }, "transactionId": { "type": "integer", "format": "int32" }, "fixBlockOrderId": { "type": "integer", "format": "int32" }, "trInstanceId": { "type": "integer", "format": "int32" }, "handlInst": { "type": "string" }, "execInst": { "type": "string" }, "side": { "type": "string" }, "locateReqd": { "type": "boolean" }, "ordType": { "type": "string" }, "limitPrice": { "type": "number", "format": "double" }, "stopPrice": { "type": "number", "format": "double" }, "timeInForce": { "type": "string" }, "ticker": { "type": "string" }, "expireTime": { "type": "string", "format": "date-time" }, "warningMessage": { "type": "string" }, "orderQty": { "type": "number", "format": "double" }, "originalOrderQty": { "type": "number", "format": "double" }, "orderAmt": { "type": "number", "format": "double" }, "orderPct": { "type": "number", "format": "double" }, "sharesOwned": { "type": "number", "format": "double" }, "mktValue": { "type": "number", "format": "double" }, "navPrice": { "type": "number", "format": "double" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "notes": { "type": "string" }, "isDiscretionary": { "type": "boolean" }, "settlmntTyp": { "type": "string" }, "futSettDate": { "type": "string", "format": "date-time" }, "changeType": { "type": "string" }, "recalcState": { "type": "integer", "format": "int32" }, "approvalStatus": { "type": "integer", "format": "int32" }, "tradeRequestFixExchangeId": { "type": "integer", "format": "int32" }, "solicited": { "type": "boolean" }, "sellPriority": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "tradingInstructions": { "type": "string" }, "productName": { "type": "string" }, "productType": { "type": "string", "enum": [ "None", "MutualFund", "Annuity", "AdvisorOne", "StockOrETF", "Option", "Bond", "Unknown", "CD", "Index" ] }, "accountType": { "type": "string" }, "custodian": { "type": "string" }, "trustType": { "type": "string", "enum": [ "None", "CTC", "EAS" ] }, "fixRouting": { "type": "string" }, "subAdvisor": { "type": "string" }, "currentModelName": { "type": "string" }, "masterAccountNumber": { "type": "string" }, "managementStyle": { "type": "string" }, "groupNum": { "type": "string" }, "qualified": { "type": "boolean" }, "rebalanceLevel": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "representativeName": { "type": "string" }, "allocStatus": { "type": "string" }, "ordStatus": { "type": "string" }, "vspDate": { "type": "string", "format": "date-time" }, "vspPrice": { "type": "number", "format": "double" }, "minCashBalance": { "type": "number", "format": "double" }, "minCashBalanceType": { "type": "string", "enum": [ "Dollars", "Percent" ] }, "replenishMinCash": { "type": "boolean" }, "assetCostCustodianId": { "type": "integer", "format": "int32" }, "cashValuePostTradeExecution": { "type": "number", "format": "double" }, "registrationSleeveStrategyName": { "type": "string" } }, "xml": { "name": "FixTradeRequestHistoryDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.CustodianOnlyCostBasisLotDto": { "properties": { "acquiredDate": { "type": "string", "format": "date-time" }, "assetId": { "type": "integer", "format": "int32" }, "assetCostCustodianId": { "type": "integer", "format": "int32" }, "type": { "type": "string", "enum": [ "Sell", "Buy", "WashSale", "NotUsed", "MoneyMarket", "StepUp", "Spinoff" ] }, "productName": { "type": "string" }, "description": { "type": "string" }, "symbol": { "type": "string" }, "costBasisPerUnit": { "type": "number", "format": "double" }, "valuePrice": { "type": "number", "format": "double" }, "units": { "type": "number", "format": "double" }, "avaiableUnits": { "type": "number", "format": "double" }, "currentValue": { "type": "number", "format": "double" }, "costBasis": { "type": "number", "format": "double" }, "gainLoss": { "type": "number", "format": "double" }, "gainLossPercent": { "type": "number", "format": "double" }, "selectedLots": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SelectedLotsDto" }, "xml": { "name": "SelectedLotsDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "CustodianOnlyCostBasisLotDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.SelectedLotsDto": { "properties": { "acquiredDate": { "type": "string", "format": "date-time" }, "assetCostCustodianId": { "type": "integer", "format": "int32" }, "assetId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "symbol": { "type": "string" }, "costBasisPerUnit": { "type": "number", "format": "double" }, "units": { "type": "number", "format": "double" } }, "xml": { "name": "SelectedLotsDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.FixIncomeTradeOrderListDto": { "properties": { "fixTradeRequestId": { "type": "integer", "format": "int32" }, "fixIncomeTradeOrdersInfos": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.FixIncomeTradeOrdersInfoDto" }, "xml": { "name": "FixIncomeTradeOrdersInfoDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "FixIncomeTradeOrderListDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.FixIncomeTradeOrdersInfoDto": { "properties": { "fixTradeRequestId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "ticker": { "type": "string" }, "price": { "type": "number", "format": "double" }, "orderQty": { "type": "number", "format": "double" } }, "xml": { "name": "FixIncomeTradeOrdersInfoDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.CreateBlocksDto": { "properties": { "batchId": { "type": "integer", "format": "int32" }, "orderIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, "xml": { "name": "CreateBlocksDto" }, "type": "object" }, "OAS.Remote.Trading.OptionTrades": { "properties": { "trades": { "items": { "$ref": "#/definitions/OAS.Remote.Trading.OptionTrade" }, "readOnly": true, "xml": { "name": "OptionTrade", "wrapped": true }, "type": "array" }, "routine": { "type": "string", "enum": [ "Undefined", "Rebalance", "GlobalTrades", "BuySell", "SellAll", "TargetPercent", "ProRated", "QuickTrade", "QuickTradeBlock", "Distribution", "OptionTrade" ] }, "scheduled": { "type": "boolean" }, "recalcInstance": { "type": "boolean" }, "scheduledRunTime": { "type": "object" }, "description": { "type": "string" }, "nsccTransactionType": { "type": "string", "enum": [ "UseDefault", "NormalPurchase", "Nav", "Roa", "Loi" ] }, "assetValues": { "type": "string", "enum": [ "UseDefault", "Current", "Pending", "PendingTransactionsAndOrders" ] }, "minTradeAmount": { "type": "number", "format": "double" }, "postProcess": { "type": "string", "enum": [ "Run", "Skip" ] }, "useProductSubstitution": { "type": "string", "enum": [ "UseDefault", "Use", "Ignore" ] }, "stfWarningDays": { "type": "integer", "format": "int32" }, "tradeInstanceID": { "type": "integer", "format": "int32" }, "includeCustodialCash": { "type": "boolean" }, "notes": { "type": "string" }, "inboxAlert": { "type": "boolean" }, "disableRealTimePrices": { "type": "boolean" }, "sessionID": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "caption": { "type": "string" }, "filename": { "type": "string" }, "runDisconnected": { "type": "boolean" }, "instanceType": { "type": "string", "enum": [ "Undefined", "GlobalTrade", "Modeling", "CheckReq", "FeeReq", "BuySell", "ACHReq", "EligibleTrades", "All", "CashFundADV", "CashFundSWD", "SWPDCA", "SysPurchTrade", "Distribution", "Contribution" ] }, "securityTicket": { "type": "string", "format": "byte" }, "commonSecurityTicket": { "type": "string", "format": "byte" }, "authToken": { "type": "string" }, "commonServer": { "type": "string" }, "databaseID": { "type": "integer", "format": "int32" }, "correlationId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "a_UserDetailId": { "type": "integer", "format": "int32" }, "i_UserDetailId": { "type": "integer", "format": "int32" } }, "xml": { "name": "OptionTrades" }, "type": "object" }, "OAS.Remote.Trading.OptionTrade": { "properties": { "tradeRequestFixId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "masterAccountNumber": { "type": "string" }, "tradeInterfaceId": { "type": "integer", "format": "int32" }, "side": { "type": "string" }, "discretionary": { "type": "boolean" }, "solicited": { "type": "boolean" }, "symbol": { "type": "string" }, "quantity": { "type": "number", "format": "double" }, "expiration": { "type": "string", "format": "date-time" }, "callOrPut": { "type": "string" }, "openOrClose": { "type": "string" }, "strikePrice": { "type": "number", "format": "double" } }, "xml": { "name": "OptionTrade" }, "type": "object" }, "OAS.WebApi.DTO.Trading.ActionDeleteDto": { "properties": { "deletedIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "updatedItems": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OrderDto" }, "xml": { "name": "OrderDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ActionDeleteDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.FixMutualFundsNotSentDto": { "properties": { "custodian": { "type": "string" }, "side": { "type": "string" }, "numberOrders": { "type": "integer", "format": "int32" }, "dollarAmount": { "type": "number", "format": "double" }, "ids": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, "xml": { "name": "FixMutualFundsNotSentDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.OutsideTradingFirmAndCustodiansDto": { "properties": { "firm": { "type": "string" }, "custodians": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OutsideTradingCustodiansDto" }, "xml": { "name": "OutsideTradingCustodiansDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "OutsideTradingFirmAndCustodiansDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.OutsideTradingCustodiansDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "custodianCode": { "type": "string" }, "name": { "type": "string" }, "blockAcctNumber": { "type": "string" } }, "xml": { "name": "OutsideTradingCustodiansDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.ClientAndCustodiansDto": { "properties": { "clientId": { "type": "integer", "format": "int32" }, "custodians": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ClientCustodiansDto" }, "xml": { "name": "ClientCustodiansDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ClientAndCustodiansDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.ClientCustodiansDto": { "properties": { "code": { "type": "string" }, "custodianId": { "type": "integer", "format": "int32" } }, "xml": { "name": "ClientCustodiansDto" }, "type": "object" }, "OAS.DataModel.Trading.OutsideTradingPositionsAndAllocations": { "properties": { "householdId": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "custodialAcctNumber": { "type": "string" }, "reason": { "type": "string", "enum": [ "Undefined", "Add", "Withdraw", "SwdFunding", "NeedReview", "SwpDca", "Withdraw100Pct" ] }, "dollarAmount": { "type": "number", "format": "double" }, "positions": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.OutsideTradingPositions" }, "xml": { "name": "OutsideTradingPositions", "wrapped": true }, "type": "array" }, "allocations": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.OutsideTradingModelAllocations" }, "xml": { "name": "OutsideTradingModelAllocations", "wrapped": true }, "type": "array" } }, "xml": { "name": "OutsideTradingPositionsAndAllocations" }, "type": "object" }, "OAS.DataModel.Trading.OutsideTradingPositions": { "properties": { "ticker": { "type": "string" }, "shares": { "type": "number", "format": "double" } }, "xml": { "name": "OutsideTradingPositions" }, "type": "object" }, "OAS.DataModel.Trading.OutsideTradingModelAllocations": { "properties": { "ticker": { "type": "string" }, "targetPercent": { "type": "number", "format": "double" }, "upperTolerance": { "type": "number", "format": "double" }, "lowerTolerance": { "type": "number", "format": "double" } }, "xml": { "name": "OutsideTradingModelAllocations" }, "type": "object" }, "OAS.WebApi.DTO.Trading.OutsideTradingRebalancedAccountDto": { "properties": { "householdId": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "acctNumber": { "type": "string" }, "estPostTradeCashValue": { "type": "number", "format": "double" }, "orders": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OutsideTradingOrdersDto" }, "xml": { "name": "OutsideTradingOrdersDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "OutsideTradingRebalancedAccountDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.OutsideTradingOrdersDto": { "properties": { "orderId": { "type": "integer", "format": "int32" }, "side": { "type": "string" }, "ticker": { "type": "string" }, "shares": { "type": "number", "format": "double" }, "dollars": { "type": "number", "format": "double" }, "estPositionValuePostTrade": { "type": "number", "format": "double" }, "tradeIt": { "type": "boolean" }, "warningMessage": { "type": "string" } }, "xml": { "name": "OutsideTradingOrdersDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.OutsideTradingTradeFileDto": { "properties": { "householdId": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "tradeFile": { "type": "string", "format": "byte" }, "filename": { "type": "string" }, "displayName": { "type": "string" } }, "xml": { "name": "OutsideTradingTradeFileDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.OutsideTradingAdditionalCustodians": { "properties": { "householdId": { "type": "integer", "format": "int32" }, "custodians": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.OutsideTradingCustodiansDto" }, "xml": { "name": "OutsideTradingCustodiansDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "OutsideTradingAdditionalCustodians" }, "type": "object" }, "OAS.WebApi.DTO.Trading.OutsideTradingUpdateBlockAccountNumberDto": { "properties": { "householdId": { "type": "integer", "format": "int32" }, "custodianId": { "type": "integer", "format": "int32" }, "blockAccountNumber": { "type": "string" } }, "xml": { "name": "OutsideTradingUpdateBlockAccountNumberDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.OverlayRestrictionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "overlayId": { "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityName": { "type": "string" }, "validationMessage": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "OverlayRestrictionDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.OverlayDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "overlayGlobalId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "isActive": { "type": "boolean" }, "useRestrictions": { "type": "boolean" }, "restrictionCount": { "type": "integer", "format": "int32" }, "auditedByDisplay": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "OverlayDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.PendAccountDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "tradeDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "PendAccountDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.PingDto": { "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "duration": { "readOnly": true, "type": "string" }, "messages": { "items": { "type": "string" }, "type": "array" } }, "xml": { "name": "PingDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.FundFamilyOverrideDTO": { "properties": { "fundFamiliesOverriden": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.FundFamilyOverride" }, "xml": { "name": "FundFamilyOverride", "wrapped": true }, "type": "array" }, "isAlternativeSymColumnShown": { "type": "boolean" } }, "xml": { "name": "FundFamilyOverrideDTO" }, "type": "object" }, "OAS.WebApi.DTO.Trading.FundFamilyOverride": { "properties": { "fundFamilyId": { "type": "integer", "format": "int32" }, "fundFamilyName": { "type": "string" }, "productId": { "type": "integer", "format": "int32" }, "tradeTicker": { "type": "string" }, "altProductId": { "type": "integer", "format": "int32" }, "altProductName": { "type": "string" }, "altTicker": { "type": "string" } }, "xml": { "name": "FundFamilyOverride" }, "type": "object" }, "OAS.WebApi.DTO.Trading.TradeQueueDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "statusIcon": { "readOnly": true, "type": "string" }, "status": { "type": "string", "enum": [ "Complete", "Pending", "Failed", "Disabled", "Duplicate", "Processing", "Manual" ] }, "registrationId": { "type": "integer", "format": "int32" }, "accountName": { "type": "string" }, "accountNumber": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "sleeveDescription": { "type": "string" }, "triggerEvent": { "type": "string" }, "holdUntil": { "type": "string", "format": "date-time" }, "currentValue": { "type": "number", "format": "double" }, "tradedDate": { "type": "string", "format": "date-time" }, "autoTradeType": { "type": "string", "enum": [ "None", "RegistrationRebalance", "SleeveRebalance", "ContributionAllocation", "TransferInRebalance" ] }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "unitBalanceScale": { "type": "integer", "format": "int32" }, "priority": { "type": "integer", "format": "int32" }, "notes": { "type": "string" }, "tradeRequestInstanceId": { "type": "integer", "format": "int32" }, "tradeDefinition": { "type": "string" }, "accountType": { "type": "string" } }, "xml": { "name": "TradeQueueDto" }, "type": "object" }, "OAS.WebApi.Domains.Trading.Dto.QuoddUserRegistrationDto": { "properties": { "first_name": { "type": "string" }, "last_name": { "type": "string" }, "address_line_1": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "is_self_employed": { "type": "boolean" }, "title": { "type": "string" }, "employer_name": { "type": "string" }, "employer_city": { "type": "string" }, "employer_state": { "type": "string" }, "employer_zip": { "type": "string" }, "employer_country": { "type": "string" }, "employee_function": { "type": "string" }, "employer_address": { "type": "string" } }, "xml": { "name": "QuoddUserRegistrationDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.QuoddSigningTokenDto": { "properties": { "canSign": { "type": "boolean" }, "token": { "type": "string" }, "hasAlreadySigned": { "type": "boolean" } }, "xml": { "name": "QuoddSigningTokenDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.RebalanceLogDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "trInstanceId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "logText": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "correlationId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "machineName": { "type": "string" }, "duration": { "type": "string" } }, "xml": { "name": "RebalanceLogDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.SimpleRebalanceLogDto": { "properties": { "createdDate": { "type": "string", "format": "date-time" }, "accountId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "SimpleRebalanceLogDto" }, "type": "object" }, "System.Web.Http.OData.Query.ODataQueryOptionsOfOAS.WebApi.DTO.Trading.AccountSleeveDto": { "properties": { "ifMatch": { "readOnly": true, "type": "object" }, "ifNoneMatch": { "readOnly": true, "type": "object" }, "context": { "$ref": "#/definitions/System.Web.Http.OData.ODataQueryContext", "readOnly": true }, "request": { "readOnly": true, "type": "object" }, "rawValues": { "$ref": "#/definitions/System.Web.Http.OData.Query.ODataRawQueryOptions", "readOnly": true }, "selectExpand": { "$ref": "#/definitions/System.Web.Http.OData.Query.SelectExpandQueryOption", "readOnly": true }, "filter": { "$ref": "#/definitions/System.Web.Http.OData.Query.FilterQueryOption", "readOnly": true }, "orderBy": { "$ref": "#/definitions/System.Web.Http.OData.Query.OrderByQueryOption", "readOnly": true }, "skip": { "$ref": "#/definitions/System.Web.Http.OData.Query.SkipQueryOption", "readOnly": true }, "top": { "$ref": "#/definitions/System.Web.Http.OData.Query.TopQueryOption", "readOnly": true }, "inlineCount": { "$ref": "#/definitions/System.Web.Http.OData.Query.InlineCountQueryOption", "readOnly": true }, "validator": { "$ref": "#/definitions/System.Web.Http.OData.Query.Validators.ODataQueryValidator" } }, "xml": { "name": "ODataQueryOptions`1" }, "type": "object" }, "OAS.WebApi.DTO.Trading.AccountSleeveDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "sleeveDescription": { "type": "string" }, "targetAllocation": { "type": "number", "format": "double" }, "currentAllocation": { "type": "number", "format": "double" }, "currentValue": { "type": "number", "format": "double" }, "contributionAllocation": { "type": "number", "format": "double" }, "distributionAllocation": { "type": "number", "format": "double" }, "corporateActionAllocation": { "type": "number", "format": "double" }, "toleranceUpper": { "type": "number", "format": "double" }, "toleranceLower": { "type": "number", "format": "double" }, "sleeveType": { "type": "string", "enum": [ "Normal sleeve", "Custodial account", "Contribution sleeve", "Distribution sleeve", "Unmanaged sleeve" ] }, "modelAgg": { "type": "string" }, "managementStyle": { "type": "string" }, "subAdvisor": { "type": "string" }, "modelType": { "type": "string" }, "registrationId": { "type": "integer", "format": "int32" }, "subAdvisorId": { "type": "integer", "format": "int32" }, "modelAggId": { "type": "integer", "format": "int32" }, "managementStyleId": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "targetBalanceType": { "type": "string", "enum": [ "Dollars", "Percent" ] }, "doNotTrade": { "type": "boolean" }, "riskScore": { "type": "number", "format": "double" }, "regValue": { "type": "number", "format": "double" }, "isCustomized": { "type": "boolean" }, "sleeveStrategyDetailId": { "type": "integer", "format": "int32" }, "sleeveStrategyId": { "type": "integer", "format": "int32" }, "sleeveStrategy": { "type": "string" }, "sleeveStrategyToleranceUpper": { "type": "number", "format": "double" }, "sleeveStrategyToleranceLower": { "type": "number", "format": "double" }, "modelAggExcludeRebalanceSleeve": { "type": "boolean" }, "businessLine": { "type": "string" }, "unitBalanceScale": { "type": "string" }, "assets": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetDto" }, "xml": { "name": "AssetDto", "wrapped": true }, "type": "array" }, "categoryAllocations": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.AccountSleeveAssetCategoryAllocationsDto" }, "readOnly": true, "xml": { "name": "AccountSleeveAssetCategoryAllocationsDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "AccountSleeveDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.AccountSleeveAssetCategoryAllocationsDto": { "properties": { "category": { "type": "string" }, "value": { "type": "number", "format": "double" }, "percent": { "type": "number", "format": "double" } }, "xml": { "name": "AccountSleeveAssetCategoryAllocationsDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.AccountSleeveHistoryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "changeType": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "modelAggId": { "type": "integer", "format": "int32" }, "modelName": { "type": "string" }, "targetAllocation": { "type": "number", "format": "double" }, "contributionAllocation": { "type": "number", "format": "double" }, "distributionAllocation": { "type": "number", "format": "double" }, "corporateActionAllocation": { "type": "number", "format": "double" }, "toleranceUpper": { "type": "number", "format": "double" }, "toleranceLower": { "type": "number", "format": "double" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "sleeveType": { "type": "string", "enum": [ "Normal sleeve", "Custodial account", "Contribution sleeve", "Distribution sleeve", "Unmanaged sleeve" ] }, "autoTradeTypes": { "type": "string", "enum": [ "None", "RegistrationRebalance", "SleeveRebalance", "ContributionAllocation", "TransferInRebalance" ] }, "autoTradeRequested": { "type": "string", "format": "date-time" }, "autoTradeRequestedBy": { "type": "string" }, "autoTradeProcessed": { "type": "string", "format": "date-time" }, "suspendAutoContribUntil": { "type": "string", "format": "date-time" }, "targetBalanceType": { "type": "string", "enum": [ "Dollars", "Percent" ] }, "doNotTrade": { "type": "boolean" }, "sleeveStrategyToleranceUpper": { "type": "number", "format": "double" }, "sleeveStrategyToleranceLower": { "type": "number", "format": "double" } }, "xml": { "name": "AccountSleeveHistoryDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.AgingCashBalancesDto": { "properties": { "status": { "readOnly": true, "type": "string" }, "lastZeroBalanceDate": { "type": "string", "format": "date-time" }, "minTransactionDateSinceZeroBalance": { "readOnly": true, "type": "string", "format": "date-time" }, "ageInDays": { "readOnly": true, "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "sleeveDescription": { "type": "string" }, "targetAllocation": { "type": "number", "format": "double" }, "currentAllocation": { "type": "number", "format": "double" }, "currentValue": { "type": "number", "format": "double" }, "contributionAllocation": { "type": "number", "format": "double" }, "distributionAllocation": { "type": "number", "format": "double" }, "corporateActionAllocation": { "type": "number", "format": "double" }, "toleranceUpper": { "type": "number", "format": "double" }, "toleranceLower": { "type": "number", "format": "double" }, "sleeveType": { "type": "string", "enum": [ "Normal sleeve", "Custodial account", "Contribution sleeve", "Distribution sleeve", "Unmanaged sleeve" ] }, "modelAgg": { "type": "string" }, "managementStyle": { "type": "string" }, "subAdvisor": { "type": "string" }, "modelType": { "type": "string" }, "registrationId": { "type": "integer", "format": "int32" }, "subAdvisorId": { "type": "integer", "format": "int32" }, "modelAggId": { "type": "integer", "format": "int32" }, "managementStyleId": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "targetBalanceType": { "type": "string", "enum": [ "Dollars", "Percent" ] }, "doNotTrade": { "type": "boolean" }, "riskScore": { "type": "number", "format": "double" }, "regValue": { "type": "number", "format": "double" }, "isCustomized": { "type": "boolean" }, "sleeveStrategyDetailId": { "type": "integer", "format": "int32" }, "sleeveStrategyId": { "type": "integer", "format": "int32" }, "sleeveStrategy": { "type": "string" }, "sleeveStrategyToleranceUpper": { "type": "number", "format": "double" }, "sleeveStrategyToleranceLower": { "type": "number", "format": "double" }, "modelAggExcludeRebalanceSleeve": { "type": "boolean" }, "businessLine": { "type": "string" }, "unitBalanceScale": { "type": "string" }, "assets": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetDto" }, "xml": { "name": "AssetDto", "wrapped": true }, "type": "array" }, "categoryAllocations": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.AccountSleeveAssetCategoryAllocationsDto" }, "readOnly": true, "xml": { "name": "AccountSleeveAssetCategoryAllocationsDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "AgingCashBalancesDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.SleeveActionTransferDto": { "properties": { "assetIdOut": { "type": "integer", "format": "int32" }, "accountIdIn": { "type": "integer", "format": "int32" }, "sharesToTransfer": { "type": "number", "format": "double" }, "asOfDate": { "type": "string", "format": "date-time" }, "notBilled": { "type": "boolean" } }, "xml": { "name": "SleeveActionTransferDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.RegistrationSleeveDto": { "properties": { "registrationId": { "type": "integer", "format": "int32" }, "sleeveStrategyAggId": { "type": "integer", "format": "int32" }, "sleeveStrategyId": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "isDoNotTrade": { "type": "boolean" }, "custodialAccountNumber": { "type": "string" }, "asOfDate": { "type": "string", "format": "date-time" }, "eclipseFirmId": { "type": "integer", "format": "int32" }, "tolerancePercent": { "type": "number", "format": "double" }, "aggregateRiskScore": { "type": "number", "format": "double" }, "registrationRiskTolerance": { "type": "integer", "format": "int32" }, "contributionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "distributionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "corporateActionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "autoRebalFrequency": { "type": "string", "enum": [ "None", "Monthly", "Quarterly", "Semiannual", "Annual" ] }, "autoRebalMonth": { "type": "integer", "format": "int32" }, "autoRebalDay": { "type": "integer", "format": "int32" }, "mandate": { "type": "boolean" }, "needsUpdate": { "type": "boolean" }, "needsUpdateReason": { "type": "string" } }, "xml": { "name": "RegistrationSleeveDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.RegistrationCheckDto": { "description": "A DTO used to inform the front-end of any issues pertaining to a given Registration.", "properties": { "promptToSplit": { "description": "If , causes the front-end to prompt the user\r\n\"Would you like to create separate registrations for each account so it can be sleeved?\"", "type": "boolean" }, "message": { "description": "The message to display to the user relating to the error or warning.", "type": "string" }, "id": { "description": "The ID of the Registration being validated.", "type": "integer", "format": "int32" }, "regName": { "description": "The name of the Registration being validated.", "type": "string" }, "isError": { "description": "When set to , the user is not able to process the sleeves.", "type": "boolean" }, "isWarning": { "type": "boolean" }, "alwaysLoadSleeves": { "description": "When {OAS.WebApi.DTO.Trading.RegistrationCheckDto.AlwaysLoadSleeves} and {OAS.WebApi.DTO.Trading.RegistrationCheckDto.IsError} are both the\r\nfront-end should always load any sleeves associated with the Registration.", "type": "boolean" }, "sleeveStrategyAggId": { "description": "The ID of the Sleeve Strategy Agg being assigned to the Registration.", "type": "integer", "format": "int32" }, "sleeveStrategyAggName": { "description": "The name of the Sleeve Strategy Agg being assigned to the Registration.", "type": "string" } }, "xml": { "name": "RegistrationCheckDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.RegistrationSleeveFullDto": { "properties": { "accountSleeves": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.AccountSleeveProcessDto" }, "xml": { "name": "AccountSleeveProcessDto", "wrapped": true }, "type": "array" }, "custodialBilling": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveCustodialAcctBillingDto" }, "sleeveBilling": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveNormalAcctBillingDto" }, "excludedAssets": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "includedAssets": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "deletedSleeveTargets": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.DeletedSleeveTargetDto" }, "xml": { "name": "DeletedSleeveTargetDto", "wrapped": true }, "type": "array" }, "clientId": { "type": "integer", "format": "int32" }, "isPendingAccount": { "type": "boolean" }, "registrationId": { "type": "integer", "format": "int32" }, "sleeveStrategyAggId": { "type": "integer", "format": "int32" }, "sleeveStrategyId": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "isDoNotTrade": { "type": "boolean" }, "custodialAccountNumber": { "type": "string" }, "asOfDate": { "type": "string", "format": "date-time" }, "eclipseFirmId": { "type": "integer", "format": "int32" }, "tolerancePercent": { "type": "number", "format": "double" }, "aggregateRiskScore": { "type": "number", "format": "double" }, "registrationRiskTolerance": { "type": "integer", "format": "int32" }, "contributionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "distributionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "corporateActionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "autoRebalFrequency": { "type": "string", "enum": [ "None", "Monthly", "Quarterly", "Semiannual", "Annual" ] }, "autoRebalMonth": { "type": "integer", "format": "int32" }, "autoRebalDay": { "type": "integer", "format": "int32" }, "mandate": { "type": "boolean" }, "needsUpdate": { "type": "boolean" }, "needsUpdateReason": { "type": "string" } }, "xml": { "name": "RegistrationSleeveFullDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.AccountSleeveProcessDto": { "properties": { "modelAllocations": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ModelItemFullDto" }, "xml": { "name": "ModelItemFullDto", "wrapped": true }, "type": "array" }, "sweepAssetId": { "type": "integer", "format": "int32" }, "custodialBilling": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveCustodialAcctBillingDto" }, "sleeveBilling": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveNormalAcctBillingDto" }, "minimumCash": { "type": "number", "format": "double" }, "replenishMinCash": { "type": "boolean" }, "substitutes": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.AggregateModelSubstituteDto" }, "xml": { "name": "AggregateModelSubstituteDto", "wrapped": true }, "type": "array" }, "hasSMAModel": { "type": "boolean" }, "modelAggType": { "type": "string", "enum": [ "Normal", "CustomIndex", "SelfDirected" ] }, "minimumInvestmentAmount": { "type": "number", "format": "double" }, "createdFromOciProcess": { "type": "boolean" }, "accountId": { "type": "integer", "format": "int32" }, "sleeveDescription": { "type": "string" }, "targetAllocation": { "type": "number", "format": "double" }, "currentAllocation": { "type": "number", "format": "double" }, "currentValue": { "type": "number", "format": "double" }, "contributionAllocation": { "type": "number", "format": "double" }, "distributionAllocation": { "type": "number", "format": "double" }, "corporateActionAllocation": { "type": "number", "format": "double" }, "toleranceUpper": { "type": "number", "format": "double" }, "toleranceLower": { "type": "number", "format": "double" }, "sleeveType": { "type": "string", "enum": [ "Normal sleeve", "Custodial account", "Contribution sleeve", "Distribution sleeve", "Unmanaged sleeve" ] }, "modelAgg": { "type": "string" }, "managementStyle": { "type": "string" }, "subAdvisor": { "type": "string" }, "modelType": { "type": "string" }, "registrationId": { "type": "integer", "format": "int32" }, "subAdvisorId": { "type": "integer", "format": "int32" }, "modelAggId": { "type": "integer", "format": "int32" }, "managementStyleId": { "type": "integer", "format": "int32" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "targetBalanceType": { "type": "string", "enum": [ "Dollars", "Percent" ] }, "doNotTrade": { "type": "boolean" }, "riskScore": { "type": "number", "format": "double" }, "regValue": { "type": "number", "format": "double" }, "isCustomized": { "type": "boolean" }, "sleeveStrategyDetailId": { "type": "integer", "format": "int32" }, "sleeveStrategyId": { "type": "integer", "format": "int32" }, "sleeveStrategy": { "type": "string" }, "sleeveStrategyToleranceUpper": { "type": "number", "format": "double" }, "sleeveStrategyToleranceLower": { "type": "number", "format": "double" }, "modelAggExcludeRebalanceSleeve": { "type": "boolean" }, "businessLine": { "type": "string" }, "unitBalanceScale": { "type": "string" }, "assets": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.AssetDto" }, "xml": { "name": "AssetDto", "wrapped": true }, "type": "array" }, "categoryAllocations": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.AccountSleeveAssetCategoryAllocationsDto" }, "readOnly": true, "xml": { "name": "AccountSleeveAssetCategoryAllocationsDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "AccountSleeveProcessDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.SleeveCustodialAcctBillingDto": { "properties": { "billFeeScheduleId": { "type": "integer", "format": "int32" }, "billFeeScheduleName": { "type": "string" }, "billMasterPayoutScheduleId": { "type": "integer", "format": "int32" }, "billMasterPayoutScheduleName": { "type": "string" }, "recurringAdjustments": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BillRecurrentAdjustmentDto" }, "xml": { "name": "BillRecurrentAdjustmentDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "SleeveCustodialAcctBillingDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.SleeveNormalAcctBillingDto": { "properties": { "billFeeScheduleId": { "type": "integer", "format": "int32" }, "billFeeScheduleName": { "type": "string" }, "billMasterPayoutScheduleId": { "type": "integer", "format": "int32" }, "billMasterPayoutScheduleName": { "type": "string" }, "recurringAdjustments": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.BillRecurrentAdjustmentDto" }, "xml": { "name": "BillRecurrentAdjustmentDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "SleeveNormalAcctBillingDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.DeletedSleeveTargetDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "deletedModelId": { "type": "integer", "format": "int32" }, "targetModelId": { "type": "integer", "format": "int32" } }, "xml": { "name": "DeletedSleeveTargetDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.AggregateModelSubstituteDto": { "properties": { "sleeveStrategyDetailId": { "type": "integer", "format": "int32" }, "sleeveStrategyId": { "type": "integer", "format": "int32" }, "aggregateModelId": { "type": "integer", "format": "int32" }, "modelAggName": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "isSubstitute": { "type": "boolean" } }, "xml": { "name": "AggregateModelSubstituteDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.RegistrationSleeveFullValidationDto": { "properties": { "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" }, "rebalanceType": { "type": "string", "enum": [ "None", "RegistrationRebalance", "SleeveRebalance", "ContributionAllocation", "TransferInRebalance" ] }, "accountSleeves": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.AccountSleeveProcessDto" }, "xml": { "name": "AccountSleeveProcessDto", "wrapped": true }, "type": "array" }, "custodialBilling": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveCustodialAcctBillingDto" }, "sleeveBilling": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveNormalAcctBillingDto" }, "excludedAssets": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "includedAssets": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "deletedSleeveTargets": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.DeletedSleeveTargetDto" }, "xml": { "name": "DeletedSleeveTargetDto", "wrapped": true }, "type": "array" }, "clientId": { "type": "integer", "format": "int32" }, "isPendingAccount": { "type": "boolean" }, "registrationId": { "type": "integer", "format": "int32" }, "sleeveStrategyAggId": { "type": "integer", "format": "int32" }, "sleeveStrategyId": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "isDoNotTrade": { "type": "boolean" }, "custodialAccountNumber": { "type": "string" }, "asOfDate": { "type": "string", "format": "date-time" }, "eclipseFirmId": { "type": "integer", "format": "int32" }, "tolerancePercent": { "type": "number", "format": "double" }, "aggregateRiskScore": { "type": "number", "format": "double" }, "registrationRiskTolerance": { "type": "integer", "format": "int32" }, "contributionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "distributionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "corporateActionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "autoRebalFrequency": { "type": "string", "enum": [ "None", "Monthly", "Quarterly", "Semiannual", "Annual" ] }, "autoRebalMonth": { "type": "integer", "format": "int32" }, "autoRebalDay": { "type": "integer", "format": "int32" }, "mandate": { "type": "boolean" }, "needsUpdate": { "type": "boolean" }, "needsUpdateReason": { "type": "string" } }, "xml": { "name": "RegistrationSleeveFullValidationDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.CarsonProcessSleevesDto": { "properties": { "registrationId": { "type": "integer", "format": "int32" }, "accounts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.CarsonProcessAccount" }, "xml": { "name": "CarsonProcessAccount", "wrapped": true }, "type": "array" }, "systematic": { "$ref": "#/definitions/OAS.WebApi.DTO.Portfolio.SystematicDto" } }, "xml": { "name": "CarsonProcessSleevesDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.CarsonProcessAccount": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "feeScheduleId": { "type": "integer", "format": "int32" }, "masterPayoutScheduleId": { "type": "integer", "format": "int32" }, "managementStyleId": { "type": "integer", "format": "int32" }, "modelAggId": { "type": "integer", "format": "int32" }, "aumType": { "type": "string" }, "businessType": { "type": "string" }, "secMgrNum": { "type": "string" }, "modelType": { "type": "string" } }, "xml": { "name": "CarsonProcessAccount" }, "type": "object" }, "OAS.WebApi.DTO.Trading.UpcomingSwpDataDto": { "properties": { "custodialAccountNumbers": { "items": { "type": "string" }, "type": "array" }, "upcomingSWP": { "type": "boolean" } }, "xml": { "name": "UpcomingSwpDataDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.RegistrationSleeveHistoryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "changeType": { "type": "string" }, "registrationId": { "type": "integer", "format": "int32" }, "sleeveStrategyId": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "isDoNotTrade": { "type": "boolean" }, "custodialAccountNumber": { "type": "string" }, "contributionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "distributionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "corporateActionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "autoRebalFrequency": { "type": "string", "enum": [ "None", "Monthly", "Quarterly", "Semiannual", "Annual" ] }, "autoRebalMonth": { "type": "integer", "format": "int32" }, "autoRebalDay": { "type": "integer", "format": "int32" }, "mandate": { "type": "boolean" }, "tolerancePercent": { "type": "number", "format": "double" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "RegistrationSleeveHistoryDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.RiskGuardrailValidationConfiguration": { "properties": { "aggregateRiskScore": { "type": "number", "format": "double" }, "clientRiskProfile": { "type": "integer", "format": "int32" }, "guardrailType": { "type": "string", "enum": [ "None", "SoftStop", "HardStop" ] }, "message": { "type": "string" } }, "xml": { "name": "RiskGuardrailValidationConfiguration" }, "type": "object" }, "OAS.WebApi.DTO.Trading.RiskGuardrailValidationResponse": { "properties": { "successful": { "type": "boolean" }, "message": { "type": "string" } }, "xml": { "name": "RiskGuardrailValidationResponse" }, "type": "object" }, "OAS.WebApi.DTO.Trading.RegistrationSleeveIsDoNotTradeDto": { "properties": { "registrationId": { "type": "integer", "format": "int32" }, "isDoNotTrade": { "type": "boolean" } }, "xml": { "name": "RegistrationSleeveIsDoNotTradeDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.RegistrationTradingInstructionsDto": { "properties": { "registrationId": { "type": "integer", "format": "int32" }, "tradingInstructions": { "type": "string" } }, "xml": { "name": "RegistrationTradingInstructionsDto" }, "type": "object" }, "OAS.WebApi.Domains.Trading.Sleeve.SleeveRegistrationResponseDto": { "properties": { "IsSuccess": { "type": "boolean" }, "StatusMessage": { "type": "string" }, "RowsUpdated": { "type": "integer", "format": "int32" }, "AccountsUpdated": { "type": "integer", "format": "int32" } }, "xml": { "name": "SleeveRegistrationResponseDto" }, "type": "object" }, "System.Web.Http.OData.Query.ODataQueryOptionsOfOAS.WebApi.DTO.Trading.SleeveStrategyElementDto": { "properties": { "ifMatch": { "readOnly": true, "type": "object" }, "ifNoneMatch": { "readOnly": true, "type": "object" }, "context": { "$ref": "#/definitions/System.Web.Http.OData.ODataQueryContext", "readOnly": true }, "request": { "readOnly": true, "type": "object" }, "rawValues": { "$ref": "#/definitions/System.Web.Http.OData.Query.ODataRawQueryOptions", "readOnly": true }, "selectExpand": { "$ref": "#/definitions/System.Web.Http.OData.Query.SelectExpandQueryOption", "readOnly": true }, "filter": { "$ref": "#/definitions/System.Web.Http.OData.Query.FilterQueryOption", "readOnly": true }, "orderBy": { "$ref": "#/definitions/System.Web.Http.OData.Query.OrderByQueryOption", "readOnly": true }, "skip": { "$ref": "#/definitions/System.Web.Http.OData.Query.SkipQueryOption", "readOnly": true }, "top": { "$ref": "#/definitions/System.Web.Http.OData.Query.TopQueryOption", "readOnly": true }, "inlineCount": { "$ref": "#/definitions/System.Web.Http.OData.Query.InlineCountQueryOption", "readOnly": true }, "validator": { "$ref": "#/definitions/System.Web.Http.OData.Query.Validators.ODataQueryValidator" } }, "xml": { "name": "ODataQueryOptions`1" }, "type": "object" }, "OAS.DataProcess.DTO.OData.QueryPaginatedResponse": { "properties": { "total": { "readOnly": true, "type": "integer", "format": "int64" }, "data": { "readOnly": true, "type": "object" }, "agg": { "type": "object" } }, "xml": { "name": "QueryPaginatedResponse" }, "type": "object" }, "OAS.WebApi.DTO.Trading.SleeveStrategyDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "firmId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "contributionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "distributionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "autoRebalFreq": { "type": "string", "enum": [ "None", "Monthly", "Quarterly", "Semiannual", "Annual" ] }, "autoRebalMonth": { "type": "integer", "format": "int32" }, "autoRebalDay": { "type": "integer", "format": "int32" }, "mandate": { "type": "boolean" }, "entityId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "riskScore": { "type": "number", "format": "double" }, "originalRiskScore": { "type": "number", "format": "double" }, "sleeveStrategyRiskTypeId": { "type": "integer", "format": "int32" }, "tolerancePercent": { "type": "number", "format": "double" }, "hasAssignedRegistrations": { "type": "boolean" }, "include": { "type": "boolean" }, "useRestrictions": { "type": "boolean" }, "assetLevelAllowed": { "type": "string", "enum": [ "Default", "AssetCategory", "AssetClass", "RiskCategory" ] }, "owned": { "type": "boolean" }, "investmentObjectiveId": { "type": "integer", "format": "int32" }, "entities": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyEntityDto" }, "xml": { "name": "SleeveStrategyEntityDto", "wrapped": true }, "type": "array" }, "assetLevelsAllowed": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyAssetLevelAllowedDto" }, "xml": { "name": "SleeveStrategyAssetLevelAllowedDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "SleeveStrategyDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.SleeveStrategyEntityDto": { "properties": { "entityId": { "type": "integer", "format": "int32" }, "entityEnum": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] } }, "xml": { "name": "SleeveStrategyEntityDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.SleeveStrategyAssetLevelAllowedDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "sleeveStrategyId": { "type": "integer", "format": "int32" }, "assetLevelType": { "type": "string", "enum": [ "Default", "AssetCategory", "AssetClass", "RiskCategory" ] }, "assetLevelId": { "type": "integer", "format": "int32" } }, "xml": { "name": "SleeveStrategyAssetLevelAllowedDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.SleeveStrategyWithDetailsDto": { "properties": { "details": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyDetailDto" }, "xml": { "name": "SleeveStrategyDetailDto", "wrapped": true }, "type": "array" }, "deletedSleeveTargets": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.DeletedSleeveTargetDto" }, "xml": { "name": "DeletedSleeveTargetDto", "wrapped": true }, "type": "array" }, "id": { "type": "integer", "format": "int32" }, "firmId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "contributionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "distributionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "autoRebalFreq": { "type": "string", "enum": [ "None", "Monthly", "Quarterly", "Semiannual", "Annual" ] }, "autoRebalMonth": { "type": "integer", "format": "int32" }, "autoRebalDay": { "type": "integer", "format": "int32" }, "mandate": { "type": "boolean" }, "entityId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "riskScore": { "type": "number", "format": "double" }, "originalRiskScore": { "type": "number", "format": "double" }, "sleeveStrategyRiskTypeId": { "type": "integer", "format": "int32" }, "tolerancePercent": { "type": "number", "format": "double" }, "hasAssignedRegistrations": { "type": "boolean" }, "include": { "type": "boolean" }, "useRestrictions": { "type": "boolean" }, "assetLevelAllowed": { "type": "string", "enum": [ "Default", "AssetCategory", "AssetClass", "RiskCategory" ] }, "owned": { "type": "boolean" }, "investmentObjectiveId": { "type": "integer", "format": "int32" }, "entities": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyEntityDto" }, "xml": { "name": "SleeveStrategyEntityDto", "wrapped": true }, "type": "array" }, "assetLevelsAllowed": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyAssetLevelAllowedDto" }, "xml": { "name": "SleeveStrategyAssetLevelAllowedDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "SleeveStrategyWithDetailsDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.SleeveStrategyDetailDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "sleeveStrategyId": { "type": "integer", "format": "int32" }, "aggregateModelId": { "type": "integer", "format": "int32" }, "managementStyleId": { "type": "integer", "format": "int32" }, "subAdvisorId": { "type": "integer", "format": "int32" }, "targetAllocation": { "type": "number", "format": "double" }, "contributionAllocation": { "type": "number", "format": "double" }, "distributionAllocation": { "type": "number", "format": "double" }, "toleranceUpper": { "type": "number", "format": "double" }, "toleranceLower": { "type": "number", "format": "double" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "sleeveType": { "type": "string", "enum": [ "Normal sleeve", "Custodial account", "Contribution sleeve", "Distribution sleeve", "Unmanaged sleeve" ] }, "autoTradeTypes": { "type": "string", "enum": [ "None", "RegistrationRebalance", "SleeveRebalance", "ContributionAllocation", "TransferInRebalance" ] }, "aggregateName": { "type": "string" }, "doNotTrade": { "type": "boolean" }, "managementStyleName": { "type": "string" }, "subAdvisorName": { "type": "string" }, "aggregateModelType": { "type": "string" }, "aggregateModelTypeId": { "type": "integer", "format": "int32" }, "riskScore": { "type": "number", "format": "double" }, "minimumInvestmentAmount": { "type": "number", "format": "double" }, "aggregateExcludeRebalanceSleeve": { "type": "boolean" }, "substitutes": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.AggregateModelSubstituteDto" }, "xml": { "name": "AggregateModelSubstituteDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "SleeveStrategyDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.SleeveStrategyElementDetailDto": { "description": "Used by element to get the sleeve strategy detail data", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "aggregateModelType": { "type": "string" }, "inception": { "type": "number", "format": "double" }, "oneYr": { "type": "number", "format": "double" }, "threeYr": { "type": "number", "format": "double" }, "fiveYr": { "type": "number", "format": "double" }, "riskScore": { "type": "number", "format": "double" }, "allocation": { "type": "number", "format": "double" }, "subAdvisorId": { "type": "integer", "format": "int32" }, "subAdvisor": { "type": "string" } }, "xml": { "name": "SleeveStrategyElementDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Portfolio.RegistrationSimpleDto": { "properties": { "currentValue": { "type": "number", "format": "double" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "RegistrationSimpleDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.SleeveStrategyVerboseDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "core": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyCoreDto" }, "mandates": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyMandateDto" }, "xml": { "name": "SleeveStrategyMandateDto", "wrapped": true }, "type": "array" }, "riskType": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyRiskTypeDto" }, "details": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyDetailDto" }, "xml": { "name": "SleeveStrategyDetailDto", "wrapped": true }, "type": "array" }, "entities": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyEntityDto" }, "xml": { "name": "SleeveStrategyEntityDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "SleeveStrategyVerboseDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.SleeveStrategyCoreDto": { "properties": { "name": { "type": "string" }, "contributionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "distributionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "autoRebalFreq": { "type": "string", "enum": [ "None", "Monthly", "Quarterly", "Semiannual", "Annual" ] }, "autoRebalMonth": { "type": "integer", "format": "int32" }, "autoRebalDay": { "type": "integer", "format": "int32" }, "riskScore": { "type": "number", "format": "double" }, "originalRiskScore": { "type": "number", "format": "double" }, "sleeveStrategyRiskTypeId": { "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "strategyType": { "type": "string", "enum": [ "Undefined", "Single", "Multi" ] }, "beta": { "type": "number", "format": "double" }, "alpha": { "type": "number", "format": "double" }, "rSquared": { "type": "number", "format": "double" }, "drawdown": { "type": "number", "format": "double" }, "ytd": { "type": "number", "format": "double" }, "oneYr": { "type": "number", "format": "double" }, "threeYr": { "type": "number", "format": "double" }, "fiveYr": { "type": "number", "format": "double" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "include": { "type": "boolean" }, "useRestrictions": { "type": "boolean" }, "investmentObjectiveId": { "type": "integer", "format": "int32" } }, "xml": { "name": "SleeveStrategyCoreDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.SleeveStrategyMandateDto": { "properties": { "sleeveStrategyId": { "type": "integer", "format": "int32" }, "modelAggTypeId": { "type": "integer", "format": "int32" }, "modelAggTypeName": { "type": "string" }, "riskScore": { "type": "number", "format": "double" }, "allocation": { "type": "number", "format": "double" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "SleeveStrategyMandateDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.SleeveStrategyRiskTypeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "lowerLimit": { "type": "number", "format": "double" }, "upperLimit": { "type": "number", "format": "double" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "isPtModel": { "type": "boolean" }, "riskTypeAllocations": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyRiskTypeAllocationDto" }, "xml": { "name": "SleeveStrategyRiskTypeAllocationDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "SleeveStrategyRiskTypeDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.SleeveStrategyRiskTypeAllocationDto": { "properties": { "sleeveStrategyRiskTypeId": { "type": "integer", "format": "int32" }, "modelAggTypeId": { "type": "integer", "format": "int32" }, "modelAggTypeName": { "type": "string" }, "allocation": { "type": "number", "format": "double" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "SleeveStrategyRiskTypeAllocationDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.RegistrationsAssignedToStrategySimpleDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "isActive": { "type": "boolean" }, "needsUpdate": { "type": "boolean" }, "needsUpdateReason": { "type": "string" }, "hasCustomizedSleeves": { "description": "true -> one or more AccountSleeves are customized", "type": "boolean" }, "isSleeveAssignedToReg": { "description": "true -> passed sleeve is assigned to registration\r\nfalse - > passed sleeve is not assigned to registration but \r\npassed sleeve is one of the sleeves of sleeve agg that is assigned to registration", "type": "boolean" } }, "xml": { "name": "RegistrationsAssignedToStrategySimpleDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.RegistrationModelAssignmentValidationDto": { "properties": { "registrationId": { "type": "integer", "format": "int32" }, "aggregateModelValidationDtos": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.AggregateModelValidationDto" }, "xml": { "name": "AggregateModelValidationDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "RegistrationModelAssignmentValidationDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.AggregateModelValidationDto": { "properties": { "aggregateModelId": { "type": "integer", "format": "int32" }, "modelName": { "type": "string" } }, "xml": { "name": "AggregateModelValidationDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.SleeveStrategyHistoryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "sleeveStrategyId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "contributionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "distributionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "autoRebalFreq": { "type": "string", "enum": [ "None", "Monthly", "Quarterly", "Semiannual", "Annual" ] }, "autoRebalMonth": { "type": "integer", "format": "int32" }, "autoRebalDay": { "type": "integer", "format": "int32" }, "mandate": { "type": "boolean" }, "tolerancePercent": { "type": "number", "format": "double" }, "changeType": { "type": "string" }, "entityId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "riskScore": { "type": "number", "format": "double" }, "sleeveStrategyRiskTypeId": { "type": "integer", "format": "int32" } }, "xml": { "name": "SleeveStrategyHistoryDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.SleeveStrategyDetailHistoryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "sleeveStrategyDetailId": { "type": "integer", "format": "int32" }, "sleeveStrategyId": { "type": "integer", "format": "int32" }, "modelAggId": { "type": "integer", "format": "int32" }, "modelAggName": { "type": "string" }, "managementStyleId": { "type": "integer", "format": "int32" }, "managementStyle": { "type": "string" }, "subAdvisorId": { "type": "integer", "format": "int32" }, "subAdvisor": { "type": "string" }, "targetAllocation": { "type": "number", "format": "double" }, "targetBalanceType": { "type": "string", "enum": [ "Dollars", "Percent" ] }, "contributionAllocation": { "type": "number", "format": "double" }, "distributionAllocation": { "type": "number", "format": "double" }, "toleranceUpper": { "type": "number", "format": "double" }, "toleranceLower": { "type": "number", "format": "double" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "sleeveType": { "type": "integer", "format": "int32" }, "autoTradeTypes": { "type": "string", "enum": [ "None", "RegistrationRebalance", "SleeveRebalance", "ContributionAllocation", "TransferInRebalance" ] }, "riskScore": { "type": "number", "format": "double" }, "doNotTrade": { "type": "boolean" }, "changeType": { "type": "string" }, "managementStyleName": { "type": "string" }, "subAdvisorName": { "type": "string" } }, "xml": { "name": "SleeveStrategyDetailHistoryDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.ProcessStrategiesDto": { "properties": { "assignedRegistrationIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "unassignedRegistrationIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "removeCustomizations": { "description": "true -> process customized sleeves to match the strategy and remove the IsCustomized flag\r\nfalse -> do not process the customized sleeves to match the strategy, leave them customized", "type": "boolean" } }, "xml": { "name": "ProcessStrategiesDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.SleeveStrategyAccountAssignmentReturnDto": { "properties": { "batchId": { "type": "integer", "format": "int32" }, "sleveStrategy": { "type": "integer", "format": "int32" }, "accounts": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.ValidationAccountIdDto" }, "xml": { "name": "ValidationAccountIdDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "SleeveStrategyAccountAssignmentReturnDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.ValidationAccountIdDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "isValid": { "type": "boolean" }, "warningMessage": { "type": "string" }, "errorMessage": { "type": "string" } }, "xml": { "name": "ValidationAccountIdDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.SleeveStrategyRequestDto": { "properties": { "details": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyRequestDetailsDto" }, "xml": { "name": "SleeveStrategyRequestDetailsDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "SleeveStrategyRequestDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.SleeveStrategyRequestDetailsDto": { "properties": { "modelAggId": { "type": "integer", "format": "int32" }, "targetAllocation": { "type": "number", "format": "double" } }, "xml": { "name": "SleeveStrategyRequestDetailsDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.SleeveStrategyStatisticsResponseDto": { "properties": { "alpha": { "type": "number", "format": "double" }, "beta": { "type": "number", "format": "double" }, "rSquared": { "type": "number", "format": "double" }, "maxDrawdown": { "type": "number", "format": "double" } }, "xml": { "name": "SleeveStrategyStatisticsResponseDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.SleeveStrategyRestrictionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "sleeveStrategyId": { "type": "integer", "format": "int32" }, "entityName": { "type": "string" }, "validationMessage": { "type": "string" } }, "xml": { "name": "SleeveStrategyRestrictionDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.SleeveStrategyAggregateDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "firmId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "contributionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "distributionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "autoRebalFreq": { "type": "string", "enum": [ "None", "Monthly", "Quarterly", "Semiannual", "Annual" ] }, "autoRebalMonth": { "type": "integer", "format": "int32" }, "autoRebalDay": { "type": "integer", "format": "int32" }, "investmentObjectiveId": { "description": "Objectives often include Conservative Income, Aggressive Growth, Growth, Growth and Income, Income Only.", "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "grouping": { "type": "string" }, "singleStrategyId": { "type": "integer", "format": "int32" }, "sleeveStrategyCount": { "type": "integer", "format": "int32" }, "entities": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyAggregateEntityDto" }, "xml": { "name": "SleeveStrategyAggregateEntityDto", "wrapped": true }, "type": "array" }, "owned": { "type": "boolean" }, "include": { "type": "boolean" }, "allowCustomization": { "type": "boolean" }, "riskScore": { "type": "number", "format": "double" }, "useRestrictions": { "type": "boolean" }, "hasReadOnlyAccess": { "type": "boolean" }, "sleeveStrategyRiskTypeId": { "type": "integer", "format": "int32" }, "sleeveStrategyRiskScore": { "type": "number", "format": "double" }, "eclipseFirmId": { "type": "integer", "format": "int32" }, "associatedModelAggId": { "type": "integer", "format": "int32" } }, "xml": { "name": "SleeveStrategyAggregateDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.SleeveStrategyAggregateEntityDto": { "properties": { "entityId": { "type": "integer", "format": "int32" }, "entityEnum": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] } }, "xml": { "name": "SleeveStrategyAggregateEntityDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.SleeveStrategyAggregateWithDetailsDto": { "properties": { "details": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyAggregateDetailDto" }, "xml": { "name": "SleeveStrategyAggregateDetailDto", "wrapped": true }, "type": "array" }, "specialDetails": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyAggregateSpecialDetailDto" }, "xml": { "name": "SleeveStrategyAggregateSpecialDetailDto", "wrapped": true }, "type": "array" }, "id": { "type": "integer", "format": "int32" }, "firmId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "contributionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "distributionAllocationMethod": { "type": "string", "enum": [ "UseAssigned", "UseTarget", "UseOUB", "UseCurrent" ] }, "autoRebalFreq": { "type": "string", "enum": [ "None", "Monthly", "Quarterly", "Semiannual", "Annual" ] }, "autoRebalMonth": { "type": "integer", "format": "int32" }, "autoRebalDay": { "type": "integer", "format": "int32" }, "investmentObjectiveId": { "description": "Objectives often include Conservative Income, Aggressive Growth, Growth, Growth and Income, Income Only.", "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "grouping": { "type": "string" }, "singleStrategyId": { "type": "integer", "format": "int32" }, "sleeveStrategyCount": { "type": "integer", "format": "int32" }, "entities": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyAggregateEntityDto" }, "xml": { "name": "SleeveStrategyAggregateEntityDto", "wrapped": true }, "type": "array" }, "owned": { "type": "boolean" }, "include": { "type": "boolean" }, "allowCustomization": { "type": "boolean" }, "riskScore": { "type": "number", "format": "double" }, "useRestrictions": { "type": "boolean" }, "hasReadOnlyAccess": { "type": "boolean" }, "sleeveStrategyRiskTypeId": { "type": "integer", "format": "int32" }, "sleeveStrategyRiskScore": { "type": "number", "format": "double" }, "eclipseFirmId": { "type": "integer", "format": "int32" }, "associatedModelAggId": { "type": "integer", "format": "int32" } }, "xml": { "name": "SleeveStrategyAggregateWithDetailsDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.SleeveStrategyAggregateDetailDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "sleeveStrategyAggregateId": { "type": "integer", "format": "int32" }, "sleeveStrategyId": { "type": "integer", "format": "int32" }, "riskScore": { "type": "number", "format": "double" }, "targetAllocation": { "type": "number", "format": "double" }, "contributionAllocation": { "type": "number", "format": "double" }, "distributionAllocation": { "type": "number", "format": "double" }, "toleranceUpper": { "type": "number", "format": "double" }, "toleranceLower": { "type": "number", "format": "double" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "strategy": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyWithDetailsDto" } }, "xml": { "name": "SleeveStrategyAggregateDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.SleeveStrategyAggregateSpecialDetailDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "sleeveStrategyAggregateId": { "type": "integer", "format": "int32" }, "sleeveType": { "type": "string", "enum": [ "Normal sleeve", "Custodial account", "Contribution sleeve", "Distribution sleeve", "Unmanaged sleeve" ] }, "sleeveTypeVal": { "readOnly": true, "type": "integer", "format": "int32" }, "managementStyleId": { "type": "integer", "format": "int32" }, "managementStyleName": { "type": "string" }, "aggregateModelId": { "type": "integer", "format": "int32" }, "aggregateName": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "SleeveStrategyAggregateSpecialDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.SleeveStrategyAggregateHistoryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "changeType": { "type": "string" }, "sleeveStrategyAggregateId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "contributionAllocationMethod": { "type": "integer", "format": "int32" }, "distributionAllocationMethod": { "type": "integer", "format": "int32" }, "autoRebalFreq": { "type": "string", "enum": [ "None", "Monthly", "Quarterly", "Semiannual", "Annual" ] }, "autoRebalMonth": { "type": "integer", "format": "int32" }, "autoRebalDay": { "type": "integer", "format": "int32" }, "createdDate": { "type": "string", "format": "date-time" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "allowCustomization": { "type": "boolean" }, "useRestrictions": { "type": "boolean" }, "eclipseFirmId": { "type": "integer", "format": "int32" }, "associatedModelAggId": { "type": "integer", "format": "int32" } }, "xml": { "name": "SleeveStrategyAggregateHistoryDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.SleeveStrategyAggregateDetailHistoryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "changeType": { "type": "string" }, "sleeveStrategyAggregateDtlId": { "type": "integer", "format": "int32" }, "sleeveStrategyAggregateId": { "type": "integer", "format": "int32" }, "sleeveStrategyId": { "type": "integer", "format": "int32" }, "targetAllocation": { "type": "number", "format": "double" }, "contributionAllocation": { "type": "number", "format": "double" }, "distributionAllocation": { "type": "number", "format": "double" }, "toleranceUpper": { "type": "number", "format": "double" }, "toleranceLower": { "type": "number", "format": "double" }, "strategyName": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "SleeveStrategyAggregateDetailHistoryDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.SleeveStrategyAggregateRestrictionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "sleeveStrategyAggregateId": { "type": "integer", "format": "int32" }, "entityName": { "type": "string" }, "validationMessage": { "type": "string" }, "exceptions": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyAggregateRestrictionExceptionDto" }, "xml": { "name": "SleeveStrategyAggregateRestrictionExceptionDto", "wrapped": true }, "type": "array" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "SleeveStrategyAggregateRestrictionDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.SleeveStrategyAggregateRestrictionExceptionDto": { "description": "A data transfer object which represents an exception to a restriction.", "properties": { "id": { "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" }, "entity": { "description": "The entity type of the exception for the restriction.", "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "entityName": { "description": "The name (e.g., representative name) of the exception to the restriction.", "type": "string" }, "restrictionId": { "description": "The ID of the restriction that this DTO is an exception to.", "type": "integer", "format": "int32" }, "restriction": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.SleeveStrategyAggregateRestrictionDto", "description": "The restriction for which this exception applies." }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "SleeveStrategyAggregateRestrictionExceptionDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.SleeveUpdateQueueDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "status": { "type": "string", "enum": [ "Pending", "Approved", "Rejected", "Completed", "Failed" ] }, "currentSleeves": { "type": "string" }, "updatedSleeves": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "SleeveUpdateQueueDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.ChangeSleeveUpdateStatusDto": { "properties": { "keys": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "status": { "type": "string", "enum": [ "Pending", "Approved", "Rejected", "Completed", "Failed" ] } }, "xml": { "name": "ChangeSleeveUpdateStatusDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.TradeCountSummaryDto": { "properties": { "orders": { "type": "integer", "format": "int32" }, "pending": { "type": "integer", "format": "int32" }, "allocations": { "type": "integer", "format": "int32" }, "blocks": { "type": "integer", "format": "int32" }, "closed": { "type": "integer", "format": "int32" }, "tradeFiles": { "type": "integer", "format": "int32" }, "strategistModelRebalance": { "type": "integer", "format": "int32" }, "lastUpdate": { "type": "string", "format": "date-time" } }, "xml": { "name": "TradeCountSummaryDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.TacticalTradeDto": { "properties": { "outOfTolerance": { "readOnly": true, "type": "string" }, "accountNumber": { "type": "string" }, "action": { "type": "string" }, "ticker": { "type": "string" }, "isExcluded": { "type": "boolean" }, "tradeShares": { "type": "number", "format": "double" }, "price": { "type": "number", "format": "double" }, "tradeAmount": { "type": "number", "format": "double" }, "postTradeValue": { "readOnly": true, "type": "number", "format": "double" }, "postTradeShares": { "readOnly": true, "type": "number", "format": "double" }, "postTradePercentage": { "readOnly": true, "type": "number", "format": "double" }, "postTradeDifferenceValue": { "readOnly": true, "type": "number", "format": "double" }, "postTradeDifferenceShares": { "readOnly": true, "type": "number", "format": "double" }, "postTradeDifferencePercentage": { "readOnly": true, "type": "number", "format": "double" }, "targetValue": { "readOnly": true, "type": "number", "format": "double" }, "targetShares": { "readOnly": true, "type": "number", "format": "double" }, "targetPercentage": { "type": "number", "format": "double" }, "differenceValue": { "readOnly": true, "type": "number", "format": "double" }, "differenceShares": { "readOnly": true, "type": "number", "format": "double" }, "differencePercentage": { "readOnly": true, "type": "number", "format": "double" }, "currentValue": { "readOnly": true, "type": "number", "format": "double" }, "currentShares": { "type": "number", "format": "double" }, "currentPercentage": { "readOnly": true, "type": "number", "format": "double" }, "unrealizedCostBasisShortTerm": { "type": "number", "format": "double" }, "unrealizedCostBasisLongTerm": { "type": "number", "format": "double" }, "unrealizedGainAmount": { "readOnly": true, "type": "number", "format": "double" }, "unrealizedGainPercent": { "readOnly": true, "type": "number", "format": "double" }, "realizedTradeGain": { "type": "number", "format": "double" }, "tradeReason": { "type": "string" }, "message": { "type": "string" }, "accountDescription": { "readOnly": true, "type": "string" }, "targetCashPercentage": { "type": "number", "format": "double" }, "lowerTolerance": { "type": "number", "format": "double" }, "upperTolerance": { "type": "number", "format": "double" }, "orders": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "assetId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "account": { "type": "string" }, "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "modelName": { "type": "string" }, "cashValue": { "type": "number", "format": "double" }, "accountValue": { "type": "number", "format": "double" }, "specialInstructions": { "type": "string" }, "previousTradeShares": { "type": "number", "format": "double" }, "previousTradeAmount": { "type": "number", "format": "double" }, "previousTradeAction": { "type": "string" }, "assetClass": { "type": "string" }, "assetCategory": { "type": "string" }, "riskCategory": { "type": "string" }, "isTradingBlocked": { "type": "boolean" }, "areOrdersSent": { "type": "boolean" }, "areOrdersApproved": { "type": "boolean" }, "isRepLevelTrading": { "type": "boolean" }, "cashLowerTolerance": { "type": "number", "format": "double" }, "cashUpperTolerance": { "type": "number", "format": "double" }, "minCashBalance": { "type": "number", "format": "double" }, "minimumCashBalanceType": { "type": "string", "enum": [ "Dollars", "Percent" ] }, "unitBalanceScale": { "type": "string" }, "priceScale": { "type": "integer", "format": "int32" }, "isAccountActive": { "type": "boolean" }, "isEditable": { "readOnly": true, "type": "boolean" }, "amortizationAmount": { "type": "number", "format": "double" }, "isCustodialCash": { "type": "boolean" }, "groupValue": { "type": "number", "format": "double" }, "groupCashValue": { "type": "number", "format": "double" }, "originalTargetPercentage": { "type": "number", "format": "double" }, "originalTargetCashPercentage": { "type": "number", "format": "double" }, "groupId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" } }, "xml": { "name": "TacticalTradeDto" }, "type": "object" }, "OAS.WebApi.Domains.Trading.Dto.AccountListRequest": { "properties": { "usePendingValue": { "type": "boolean" }, "modelId": { "type": "integer", "format": "int32" }, "includeCash": { "type": "boolean" }, "ignoreDollarModel": { "type": "boolean" }, "cashValue": { "type": "number", "format": "float" }, "accountType": { "type": "string" }, "calculateCosts": { "type": "boolean" }, "resetCache": { "type": "boolean" }, "defaultAction": { "type": "string" }, "ids": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, "xml": { "name": "AccountListRequest" }, "type": "object" }, "OAS.WebApi.DTO.Trading.TradeBatchDto": { "properties": { "batchId": { "type": "integer", "format": "int32" }, "trades": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TacticalTradeDto" }, "xml": { "name": "TacticalTradeDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "TradeBatchDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.TradeBlockReasonDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "description": "The name of the trade block reason.", "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "globalId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "eclipseFirmId": { "type": "integer", "format": "int32" }, "isSystemMaintained": { "type": "boolean" }, "allowDetailAssignment": { "type": "boolean" }, "syncToEclipse": { "type": "boolean" } }, "xml": { "name": "TradeBlockReasonDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.TradeBlockDetailDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "entityId": { "description": "The ID of the {OAS.WebApi.DTO.Trading.TradeBlockDetailDto.EntityEnum}.", "type": "integer", "format": "int32" }, "entityEnum": { "description": "The entity type (aka relation type) that the block applies to.", "type": "integer", "format": "int32" }, "tradeBlockReasonId": { "description": "The cross-reference to a {OAS.WebApi.DTO.Trading.TradeBlockDetailDto.TradeBlockReason}.", "type": "integer", "format": "int32" }, "description": { "description": "A description of why this particular trade block was created.", "type": "string" }, "startDate": { "description": "The date that the trade block becomes/became effective.", "type": "string", "format": "date-time" }, "endDate": { "description": "The last day that the trade block is in effect for.", "type": "string", "format": "date-time" }, "isDeleted": { "description": " if the trade block detail had been (soft) deleted.", "type": "boolean" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "entityName": { "type": "string" }, "globalId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "errorMessage": { "type": "string" }, "isDisabled": { "type": "boolean" }, "tradeBlockReason": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TradeBlockReasonDto" }, "origin": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TradeBlockOriginContextDto", "description": "Per-detail origin metadata from Eclipse when createSyncEvent=false on the batch request.\r\nNot persisted; used by OAT to decide fan-out to other Eclipse firms." } }, "xml": { "name": "TradeBlockDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.TradeBlockOriginContextDto": { "description": "Factual metadata about where and why a trade block originated in Eclipse.\r\nOrion Connect uses this to decide its own sync and fan-out behavior.", "properties": { "wasPortfolioLevelBlock": { "description": "True when the block was created from a portfolio-level action that maps to\r\na registration entity in Orion Connect.", "type": "boolean" }, "originatingEclipseFirmId": { "description": "The Eclipse firm where the originating action occurred.", "type": "integer", "format": "int32" } }, "xml": { "name": "TradeBlockOriginContextDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.DeleteByReasonForCurrentUserRequest": { "description": "Request to soft-delete trade block details for the current user and reason across one or more entity scopes.", "properties": { "tradeBlockReasonGlobalId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "entityScopes": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Trading.TradeBlockEntityScopeRequest" }, "xml": { "name": "TradeBlockEntityScopeRequest", "wrapped": true }, "type": "array" }, "createSyncEvent": { "type": "boolean" } }, "xml": { "name": "DeleteByReasonForCurrentUserRequest" }, "type": "object" }, "OAS.WebApi.DTO.Trading.TradeBlockEntityScopeRequest": { "description": "Registration or account scope: entity enum as int (Registration = 6, Account = 7; see OrionConnect EntityEnum).", "properties": { "entityEnum": { "type": "integer", "format": "int32" }, "entityId": { "type": "integer", "format": "int32" } }, "xml": { "name": "TradeBlockEntityScopeRequest" }, "type": "object" }, "OAS.WebApi.DTO.Utility.TradeRunErrorChecksAccountDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "registrationName": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "instanceId": { "type": "integer", "format": "int32" }, "tradeOrderCaption": { "type": "string" }, "errorType": { "type": "string" }, "severity": { "type": "integer", "format": "int32" }, "errorMessage": { "type": "string" }, "accountValue": { "type": "number", "format": "double" }, "subAdvisor": { "type": "string" } }, "xml": { "name": "TradeRunErrorChecksAccountDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.MessageDto": { "properties": { "entityId": { "type": "integer", "format": "int32" }, "entityEnum": { "type": "string" }, "severity": { "type": "string" }, "severityCode": { "type": "integer", "format": "int32" }, "receivedDate": { "type": "string", "format": "date-time" }, "subject": { "type": "string" }, "message": { "type": "string" }, "details": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.MessageDetailDto" }, "xml": { "name": "MessageDetailDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "MessageDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.MessageDetailDto": { "properties": { "severityCode": { "type": "integer", "format": "int32" }, "severity": { "type": "string" }, "message": { "type": "string" }, "entityEnum": { "type": "string" }, "entityId": { "type": "integer", "format": "int32" } }, "xml": { "name": "MessageDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.TradeStatusDto": { "properties": { "abbreviation": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "TradeStatusDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.AccountTradeValidationDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "cashValuePostTrade": { "type": "number", "format": "double" }, "cashTradeAmount": { "type": "number", "format": "double" }, "warnings": { "items": { "type": "string" }, "type": "array" }, "errors": { "items": { "type": "string" }, "type": "array" } }, "xml": { "name": "AccountTradeValidationDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.ValidateStrategiesDto": { "properties": { "strategyId": { "type": "string" }, "name": { "type": "string" }, "contributionAllocationMethod": { "type": "string" }, "distributionAllocationMethod": { "type": "string" }, "autoRebalFreq": { "type": "string" }, "autoRebalMonth": { "type": "string" }, "autoRebalDay": { "type": "string" }, "entityId": { "type": "string" }, "entity": { "type": "string" }, "tolerancePercent": { "type": "string" }, "strategyDetailId": { "type": "string" }, "sleeveType": { "type": "string" }, "modelAggId": { "$ref": "#/definitions/OAS.WebApi.DTO.IdNameResolver" }, "platformId": { "$ref": "#/definitions/OAS.WebApi.DTO.IdNameResolver" }, "subAdvisorId": { "$ref": "#/definitions/OAS.WebApi.DTO.IdNameResolver" }, "targetAllocation": { "type": "string" }, "contributionAllocation": { "type": "string" }, "distributionAllocation": { "type": "string" }, "toleranceUpper": { "type": "string" }, "toleranceLower": { "type": "string" }, "autoTradeTypes": { "type": "string" }, "doNotTrade": { "type": "string" }, "substituteDetailId": { "type": "string" }, "substituteId": { "$ref": "#/definitions/OAS.WebApi.DTO.IdNameResolver" }, "assetLevelAllowed": { "type": "string" }, "assetLevelIds": { "type": "string" }, "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" }, "warningMessage": { "type": "string" } }, "xml": { "name": "ValidateStrategiesDto" }, "type": "object" }, "OAS.WebApi.DTO.IdNameResolver": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "IdNameResolver" }, "type": "object" }, "OAS.WebApi.DTO.ValidateImport.ValidateOrdersFileImportDto": { "properties": { "assetValues": { "type": "string", "enum": [ "Current", "Pending" ] }, "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile", "description": "the imported file" } }, "xml": { "name": "ValidateOrdersFileImportDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.RegistrationSleeveValidationDto": { "properties": { "registrationId": { "type": "integer", "format": "int32" }, "isDoNotTrade": { "type": "boolean" }, "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" } }, "xml": { "name": "RegistrationSleeveValidationDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.DistributionValidationDto": { "properties": { "accountId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "amount": { "type": "number", "format": "double" }, "regId": { "type": "integer", "format": "int32" }, "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" } }, "xml": { "name": "DistributionValidationDto" }, "type": "object" }, "OAS.WebApi.DTO.Trading.ValidateStrategyAggregatesDto": { "properties": { "strategyAggregateId": { "type": "string" }, "name": { "type": "string" }, "contributionAllocationMethod": { "type": "string" }, "distributionAllocationMethod": { "type": "string" }, "autoRebalFreq": { "type": "string" }, "autoRebalMonth": { "type": "string" }, "autoRebalDay": { "type": "string" }, "entityId": { "type": "string" }, "entity": { "type": "string" }, "eclipseFirmId": { "type": "string" }, "strategyAggregateDetailId": { "type": "string" }, "strategyId": { "$ref": "#/definitions/OAS.WebApi.DTO.IdNameResolver" }, "target": { "type": "string" }, "contributionAllocation": { "type": "string" }, "distributionAllocation": { "type": "string" }, "toleranceUpper": { "type": "string" }, "toleranceLower": { "type": "string" }, "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" }, "warningMessage": { "type": "string" }, "sleeveType": { "type": "string" }, "modelAggId": { "$ref": "#/definitions/OAS.WebApi.DTO.IdNameResolver" }, "platformId": { "$ref": "#/definitions/OAS.WebApi.DTO.IdNameResolver" }, "strategyAggregateSpecialDetailId": { "type": "string" } }, "xml": { "name": "ValidateStrategyAggregatesDto" }, "type": "object" }, "OAS.DataProcess.DTO.Trading.ValidateImport.FeeAndLoanDistributionValidationDto": { "properties": { "uploadType": { "type": "string" }, "description": { "type": "string" }, "accountId": { "type": "integer", "format": "int32" }, "accountNumber": { "type": "string" }, "amount": { "type": "number", "format": "double" }, "productId": { "type": "integer", "format": "int32" }, "cusip": { "type": "string" }, "ticker": { "type": "string" }, "isValid": { "type": "boolean" }, "validationMessage": { "type": "string" } }, "xml": { "name": "FeeAndLoanDistributionValidationDto" }, "type": "object" }, "OAS.WebApi.DTO.HomepageDashboard.UserHomepageDashboardSimpleDto": { "properties": { "isShared": { "type": "boolean" }, "isVisible": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "isGlobal": { "type": "boolean" }, "isPortfolioView": { "type": "boolean" }, "userId": { "type": "integer", "format": "int32" }, "dashboardType": { "type": "string", "enum": [ "Homepage", "View", "Tool" ] }, "id": { "type": "integer", "format": "int32" }, "dashboardName": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "UserHomepageDashboardSimpleDto" }, "type": "object" }, "OAS.WebApi.DTO.HomepageDashboard.RoleDashboardDto": { "properties": { "roleId": { "type": "integer", "format": "int32" }, "roleName": { "type": "string" }, "defaultDashboardId": { "type": "integer", "format": "int32" }, "dashboards": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.HomepageDashboard.SharedDashboardDto" }, "xml": { "name": "SharedDashboardDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "RoleDashboardDto" }, "type": "object" }, "OAS.WebApi.DTO.HomepageDashboard.SharedDashboardDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "dashboardName": { "type": "string" }, "isDefault": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "userId": { "type": "integer", "format": "int32" }, "isGlobal": { "type": "boolean" }, "firmId": { "type": "integer", "format": "int32" }, "roleName": { "type": "string" }, "roleId": { "type": "integer", "format": "int32" }, "dashboardType": { "type": "string", "enum": [ "Homepage", "View", "Tool" ] } }, "xml": { "name": "SharedDashboardDto" }, "type": "object" }, "OAS.DataModel.Utility.spimRequestLogViewerGetList": { "required": [ "appName" ], "properties": { "dbName": { "type": "string", "maxLength": 200, "minLength": 0 }, "userID": { "type": "string", "maxLength": 200, "minLength": 0 }, "requestTime": { "type": "string", "format": "date-time" }, "responseTime": { "type": "string", "format": "date-time" }, "duration": { "type": "integer", "format": "int32" }, "fkUserDtl": { "type": "integer", "format": "int32" }, "appName": { "type": "string", "maxLength": 100, "minLength": 0 }, "hostName": { "type": "string", "maxLength": 128, "minLength": 0 }, "clientIp": { "type": "string", "maxLength": 20, "minLength": 0 }, "verb": { "type": "string", "maxLength": 10, "minLength": 0 }, "routeUrl": { "type": "string" }, "request": { "type": "string" }, "response": { "type": "string" }, "hasException": { "type": "boolean" }, "message": { "type": "string" }, "stackTrace": { "type": "string" }, "correlationId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "app": { "type": "string", "maxLength": 255, "minLength": 0 }, "appPath": { "type": "string", "maxLength": 255, "minLength": 0 }, "loginEntity": { "type": "string", "maxLength": 30, "minLength": 0 }, "fkPartnerApp": { "type": "integer", "format": "int32" }, "userAgent": { "type": "string" } }, "xml": { "name": "spimRequestLogViewerGetList" }, "type": "object" }, "OAS.WebApi.Domains.Utility.UtilityController.AuditFileImportFileDto": { "properties": { "userMessage": { "type": "string" }, "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" } }, "xml": { "name": "AuditFileImportFileDto" }, "type": "object" }, "OAS.DataModel.Utility.DatabaseCreation.DatabaseActionRequest": { "properties": { "databaseActionType": { "type": "string", "enum": [ "DatabaseCreation" ] }, "databaseActionConfigJSON": { "items": { "$ref": "#/definitions/OAS.DataModel.Utility.DatabaseCreation.DatabaseActionConfigJsonValue" }, "xml": { "name": "DatabaseActionConfigJsonValue", "wrapped": true }, "type": "array" } }, "xml": { "name": "DatabaseActionRequest" }, "type": "object" }, "OAS.DataModel.Utility.DatabaseCreation.DatabaseActionConfigJsonValue": { "properties": { "id": { "type": "string" }, "value": { "type": "string" } }, "xml": { "name": "DatabaseActionConfigJsonValue" }, "type": "object" }, "OAS.WebApi.DTO.Utility.DatabaseGroupDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "isPrivate": { "type": "boolean" }, "auditedBy": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "userId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "alClientId": { "type": "integer", "format": "int32" }, "alClientName": { "type": "string" }, "databases": { "items": { "$ref": "#/definitions/OAS.DataModel.SimpleEntity" }, "xml": { "name": "SimpleEntity", "wrapped": true }, "type": "array" } }, "xml": { "name": "DatabaseGroupDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.DateExpressionResultDto": { "properties": { "date": { "type": "string" }, "expression": { "type": "string" }, "isValid": { "type": "boolean" } }, "xml": { "name": "DateExpressionResultDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.ImportSingleFileDto": { "properties": { "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" } }, "xml": { "name": "ImportSingleFileDto" }, "type": "object" }, "OAS.DataProcess.Utility.Excel.IWorkbook": { "properties": { "name": { "readOnly": true, "type": "string" }, "sheets": { "items": { "$ref": "#/definitions/OAS.DataProcess.Utility.Excel.ISheet" }, "readOnly": true, "xml": { "name": "ISheet", "wrapped": true }, "type": "array" }, "type": { "readOnly": true, "type": "string" } }, "xml": { "name": "IWorkbook" }, "type": "object" }, "OAS.DataProcess.Utility.Excel.ISheet": { "properties": { "name": { "readOnly": true, "type": "string" }, "data": { "readOnly": true, "type": "object" }, "type": { "readOnly": true, "type": "string" } }, "xml": { "name": "ISheet" }, "type": "object" }, "OAS.WebApi.DTO.Utility.FeatureFlagAlClientDto": { "properties": { "featureFlagId": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedBy": { "type": "string" } }, "xml": { "name": "FeatureFlagAlClientDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.FeatureFlagDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "code": { "type": "string" }, "globalValue": { "type": "string" }, "description": { "type": "string" }, "typeConfigJSON": { "type": "string" }, "defaultValue": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedBy": { "type": "string" } }, "xml": { "name": "FeatureFlagDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.DynamicGroupingDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "pageViewId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "Dynamic", "Static" ] }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "usedFor": { "type": "string", "enum": [ "None", "Trading", "Reporting", "RepProfileAssignment", "Compass" ] }, "isPrivate": { "type": "boolean" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "DynamicGroupingDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.DynamicGroupingFullDto": { "properties": { "details": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.DynamicGroupingDetailDto" }, "xml": { "name": "DynamicGroupingDetailDto", "wrapped": true }, "type": "array" }, "id": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "pageViewId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "Dynamic", "Static" ] }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "usedFor": { "type": "string", "enum": [ "None", "Trading", "Reporting", "RepProfileAssignment", "Compass" ] }, "isPrivate": { "type": "boolean" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" } }, "xml": { "name": "DynamicGroupingFullDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.DynamicGroupingDetailDto": { "properties": { "entityId": { "type": "integer", "format": "int32" }, "entity": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "name": { "type": "string" } }, "xml": { "name": "DynamicGroupingDetailDto" }, "type": "object" }, "OAS.WebApi.Code.Projection.ProjectionManipulatorOfOAS.WebApi.DTO.Utility.GroupingViewAccountDto": { "properties": { "type": { "readOnly": true, "type": "string" }, "hasImpact": { "readOnly": true, "type": "boolean" }, "top": { "readOnly": true, "type": "integer", "format": "int32" }, "skip": { "readOnly": true, "type": "integer", "format": "int32" }, "requestedProperties": { "description": "The properties the user specifically asked for", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" }, "requiredProperties": { "description": "The properties that are required to fulfill the requested properties", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProjectionManipulator`1" }, "type": "object" }, "OAS.WebApi.DTO.Utility.GroupingViewAccountDto": { "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "accountNumber": { "type": "string" }, "custodian": { "type": "string" }, "isManaged": { "type": "boolean" }, "isActive": { "type": "boolean" }, "tradeBlocked": { "type": "boolean" }, "repName": { "type": "string" }, "modelName": { "type": "string" }, "accountType": { "type": "string" }, "fundName": { "type": "string" }, "managementStyle": { "type": "string" }, "shareClass": { "type": "string" }, "subAdvisor": { "type": "string" }, "registrationId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "repId": { "type": "integer", "format": "int32" }, "reportName": { "type": "string" }, "statementDelivery": { "type": "string" }, "email": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "birthDate": { "type": "string" }, "registratioName": { "type": "string" }, "repNo": { "type": "string" }, "planName": { "type": "string" }, "planSponsor": { "type": "string" }, "isAnnuity": { "type": "boolean" }, "outsideID": { "type": "string" }, "fixVersion": { "type": "string" }, "taxable": { "type": "boolean" }, "busiessLine": { "type": "string" }, "minCashBalance": { "type": "number", "format": "double" }, "replenishMinCash": { "type": "boolean" }, "billPaymentMethod": { "type": "string" }, "tradingInstructions": { "type": "string" }, "feeSchedule": { "type": "string" }, "payoutSchedule": { "type": "string" }, "brokerDealer": { "type": "string" }, "isQualified": { "type": "boolean" }, "currentValue": { "type": "number", "format": "double" }, "accountHistoryId": { "type": "integer", "format": "int32" }, "secondaryAccountNumber": { "type": "string" }, "billStartDate": { "type": "string", "format": "date-time" }, "cancelDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "downloadSource": { "type": "string" }, "household": { "type": "string" }, "includeInAggregate": { "type": "boolean" }, "modelGroupNumber": { "type": "string" }, "modelAggId": { "type": "integer", "format": "int32" }, "riskBudget": { "type": "integer", "format": "int32" }, "riskScore": { "type": "number", "format": "double" }, "isSleeveAccount": { "type": "boolean" }, "accountStartDate": { "type": "string", "format": "date-time" }, "accountStartValue": { "type": "number", "format": "double" }, "isSweepAccount": { "type": "boolean" }, "sweepAssetId": { "type": "integer", "format": "int32" }, "billStyle": { "type": "string", "enum": [ "Advance", "Arrears" ] }, "billFrequency": { "type": "string", "enum": [ "Undefined", "Monthly", "Quarterly", "Triannual", "Semiannually", "Annually", "AtMaturity" ] }, "cycleMonth": { "type": "integer", "format": "int32" }, "type": { "readOnly": true, "type": "string" }, "id": { "type": "integer", "format": "int32" }, "additionalColumns": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Interface.AdditionalColumnDefinition" }, "xml": { "name": "AdditionalColumnDefinition", "wrapped": true }, "type": "array" } }, "xml": { "name": "GroupingViewAccountDto" }, "type": "object" }, "OAS.WebApi.Code.Projection.ProjectionManipulatorOfOAS.WebApi.DTO.Utility.GroupingViewRegistrationDto": { "properties": { "type": { "readOnly": true, "type": "string" }, "hasImpact": { "readOnly": true, "type": "boolean" }, "top": { "readOnly": true, "type": "integer", "format": "int32" }, "skip": { "readOnly": true, "type": "integer", "format": "int32" }, "requestedProperties": { "description": "The properties the user specifically asked for", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" }, "requiredProperties": { "description": "The properties that are required to fulfill the requested properties", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProjectionManipulator`1" }, "type": "object" }, "OAS.WebApi.DTO.Utility.GroupingViewRegistrationDto": { "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "isActive": { "type": "boolean" }, "repName": { "type": "string" }, "accountType": { "type": "string" }, "clientId": { "type": "integer", "format": "int32" }, "repId": { "type": "integer", "format": "int32" }, "reportName": { "type": "string" }, "statementDelivery": { "type": "string" }, "email": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "birthDate": { "type": "string" }, "registratioName": { "type": "string" }, "repNo": { "type": "string" }, "taxable": { "type": "boolean" }, "brokerDealer": { "type": "string" }, "currentValue": { "type": "number", "format": "double" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "typeCode": { "type": "string" }, "typeId": { "type": "integer", "format": "int32" }, "householdName": { "type": "string" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "riskBudget": { "type": "integer", "format": "int32" }, "stockPercent": { "type": "string" }, "bondPercent": { "readOnly": true, "type": "string" }, "type": { "readOnly": true, "type": "string" }, "id": { "type": "integer", "format": "int32" }, "additionalColumns": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Interface.AdditionalColumnDefinition" }, "xml": { "name": "AdditionalColumnDefinition", "wrapped": true }, "type": "array" } }, "xml": { "name": "GroupingViewRegistrationDto" }, "type": "object" }, "OAS.WebApi.Code.Projection.ProjectionManipulatorOfOAS.WebApi.DTO.Utility.GroupingViewClientDto": { "properties": { "type": { "readOnly": true, "type": "string" }, "hasImpact": { "readOnly": true, "type": "boolean" }, "top": { "readOnly": true, "type": "integer", "format": "int32" }, "skip": { "readOnly": true, "type": "integer", "format": "int32" }, "requestedProperties": { "description": "The properties the user specifically asked for", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" }, "requiredProperties": { "description": "The properties that are required to fulfill the requested properties", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProjectionManipulator`1" }, "type": "object" }, "OAS.WebApi.DTO.Utility.GroupingViewClientDto": { "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "isActive": { "type": "boolean" }, "repName": { "type": "string" }, "repId": { "type": "integer", "format": "int32" }, "reportName": { "type": "string" }, "statementDelivery": { "type": "string" }, "email": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "birthDate": { "type": "string" }, "repNo": { "type": "string" }, "currentValue": { "type": "number", "format": "double" }, "brokerDealer": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "additionalAccounts": { "type": "integer", "format": "int32" }, "type": { "readOnly": true, "type": "string" }, "id": { "type": "integer", "format": "int32" }, "additionalColumns": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Interface.AdditionalColumnDefinition" }, "xml": { "name": "AdditionalColumnDefinition", "wrapped": true }, "type": "array" } }, "xml": { "name": "GroupingViewClientDto" }, "type": "object" }, "OAS.WebApi.Code.Projection.ProjectionManipulatorOfOAS.WebApi.DTO.Utility.GroupingViewRepresentativeDto": { "properties": { "type": { "readOnly": true, "type": "string" }, "hasImpact": { "readOnly": true, "type": "boolean" }, "top": { "readOnly": true, "type": "integer", "format": "int32" }, "skip": { "readOnly": true, "type": "integer", "format": "int32" }, "requestedProperties": { "description": "The properties the user specifically asked for", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" }, "requiredProperties": { "description": "The properties that are required to fulfill the requested properties", "items": { "$ref": "#/definitions/OAS.WebApi.Code.Projection.ProjectionManipulatorProperty" }, "readOnly": true, "xml": { "name": "ProjectionManipulatorProperty", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProjectionManipulator`1" }, "type": "object" }, "OAS.WebApi.DTO.Utility.GroupingViewRepresentativeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "repNo": { "type": "string" }, "fullName": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "phoneNumber": { "type": "string" }, "email": { "type": "string" }, "company": { "type": "string" }, "mobilePhoneNumber": { "type": "string" }, "faxNumber": { "type": "string" }, "brokerDealer": { "type": "string" }, "businessPhoneNumber": { "type": "string" }, "households": { "type": "integer", "format": "int32" }, "value": { "type": "number", "format": "double" }, "isActive": { "type": "boolean" }, "accountingLedgerNo": { "type": "string" }, "branch": { "type": "string" }, "copyToRep": { "type": "boolean" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "default": { "type": "boolean" }, "destinationDownload": { "type": "boolean" }, "editedBy": { "type": "string" }, "editedDate": { "type": "string", "format": "date-time" }, "firmName": { "type": "string" }, "hasADV": { "type": "boolean" }, "hasU4": { "type": "boolean" }, "importKey": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "payee": { "type": "integer", "format": "int32" }, "planAdministrator": { "type": "integer", "format": "int32" }, "raActive": { "type": "boolean" }, "raAmount": { "type": "number", "format": "double" }, "raDate": { "type": "string", "format": "date-time" }, "repRestriction": { "type": "string" }, "riaId": { "type": "integer", "format": "int32" }, "riaName": { "type": "string" }, "royalTCode": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "ActiveNoIssues", "HoldForCompliance", "ActiveNoNewClients", "InActive", "Pending", "Limited", "Prospect", "Rejected" ] }, "wholeSaler": { "type": "string" } }, "xml": { "name": "GroupingViewRepresentativeDto" }, "type": "object" }, "Hangfire.Storage.Monitoring.ServerDto": { "properties": { "name": { "type": "string" }, "workersCount": { "type": "integer", "format": "int32" }, "startedAt": { "type": "string", "format": "date-time" }, "queues": { "items": { "type": "string" }, "type": "array" }, "heartbeat": { "type": "string", "format": "date-time" } }, "xml": { "name": "ServerDto" }, "type": "object" }, "OAS.DataProcess.HomePageDashboard.Services.TableData": { "properties": { "name": { "type": "string" }, "columnDefs": { "items": { "$ref": "#/definitions/OAS.DataProcess.HomePageDashboard.Services.ColumnDef" }, "xml": { "name": "ColumnDef", "wrapped": true }, "type": "array" }, "groups": { "items": { "type": "string", "enum": [ "Undefined", "Payee", "BrokerDealer", "Wholesaler", "Representative", "Client", "Registration", "Account", "Asset", "Product", "Transaction", "Distribution", "FundFamily", "Personal", "PayoutSchedule", "FeeSchedule", "Platform", "RIA", "Custodian", "Journal", "SWP", "Other", "NASD", "CashFunding", "Bill", "BillInstance", "BillMasterPayout", "Model", "NewAccountClient", "NewAccountReg", "DownloadExclusion", "Price", "UserDefinedFields", "NewAcctUserDef", "ManagersMessage", "IndexEntry", "PerformanceFee", "PerformancePayout", "NewAccountAsset", "Owner", "Administrator", "OutsideClient", "SubAdvisor", "ModelRange", "FaxCover", "Fax", "OneTimeDistribution", "WebLogin", "Plan401k", "BillAccountItem", "ThirdPartyAdministrator", "CrmContact", "Participant", "PlanSponsor", "CRMEmailList", "ThirdParty", "WorkflowItem", "WorkflowAction", "ServiceAccount", "EntityOption", "HouseholdMember", "DownloadSymbol", "IndexBlend", "NABenefit", "AggregateModel", "CompositeRange", "RepAccountManager", "ScriptsScrubs", "ServiceAccountBrokerDealer", "BusinessLine", "Blob", "AssetClass", "ServiceAccountLite", "NewAcctUserDefDtl", "Branch", "AssetLevelStrategy", "Report", "DataQueries", "PriceUnUsed", "ModelItem", "AssetCategory", "RiskCategory", "PlatformRange", "Dividend", "RegistrationType", "CustodianCommon", "RepState", "QpeDashboard", "ReportBatch", "ModelGroup", "ShareClass", "DownloadFile", "User", "DynamicGrouping", "ProductType", "ProductSubType", "InvestmentObjective", "PortfolioGroup", "OrionRealizedLot", "OrionUnrealizedLot", "CustodianRealizedLot", "CustodianUnrealizedLot", "AssetCategoryParent", "TaxType", "AuditRequest", "AuditRequestLetter", "ManagedUnmanaged", "AuditRowAttachment", "InformPolicy", "InformAnswerAttachment", "UserDetail", "BillPayMethod", "ModelInclusion", "CommunityModel", "EclipseModel", "Global", "ClientCategory", "Taxability", "Qualified", "TaxID", "BondState", "ProductTaxability", "TargetAllocation", "RIATable", "ProductRegion", "ProductPropertyType", "ProductManagerAip", "MoodyRating", "SPRating", "BondMaturityYear", "InterestRate", "RegistrationTaxType", "MaturityPeriod", "NewHousehold", "BillPayoutDashboardPayment", "OptionLevel", "MarginAgreement", "PrimeBrokerage", "InformHistoricalDocument", "SleeveStrategyAggregate", "MorningstarSector", "BillEntity", "SleeveStrategy", "MorningstarGeography", "GenericProspect", "BillEntityType", "AdditionalRep", "BillPayoutReport", "ProductSubHolding", "DownloadSource", "ModelVsActual", "ProductVintageYear", "EclipsePortfolio", "Country", "Currency", "SecurityClassification1", "SecurityClassification2", "SecurityClassification3", "SecurityClassification4", "SecurityClassification5", "SecurityClassification6", "SecurityClassification7", "SecurityClassification8", "SecurityClassification9", "SecurityClassification10", "SecurityClassification11", "SecurityClassification12", "SecurityClassification13", "SecurityClassification14", "SecurityClassification15", "SecurityClassification16", "SecurityClassification17", "SecurityClassification18", "SecurityClassification19", "SecurityClassification20", "SecurityClassification21", "SecurityClassification22", "SecurityClassification23", "SecurityClassification24", "SecurityClassification25", "DownloadRecord", "CustomGrouping", "Cotenant", "AllocatedUnrealizedCostBasis", "AllocatedRealizedCostBasis" ] }, "xml": { "name": "Entity", "wrapped": true }, "type": "array" }, "rows": { "items": { "$ref": "#/definitions/OAS.DataProcess.HomePageDashboard.Services.TableRow" }, "xml": { "name": "TableRow", "wrapped": true }, "type": "array" } }, "xml": { "name": "TableData" }, "type": "object" }, "OAS.DataProcess.HomePageDashboard.Services.ColumnDef": { "properties": { "displayName": { "type": "string" }, "field": { "type": "string" } }, "xml": { "name": "ColumnDef" }, "type": "object" }, "OAS.DataProcess.HomePageDashboard.Services.TableRow": { "properties": { "data": { "type": "object" }, "children": { "items": { "$ref": "#/definitions/OAS.DataProcess.HomePageDashboard.Services.TableRow" }, "xml": { "name": "TableRow", "wrapped": true }, "type": "array" } }, "xml": { "name": "TableRow" }, "type": "object" }, "OAS.WebApi.DTO.Utility.PdfSettingDto": { "required": [ "url" ], "properties": { "downloadFileName": { "type": "string" }, "url": { "type": "string" } }, "xml": { "name": "PdfSettingDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.ImportCreateFromFileDto": { "properties": { "file": { "$ref": "#/definitions/MultipartDataMediaFormatter.Infrastructure.HttpFile" }, "importTypeId": { "type": "integer", "format": "int32" }, "importName": { "type": "string" }, "source": { "type": "string", "enum": [ "None", "OrionVision", "DataQuery" ] } }, "xml": { "name": "ImportCreateFromFileDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.ImportCommonExtDto": { "properties": { "importCommonId": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "rowCountsJSON": { "type": "string" }, "status": { "type": "string", "enum": [ "Unknown", "ValidationErrors", "Validated", "ReverseGenerated", "Imported", "PendingImport", "PendingValidation", "PendingApply", "PendingReversal", "Failed", "PendingReset", "PendingDelete" ] }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "canDelete": { "type": "boolean" }, "isReversal": { "type": "boolean" } }, "xml": { "name": "ImportCommonExtDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.ImportCommonExtImportCommonDto": { "properties": { "id": { "readOnly": true, "type": "string" }, "groupedName": { "readOnly": true, "type": "string" }, "masterId": { "type": "integer", "format": "int32" }, "importId": { "type": "integer", "format": "int32" }, "importName": { "type": "string" }, "importStatus": { "type": "string", "enum": [ "Unknown", "ValidationErrors", "Validated", "ReverseGenerated", "Imported", "PendingImport", "PendingValidation", "PendingApply", "PendingReversal", "Failed", "PendingReset", "PendingDelete" ] }, "importType": { "type": "string" }, "importTypeId": { "type": "integer", "format": "int32" }, "importTypeReverseId": { "type": "integer", "format": "int32" }, "numberOfDatasets": { "type": "integer", "format": "int32" }, "databaseName": { "type": "string" }, "isReversal": { "type": "boolean" }, "alClientId": { "type": "integer", "format": "int32" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "canDelete": { "readOnly": true, "type": "boolean" }, "canExcludeErrors": { "readOnly": true, "type": "boolean" } }, "xml": { "name": "ImportCommonExtImportCommonDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.UserDatabasesDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "databaseName": { "type": "string" }, "clientName": { "type": "string" }, "advisorNumber": { "type": "integer", "format": "int32" } }, "xml": { "name": "UserDatabasesDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.ImportCommonExtDetailsDto": { "properties": { "id": { "readOnly": true, "type": "string" }, "masterId": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "databaseName": { "type": "string" }, "importId": { "type": "integer", "format": "int32" }, "importStatus": { "type": "string", "enum": [ "Unknown", "ValidationErrors", "Validated", "ReverseGenerated", "Imported", "PendingImport", "PendingValidation", "PendingApply", "PendingReversal", "Failed", "PendingReset", "PendingDelete" ] }, "importTypeId": { "type": "integer", "format": "int32" }, "importTypeReverseId": { "type": "integer", "format": "int32" }, "numberOfRows": { "readOnly": true, "type": "integer", "format": "int32" }, "rowsWithErrors": { "readOnly": true, "type": "integer", "format": "int32" }, "isReversal": { "type": "boolean" }, "canDelete": { "readOnly": true, "type": "boolean" }, "canValidate": { "readOnly": true, "type": "boolean" }, "canApply": { "readOnly": true, "type": "boolean" }, "canReset": { "readOnly": true, "type": "boolean" }, "canReverse": { "readOnly": true, "type": "boolean" }, "canExcludeErrors": { "readOnly": true, "type": "boolean" } }, "xml": { "name": "ImportCommonExtDetailsDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.ImportCommonSummaryDto": { "properties": { "importCommonId": { "type": "integer", "format": "int32" }, "importType": { "type": "string" }, "importTypeId": { "type": "integer", "format": "int32" }, "importName": { "type": "string" }, "createdBy": { "type": "string" }, "createdDate": { "type": "string", "format": "date-time" }, "numberOfDbErrors": { "type": "integer", "format": "int32" }, "numberOfDatabases": { "type": "integer", "format": "int32" }, "canReverseImport": { "type": "boolean" } }, "xml": { "name": "ImportCommonSummaryDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.ImportCommonActionDto": { "properties": { "alClientId": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "action": { "type": "string" }, "importCommonId": { "type": "integer", "format": "int32" }, "isReversal": { "type": "boolean" }, "importSource": { "type": "string", "enum": [ "None", "OrionVision", "DataQuery" ] } }, "xml": { "name": "ImportCommonActionDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.ImportWithoutDataDto": { "properties": { "importId": { "type": "integer", "format": "int32" }, "importStatusIcon": { "readOnly": true, "type": "string" }, "importName": { "type": "string" }, "importStatus": { "type": "string" }, "importType": { "type": "string" }, "importTypeId": { "type": "integer", "format": "int32" }, "startedByDisplay": { "type": "string" }, "startedDate": { "type": "string", "format": "date-time" }, "importedByDisplay": { "type": "string" }, "importedDate": { "type": "string", "format": "date-time" }, "auditInfoDisplay": { "type": "string" }, "validated": { "type": "boolean" }, "imported": { "type": "boolean" }, "reversed": { "type": "boolean" }, "validationPercentComplete": { "$ref": "#/definitions/OAS.WebApi.DTO.Code.SlickPercentCompleteFraction", "readOnly": true }, "importParentId": { "type": "integer", "format": "int32" }, "preImportDataIsNull": { "type": "boolean" }, "postImportDataIsNull": { "type": "boolean" }, "source": { "type": "string" }, "importCommonId": { "type": "integer", "format": "int32" } }, "xml": { "name": "ImportWithoutDataDto" }, "type": "object" }, "OAS.WebApi.DTO.Code.SlickPercentCompleteFraction": { "properties": { "type": { "readOnly": true, "type": "string" }, "numerator": { "type": "integer", "format": "int32" }, "denominator": { "type": "integer", "format": "int32" } }, "xml": { "name": "SlickPercentCompleteFraction" }, "type": "object" }, "OAS.WebApi.DTO.Utility.ImportModifyDto": { "properties": { "importId": { "type": "integer", "format": "int32" }, "importTypeId": { "type": "integer", "format": "int32" }, "workingData": { "type": "object" }, "importName": { "type": "string" }, "source": { "type": "string", "enum": [ "None", "OrionVision", "DataQuery" ] }, "importCommonId": { "type": "integer", "format": "int32" } }, "xml": { "name": "ImportModifyDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.ImportTypeBaseInfoDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "importTypeName": { "type": "string" }, "importTypeDescription": { "type": "string" }, "privilegeId": { "type": "integer", "format": "int32" }, "tags": { "type": "string" }, "importTypeReverseId": { "type": "integer", "format": "int32" }, "storedProcedure": { "type": "string" }, "requiredFields": { "type": "string" } }, "xml": { "name": "ImportTypeBaseInfoDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.ImportTypeDto": { "properties": { "config": { "type": "object" }, "canReverseImport": { "type": "boolean" }, "id": { "type": "integer", "format": "int32" }, "importTypeName": { "type": "string" }, "importTypeDescription": { "type": "string" }, "privilegeId": { "type": "integer", "format": "int32" }, "tags": { "type": "string" }, "importTypeReverseId": { "type": "integer", "format": "int32" }, "storedProcedure": { "type": "string" }, "requiredFields": { "type": "string" } }, "xml": { "name": "ImportTypeDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.MaintenanceLastRunDto": { "properties": { "maintenanceName": { "type": "string" }, "startDateTime": { "type": "string", "format": "date-time" }, "endDateTime": { "type": "string", "format": "date-time" }, "recordProcessed": { "type": "integer", "format": "int32" }, "recordPending": { "type": "integer", "format": "int32" }, "spid": { "type": "integer", "format": "int32" }, "frequency": { "type": "string" }, "errorMessage": { "type": "string" } }, "xml": { "name": "MaintenanceLastRunDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.PageQueryDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string" }, "parameters": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.PageQueryParameterDto" }, "xml": { "name": "PageQueryParameterDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "PageQueryDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.PageQueryParameterDto": { "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "value": { "type": "string" }, "code": { "type": "string" }, "promptUser": { "type": "boolean" }, "type": { "type": "string" } }, "xml": { "name": "PageQueryParameterDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.Process.ProcessActivityDto": { "properties": { "id": { "type": "integer", "format": "int32" } }, "xml": { "name": "ProcessActivityDto" }, "type": "object" }, "OAS.DataModel.Utility.Process.ProcessActivity": { "required": [ "id", "type", "name" ], "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "type": "string", "enum": [ "AbstractTask", "ServiceTask", "SendTask", "ReceiveTask", "UserTask", "ManualTask", "BusinessRuleTask", "ScriptTask", "SubProcess", "AdhocSubProcess", "Transaction", "EventSubProcess", "AbstractCallActivity", "UserCallActivity", "ManualCallActivity", "BusinessRuleActivity", "ScriptCallActivity" ] }, "name": { "type": "string", "maxLength": 100, "minLength": 0 }, "description": { "type": "string", "maxLength": 2500, "minLength": 0 } }, "xml": { "name": "ProcessActivity" }, "type": "object" }, "OAS.WebApi.DTO.Utility.Process.ProcessEventDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "elementId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "catchEventId": { "type": "integer", "format": "int32" }, "throwEventIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "type": { "type": "string", "enum": [ "Generic", "Message", "Timer", "Conditional", "Signal", "Multiple", "MultipleParallel", "Escalation", "Error", "Compensation", "Link", "Cancel", "Terminate" ] }, "position": { "type": "string", "enum": [ "Start", "Intermediate", "End" ] } }, "xml": { "name": "ProcessEventDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.Process.ProcessElementDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "parentId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "Process", "Event", "Activity" ] }, "participantId": { "type": "integer", "format": "int32" }, "activityId": { "type": "integer", "format": "int32" }, "eventId": { "type": "integer", "format": "int32" }, "descendantIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" }, "eventIds": { "items": { "type": "integer", "format": "int32" }, "type": "array" } }, "xml": { "name": "ProcessElementDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.Process.ProcessParticipantDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "definitionId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "rules": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessParticipantRuleDto" }, "xml": { "name": "ProcessParticipantRuleDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProcessParticipantDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.Process.ProcessParticipantRuleDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "type": "string", "enum": [ "Role", "Privilege", "User", "AlClient" ] }, "priority": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "roleId": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "privilegeId": { "type": "integer", "format": "int32" } }, "xml": { "name": "ProcessParticipantRuleDto" }, "type": "object" }, "OAS.DataModel.Utility.Process.ProcessParticipant": { "required": [ "id", "name", "auditedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "maxLength": 100, "minLength": 0 }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "rules": { "items": { "$ref": "#/definitions/OAS.DataModel.Utility.Process.ProcessParticipantRule" }, "xml": { "name": "ProcessParticipantRule", "wrapped": true }, "type": "array" }, "elements": { "items": { "$ref": "#/definitions/OAS.DataModel.Utility.Process.ProcessElement" }, "xml": { "name": "ProcessElement", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProcessParticipant" }, "type": "object" }, "OAS.DataModel.Utility.Process.ProcessParticipantRule": { "required": [ "id", "type", "auditedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "participantId": { "type": "integer", "format": "int32" }, "priority": { "type": "integer", "format": "int32" }, "alClientId": { "type": "integer", "format": "int32" }, "roleId": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "privilegeId": { "type": "integer", "format": "int32" }, "type": { "type": "string", "enum": [ "Role", "Privilege", "User", "AlClient" ] }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "participant": { "$ref": "#/definitions/OAS.DataModel.Utility.Process.ProcessParticipant" }, "alClient": { "$ref": "#/definitions/OAS.DataModel.Security.AlClient" }, "role": { "$ref": "#/definitions/OAS.DataModel.Security.Role" }, "user": { "$ref": "#/definitions/OAS.DataModel.Security.User" }, "privilege": { "$ref": "#/definitions/OAS.DataModel.Security.Privilege" } }, "xml": { "name": "ProcessParticipantRule" }, "type": "object" }, "OAS.DataModel.Utility.Process.ProcessElement": { "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int32" }, "parentId": { "type": "integer", "format": "int32" }, "participantId": { "type": "integer", "format": "int32" }, "type": { "type": "string", "enum": [ "Process", "Event", "Activity" ] }, "parent": { "$ref": "#/definitions/OAS.DataModel.Utility.Process.ProcessElement" }, "elements": { "items": { "$ref": "#/definitions/OAS.DataModel.Utility.Process.ProcessElement" }, "xml": { "name": "ProcessElement", "wrapped": true }, "type": "array" }, "events": { "items": { "$ref": "#/definitions/OAS.DataModel.Utility.Process.ProcessEvent" }, "xml": { "name": "ProcessEvent", "wrapped": true }, "type": "array" }, "elementActivity": { "$ref": "#/definitions/OAS.DataModel.Utility.Process.ProcessElementActivity" }, "elementEvent": { "$ref": "#/definitions/OAS.DataModel.Utility.Process.ProcessElementEvent" }, "participant": { "$ref": "#/definitions/OAS.DataModel.Utility.Process.ProcessParticipant" } }, "xml": { "name": "ProcessElement" }, "type": "object" }, "OAS.DataModel.Utility.Process.ProcessEvent": { "properties": { "id": { "type": "integer", "format": "int32" }, "elementId": { "type": "integer", "format": "int32" }, "catchEventId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "position": { "type": "string", "enum": [ "Start", "Intermediate", "End" ] }, "type": { "type": "string", "enum": [ "Generic", "Message", "Timer", "Conditional", "Signal", "Multiple", "MultipleParallel", "Escalation", "Error", "Compensation", "Link", "Cancel", "Terminate" ] }, "element": { "$ref": "#/definitions/OAS.DataModel.Utility.Process.ProcessElement" }, "catchEvent": { "$ref": "#/definitions/OAS.DataModel.Utility.Process.ProcessEvent" }, "throwEvents": { "items": { "$ref": "#/definitions/OAS.DataModel.Utility.Process.ProcessEvent" }, "xml": { "name": "ProcessEvent", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProcessEvent" }, "type": "object" }, "OAS.DataModel.Utility.Process.ProcessElementActivity": { "required": [ "elementId" ], "properties": { "elementId": { "type": "integer", "format": "int32" }, "activityId": { "type": "integer", "format": "int32" }, "activity": { "$ref": "#/definitions/OAS.DataModel.Utility.Process.ProcessActivity" } }, "xml": { "name": "ProcessElementActivity" }, "type": "object" }, "OAS.DataModel.Utility.Process.ProcessElementEvent": { "required": [ "elementId" ], "properties": { "elementId": { "type": "integer", "format": "int32" }, "eventId": { "type": "integer", "format": "int32" }, "event": { "$ref": "#/definitions/OAS.DataModel.Utility.Process.ProcessEvent" } }, "xml": { "name": "ProcessElementEvent" }, "type": "object" }, "OAS.WebApi.DTO.Utility.Process.ProcessFieldDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "templateId": { "type": "integer", "format": "int32" }, "sourceId": { "type": "integer", "format": "int32" }, "fieldType": { "type": "string", "enum": [ "Text", "TextArea", "Date", "DateTime", "RadioList", "CheckList", "SelectList", "Number", "Email", "Entity" ] }, "dataType": { "type": "integer", "format": "int32" }, "isRequired": { "type": "boolean" }, "label": { "type": "string" }, "description": { "type": "string" }, "options": { "type": "string" }, "max": { "type": "integer", "format": "int32" }, "min": { "type": "integer", "format": "int32" }, "entity": { "type": "integer", "format": "int32" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "ProcessFieldDto" }, "type": "object" }, "OAS.DataModel.Utility.Process.ProcessField": { "required": [ "id", "templateId", "fieldType", "isRequired", "label", "description", "auditedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "templateId": { "type": "integer", "format": "int32" }, "elementId": { "type": "integer", "format": "int32" }, "fieldType": { "type": "string", "enum": [ "Text", "TextArea", "Date", "DateTime", "RadioList", "CheckList", "SelectList", "Number", "Email", "Entity" ] }, "dataType": { "type": "integer", "format": "int32" }, "isRequired": { "type": "boolean" }, "label": { "type": "string", "maxLength": 100, "minLength": 0 }, "description": { "type": "string", "maxLength": 2500, "minLength": 0 }, "options": { "type": "string", "maxLength": 1000, "minLength": 0 }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "ProcessField" }, "type": "object" }, "OAS.WebApi.DTO.Utility.Process.ProcessInstanceDetailDto": { "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "period": { "type": "integer", "format": "int32" }, "processTypeId": { "type": "integer", "format": "int32" }, "definition": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessDefinitionDto" }, "tasks": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessTaskDto" }, "xml": { "name": "ProcessTaskDto", "wrapped": true }, "type": "array" }, "participants": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessParticipantDto" }, "xml": { "name": "ProcessParticipantDto", "wrapped": true }, "type": "array" }, "id": { "type": "integer", "format": "int32" }, "definitionId": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "targetDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time" }, "completeDate": { "type": "string", "format": "date-time" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "assignees": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessAssignmentDto" }, "xml": { "name": "ProcessAssignmentDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProcessInstanceDetailDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.Process.ProcessDefinitionDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "rootElementId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "urlName": { "type": "string" }, "description": { "type": "string" }, "processName": { "type": "string" }, "taskName": { "type": "string" }, "canUnassignTask": { "type": "boolean" }, "canReassignTask": { "type": "boolean" }, "allowTaskCategories": { "type": "boolean" }, "allowDeptCategories": { "type": "boolean" }, "allowTaskStatuses": { "type": "boolean" }, "allowAssignTasks": { "type": "boolean" }, "allowMultipleTasks": { "type": "boolean" }, "allowMultipleTaskAssignments": { "type": "boolean" }, "emailOwnerOnChange": { "type": "boolean" }, "dontEmailIfOwnerIsAssigned": { "type": "boolean" }, "autoAssignUsers": { "type": "boolean" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "ProcessDefinitionDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.Process.ProcessTaskDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "processActivityId": { "type": "integer", "format": "int32" }, "instanceId": { "type": "integer", "format": "int32" }, "assignmentId": { "type": "integer", "format": "int32" }, "assignedUserId": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "targetDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time" }, "completeDate": { "type": "string", "format": "date-time" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "assignee": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessAssignmentDto" }, "name": { "type": "string" }, "description": { "type": "string" }, "isPrivate": { "type": "boolean" }, "isRequired": { "type": "boolean" }, "participantId": { "type": "integer", "format": "int32" }, "fields": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessFieldDto" }, "xml": { "name": "ProcessFieldDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProcessTaskDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.Process.ProcessAssignmentDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "participantId": { "type": "integer", "format": "int32" }, "instanceId": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "isOwner": { "type": "boolean" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "userName": { "type": "string" }, "participant": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessParticipantDto" }, "user": { "$ref": "#/definitions/OAS.WebApi.DTO.Security.UserProfileDto" } }, "xml": { "name": "ProcessAssignmentDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.Process.ProcessInstanceDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "definitionId": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "targetDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time" }, "completeDate": { "type": "string", "format": "date-time" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "assignees": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessAssignmentDto" }, "xml": { "name": "ProcessAssignmentDto", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProcessInstanceDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.Process.ProcessDefinitionDetailDto": { "properties": { "participants": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessParticipantDto" }, "xml": { "name": "ProcessParticipantDto", "wrapped": true }, "type": "array" }, "elements": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessElementDto" }, "xml": { "name": "ProcessElementDto", "wrapped": true }, "type": "array" }, "events": { "items": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.Process.ProcessEventDto" }, "xml": { "name": "ProcessEventDto", "wrapped": true }, "type": "array" }, "id": { "type": "integer", "format": "int32" }, "rootElementId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "urlName": { "type": "string" }, "description": { "type": "string" }, "processName": { "type": "string" }, "taskName": { "type": "string" }, "canUnassignTask": { "type": "boolean" }, "canReassignTask": { "type": "boolean" }, "allowTaskCategories": { "type": "boolean" }, "allowDeptCategories": { "type": "boolean" }, "allowTaskStatuses": { "type": "boolean" }, "allowAssignTasks": { "type": "boolean" }, "allowMultipleTasks": { "type": "boolean" }, "allowMultipleTaskAssignments": { "type": "boolean" }, "emailOwnerOnChange": { "type": "boolean" }, "dontEmailIfOwnerIsAssigned": { "type": "boolean" }, "autoAssignUsers": { "type": "boolean" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" } }, "xml": { "name": "ProcessDefinitionDetailDto" }, "type": "object" }, "OAS.DataModel.Utility.Process.ProcessAssignment": { "required": [ "id", "participantId", "instanceId", "userId", "isOwner", "auditedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "participantId": { "type": "integer", "format": "int32" }, "instanceId": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "isOwner": { "type": "boolean" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "user": { "$ref": "#/definitions/OAS.DataModel.Security.User" }, "instance": { "$ref": "#/definitions/OAS.DataModel.Utility.Process.ProcessInstance" }, "tasks": { "items": { "$ref": "#/definitions/OAS.DataModel.Utility.Process.ProcessTask" }, "xml": { "name": "ProcessTask", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProcessAssignment" }, "type": "object" }, "OAS.DataModel.Utility.Process.ProcessInstance": { "required": [ "id", "definitionId", "startDate", "auditedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "definitionId": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "targetDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time" }, "completeDate": { "type": "string", "format": "date-time" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "definition": { "$ref": "#/definitions/OAS.DataModel.Utility.Process.ProcessDefinition" }, "tasks": { "items": { "$ref": "#/definitions/OAS.DataModel.Utility.Process.ProcessTask" }, "xml": { "name": "ProcessTask", "wrapped": true }, "type": "array" }, "assignees": { "items": { "$ref": "#/definitions/OAS.DataModel.Utility.Process.ProcessAssignment" }, "xml": { "name": "ProcessAssignment", "wrapped": true }, "type": "array" } }, "xml": { "name": "ProcessInstance" }, "type": "object" }, "OAS.DataModel.Utility.Process.ProcessTask": { "required": [ "id", "processActivityId", "instanceId", "assignmentId", "startDate", "auditedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "processActivityId": { "type": "integer", "format": "int32" }, "instanceId": { "type": "integer", "format": "int32" }, "assignmentId": { "type": "integer", "format": "int32" }, "startDate": { "type": "string", "format": "date-time" }, "targetDate": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time" }, "completeDate": { "type": "string", "format": "date-time" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "elementActivity": { "$ref": "#/definitions/OAS.DataModel.Utility.Process.ProcessElementActivity" }, "instance": { "$ref": "#/definitions/OAS.DataModel.Utility.Process.ProcessInstance" }, "assignee": { "$ref": "#/definitions/OAS.DataModel.Utility.Process.ProcessAssignment" } }, "xml": { "name": "ProcessTask" }, "type": "object" }, "OAS.DataModel.Utility.Process.ProcessDefinition": { "required": [ "id", "rootElementId", "name", "urlName", "description", "canUnassignTask", "canReassignTask", "allowTaskCategories", "allowDeptCategories", "allowTaskStatuses", "allowAssignTasks", "allowMultipleTasks", "allowMultipleTaskAssignments", "emailOwnerOnChange", "dontEmailIfOwnerIsAssigned", "autoAssignUsers", "auditedDate" ], "properties": { "id": { "type": "integer", "format": "int32" }, "rootElementId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "maxLength": 100, "minLength": 0 }, "urlName": { "type": "string", "maxLength": 100, "minLength": 0 }, "description": { "type": "string", "maxLength": 2500, "minLength": 0 }, "canUnassignTask": { "type": "boolean" }, "canReassignTask": { "type": "boolean" }, "allowTaskCategories": { "type": "boolean" }, "allowDeptCategories": { "type": "boolean" }, "allowTaskStatuses": { "type": "boolean" }, "allowAssignTasks": { "type": "boolean" }, "allowMultipleTasks": { "type": "boolean" }, "allowMultipleTaskAssignments": { "type": "boolean" }, "emailOwnerOnChange": { "type": "boolean" }, "dontEmailIfOwnerIsAssigned": { "type": "boolean" }, "autoAssignUsers": { "type": "boolean" }, "auditedDate": { "type": "string", "format": "date-time" }, "auditedByDisplay": { "type": "string" }, "rootElement": { "$ref": "#/definitions/OAS.DataModel.Utility.Process.ProcessElement" } }, "xml": { "name": "ProcessDefinition" }, "type": "object" }, "OAS.DataModel.Trading.TradeEntityInfo": { "properties": { "entityId": { "type": "integer", "format": "int32" }, "tradingPlatform": { "type": "string", "enum": [ "TOM", "Eclipse" ] } }, "xml": { "name": "TradeEntityInfo" }, "type": "object" }, "OAS.WebApi.DTO.Search.SearchProductExtendedDto": { "properties": { "price": { "type": "number", "format": "double" }, "ticker": { "type": "string" }, "productId": { "type": "integer", "format": "int32" }, "productName": { "type": "string" }, "productType": { "type": "integer", "format": "int32" }, "productTypeName": { "type": "string" }, "shareClass": { "$ref": "#/definitions/OAS.DataModel.Portfolio.ShareClass" }, "externalId": { "type": "integer", "format": "int32" }, "productRiskScore": { "type": "integer", "format": "int32" }, "productClass": { "type": "string" }, "productCategory": { "type": "string" }, "riskScore": { "type": "integer", "format": "int32" } }, "xml": { "name": "SearchProductExtendedDto" }, "type": "object" }, "OAS.DataModel.Trading.LocalTradeOrderInstance": { "properties": { "id": { "type": "integer", "format": "int32" }, "orionRepId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "completed": { "type": "boolean" }, "deleted": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "products": { "items": { "$ref": "#/definitions/OAS.DataModel.Trading.LocalTradeOrderInstanceProduct" }, "xml": { "name": "LocalTradeOrderInstanceProduct", "wrapped": true }, "type": "array" } }, "xml": { "name": "LocalTradeOrderInstance" }, "type": "object" }, "OAS.DataModel.Trading.LocalTradeOrderInstanceProduct": { "properties": { "tradeOrderInstanceId": { "type": "integer", "format": "int32" }, "productId": { "type": "integer", "format": "int32" }, "ticker": { "type": "string" }, "tradeType": { "type": "string", "enum": [ "Sell", "Buy" ] }, "amount": { "type": "number", "format": "double" }, "deleted": { "type": "boolean" }, "createdDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" } }, "xml": { "name": "LocalTradeOrderInstanceProduct" }, "type": "object" }, "OAS.WebApi.DTO.Utility.AllDatabaseSearchDto": { "properties": { "databaseName": { "type": "string" }, "brokerDealerId": { "type": "integer", "format": "int32" }, "repId": { "type": "integer", "format": "int32" }, "clientId": { "type": "integer", "format": "int32" }, "registrationId": { "type": "integer", "format": "int32" }, "accountId": { "type": "integer", "format": "int32" }, "accountType": { "type": "string" }, "subAdvisorId": { "type": "integer", "format": "int32" }, "householdLName": { "type": "string" }, "householdFName": { "type": "string" }, "householdSSN_TaxID": { "type": "string" }, "repLName": { "type": "string" }, "repFName": { "type": "string" }, "repNo": { "type": "string" }, "registrationLName": { "type": "string" }, "registrationFName": { "type": "string" }, "registrationSSN_TaxID": { "type": "string" }, "acctCode": { "type": "string" }, "outsideId": { "type": "string" }, "isActive": { "type": "boolean" }, "alClientId": { "type": "integer", "format": "int32" } }, "xml": { "name": "AllDatabaseSearchDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.SubscriptionCenter.SubscriptionCenterUserRequestDto": { "properties": { "subscriptionIds": { "items": { "type": "string" }, "type": "array" }, "masterFirmGlobalId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "firmGlobalId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "firmName": { "type": "string" }, "userGlobalId": { "example": "00000000-0000-0000-0000-000000000000", "type": "string", "format": "uuid" }, "userInfo": { "$ref": "#/definitions/OAS.WebApi.DTO.Utility.SubscriptionCenter.SubscriptionCenterUserInfoDto" } }, "xml": { "name": "SubscriptionCenterUserRequestDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.SubscriptionCenter.SubscriptionCenterUserInfoDto": { "properties": { "isDatabaseOwner": { "type": "boolean" }, "userId": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "company": { "type": "string" }, "businessPhone": { "type": "string" }, "businessPhoneExtension": { "type": "string" } }, "xml": { "name": "SubscriptionCenterUserInfoDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.ExpressionValidResultDto": { "properties": { "expression": { "type": "string" }, "isValid": { "type": "boolean" } }, "xml": { "name": "ExpressionValidResultDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.WorkflowProcessInstanceDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "instanceName": { "type": "string" } }, "xml": { "name": "WorkflowProcessInstanceDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.WorkflowProcessInstanceDashboardDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "instanceName": { "type": "string" }, "waitingOn": { "type": "string" }, "lastUpdate": { "type": "string", "format": "date-time" }, "percentComplete": { "type": "number", "format": "double" } }, "xml": { "name": "WorkflowProcessInstanceDashboardDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.WorkflowProcessTemplateDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "processName": { "type": "string" }, "processDescription": { "type": "string" }, "processCode": { "type": "string" }, "workflowProcessTypeId": { "type": "integer", "format": "int32" } }, "xml": { "name": "WorkflowProcessTemplateDto" }, "type": "object" }, "OAS.WebApi.DTO.Utility.WorkflowProcessTypeDto": { "properties": { "id": { "type": "integer", "format": "int32" }, "processTypeName": { "type": "string" }, "processTypeDescription": { "type": "string" }, "processTypeCode": { "type": "string" } }, "xml": { "name": "WorkflowProcessTypeDto" }, "type": "object" }, "OAS.WebApi.DTO.ValidateImport.AccountContributionDto": { "properties": { "contributionCodeId": { "type": "integer", "format": "int32" }, "id": { "type": "integer", "format": "int32" }, "number": { "type": "string" }, "amount": { "type": "number", "format": "double" }, "isValid": { "type": "boolean" }, "message": { "type": "string" } }, "xml": { "name": "AccountContributionDto" }, "type": "object" }, "OAS.WebApi.DTO.Billing.BillSimpleEntityDto": { "properties": { "isRecalc": { "type": "boolean" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } }, "xml": { "name": "BillSimpleEntityDto" }, "type": "object" } }, "securityDefinitions": { "Authorization": { "type": "apiKey", "description": "JWT Authorization header using the Session scheme. Example: \"Authorization: Session {token}\"", "name": "Authorization", "in": "header" } }, "tags": [ { "name": "{uri}" }, { "name": "AdvisorTrading/BuySell" }, { "name": "AdvisorTrading/Core" }, { "name": "AdvisorTrading/Instances" }, { "name": "AdvisorTrading/SleeveAssignment" }, { "name": "Aggregator" }, { "name": "Aggregator/AccessToken" }, { "name": "Aggregator/Accounts" }, { "name": "Aggregator/Holdings" }, { "name": "Aggregator/Token" }, { "name": "Aggregator/Transactions" }, { "name": "Authorization/Databases" }, { "name": "Authorization/Profiles" }, { "name": "Authorization/User" }, { "name": "Billing/Accounts" }, { "name": "Billing/accountsPaidByFor" }, { "name": "Billing/AccountStatusTypes" }, { "name": "Billing/AdjustmentTypes" }, { "name": "Billing/Assets" }, { "name": "Billing/Audit" }, { "name": "Billing/BillAssetItem" }, { "name": "Billing/BillCompareDashboard" }, { "name": "Billing/BillDataExport" }, { "name": "Billing/BillGenerator" }, { "name": "Billing/BillingCompare" }, { "name": "Billing/BillingEntities" }, { "name": "Billing/BillingSummary" }, { "name": "Billing/BillPayMethods" }, { "name": "Billing/BillProductGroup" }, { "name": "Billing/Bills" }, { "name": "Billing/BillScheduleElementRestrictions" }, { "name": "Billing/BillTransmitMethods" }, { "name": "Billing/CancellationFeeAdjDefault" }, { "name": "Billing/CashFunding" }, { "name": "Billing/Clients" }, { "name": "Billing/ClientStatuses" }, { "name": "Billing/Consolidation" }, { "name": "Billing/Counts" }, { "name": "Billing/CreateNewBillAccountItemAdj" }, { "name": "Billing/CreateNewPayableItemAdj" }, { "name": "Billing/DeleteNotes" }, { "name": "Billing/Entities" }, { "name": "Billing/Enums" }, { "name": "Billing/FeatureFlags" }, { "name": "Billing/FeeCollection" }, { "name": "Billing/FeeFile" }, { "name": "Billing/FeeType" }, { "name": "Billing/FinalBills" }, { "name": "Billing/FinancialPlanningFee" }, { "name": "Billing/GenerateMockBills" }, { "name": "Billing/Hierarchy" }, { "name": "Billing/HouseholdSummary" }, { "name": "Billing/IndirectScript" }, { "name": "Billing/Instances" }, { "name": "Billing/Invoices" }, { "name": "Billing/ManagementFeesNotPosted" }, { "name": "Billing/MasterPayoutSchedule" }, { "name": "Billing/PayablesByRep" }, { "name": "Billing/PayablesSummary" }, { "name": "Billing/Payees" }, { "name": "Billing/PayMethods" }, { "name": "Billing/PayoutDashboard" }, { "name": "Billing/Payouts" }, { "name": "Billing/PersonalizedPortfolio" }, { "name": "Billing/PostAuditFiles" }, { "name": "Billing/PostedPayments" }, { "name": "Billing/PostManagementFees" }, { "name": "Billing/PostPayments" }, { "name": "Billing/Products" }, { "name": "Billing/RecalcProcess" }, { "name": "Billing/ReceiveableSummary" }, { "name": "Billing/ReferralPayments" }, { "name": "Billing/ReferralPayouts" }, { "name": "Billing/RelatedBillingClient" }, { "name": "Billing/RevenuePayout" }, { "name": "Billing/Run" }, { "name": "Billing/Schedules" }, { "name": "Billing/SyncCashtoEclipse" }, { "name": "Billing/Transactions" }, { "name": "Billing/UpdateBillaccountItem" }, { "name": "Billing/UpdateNotes" }, { "name": "Billing/ValidateImport" }, { "name": "Blogging/Blogs" }, { "name": "Blogging/Emails" }, { "name": "Blogging/Newsfeed" }, { "name": "Compliance/Archive" }, { "name": "Compliance/AuditRequests" }, { "name": "Compliance/AuditTests" }, { "name": "Compliance/Bcc" }, { "name": "Compliance/Dashboard" }, { "name": "Compliance/Disclose" }, { "name": "Compliance/Filter" }, { "name": "Compliance/Inform" }, { "name": "Compliance/InformEmail" }, { "name": "Compliance/RiskDashboard" }, { "name": "Configuration/{configuration}" }, { "name": "Configuration/raw" }, { "name": "Confirm/ABCompare" }, { "name": "Confirm/AccountMergeBatch" }, { "name": "Confirm/AccountMergeBatchDetail" }, { "name": "Confirm/AccountRestore" }, { "name": "Confirm/AccountRestoreBatch" }, { "name": "Confirm/Alternative" }, { "name": "Confirm/CorporateAction" }, { "name": "Confirm/CustomImportFiles" }, { "name": "Confirm/CustomImports" }, { "name": "Confirm/DatabaseBackupFileRestore" }, { "name": "Confirm/DataQueryEntityExcludes" }, { "name": "Confirm/DownloadFiles" }, { "name": "Confirm/DownloadFormat" }, { "name": "Confirm/DownloadFormats" }, { "name": "Confirm/DownloadFormatSourceDefault" }, { "name": "Confirm/DownloadFormatVersion" }, { "name": "Confirm/DownloadMap" }, { "name": "Confirm/DownloadPositionProcess" }, { "name": "Confirm/DownloadProcess" }, { "name": "Confirm/DownloadScrubAutomation" }, { "name": "Confirm/DownloadSourceNote" }, { "name": "Confirm/DownloadSources" }, { "name": "Confirm/DownloadTextModification" }, { "name": "Confirm/DuplicateAccountMapping" }, { "name": "Confirm/Exclusions" }, { "name": "Confirm/ExclusionSync" }, { "name": "Confirm/FileExports" }, { "name": "Confirm/Groups" }, { "name": "Confirm/HeldAway" }, { "name": "Confirm/InterfaceReconciliations" }, { "name": "Confirm/InterfaceSyncs" }, { "name": "Confirm/localexclusion" }, { "name": "Confirm/MatrixCashActivityGemini" }, { "name": "Confirm/MissingPriceSyncs" }, { "name": "Confirm/Overview" }, { "name": "Confirm/Pgp" }, { "name": "Confirm/Recon" }, { "name": "Confirm/ReconJobStatuses" }, { "name": "Confirm/RecordTypes" }, { "name": "Confirm/Results" }, { "name": "Confirm/Rules" }, { "name": "Confirm/SchedulerMaintenance" }, { "name": "Confirm/SignOffs" }, { "name": "Confirm/SleeveSettings" }, { "name": "Confirm/StatusTypes" }, { "name": "Confirm/SyncDashboard" }, { "name": "Confirm/SyncTypes" }, { "name": "Confirm/TaxCenter" }, { "name": "Confirm/TaxError" }, { "name": "Confirm/UploadFormats" }, { "name": "Confirm/UploadTarget" }, { "name": "Dashboards/Cards" }, { "name": "DataMaintenance/DataProvider" }, { "name": "Email/Clients" }, { "name": "FileImport/{key}" }, { "name": "FileImport/Instance" }, { "name": "FileImport/Log" }, { "name": "FileImport/Upload" }, { "name": "Fuse/Config" }, { "name": "Fuse/Notifications" }, { "name": "Fuse/PartnerApps" }, { "name": "Fuse/Slack" }, { "name": "Fuse/Users" }, { "name": "Global/CorporateActions" }, { "name": "Global/Custodians" }, { "name": "Global/Dividends" }, { "name": "Global/DownloadSymbols" }, { "name": "Global/FundFamilies" }, { "name": "Global/Prices" }, { "name": "Global/Products" }, { "name": "Global/ServiceTeamMembers" }, { "name": "Global/ServiceTeams" }, { "name": "Global/StatesMunicipalBondTax" }, { "name": "Global/StaticFiles" }, { "name": "Global/SubHoldings" }, { "name": "Global/UserFeedback" }, { "name": "Homepage/Action" }, { "name": "Homepage/Beneficiaries" }, { "name": "Homepage/Dashboards" }, { "name": "Homepage/ODataQueries" }, { "name": "Homepage/Performance" }, { "name": "Homepage/PortfolioTree" }, { "name": "Homepage/PortfolioView" }, { "name": "Homepage/PortfolioViews" }, { "name": "Homepage/Roles" }, { "name": "Homepage/Setting" }, { "name": "Homepage/UserDashboard" }, { "name": "Homepage/Users" }, { "name": "Integration/Certs" }, { "name": "Integration/RolesForCode" }, { "name": "Integration/RolesForKey" }, { "name": "Integration/UpdateRoles" }, { "name": "Integrations/AdviceWorks" }, { "name": "Integrations/AdvisorCloudStorage" }, { "name": "Integrations/AdvisoryWorld" }, { "name": "Integrations/Advizr" }, { "name": "Integrations/Akoya" }, { "name": "Integrations/Apex" }, { "name": "Integrations/Apps" }, { "name": "Integrations/Ascent" }, { "name": "Integrations/AssetMap" }, { "name": "Integrations/Astro" }, { "name": "Integrations/Axos" }, { "name": "Integrations/BasisCode" }, { "name": "Integrations/BizEquity" }, { "name": "Integrations/BlackRock" }, { "name": "Integrations/Blaze" }, { "name": "Integrations/BluePay" }, { "name": "Integrations/ByAllAccounts" }, { "name": "Integrations/CAIS" }, { "name": "Integrations/CapitalNetwork" }, { "name": "Integrations/Cetera" }, { "name": "Integrations/Cheetah" }, { "name": "Integrations/ChicagoClearing" }, { "name": "Integrations/CleverDome" }, { "name": "Integrations/ClientBoxFolder" }, { "name": "Integrations/CloudStorage" }, { "name": "Integrations/Communities" }, { "name": "Integrations/Configuration" }, { "name": "Integrations/CustodialIntegrator" }, { "name": "Integrations/Custodian" }, { "name": "Integrations/CustodianDashboard" }, { "name": "Integrations/CustodianDocuments" }, { "name": "Integrations/DataTransmissionService" }, { "name": "Integrations/Dimensional" }, { "name": "Integrations/Docusign" }, { "name": "Integrations/DPL" }, { "name": "Integrations/Eclipse" }, { "name": "Integrations/Element" }, { "name": "Integrations/ElementTrading" }, { "name": "Integrations/eMoney" }, { "name": "Integrations/FCS" }, { "name": "Integrations/Fidelity" }, { "name": "Integrations/FinaMetrica" }, { "name": "Integrations/FinMason" }, { "name": "Integrations/Flourish" }, { "name": "Integrations/FPAlpha" }, { "name": "Integrations/HiddenLevers" }, { "name": "Integrations/Instream" }, { "name": "Integrations/IntegrationSync" }, { "name": "Integrations/Intuit" }, { "name": "Integrations/iRebal" }, { "name": "Integrations/Junxure" }, { "name": "Integrations/LaserApp" }, { "name": "Integrations/LexisNexis" }, { "name": "Integrations/Marketor" }, { "name": "Integrations/MFE" }, { "name": "Integrations/Mindflash" }, { "name": "Integrations/MindTouchCls" }, { "name": "Integrations/MoneyGuidePro" }, { "name": "Integrations/NewAccount" }, { "name": "Integrations/Notifications" }, { "name": "Integrations/Onboarding" }, { "name": "integrations/openai" }, { "name": "Integrations/OrionElement" }, { "name": "Integrations/OutboxSync" }, { "name": "Integrations/Paperwork" }, { "name": "Integrations/Pershing" }, { "name": "Integrations/Plaid" }, { "name": "Integrations/Quantum" }, { "name": "integrations/querysmith" }, { "name": "Integrations/Quik" }, { "name": "Integrations/Redtail" }, { "name": "Integrations/RightCapital" }, { "name": "Integrations/RiskAlyze" }, { "name": "Integrations/RiskAnalytics" }, { "name": "Integrations/RiskScores" }, { "name": "Integrations/SaleMove" }, { "name": "Integrations/Salesforce" }, { "name": "Integrations/SalesforceSync" }, { "name": "Integrations/SAML" }, { "name": "Integrations/SchwabAlliance" }, { "name": "Integrations/SchwabBatch" }, { "name": "Integrations/SchwabServiceRequest" }, { "name": "Integrations/SchwabSII" }, { "name": "Integrations/SchwabStatus" }, { "name": "Integrations/ShareFile" }, { "name": "Integrations/SmartIQ" }, { "name": "Integrations/Support" }, { "name": "Integrations/SyncHistory" }, { "name": "Integrations/TDAmeritrade" }, { "name": "Integrations/Tolerisk" }, { "name": "Integrations/TRX" }, { "name": "Integrations/Vanilla" }, { "name": "Integrations/Vision" }, { "name": "Integrations/WealthAccess" }, { "name": "Integrations/WealthSite" }, { "name": "Integrations/YahooFinance" }, { "name": "MarketProperties/BullBearDates" }, { "name": "Mobile/Clients" }, { "name": "Mobile/Register" }, { "name": "Monitor", "description": "Primary controller for public information." }, { "name": "OrionStored/Compare" }, { "name": "OrionStored/RunAsset" }, { "name": "Performance/AttributionAssignment" }, { "name": "Performance/AttributionDetails" }, { "name": "Performance/Batch" }, { "name": "Performance/Compare" }, { "name": "Performance/Maintenance" }, { "name": "Performance/Overview" }, { "name": "Performance/StoredPerformanceImport" }, { "name": "Portfolio/AccountCancellationSubjects" }, { "name": "Portfolio/AccountCustodialInfo" }, { "name": "Portfolio/Accounts" }, { "name": "Portfolio/AccountStatuses" }, { "name": "Portfolio/ALClientOps" }, { "name": "Portfolio/AssetLevelStrategies" }, { "name": "Portfolio/Assets" }, { "name": "Portfolio/AvailableAccountNumbers" }, { "name": "Portfolio/Benchmarks" }, { "name": "Portfolio/BondRatings" }, { "name": "Portfolio/BrokerDealers" }, { "name": "Portfolio/BusinessLines" }, { "name": "Portfolio/ClientCategories" }, { "name": "Portfolio/ClientChanges" }, { "name": "Portfolio/Clients" }, { "name": "Portfolio/CompareTool" }, { "name": "Portfolio/CorporateActionNotifications" }, { "name": "Portfolio/CostBasis" }, { "name": "Portfolio/Counts" }, { "name": "Portfolio/CrmDocuments" }, { "name": "Portfolio/CustodianRealized" }, { "name": "Portfolio/Custodians" }, { "name": "Portfolio/CustodianUnRealized" }, { "name": "Portfolio/Element" }, { "name": "Portfolio/Esg" }, { "name": "Portfolio/FundFamilies" }, { "name": "Portfolio/Genders" }, { "name": "Portfolio/Goals" }, { "name": "Portfolio/HouseholdMemberTypes" }, { "name": "Portfolio/IndexBlends" }, { "name": "Portfolio/InvestmentObjectives" }, { "name": "Portfolio/Locale" }, { "name": "Portfolio/Managers" }, { "name": "Portfolio/MatrixB50" }, { "name": "Portfolio/NoteCategories" }, { "name": "Portfolio/OfacChecks" }, { "name": "Portfolio/OfacFiles" }, { "name": "Portfolio/OrionRealized" }, { "name": "Portfolio/OrionUnrealized" }, { "name": "Portfolio/ParentCategories" }, { "name": "Portfolio/Participants" }, { "name": "Portfolio/PlanAdministrators" }, { "name": "Portfolio/Plans" }, { "name": "Portfolio/PlanSponsors" }, { "name": "Portfolio/Platforms" }, { "name": "Portfolio/PlatformTypes" }, { "name": "Portfolio/PortfolioAudit" }, { "name": "Portfolio/PortfolioGroupAutomation" }, { "name": "Portfolio/PortfolioGroups" }, { "name": "Portfolio/ProductCategories" }, { "name": "Portfolio/ProductClassAutoAssignOverride" }, { "name": "Portfolio/ProductClasses" }, { "name": "Portfolio/ProductDescriptionProvider" }, { "name": "Portfolio/ProductExpenseRatio" }, { "name": "Portfolio/Products" }, { "name": "Portfolio/ProductTypes" }, { "name": "Portfolio/PropertyTypes" }, { "name": "Portfolio/QPENonManaged" }, { "name": "Portfolio/Regions" }, { "name": "Portfolio/RegistrationChanges" }, { "name": "Portfolio/Registrations" }, { "name": "Portfolio/ReportGroup" }, { "name": "Portfolio/RepresentativeChanges" }, { "name": "Portfolio/Representatives" }, { "name": "Portfolio/ReturnObjectives" }, { "name": "Portfolio/Rias" }, { "name": "Portfolio/RiskCategories" }, { "name": "Portfolio/RiskCategoryAutoAssignOverride" }, { "name": "Portfolio/SecurityClassification" }, { "name": "Portfolio/ShareClasses" }, { "name": "Portfolio/SleeveTransfer" }, { "name": "Portfolio/States" }, { "name": "Portfolio/SubAdvisors" }, { "name": "Portfolio/SystematicAccount" }, { "name": "Portfolio/TaxLotAssignments" }, { "name": "Portfolio/ThirdPartyAdministrators" }, { "name": "Portfolio/TimeHorizons" }, { "name": "Portfolio/Transactions" }, { "name": "Portfolio/TRInterfaceFormats" }, { "name": "Portfolio/ValidateImport" }, { "name": "Portfolio/Wholesalers" }, { "name": "PortfolioDataSync/DataSharing" }, { "name": "Product/CreateProducts" }, { "name": "Public/Database" }, { "name": "Public/Databases" }, { "name": "Public/Partners" }, { "name": "Public/RequestForgotPassword" }, { "name": "Public/SecurityQuestion" }, { "name": "Public/SMS" }, { "name": "Public/UrlShortener" }, { "name": "Public/User" }, { "name": "QueryStudio/NaturalLanguage" }, { "name": "QueryStudio/Queries" }, { "name": "QueryStudio/QueryTags" }, { "name": "QueryStudio/QueryTagSources" }, { "name": "QueryStudio/RelatedColumns" }, { "name": "Remove" }, { "name": "RepExpTrading/{entity}" }, { "name": "RepExpTrading/{entityEnum}" }, { "name": "ReportAdministration/Reports" }, { "name": "ReportBuilder/CoverPages" }, { "name": "ReportBuilder/Reports" }, { "name": "ReportBuilder/Sections" }, { "name": "ReportBuilder/Themes" }, { "name": "ReportBuilder/WebMenuOptions" }, { "name": "Reporting/Activity" }, { "name": "Reporting/Admin" }, { "name": "Reporting/Assistant" }, { "name": "Reporting/AutomatedCompares" }, { "name": "Reporting/Batch" }, { "name": "Reporting/BI" }, { "name": "Reporting/Billing" }, { "name": "Reporting/Calculate" }, { "name": "Reporting/Compares" }, { "name": "Reporting/Composite" }, { "name": "Reporting/Custom" }, { "name": "Reporting/Dashboards" }, { "name": "Reporting/Data" }, { "name": "Reporting/Deliver" }, { "name": "Reporting/Element" }, { "name": "Reporting/Envision" }, { "name": "Reporting/Extracts" }, { "name": "Reporting/FundPerformance" }, { "name": "Reporting/Fuse" }, { "name": "Reporting/GainLoss" }, { "name": "Reporting/Implementation" }, { "name": "Reporting/InterfaceSetup" }, { "name": "Reporting/NotificationGroups" }, { "name": "Reporting/Notifications" }, { "name": "Reporting/NotificationTypes" }, { "name": "Reporting/Performance" }, { "name": "Reporting/PortalProtoType" }, { "name": "Reporting/PortalTask" }, { "name": "Reporting/Preview" }, { "name": "Reporting/ProcessManager" }, { "name": "Reporting/Proto" }, { "name": "Reporting/Qpe" }, { "name": "Reporting/ReportGroups" }, { "name": "Reporting/ReportInbox" }, { "name": "Reporting/ReportPackages" }, { "name": "Reporting/Reports" }, { "name": "Reporting/ReportTemplates" }, { "name": "Reporting/RequiredMinimumDistribution" }, { "name": "Reporting/Scope" }, { "name": "Reporting/ScrubSchedules" }, { "name": "Reporting/StaticFiles" }, { "name": "Reporting/VideoStatements" }, { "name": "Reporting/Widgets" }, { "name": "Rollups/AssetValueDaily" }, { "name": "Rollups/InvalidateTodaysStoredPerformanceCheck" }, { "name": "Rollups/RollupCompares" }, { "name": "Scheduler/Jobs" }, { "name": "Scheduler/JobSchedules" }, { "name": "Scheduler/NotificationGroup" }, { "name": "Security/Databases" }, { "name": "Security/EndpointDetails" }, { "name": "Security/Endpoints" }, { "name": "Security/Endpoints2" }, { "name": "Security/FirmContacts" }, { "name": "Security/Formatters" }, { "name": "Security/Login" }, { "name": "Security/LoginEntities" }, { "name": "Security/PartnerAppAdvisors" }, { "name": "Security/PartnerApps" }, { "name": "Security/Privileges" }, { "name": "Security/Profiles" }, { "name": "Security/Rights" }, { "name": "Security/Roles" }, { "name": "Security/Token" }, { "name": "Security/Users" }, { "name": "Security/ValidateImport" }, { "name": "Settings/Apps" }, { "name": "Settings/CustomSettings" }, { "name": "Settings/Database" }, { "name": "Settings/EntityOptions" }, { "name": "Settings/Options" }, { "name": "Settings/Owner" }, { "name": "Settings/UserDefinedFields" }, { "name": "Settings/UserDefinedTimeFields" }, { "name": "Settings/UserOptions" }, { "name": "Settings/Views" }, { "name": "Settings/WebAcknowledgements" }, { "name": "Settings/WebOptions" }, { "name": "Setup" }, { "name": "Status/Hangfire" }, { "name": "Theoretical/InflationRates" }, { "name": "Trading/AccountTradeInfo" }, { "name": "Trading/Confirm" }, { "name": "Trading/ContributionCodeExts" }, { "name": "Trading/ContributionCodes" }, { "name": "Trading/Contributions" }, { "name": "Trading/ConvexRebalanceAccount" }, { "name": "Trading/DistributionCodes" }, { "name": "Trading/ExecutionLogs" }, { "name": "Trading/FixBatches" }, { "name": "Trading/FixBlockOrders" }, { "name": "Trading/GenerateTrades" }, { "name": "Trading/GlobalTradeCount" }, { "name": "Trading/Instances" }, { "name": "Trading/ModelAggs" }, { "name": "Trading/ModelAggTypes" }, { "name": "Trading/ModelAnalyzer" }, { "name": "Trading/ModelDetails" }, { "name": "Trading/Models" }, { "name": "Trading/Orders" }, { "name": "Trading/OutsideTrading" }, { "name": "Trading/Overlays" }, { "name": "Trading/PendAccounts" }, { "name": "Trading/Ping" }, { "name": "Trading/PingMany" }, { "name": "Trading/Price" }, { "name": "Trading/Products" }, { "name": "Trading/Queues" }, { "name": "Trading/QUODD" }, { "name": "Trading/RebalanceLog" }, { "name": "Trading/Sleeve" }, { "name": "Trading/SleeveStrategy" }, { "name": "Trading/SleeveStrategyAggregate" }, { "name": "Trading/SleeveStrategyRiskType" }, { "name": "Trading/SleeveUpdateQueue" }, { "name": "Trading/SummaryCount" }, { "name": "Trading/Tactical" }, { "name": "Trading/TradeBlockReasons" }, { "name": "Trading/TradeBlocks" }, { "name": "Trading/TradeDefinition" }, { "name": "Trading/TradeExecution" }, { "name": "Trading/TradeFiles" }, { "name": "Trading/TradeGenerationStatus" }, { "name": "Trading/TradeStatuses" }, { "name": "Trading/TradeValidation" }, { "name": "Trading/Transactions" }, { "name": "Trading/TransactionSubTypes" }, { "name": "Trading/TransactionTypes" }, { "name": "Trading/UnallocatedOrders" }, { "name": "Trading/UploadTargets" }, { "name": "Trading/ValidateImport" }, { "name": "User/Homepage" }, { "name": "Utility/APILogs" }, { "name": "Utility/Archive" }, { "name": "Utility/AuditAlert" }, { "name": "Utility/BatchProcessing" }, { "name": "Utility/Cache" }, { "name": "Utility/DatabaseActionQueue" }, { "name": "Utility/DatabaseGroups" }, { "name": "Utility/DateExpressions" }, { "name": "Utility/EmailClients" }, { "name": "Utility/EntitySession" }, { "name": "Utility/Excel" }, { "name": "Utility/FeatureFlag" }, { "name": "Utility/FileToBase64" }, { "name": "Utility/Groupings" }, { "name": "Utility/Hangfire" }, { "name": "Utility/HomepageDashboard" }, { "name": "Utility/Html" }, { "name": "Utility/Html2Pdf" }, { "name": "Utility/Import" }, { "name": "Utility/ImportType" }, { "name": "Utility/Logging" }, { "name": "Utility/MaintenanceLastRun" }, { "name": "Utility/PageQueries" }, { "name": "Utility/Pgp" }, { "name": "Utility/PreviousBusinessDay" }, { "name": "Utility/Process" }, { "name": "Utility/Routing" }, { "name": "Utility/Search" }, { "name": "Utility/SlickGridExport" }, { "name": "Utility/SMS" }, { "name": "Utility/SubscriptionCenter" }, { "name": "Utility/ValidateExpressions" }, { "name": "Utility/WorkflowProcessInstances" }, { "name": "Utility/WorkflowProcessTemplates" }, { "name": "Utility/WorkflowProcessTypes" }, { "name": "ValidateImport/Accounts" }, { "name": "ValidateImport/Billing" }, { "name": "ValidateImport/Echo" } ] }